You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/declarative-customization/site-design-overview.md
+30-26Lines changed: 30 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,30 @@
1
1
---
2
2
title: SharePoint site design and site script overview
3
3
description: Use SharePoint site scripts and site designs to provide custom configurations to apply when new sites are created.
4
-
ms.date: 06/18/2020
4
+
ms.date: 04/15/2021
5
5
localization_priority: Priority
6
6
---
7
7
8
8
# SharePoint site design and site script overview
9
9
10
10
> [!NOTE]
11
-
> Site designs and site scripts are currently only supported by SharePoint Online.
11
+
> - Site designs and site scripts are currently only supported by SharePoint Online.
12
+
> - In previous versions of SharePoint, site templates were called site designs but will be referred to as site templates moving forward.
13
+
> - SharePoint has a new site template experience that will be available to all SharePoint user with permissions to create SharePoint sites. [Learn more about the new site template experience](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398?ui=en-US&rs=en-US&ad=US).
14
+
> - As of today, the site template experience cannot be disabled.
15
+
> - Site template version history is not currently available for the new site template experience but will be included in future iterations.
12
16
13
-
Use site designs and site scripts to automate provisioning new or existing modern SharePoint sites that use your own custom configurations.
17
+
Use site templates and site scripts to automate provisioning new or existing modern SharePoint sites that use your own custom configurations.
14
18
15
19
When people in your organization create new SharePoint sites, you often need to ensure some level of consistency. For example, you may need proper branding and theming applied to each new site. You may also have detailed site provisioning scripts, such as using the PnP provisioning engine, that need to be applied each time a new site is created.
16
20
17
-
This article describes how you can use site designs and site scripts to provide custom configurations to apply when new sites are created.
21
+
This article describes how you can use site templates and site scripts to provide custom configurations to apply when new sites are created.
18
22
19
-
## How site designs work
23
+
## How site templates work
20
24
21
-
Site designs are like a template. They can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (group-connected Team and Communication sites). Most actions typically affect the site itself, such as setting the theme or creating lists. But a site design can also include other actions, such as recording the new site URL to a log, or sending a tweet.
25
+
Site templates can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (group-connected Team and Communication sites). Most actions typically affect the site itself, such as setting the theme or creating lists. But a site template can also include other actions, such as recording the new site URL to a log, or sending a tweet.
22
26
23
-
You create site designs and register them in SharePoint to one of the modern template sites: the Team site or the Communication site. You can see how this works in the following steps.
27
+
You create site templates and register them in SharePoint to one of the modern template sites: the Team site or the Communication site. You can see how this works in the following steps.
24
28
25
29
1. Go to the SharePoint start page on your developer tenant.
26
30
@@ -30,36 +34,36 @@ You create site designs and register them in SharePoint to one of the modern tem
30
34
31
35
3. Choose **Communication site**.
32
36
33
-
The Communication site has a **Choose a design** box, which comes with the following site designs:
37
+
The Communication site has a **Choose a design** box, which comes with the following site templates:
34
38
35
39
- Topic
36
40
- Showcase
37
41
- Blank
38
42
39
-
These are the default site designs. For each site design, there is a title, description, and image.
43
+
These are the default site templates. For each site template, there is a title, description, and image.
40
44
41
45

42
46
43
-
Had you chosen the Team site template, it contains only one default site design named **Team site**.
47
+
Had you chosen the Team site template, it contains only one default site template named **Team site**.
44
48
45
-
For more information about how you can change the default site designs, see [Customize a default site design](customize-default-site-design.md).
49
+
For more information about how you can change the default site templates, see [Customize a default site design](customize-default-site-design.md).
46
50
47
-
When a site design is selected, SharePoint creates the new site, and runs site scripts for the site design. The site scripts detail the work such as creating new lists or applying a theme. These script actions are run in the background. A notification bar will be displayed, which the site creator can click to view the status of the actions being applied.
51
+
When a site template is selected, SharePoint creates the new site, and runs site scripts for the site design. The site scripts detail the work such as creating new lists or applying a theme. These script actions are run in the background. A notification bar will be displayed, which the site creator can click to view the status of the actions being applied.
48
52
49
53

50
54
51
55
When the scripts are complete the notification bar message will change - allowing the site creator to either refresh the page to see the results of the applied scripts or to view the site script details.
52
56
53
57

54
58
55
-
The site design information panel can be invoked by a site owner at any time to see what site designs have been applied to the site (and their script details) as well as to apply new or updated site designs.
59
+
The site template information panel can be invoked by a site owner at any time to see what site templates have been applied to the site (and their script details) as well as to apply new or updated site templates.
56
60
57
61
When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane.
58
62
59
63

