PowerShell Script for Moving Files in SharePoint Online

This PowerShell script is designed to move files from one document library to another within SharePoint Online. The script utilizes the SharePoint PnP PowerShell module, which provides a simplified way to work with SharePoint resources.

Code Breakdown

1. Setting Source and Destination URLs

$sourceURL = "https://yourtenant.sharepoint.com/sites/sourceSite/SourceLibrary"
$destURL = "https://yourtenant.sharepoint.com/sites/destinationSite/DestinationLibrary"

• Purpose: This section defines the source and destination URLs, where files will be moved from and to, respectively.
• Variables:
  • $sourceURL: Location of the document library where files currently reside.
  • $destURL: Location of the document library where files will be transferred.

2. Credentials and Connection

$credentials = Get-Credential
Connect-PnPOnline -Url $sourceURL -Credentials $credentials

• Get-Credential: This command prompts the user to enter their SharePoint credentials (username and password), which are stored in the $credentials variable.
• Connect-PnPOnline: This cmdlet establishes a connection to the SharePoint Online site using the provided URL and credentials. It enables subsequent commands to interact with SharePoint.

3. Moving Files from Source to Destination

Get-PnPListItem -List "SourceLibrary" | ForEach-Object {
    Move-PnPFile -ServerRelativeUrl $_.FieldValues.FileRef -TargetUrl $destURL -Force
}

• Get-PnPListItem:
  • This cmdlet retrieves all items (files) from the specified SharePoint list (in this case, "SourceLibrary").
• ForEach-Object: This cmdlet iterates over each retrieved item, allowing actions to be performed on them individually.
• Move-PnPFile:
  • -ServerRelativeUrl: This parameter specifies the path of the file to move, taken from the current item being processed ($_.FieldValues.FileRef).
  • -TargetUrl: This parameter indicates the destination URL where the file should be moved.
  • -Force: This option allows the move operation to overwrite any existing files at the destination without prompting for confirmation.

Key Concepts Explained

SharePoint PnP PowerShell Module

• The SharePoint Patterns and Practices (PnP) PowerShell module helps manage SharePoint Online easily. It includes cmdlets that simplify common tasks associated with SharePoint management, such as connecting, retrieving, and manipulating site and list content.

Moving Files

• Moving files in SharePoint involves transferring files from one location to another while preserving metadata. The Move-PnPFile cmdlet is an effective way to achieve this in a single command.

Additional Example

To enhance understanding, here is a modified example that includes error handling:

$sourceURL = "https://yourtenant.sharepoint.com/sites/sourceSite/SourceLibrary"
$destURL = "https://yourtenant.sharepoint.com/sites/destinationSite/DestinationLibrary"
$credentials = Get-Credential
Connect-PnPOnline -Url $sourceURL -Credentials $credentials

try {
    Get-PnPListItem -List "SourceLibrary" | ForEach-Object {
        Move-PnPFile -ServerRelativeUrl $_.FieldValues.FileRef -TargetUrl $destURL -Force
    }
    Write-Host "Files moved successfully."
} catch {
    Write-Error "Error moving files: $_"
}

Modifications Explained:

• try / catch Block: This structure allows for error handling. If the move operation encounters an issue, it will catch the error and output a message without terminating the script abruptly.
• Write-Host: This cmdlet outputs a success message if files are moved without issues.

Conclusion

This PowerShell script serves as an efficient method for managing files between libraries in SharePoint Online. Understanding each component of the script enhances the ability to tailor similar scripts for specific needs in SharePoint management tasks. For further advancement in data management and software engineering concepts, consider exploring the courses available on the Enterprise DNA platform.