Site Template Export

PowerShell Script

# Script to generate a PnP template that gets the main structural parts of the site.

# --- Configurable parameters ---
$SiteUrl = "https://tenantName.sharepoint.com/sites/siteName" # Add target site path
$CurrentDateTime = Get-Date -Format "yyyyMMddHHmmss"
$OutputFileName = "SiteTemplateTest.xml"
$PathToSave = "" # Add file path for output
$ClientId = "" # Add client id

$LogFilePath = Join-Path -Path $PathToSave -ChildPath "PnP_Script_Log_$CurrentDateTime.log" # File path for the log file

# --- Logging configuration ---
# Send all error messages to log
$ErrorActionPreference = "Stop" # Stops execution if an unhandled error occurs
Set-PnPTraceLog -On -LogFile $LogFilePath -Level Debug # Activate detailed logging for PnP


Try {
    Connect-PnPOnline -Url $SiteUrl -Interactive -ClientId $ClientId
}
Catch {
    Write-Error "Error connecting to SharePoint site: $($_.Exception.Message)"
    Exit
}

# --- Make sure the save path exists ---
If (-not (Test-Path $PathToSave)) {
    Write-Host "Creating directory $($PathToSave)..."
    New-Item -ItemType Directory -Path $PathToSave | Out-Null
}

# --- Export the PnP template ---
$OutputFilePath = Join-Path -Path $PathToSave -ChildPath $OutputFileName
Write-Host "Generating PnP template for lists, site columns, content types, pages..."

Try {
    Get-PnPSiteTemplate -Out $OutputFilePath `
        -Handlers "All" `
        -PersistMultiLanguageResources `
        -PersistBrandingFiles `
        -Force ` # Overwrites the file if it already exists

    Write-Host "Template successfully created in: $($OutputFilePath)"

    # Array of list names to add data rows for
    $ListsToIncludeData = @(
        "Events",
        "Feedback",
        "Tools"
    )

    # Loop through each list and add data rows to template
    ForEach ($ListName in $ListsToIncludeData) {
        Write-Host "Adding data rows for list: $ListName"
        Add-PnPDataRowsToSiteTemplate -Path $OutputFilePath `
            -List $ListName `
            -Query ""
    }

}
Catch {
    Write-Error "Error creating PnP Template: $($_.Exception.Message)"
}
Finally {
    Write-Host "Disconnecting from SharePoint Online."
    Disconnect-PnPOnline
    Set-PnPTraceLog -Off # Turn off the logging
}

Write-Host "Script finished."