60
64
61
65
> [!NOTE]
62
-
> Site designs can now be applied to previously created modern site collections. For more information, see the [REST API](site-design-rest-api.md) and [PowerShell](site-design-powershell.md) articles.
66
+
> Site templates can now be applied to previously created modern site collections. For more information, see the [REST API](site-design-rest-api.md) and [PowerShell](site-design-powershell.md) articles.
63
67
64
68
## Anatomy of a site script
65
69
@@ -139,19 +143,19 @@ Available actions include:
139
143
For a complete list of available actions and their parameters, see the [JSON schema](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema).
140
144
141
145
> [!NOTE]
142
-
> For libraries and lists, use the PowerShell command [Get-SPOSiteScriptFromList](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList?view=sharepoint-ps) to create the site script syntax from an existing SharePoint list.
146
+
> For libraries and lists, use the PowerShell command [Get-SPOSiteScriptFromList](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList) to create the site script syntax from an existing SharePoint list.
143
147
144
148
Site scripts can be run again on the same site after provisioning. Site scripts are non-destructive, so when they run again, they ensure that the site matches the configuration in the script.
145
149
146
150
For example, if the site already has a list with the same name that the site script is creating, the site script will only add missing fields to the existing list.
147
151
148
-
We'd previously capped the limit of site script actions to 30. This remains the limit for scripts applied synchronously using the [Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Invoke-SPOSiteDesign?view=sharepoint-ps) command, but based on customer feedback and support for additional actions we have bumped this limit to 300 actions (or 100,000 characters) when the scripts are applied asynchronously (either through the UI or using the [Add-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteDesignTask?view=sharepoint-ps) command).
152
+
We'd previously capped the limit of site script actions to 30. This remains the limit for scripts applied synchronously using the [Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Invoke-SPOSiteDesign) command, but based on customer feedback and support for additional actions we have bumped this limit to 300 actions (or 100,000 characters) when the scripts are applied asynchronously (either through the UI or using the [Add-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteDesignTask) command).
149
153
150
-
There is also a limit of 100 site scripts and 100 site designs per tenant.
154
+
There is also a limit of 100 site scripts and 100 site templates per tenant.
151
155
152
-
## Using PowerShell or REST to work with site designs and site scripts
156
+
## Using PowerShell or REST to work with site templates and site scripts
153
157
154
-
You can create site designs and site scripts by using PowerShell or the REST API. The following example creates a site script and a site design that uses the site script.
158
+
You can create site templates and site scripts by using PowerShell or the REST API. The following example creates a site script and a site template that uses the site script.
155
159
156
160
<!-- The PowerShell example loads the script from a file, while the REST example has the script inline. -->
157
161
@@ -244,15 +248,15 @@ In the previous example, the **Add-SPOSiteScript** cmdlet or **CreateSiteScript*
244
248
The **WebTemplate** parameter set to the value 64 indicates registering this site design with the Team site template. If you have disabled modern Group creation, then publish your site designs using WebTemplate 1 so that they display for the "Group-less" Team site template. The value 68 would indicate registering with the Communication site template. The **Title** and **Description** parameters are displayed when a user views site designs as they create a new Team site.
245
249
246
250
> [!NOTE]
247
-
> A site design can run multiple scripts. The script IDs are passed in an array, and they run in the order listed.
251
+
> A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed.
248
252
249
-
For step-by-step information about creating a site design, see [Get started creating site designs](get-started-create-site-design.md).
253
+
For step-by-step information about creating a site template, see [Get started creating site designs](get-started-create-site-design.md).
250
254
251
255
## PnP provisioning and customization using Power Automate
252
256
253
257
One action provided by site scripts is the ability to trigger a Power Automate flow. This allows you to specify any custom action that you need beyond the actions provided natively in site scripts.
254
258
255
-
If you use the PnP provisioning engine to automate site creation, you can use a Power Automate flow to integrate with site designs. You can maintain all your existing provisioning scripts as well as create new custom provisioning scripts by using this technique.
259
+
If you use the PnP provisioning engine to automate site creation, you can use a Power Automate flow to integrate with site templates. You can maintain all your existing provisioning scripts as well as create new custom provisioning scripts by using this technique.
256
260
257
261
<br/>
258
262
@@ -272,11 +276,11 @@ For a step-by-step tutorial about how to configure your own Power Automate flow
272
276
273
277
## Scoping
274
278
275
-
You can configure site designs to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site designs intended for them. For example, you might want the accounting department to only see site designs specifically for them. And the accounting site designs may not make sense to show to anyone else.
279
+
You can configure site templates to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site templates intended for them. For example, you might want the accounting department to only see site templates specifically for them. And the accounting site templates may not make sense to show to anyone else.
276
280
277
-
By default, a site design can be viewed by everyone when it is created. Scopes are applied by using the **Grant-SPOSiteDesignRights** cmdlet or the **GrantSiteDesignRights** REST API. You can specify the scope by user or a mail-enabled security group.
281
+
By default, a site template can be viewed by everyone when it is created. Scopes are applied by using the **Grant-SPOSiteDesignRights** cmdlet or the **GrantSiteDesignRights** REST API. You can specify the scope by user or a mail-enabled security group.
278
282
279
-
The following example shows how to add Nestor (a user at the fictional Contoso site) view rights on a site design.
283
+
The following example shows how to add Nestor (a user at the fictional Contoso site) view rights on a site template.
280
284
281
285
```powershell
282
286
Grant-SPOSiteDesignRights `
@@ -295,7 +299,7 @@ For more information about working with scopes, see [Scoping access to site desi
295
299
296
300
## See also
297
301
298
-
-[Get started creating site designs](get-started-create-site-design.md)
302
+
-[Get started creating site template](get-started-create-site-design.md)
299
303
-[Apply a scope to your site design](site-design-scoping.md)
0 commit comments