SharePoint Hosting – Move SharePoint List/Library From One Site To Another With Data Or Without Data

Many times, we arrive in a situation when we want to move the SharePoint Online List/Library from one site to another site either with data or without data. This article describes how to move the master list with data and transaction list without data from one site to another site. e.g., Movement from Development to Quality or from Quality to Production.

Maintain the SharePoint List and Library which need to be copied from one site to another site

To keep the thinks configurable and this solution will have two files.

Lists.csv – which will contain the list details which need to be copied from one site to another site. Edit the Lists.csv file and add your list name and a 0 or 1 for if this is a lookup list.
environments.json – Edit this file to maintain environment details.

Sample Lists.cs

Sample Environments.json

PowerShell Script

<span class="token keyword keyword-class">class</span> <span class="token class-name">CopySpoList</span> <span class="token punctuation">{</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$SourceUrl<span class="token punctuation">;</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$DestinationUrl<span class="token punctuation">;</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$DestinationEnvironment<span class="token punctuation">;</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$SourceEnvironment<span class="token punctuation">;</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">Object</span></span><span class="token punctuation">]</span>$Environments<span class="token punctuation">;</span>
    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">bool</span></span><span class="token punctuation">]</span>$IsEnvironmentValid <span class="token operator">=</span> $<span class="token boolean">true</span><span class="token punctuation">;</span>

    <span class="token function">CopySpoList</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
        Write<span class="token operator">-</span>Host 'Below <span class="token keyword keyword-is">is</span> <span class="token class-name">the</span> list of valid environments' <span class="token operator">-</span><span class="token class-name">ForegroundColor</span> Green<span class="token punctuation">;</span>
        Write<span class="token operator">-</span>Host <span class="token punctuation">(</span>'DEV'<span class="token punctuation">,</span> 'QA'<span class="token punctuation">,</span> 'PROD'<span class="token punctuation">)</span> <span class="token operator">-</span>Separator '<span class="token punctuation">,</span> <span class="token operator">-&gt;</span> ' <span class="token operator">-</span><span class="token class-name">ForegroundColor</span> DarkGreen<span class="token punctuation">;</span>
        $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments <span class="token operator">=</span> Get<span class="token operator">-</span>Content <span class="token operator">-</span>Path '<span class="token range operator">..</span>\environments<span class="token punctuation">.</span>json' <span class="token operator">|</span> ConvertFrom<span class="token operator">-</span>Json<span class="token punctuation">;</span>
        $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceEnvironment <span class="token operator">=</span> Read<span class="token operator">-</span>Host 'Enter the source environment'<span class="token punctuation">;</span>
        $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span><span class="token function">ValidateEnvironment</span><span class="token punctuation">(</span>$<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceEnvironment<span class="token punctuation">.</span><span class="token function">ToUpper</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> 'Source'<span class="token punctuation">)</span>
        $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationEnvironment <span class="token operator">=</span> Read<span class="token operator">-</span>Host 'Enter the destination environment'<span class="token punctuation">;</span>
        $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span><span class="token function">ValidateEnvironment</span><span class="token punctuation">(</span>$<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationEnvironment<span class="token punctuation">.</span><span class="token function">ToUpper</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> 'Destination'<span class="token punctuation">)</span>
    <span class="token punctuation">}</span>

    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">void</span></span><span class="token punctuation">]</span>  <span class="token function">ValidateEnvironment</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$environmentName<span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">string</span></span><span class="token punctuation">]</span>$environmentType<span class="token punctuation">)</span> <span class="token punctuation">{</span>
        <span class="token keyword keyword-switch">switch</span> <span class="token punctuation">(</span>$environmentName<span class="token punctuation">)</span> <span class="token punctuation">{</span>
            'DEV' <span class="token punctuation">{</span>
                <span class="token keyword keyword-if">if</span> <span class="token punctuation">(</span>$environmentType <span class="token operator">-</span>eq 'Source'<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>DEV<span class="token punctuation">;</span>
                <span class="token punctuation">}</span> <span class="token keyword keyword-else">else</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>DEV<span class="token punctuation">;</span>
                <span class="token punctuation">}</span>
                <span class="token keyword keyword-break">break</span><span class="token punctuation">;</span>
            <span class="token punctuation">}</span>
            'QA' <span class="token punctuation">{</span>
                <span class="token keyword keyword-if">if</span> <span class="token punctuation">(</span>$environmentType <span class="token operator">-</span>eq 'Source'<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>QA<span class="token punctuation">;</span>
                <span class="token punctuation">}</span> <span class="token keyword keyword-else">else</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>QA<span class="token punctuation">;</span>
                <span class="token punctuation">}</span>
                <span class="token keyword keyword-break">break</span><span class="token punctuation">;</span>
            <span class="token punctuation">}</span>
            'PROD' <span class="token punctuation">{</span>
                <span class="token keyword keyword-if">if</span> <span class="token punctuation">(</span>$environmentType <span class="token operator">-</span>eq 'Source'<span class="token punctuation">)</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>PROD<span class="token punctuation">;</span>
                <span class="token punctuation">}</span> <span class="token keyword keyword-else">else</span> <span class="token punctuation">{</span>
                    $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationUrl <span class="token operator">=</span> $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>Environments<span class="token punctuation">.</span>PROD<span class="token punctuation">;</span>
                <span class="token punctuation">}</span>
                <span class="token keyword keyword-break">break</span><span class="token punctuation">;</span>
            <span class="token punctuation">}</span>
            Default <span class="token punctuation">{</span>
                $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>IsEnvironmentValid <span class="token operator">=</span> $<span class="token boolean">false</span><span class="token punctuation">;</span>
                Write<span class="token operator">-</span>Host 'Value does <span class="token keyword keyword-not">not</span> fall <span class="token keyword keyword-in">in</span> valid environment range' <span class="token operator">-</span><span class="token class-name">ForegroundColor</span> Red<span class="token punctuation">;</span>
                Write<span class="token operator">-</span>Host <span class="token punctuation">(</span>'DEV'<span class="token punctuation">,</span> 'QA'<span class="token punctuation">,</span> 'PROD'<span class="token punctuation">)</span> <span class="token operator">-</span>Separator '<span class="token punctuation">,</span> <span class="token operator">-&gt;</span> ' <span class="token operator">-</span>ForegroundColor Red
            <span class="token punctuation">}</span>
        <span class="token punctuation">}</span>
    <span class="token punctuation">}</span>

    <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">void</span></span><span class="token punctuation">]</span> <span class="token function">MoveSpoList</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
        <span class="token preprocessor property"># looping through the lists</span>
        $csvInput <span class="token operator">=</span> Import<span class="token operator">-</span>Csv <span class="token operator">-</span>Path '<span class="token punctuation">.</span>\Lists<span class="token punctuation">.</span>csv'
        <span class="token keyword keyword-foreach">foreach</span> <span class="token punctuation">(</span>$row <span class="token keyword keyword-in">in</span> $csvInput<span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token keyword keyword-try">try</span> <span class="token punctuation">{</span>

                <span class="token preprocessor property"># Connects SharePoint Online</span>
                Connect<span class="token operator">-</span>PnPOnline <span class="token operator">-</span>Url $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>SourceUrl<span class="token punctuation">.</span><span class="token function">Trim</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">-</span>Interactive
                Get<span class="token operator">-</span>PnPWeb

                $ListName <span class="token operator">=</span> $row<span class="token punctuation">.</span>ListName<span class="token punctuation">.</span><span class="token function">Trim</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                $IsLookUpList <span class="token operator">=</span> $row<span class="token punctuation">.</span>IsLookUpList<span class="token punctuation">.</span><span class="token function">Trim</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                Write<span class="token operator">-</span>Host $ListName
                Write<span class="token operator">-</span>Host $IsLookUpList

                <span class="token preprocessor property">#Getting List Template Name</span>
                $timestamp <span class="token operator">=</span> Get<span class="token operator">-</span>Date <span class="token operator">-</span>Format FileDateTimeUniversal
                $tempFile <span class="token operator">=</span> '<span class="token punctuation">.</span><span class="token operator">/</span>SourceListBackup<span class="token operator">/</span>' <span class="token operator">+</span> $ListName <span class="token operator">+</span> $timestamp <span class="token operator">+</span> '<span class="token punctuation">.</span>xml'<span class="token punctuation">;</span>

                Get<span class="token operator">-</span>PnPSiteTemplate <span class="token operator">-</span>Handlers Lists <span class="token operator">-</span>ListsToExtract $ListName <span class="token operator">-</span>Out $tempFile

                <span class="token preprocessor property">#Adding Rows to List Template</span>
                <span class="token keyword keyword-if">if</span> <span class="token punctuation">(</span>$IsLookUpList <span class="token operator">-</span>eq <span class="token number">1</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                    Add<span class="token operator">-</span>PnPDataRowsToSiteTemplate <span class="token operator">-</span>Path $tempFile <span class="token operator">-</span>List $ListName <span class="token operator">-</span>Query '<span class="token operator">&lt;</span>View<span class="token operator">&gt;</span><span class="token operator">&lt;</span><span class="token operator">/</span>View<span class="token operator">&gt;</span>'
                <span class="token punctuation">}</span>

                <span class="token preprocessor property">#Applying Template to Destination Site</span>
                Connect<span class="token operator">-</span>PnPOnline <span class="token operator">-</span>Url $<span class="token keyword keyword-this">this</span><span class="token punctuation">.</span>DestinationUrl<span class="token punctuation">.</span><span class="token function">Trim</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">-</span>Interactive
                Get<span class="token operator">-</span>PnPWeb
                Invoke<span class="token operator">-</span>PnPSiteTemplate <span class="token operator">-</span>Path $tempFile
            <span class="token punctuation">}</span> <span class="token keyword keyword-catch">catch</span> <span class="token punctuation">{</span>
                Write<span class="token operator">-</span>Host <span class="token operator">-</span>ForegroundColor Red 'Error '<span class="token punctuation">,</span> <span class="token string character">':'</span><span class="token punctuation">,</span> $Error<span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">]</span><span class="token punctuation">.</span><span class="token function">ToString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
                Start<span class="token operator">-</span>Sleep <span class="token number">10</span>
            <span class="token punctuation">}</span>
        <span class="token punctuation">}</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

