welcome to XRM blog

Keep in touch with latest CRM/ERP articles

To remain competitive your organisation must be efficient across the business process spectrum. To do so you need to take sound decisions based on a balance between the cost and risk. To do so you will be heavily dependent on your content management in itself needs...

image
Blog

PnP PowerShell Site Script Export Template

By Anurag on 11/14/2023

In SharePoint Online users can export a SharePoint site script template in XML form using PnP PowerShell. It is a reusable component if the user wants to create the same SharePoint site collection multiple times. PnP PowerShell is a powerful way to provision site artifacts in SharePoint online including site structure and its content.

Using the PnP Provisioning engine users can model a site by configuring the design of site columns, content types, list definition and instances, pages, and more via web browser. When users are done with the design templates, they can export that site template into a provisioning template format (XML, JSON, or a container format called a PnP file) and apply it to as many target sites as they want.

PnP PowerShell Version

It supports the latest version of PowerShell so make sure before starting to work that the user must install the latest version of PowerShell MSI Packages which is “PowerShell 7.3.9”, or the user can explore the below link to know the latest versions of PowerShell.

https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3

Steps to Extract PnP Site Template

1. After installing PnP PowerShell, users can directly run the command on the PnP PowerShell Command window to extract the site template.

            a. Search “PowerShell” and open as Administrator.

b. The user will get the administrator window as below snapshot.

c. If users have installed the SharePointPnPPowerShellOnline Module, then first uninstall this module by running the below command.

    Uninstall-Module SharePointPnPPowerShellOnline -Force –AllVersions

d. Install the new PnP.PowerShell module by running the below command.

    Install-Module PnP.PowerShell

e. Now user can extract the site script template by running the PnP PowerShell Command

2. The user can use Visual Studio code to extract the PnP site script template. By using Visual Studio code users can save export and import site script templates into PowerShell format (.ps1)

      Example – TestScript.ps1

a. Install the PnP PowerShell extension on VS code.

b. To work on PnP PowerShell, choose the folder where the user wants to store all the files and scripts.

c. In VS Code user can also follow the above command to install the PnP PowerShell Module.

Steps to get the source site schema template into XML.

a. Create a new Config.json file in TestScriptTemplate folder to configure the site collection content, which means to configure the SharePoint list, library, and pages that the user wants to export.

b. Create a new PS file in the folder as TestScript.ps1 to write the export template command as given below.

1. Enter the source site address to $SiteURL Variable that the user wants to extract the templates.

2. Enter the config.json folder address in the configuration section.

3. Enter the file address where the user wants to store the extracted file.

    FilePath\{EnterScriptTemplate Name.xml}

4. Run the command. It will extract the site template into XML form.

 Steps to apply the site schema to the target site.

a. Create a new file PS file in the folder as ImportTestScript.ps1 to write the invoke site template command.

1. Enter the Destination site address to $SiteURL Variable that the user wants to invoke the templates.

2. Enter the Path of the extracted site template.

3. Run the command. It will apply the site template to the destination site collection.

To follow all the above steps user will be able to create the duplicate site template using PnP PowerShell.

Example-

Source SharePoint Site Collection

Destination SharePoint Site Collection

Please note, that the PnP Provisioning template method only extracts the site template without its contents. If users need to copy the site with its content, they need to do it with a PowerShell script creating the configuration file.

https://learn.microsoft.com/en-us/sharepoint/dev/solution-guidance/configuring-the-pnp-provisioning-engine

Conclusion

Creating site designs and site scripts in SharePoint Online is a powerful way to automate the creation of customized sites and ensure consistency across the organization’s SharePoint environment. Site designs allow users to define a set of actions that will be performed when a new site is created, such as adding lists, pages, and web parts.

Site scripts allow users to define the structure and content of a new site, such as creating lists, libraries, and pages. By following these steps, users can easily create custom site designs and site scripts that can be used to create new sites in SharePoint Online with the desired structure content.
 

PnP
PnP PowerShell
PnP PowerShell Site
Author
Blog Calendar
Blog Calendar List
2024 Apr  18  4
2024 Mar  33  4
2024 Feb  28  3
2024 Jan  8  7
2023 Dec  14  6
2023 Nov  45  5
2023 Oct  118  12
2023 Sep  245  9
2023 Aug  63  7
2023 Jul  31  5
2023 Jun  20  4
2023 May  43  5
2023 Apr  35  5
2023 Mar  98  6
2023 Feb  112  5
2023 Jan  41  4
2022 Dec  94  7
2022 Nov  257  2
2022 Sep  13  1
2022 Aug  28  2
2022 Jun  7  2
2022 May  4  2
2022 Apr  6  2
2022 Mar  2  1
2022 Feb  2  1
2022 Jan  1  1
2021 Dec  4  1
2021 Nov  2  1
2021 Oct  2  1
2021 Sep  12  1
2021 Aug  38  5
2021 Jul  36  4
2021 Jun  1247  5
2021 May  31  3
2021 Apr  2036  3
2021 Mar  189  5
2021 Feb  2142  7
2021 Jan  3108  9
2020 Dec  446  7
2020 Sep  74  3
2020 Aug  685  3
2020 Jul  128  1
2020 Jun  75  3
2020 Apr  69  3
2020 Mar  13  2
2020 Feb  28  5
2020 Jan  34  7
2019 Dec  17  4
2019 Nov  30  1
2019 Jan  23  2
2018 Dec  71  4
2018 Nov  68  3
2018 Oct  18  3
2018 Sep  1152  11
2018 Aug  7  2
2018 Jun  14  1
2018 Jan  68  2
2017 Sep  585  5
2017 Aug  17  1
2017 Jul  17  2
2017 Jun  62  2
2017 May  21  1
2017 Apr  35  2
2017 Mar  135  4
2017 Feb  784  4
2016 Dec  204  3
2016 Nov  834  8
2016 Oct  307  10
2016 Sep  705  6
2016 Aug  39  1
2016 Jun  1876  6
2016 May  110  3
2016 Jan  71  2
2015 Dec  485  6
2015 Nov  4  1
2015 Oct  13  1
2015 Sep  1464  6
2015 Aug  14  1
2015 Jul  128  2
2015 Jun  11  1
2015 May  20  1
2015 Apr  30  3
2015 Mar  80  3
2015 Jan  5335  4
2014 Dec  17  1
2014 Nov  2257  4
2014 Oct  68  1
2014 Sep  107  2
2014 Aug  5280  1
2014 Jul  49  2
2014 Apr  2578  12
2014 Mar  301  17
2014 Feb  220  6
2014 Jan  1510  16
2013 Dec  21  2
2013 Nov  690  2
2013 Oct  256  3
2013 Sep  11  1
2013 Aug  40  3
2013 Jul  214  1
2013 Apr  57  6
2013 Mar  2292  10
2013 Feb  127  3
2013 Jan  343  2
2012 Nov  57  2
2012 Oct  499  10
Tag Cloud
Interested in our services? Still not sure about project details? get a quote