Skip to content

Commit 9f34b6c

Browse files
author
Vesa Juvonen
committed
New tenant-wide deployment option documentation
1 parent 5e160fa commit 9f34b6c

File tree

5 files changed

+64
-0
lines changed

5 files changed

+64
-0
lines changed

docs/spfx/tenant-scoped-deployment.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Tenant-wide solution deployment for SharePoint Framework solutions
2+
3+
You can configure your SharePoint Framework components to be immediately available cross the tenant when solution package is installed to tenant app catalog. This can be configured by using **skipFeatureDeployment** attribute in the **package-solution.json** file.
4+
5+
When solution has this attribute enabled, tenant administrator will be provided option to enable the solution to be available automatically cross all site collections and sites in tenant, when the solution package is installed to the tenant app catalog.
6+
7+
You can also see the tenant-wide deployment option demonstrated by watching following video on the [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=pemHOZCSwZI).
8+
9+
<a href="https://www.youtube.com/watch?v=pemHOZCSwZI&list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG">
10+
<img src="../../images/tenant-deploy-youtube-video.png" alt="PnP Short Guidance video on tenant-wide deployment option" />
11+
</a>
12+
13+
> Notice. You have to update to latest SharePoint Framework Yeoman template version to be able to use this capability. You can update your global installation by executing `npm install -g @microsoft/generator-sharepoint`.
14+
15+
## Solution specific requirements
16+
17+
When this option is used, any feature framework definitions in the SharePoint Framework solution will be ignored. If solution contains Feature Framework definitions, for example for creating a custom list, you should not use this solution specific option.
18+
19+
* [Provision SharePoint assets with your solution package](#)
20+
21+
> Notice. Solutions which are configured to be automatically deployed cross tenants are not visible in the add an app capability at the site level.
22+
23+
## Configuring solution to be available cross tenant
24+
25+
SharePoint Framework Yeoman template will ask a specific question related on this option. This question will impact directly on the **skipFeatureDeployment** attribute in the **package-solution.json** file.
26+
27+
![Yeoman question around tenant deployed option](../../images/tenant-deploy-yeoman.png)
28+
29+
In following example configuration, **skipFeatureDeployment** is set to true, which indicates that solution can be centrally deployed cross the tenant.
30+
31+
```json
32+
{
33+
"solution": {
34+
"name": "tenant-deploy-client-side-solution",
35+
"id": "dd4feca4-6f7e-47f1-a0e2-97de8890e3fa",
36+
"version": "1.0.0.0",
37+
"skipFeatureDeployment": true
38+
},
39+
"paths": {
40+
"zippedPackage": "solution/tenant-deploy-true.sppkg"
41+
}
42+
}
43+
44+
```
45+
46+
### Approving tenant wide deployment in app catalog
47+
48+
When solution with **skipFeatureDeployment** attribute set to **true** is deployed to tenant app catalog, administrator is given an option to configure solution to be deployed centrally cross the tenant.
49+
50+
By default, "**Make this solution available to all sites in the organization**" checkbox is unchecked. If the checkbox is checked by the administrator, components in the solutions will be automatically visible and available cross the tenant.
51+
52+
!["Make this solution available to all sites in the organization" setting visible when solution is deployed to app catalog](../../images/tenant-deploy-app-catalog.png)
53+
54+
Notice that since the solution and site -specific upgrade actions are only available when you use feature framework, there's no specific upgrade option for the centrally deployed solutions. These solutions can be simply updated by updating solution specific assets in the CDN and by updating package in the app catalog. This will update automatically all existing component instances cross the tenant to use the latest component assets, like JavaScript files and updated CSS files.
55+
56+
## Client-side web part visibility in SharePoint sites
57+
58+
Web parts included in solutions which have been centrally deployed, will be immediately visible in the web part picker in both classic and modern pages.
59+
60+
## Impact of skipFeatureDeployment setting with Extensions
61+
62+
SharePoint Framework extensions will be immediately available to be used in the SharePoint sites. This means that they can be associated to be used with **ClientSideComponentId** properties in the specific SharePoint elements, like *fields* and *user custom actions*.
63+

images/tenant-deploy-app-catalog.png

25 KB
Loading

images/tenant-deploy-yeoman.png

45 KB
Loading
58 KB
Loading

misc/SharePointDocumentationToc.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<Item text="Enterprise Guidance" url="spfx/enterprise-guidance" SEODescription="SharePoint Framework Enterprise architecture and development guidance." />
1212
<Item text="Team-based development" url="spfx/team-based-development-on-sharepoint-framework" SEODescription="Team-based development on SharePoint Framework." />
1313
<Item text="Using GraphHttpClient" url="spfx/call-microsoft-graph-using-graphhttpclient" SEODescription="Call Microsoft Graph using the SharePoint Framework GraphHttpClient." />
14+
<Item text="Tenant-wide deployment" url="spfx/tenant-scoped-deployment" SEODescription="Tenant-wide deployment option for SharePoint Framework solutions (skipFeatureDeployment)." />
1415
<Item text="Toolchain" url="spfx/toolchain/sharepoint-framework-toolchain" SEODescription="">
1516
<Item text="SharePoint Framework Toolchain" url="spfx/toolchain/sharepoint-framework-toolchain" SEODescription="The SharePoint Framework toolchain is the set of build tools, framework packages, and other items that manage building and deploying your client side projects." />
1617
<Item text="Yeoman Sharepoint generator" url="spfx/toolchain/scaffolding-projects-using-yeoman-sharepoint-generator" SEODescription="Create new client-side solution projects using yeoman SharePoint generator." />

0 commit comments

Comments
 (0)