<span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">CopySpoList</span></span><span class="token punctuation">]</span>$copySpList <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token attribute"><span class="token class-name">CopySpoList</span></span><span class="token punctuation">]</span><span class="token punctuation">::</span><span class="token keyword keyword-new">new</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword keyword-if">if</span> <span class="token punctuation">(</span>$copySpList<span class="token punctuation">.</span>IsEnvironmentValid<span class="token punctuation">)</span> <span class="token punctuation">{</span>
    $copySpList<span class="token punctuation">.</span><span class="token function">MoveSpoList</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

class CopySpoList {

[string]$SourceUrl;

[Object]$Environments;

[bool]$IsEnvironmentValid = $true;

CopySpoList() {

Write-Host 'Below is the list of valid environments' -ForegroundColor Green;

Write-Host ('DEV', 'QA', 'PROD') -Separator ', -> ' -ForegroundColor DarkGreen;

$this.Environments = Get-Content -Path '..\environments.json' | ConvertFrom-Json;

$this.SourceEnvironment = Read-Host 'Enter the source environment';

$this.ValidateEnvironment($this.SourceEnvironment.ToUpper(), 'Source')

$this.DestinationEnvironment = Read-Host 'Enter the destination environment';

$this.ValidateEnvironment($this.DestinationEnvironment.ToUpper(), 'Destination')

}

[void] ValidateEnvironment([string]$environmentName, [string]$environmentType) {

switch ($environmentName) {

'DEV' {

if ($environmentType -eq 'Source') {

$this.SourceUrl = $this.Environments.DEV;

} else {

$this.DestinationUrl = $this.Environments.DEV;

}

break;

}

'QA' {

} else {

}

break;

}

'PROD' {

} else {

}

break;

}

Default {

$this.IsEnvironmentValid = $false;

Write-Host 'Value does not fall in valid environment range' -ForegroundColor Red;

}

# looping through the lists

$csvInput = Import-Csv -Path '.\Lists.csv'

foreach ($row in $csvInput) {

try {

# Connects SharePoint Online

Connect-PnPOnline -Url $this.SourceUrl.Trim() -Interactive

Get-PnPWeb

$ListName = $row.ListName.Trim();

$IsLookUpList = $row.IsLookUpList.Trim();

Write-Host $ListName

Write-Host $IsLookUpList

#Getting List Template Name

$timestamp = Get-Date -Format FileDateTimeUniversal

$tempFile = './SourceListBackup/' + $ListName + $timestamp + '.xml';

Get-PnPSiteTemplate -Handlers Lists -ListsToExtract $ListName -Out $tempFile

#Adding Rows to List Template

if ($IsLookUpList -eq 1) {

Add-PnPDataRowsToSiteTemplate -Path $tempFile -List $ListName -Query '<View></View>'

}

#Applying Template to Destination Site

Connect-PnPOnline -Url $this.DestinationUrl.Trim() -Interactive

Get-PnPWeb

Invoke-PnPSiteTemplate -Path $tempFile

} catch {

Write-Host -ForegroundColor Red 'Error ', ':', $Error[0].ToString();

Start-Sleep 10

}

[CopySpoList]$copySpList = [CopySpoList]::new();

if ($copySpList.IsEnvironmentValid) {

$copySpList.MoveSpoList();

}

Output

Summary

PnP PowerShell is a preferred way to go with modern SharePoint. It helps to easily move the SharePoint List from one site to another site.

SharePoint Hosting – Move SharePoint List/Library From One Site To Another With Data Or Without Data

Maintain the SharePoint List and Library which need to be copied from one site to another site

Summary

BLOGROLL

Featured On

SharePoint Hosting – Move SharePoint List/Library From One Site To Another With Data Or Without Data

Maintain the SharePoint List and Library which need to be copied from one site to another site

Summary

BLOGROLL

Featured On

Tags