Skip to content

Commit fd737a7

Browse files
PaoloPiaPaoloPia
authored
Article about Look Book PnP provisioning (SharePoint#9631)
* Initial commit of articles about Bot Powered ACEs * Updated article about building first Bot Powered ACE * Added metadata to articles * Fixed issues in articles, accordingly to guidance * Fixed issues in articles, accordingly to guidance * Finalized initial batch of articles about Bot Powered ACEs * Finalized initial batch of articles about Bot Powered ACEs * Added article about security for Bot Powered ACEs * Updated articles about Bot Powered ACEs * Updated articles about Bot Powered ACEs * Updated articles about Bot Powered ACEs * Finalized second batch of articles about Bot Powered ACEs * Finalized second batch of articles about Bot Powered ACEs * Finalized second batch of articles about Bot Powered ACEs * Finalized second batch of articles about Bot Powered ACEs * Added article about Look Book PnP templates provisioning * Finalized article about Look Book PnP templates provisioning * Finalized article about look book PnP templates provisioning * Fixed learn.microsoft.com URLs * Fixed learn.microsoft.com URLs
1 parent e601f04 commit fd737a7

File tree

2 files changed

+125
-0
lines changed

2 files changed

+125
-0
lines changed

‎docs/solution-guidance/applying-pnp-templates.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title: Applying PnP Templates to SharePoint Sites
3+
description: This article explains how to manually provision a look book PnP template using PnP PowerShell.
4+
ms.date: 04/10/2024
5+
ms.localizationpriority: high
6+
---
7+
8+
# Applying PnP Templates to SharePoint Sites
9+
10+
In this page, you can find detailed information about how to manually provision a look book template on your tenant.
11+
12+
You can also follow these steps by watching this video on the Microsoft 365 Platform Community (PnP) YouTube Channel:
13+
14+
> [!Video https://www.youtube.com/embed/lK17E412uNg]
15+
16+
## Software prerequisites
17+
18+
In order to provision the look book templates, you need to have the following software tools installed on your machine:
19+
20+
- [PowerShell](/powershell/scripting/install/installing-powershell)
21+
- [PnP PowerShell](https://pnp.github.io/powershell/)
22+
23+
Once the above tools are installed, you can proceed with the following sections.
24+
25+
[!INCLUDE [pnp-provisioning-engine](../../includes/snippets/open-source/pnp-provisioning-engine.md)]
26+
27+
## Available templates
28+
29+
The look book templates are based on the PnP Provisioning engine. As such, every single template is a `.pnp` (pnp stands for Patterns & Practices) file, which is nothing more than an OpenXML file that includes all the needed content to deploy the template.
30+
Here follows a table where you can find the list of all the look book templates, a link do download the corresponding `.pnp` template file, the configuration parameters, and the prerequisites.
31+
32+
Category|Template|Site Type|Parameters|Prerequisites
33+
--------|--------|---------|----------|-------------
34+
|Organization|[Leadership Connection](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/leadershipconnection/leadershipconnection.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
35+
||[The Perspective](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/theperspective/theperspective.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
36+
||[Crisis Communications](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/crisis-mgmt/crisis-mgmt.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
37+
||[News site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/contosonews/contosonews.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
38+
||[The Landing](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/thelanding/thelanding.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
39+
||[Benefits](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/benefits/benefits.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
40+
||[LGBTQ+ Employee Resource Group](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/pride/pride.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
41+
||[Hispanic Heritage Month Employee Resource Group](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/hispanicheritage/template.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
42+
|Department|[Retail Operations](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/retailoperations/retailoperations.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
43+
||[Fly Safe Conference](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/flysafeconference/flysafeconference.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
44+
||[Global sales hub](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/globalsales/globalsales.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li><li>RetailOperationsSiteTitle</li><li>RetailOperationsSiteUrl</li><li>ConsumerRetailSiteTitle</li><li>ConsumerRetailSiteUrl</li></ul>|SharePoint Online Admin
45+
||[Workshop training site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/droneproducttraining/droneproducttraining.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
46+
||[Global marketing hub](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/globalmarketing/globalmarketing.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li><li>CommunicationSiteTitle</li><li>CommunicationSiteUrl</li></ul>|SharePoint Online Admin
47+
||[Human resources hub](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/contosoworks/contosoworks.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li><li>BenefitsSiteTitle</li><li>BenefitsSiteUrl</li></ul>|SharePoint Online Admin
48+
|Team|[Collaboration team site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/ContosoTeamSite/ContosoTeamSite.pnp)|Modern Team Site|<ul><li>SiteTitle</li><li>SiteAlias</li></ul>|SharePoint Online Admin
49+
||[Team communication site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/communications/communications.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
50+
||[Mark8 Project Team](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/mark8projectteam/mark8projectteam.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
51+
||[Product Support](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/productsupport/productsupport.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
52+
|Community|[Branding Site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/contosobrand/contosobrand.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
53+
||[Charitable site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/give/give.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
54+
|Solutions|[Microsoft 365 learning pathways](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/M365LearningPathways/M365LP.pnp)|Communication Site|<ul><li>SiteUrl</li></ul>|SharePoint Online Admin, App Catalog
55+
||[New employee departmental onboarding site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/NEO-departmental/template.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
56+
||[Workplace Transformation site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/HybridWork/HybridWork.pnp)|Communication Site|<ul><li>SiteUrl</li></ul>|SharePoint Online Admin
57+
||[New employee pre-onboarding site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/NEO-preonboarding/template.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
58+
||[New employee corporate onboarding site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/NEO-main/template.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|SharePoint Online Admin
59+
||[Microsoft 365 freelance communications site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/FreelanceToolkit/M365FreelanceCommsSite.pnp)|Communication Site|<ul><li>SiteUrl</li></ul>|SharePoint Online Admin
60+
||[SharePoint Success Site](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/tenant/SharePointSuccessSite/SharePointSuccessSite.pnp)|Communication Site|<ul><li>SiteUrl</li></ul>|SharePoint Online Admin, App Catalog
61+
|Schools|[School home page](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/site/eduportal/eduportal.pnp)|Communication Site|<ul><li>SiteTitle</li><li>SiteUrl</li></ul>|Regular user
62+
||[Staff home page](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/site/edustaff/edustaff.pnp)|Team Site|<ul><li>SiteUrl</li></ul>|Regular user
63+
||[Class home page](https://github.com/SharePoint/sp-dev-provisioning-templates/blob/master/site/educlass/educlass.pnp)|Team Site|<ul><li>SiteUrl</li></ul>|Regular user
64+
65+
Here follows a brief guidance about the parameters:
66+
67+
- **SiteTitle**: is the title that is provisioned on the target site.
68+
- **SiteUrl**: is the server-relative URL of the site provisioned by the template. It can be something like: _/sites/name-of-the-site_.
69+
- **RetailOperationsSiteTitle**: is the title of the Communication Site provisioned on the target tenant for the Global Sales Hub template.
70+
- **RetailOperationsSiteUrl**: is the server-relative URL of the Retail Operations Communication Site provisioned by the template Global Sales Hub. It can be something like: _/sites/name-of-the-site_.
71+
- **ConsumerRetailSiteTitle**: is the title of the Retail Operations Communication Site provisioned on the target tenant for the Global Sales Hub template.
72+
- **ConsumerRetailSiteUrl**: is the server-relative URL of the Consumer Retail Communication Site provisioned by the template Global Sales Hub. It can be something like: _/sites/name-of-the-site_.
73+
- **CommunicationSiteTitle**: is the title of the Consumer Retail Communication Site provisioned on the target tenant for the Global Marketing Hub template.
74+
- **CommunicationSiteUrl**: is the server-relative URL of the Communication Site provisioned by the template Global Marketing Hub. It can be something like: _/sites/name-of-the-site_.
75+
- **BenefitsSiteTitle**: is the title of the Communication Site provisioned by the Human Resources Hub template.
76+
- **BenefitsSiteUrl**: is the server-relative URL of the Communication Siteprovisioned by the Human Resources Hub template. It can be something like: _/sites/name-of-the-site_.
77+
78+
79+
Here follows a brief guidance about the meaning of the prerequisites:
80+
81+
- SharePoint Online Admin: you need to execute the provisioning using a user who is member of the SharePoint Online Administrators group.
82+
- App Catalog: you need to have a fully functional tenant-wide App Catalog in your target tenant, and you need to execute the provisioning using a user who has admin access to the App Catalog site.
83+
- Regular user: you can execute the provisioning with a regular user of SharePoint Online.
84+
85+
> Note: If you don't have the App Catalog configured in your tenant, and the template that you are willing to provision requires the App Catalog, you can follow the instructions provided in this [online document](/sharepoint/dev/spfx/set-up-your-developer-tenant#create-app-catalog-site).
86+
87+
## Provisioning a template
88+
89+
In order to execute the actual provisioning, you need to execute a PowerShell cmdlet provided by the PnP PowerShell extensions.
90+
91+
### Provisioning templates that require a SharePoint Online Admin
92+
93+
Download the `.PNP` template file that you want to provision, save it in a local folder, and run the following PowerShell command:
94+
95+
```powershell
96+
Connect-PnPOnline https://<tenant>-admin.sharepoint.com/ -Interactive
97+
98+
Invoke-PnPTenantTemplate -Path .\your-template-file.pnp -Parameters @{"SiteTitle"="<Title-of-your-target-site>";"SiteUrl"="/sites/<URL-of-your-target-site>"}
99+
```
100+
101+
Replace \<tenant\> with the actual name of your SharePoint Online tenant in Microsoft 365.
102+
Remember to provide a value for all the parameters declared in the above table.
103+
104+
> Important: The very first time that you will connect to your target environment using the `Connect-PnPOnline` command let, you will have to grant a set of permissions to the _PnP Management Shell_ application.
105+
106+
### Provisioning templates that require a Regular User
107+
108+
Download the `.PNP` template file that you want to provision, save it in a local folder, and run the following PowerShell command:
109+
110+
```powershell
111+
Connect-PnPOnline https://<tenant>-admin.sharepoint.com/
112+
113+
Invoke-PnPSiteTemplate -Path .\your-template-file.pnp -Parameters @{"SiteTitle"="<Title-of-your-target-site>";"SiteUrl"="/sites/<URL-of-your-target-site>"}
114+
```
115+
116+
Replace \<tenant\> with the actual name of your SharePoint Online tenant in Microsoft 365.
117+
Remember to provide a value for all the parameters declared in the above table.
118+
119+
## Next Steps
120+
121+
Now that the look book template is provisioned on your tenant, feel free to browse to the site URL that you selected and play with the new site.
122+
123+
In there's any issue, don't hesitate to file an issue in the [PnP Provisioning Service repository on GitHub](https://github.com/SharePoint/sp-provisioning-service/issues).

‎docs/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@
5757
href: declarative-customization/site-design-trigger-flow-tutorial.md
5858
- name: PnP provisioning engine
5959
href: declarative-customization/site-design-pnp-provisioning.md
60+
- name: Applying PnP Templates to SharePoint Sites
61+
href: declarative-customization/site-design-pnp-provisioning.md
6062
- name: SPO PowerShell cmdlets
6163
href: declarative-customization/site-design-powershell.md
6264
- name: PnP PowerShell cmdlets

0 commit comments

Comments
 (0)