Smart List Items Copying through PnP PowerShell - Part Two

In this blog, you will learn about Smart List Items Copying through PnP PowerShell.

Introduction 

 

Hi guys, If you have already tried my previous script (available here) it's time to develop scripts on a deeper level. Here is one more cool script to run so that we can copy all the list items from a Source List to Target List within the same collection. This is a smart modern way of copying list items without losing data from any column values. The amazing part of this PS script is it can handle all types of List Columns like look-ups, Metadata, other data types + attachments. I have added/updated a few more blocks of code on my PS script and present a better but more refined PnP script.

 

Script 

 

Here is the PnP Script,

#Function to copy attachments between list items
Function Copy - SPOAttachments() {
        param(
            [Parameter(Mandatory = $true)][Microsoft.SharePoint.Client.ListItem] $SourceItem,
            [Parameter(Mandatory = $true)][Microsoft.SharePoint.Client.ListItem] $DestinationItem)
        Try {
            #Get All Attachments from Source list items
            $Attachments = Get - PnPProperty - ClientObject $SourceItem - Property "AttachmentFiles"
            $Attachments | ForEach - Object {
                #Download the Attachment to Temp
                $File = Get - PnPFile - Connection $SourceConn - Url $_.ServerRelativeUrl - FileName $_.FileName - Path $Env: TEMP - AsFile - force
                #Add Attachment to Destination List Item
                $FileStream = New - Object IO.FileStream(($Env: TEMP + "\"+$_.FileName),[System.IO.FileMode]::Open)
                        $AttachmentInfo = New - Object - TypeName Microsoft.SharePoint.Client.AttachmentCreationInformation $AttachmentInfo.FileName = $_.FileName $AttachmentInfo.ContentStream = $FileStream $AttachFile = $DestinationItem.AttachmentFiles.Add($AttachmentInfo) Invoke - PnPQuery - Connection $DestinationConn #Delete the Temporary File Remove - Item - Path $Env: TEMP\ $($_.FileName) - Force
                    }
                }
                Catch {
                    write - host - f Red "Error Copying Attachments:"
                    $_.Exception.Message
                }
            }
            #Function to copy list items from one list to another
            Function Copy - SPOListItems() {
                param(
                    [Parameter(Mandatory = $true)][Microsoft.SharePoint.Client.List] $SourceList,
                    [Parameter(Mandatory = $true)][Microsoft.SharePoint.Client.List] $DestinationList)
                Try {
                    #Get All Items from the Source List in batches
                    Write - Progress - Activity "Reading Source..." - Status "Getting Items from Source List. Please wait..."
                    $SourceListItems = Get - PnPListItem - List $SourceList - PageSize 500 - Connection $SourceConn
                    $SourceListItemsCount = $SourceListItems.count
                    Write - host "Total Number of Items Found:"
                    $SourceListItemsCount
                    #Get fields to Update from the Source List - Skip Read only, hidden fields, content type and attachments
                    $SourceListFields = Get - PnPField - List $SourceListName | Where {
                        (-Not($_.ReadOnlyField)) - and(-Not($_.Hidden)) - and($_.InternalName - ne "ContentType") - and($_.InternalName - ne "Attachments")
                    }
                    #Loop through each item in the source and Get column values, add them to Destination[int] $Counter = 1
                    ForEach($SourceItem in $SourceListItems) {
                        $ItemValue = @ {}
                        #Map each field from source list to Destination list
                        Foreach($SourceField in $SourceListFields) {
                            #Check
                            if the Field value is not Null
                            If($SourceItem[$SourceField.InternalName] - ne $Null) {
                                #Handle Special Fields
                                $FieldType = $SourceField.TypeAsString
                                If($FieldType - eq "User" - or $FieldType - eq "UserMulti" - or $FieldType - eq "Lookup" - or $FieldType - eq "LookupMulti") #People Picker or Lookup Field {
                                    $LookupIDs = $SourceItem[$SourceField.InternalName] | ForEach - Object {
                                        $_.LookupID.ToString()
                                    }
                                    $ItemValue.add($SourceField.InternalName, $LookupIDs)
                                }
                                ElseIf($FieldType - eq "URL") #Hyperlink {
                                    $URL = $SourceItem[$SourceField.InternalName].URL
                                    $Description = $SourceItem[$SourceField.InternalName].Description
                                    $ItemValue.add($SourceField.InternalName, "$URL, $Description")
                                }
                                ElseIf($FieldType - eq "TaxonomyFieldType" - or $FieldType - eq "TaxonomyFieldTypeMulti") #MMS {
                                    $TermGUIDs = $SourceItem[$SourceField.InternalName] | ForEach - Object {
                                        $_.TermGuid.ToString()
                                    }
                                    $ItemValue.add($SourceField.InternalName, $TermGUIDs)
                                }
                                Else {
                                    #Get Source Field Value and add to Hashtable
                                    $ItemValue.add($SourceField.InternalName, $SourceItem[$SourceField.InternalName])
                                }
                            }
                        }
                        Write - Progress - Activity "Copying List Items:" - Status "Copying Item ID '$($SourceItem.Id)' from Source List ($($Counter) of $($SourceListItemsCount))" - PercentComplete(($Counter / $SourceListItemsCount) * 100)
                        #Copy column value from source to Destination
                        $NewItem = Add - PnPListItem - List $DestinationList - Values $ItemValue
                        #Copy Attachments
                        Copy - SPOAttachments - SourceItem $SourceItem - DestinationItem $NewItem
                        Write - Host "Copied Item ID from Source to Destination List:$($SourceItem.Id) ($($Counter) of $($SourceListItemsCount))"
                        $Counter++
                    }
                }
                Catch {
                    Write - host - f Red "Error:"
                    $_.Exception.Message
                }
            }
            #Set Parameters
            $SourceSiteURL = "https://abcd.sharepoint.com/sites/ArchivalDevelopmentTest"
            $SourceListName = "CountriesArchive"
            $DestinationSiteURL = "https://abcd.sharepoint.com/sites/ArchivalDevelopmentTest"
            $DestinationListName = "CountriesArchive2"
            #Connect to Source and destination sites
            $SourceConn = Connect - PnPOnline - Url $SourceSiteURL - UseWebLogin - ReturnConnection
            $SourceList = Get - PnPList - Identity $SourceListName - Connection $SourceConn
            $DestinationConn = Connect - PnPOnline - Url $DestinationSiteURL - UseWebLogin - ReturnConnection
            $DestinationList = Get - PnPList - Identity $DestinationListName - Connection $DestinationConn
            #Call the Function to Copy List Items between Lists
            Copy - SPOListItems - SourceList $SourceList - DestinationList $DestinationList

Just configure the above highlighted areas as per your requirement.

 

Steps 

 

Open Windows ISE >> Open the above script file >> Run Script or F5 

 

Advantages

 

You can use the above script for a cool, smooth archival process = Copy + Remove as you know how to remove List Items batchwise using PowerShell once above Copying is finished.

 

Applicable for both modern and classic experience.

 

Drawbacks

 

Copying Duplicate values if we run it multiple times

 

Can copy ListItems to another List within the same Site Collection only as SP Context can read one Site Coll at a time.

 

CrossSites not supported

 

Other Ideas:- Go with Migration Tools if you want to go with Site Collections from different Tenants on SP Online.

 

Cheers!