Skip to main content

Introduction to SharePoint site template and site script

In this article, we are going to learn about site templates, site design, and site scripts in SharePoint online. We will also create one template in SharePoint online.
SharePoint's site template feature gives us the flexibility to do a common set of things on a SharePoint site. SharePoint templates can also be used on SharePoint sites that already exist, such as the Team site or Communication site.
You can make site templates with common features like lists structures , or custom actions so that your users can quickly build new SharePoint sites with the same features by applying the templates.

There are two parts to the site template. One is site design, and the other is site script, First, we'll figure out these two things.

Site Script:  A site script is a JSON file with a list of actions that will be run when you apply site design.
Site Design: Site design act as a container of the site script. Site scripts are attached to the site design, you can attach more than one site script to the site design.

How it will work?? 

You will create a site script using a JSON template and add all the actions in the JSON file, which you want to execute like creating lists, deploying a client-side solution, etc., and then we will add this script to our tenant.

A step-by-step guide to creating a template :

Step 1: Create a site script with all the required actions and keep it in your system. 
Step 2: You can create site templates and site scripts by using PowerShell. Considering that you have SharePoint management shell installed on your system. First, we will add the Site Script, use the command mentioned below, replace the location with your file location and provide the title as per your requirement.
Get-Content  'c:\MyScript\script.json' `    -Raw | `   Add-SPOSiteScript `   -Title "Custom Department Theme"
Once the command gets executed, It will provide you Id, Title, Description, Content, and Version. Copy the Id for future reference.
Step 3:  Now we will attach the script to the site design. 
Add-SPOSiteDesign
It will ask some questions: 
Title - According to you put the template name 
WebTemplate -  64 code is for the team site template and 68 for the communication site template. 
SiteScript[0] - Paste the id we have copied, command (If you want to add multiple scripts so enter and add more script 
Great! Now the site template is added to the tenant.

Apply site template :

To apply templates, you need to create the SharePoint site(Communication site or Team site) or you can apply a site template on the existing site.
  • Navigate to the site where you want to apply the custom template.
  • Move to the setting by clicking on the gear icon.
  • Click on the Apply a site template

    SiteScript
  • You will be redirected to the Select template page, Click on the From Your Organization

    SiteScript
  • It will redirect you to the From your organization template page, you will be able to see all the custom templates created by your organization.

    Template

  • You can select the template which you want to apply on the site. It will show all the actions that it will be executing while applying this site template. Click on apply.










It will take few seconds and then changes will reflect on the site.
Labels:

Comments

Post a Comment

Popular posts from this blog

SPFx Interview Questions With Answers

In this article, we are going to discuss interview questions related to the SPFx (SharePoint Framework Development ). It will help you to prepare for the interview and in getting clarity on the core concepts of SPFx development. What is SPFx? SPFx, short for SharePoint Framework,  SPFx  allows us for client-side SharePoint development, we can easily connect with SharePoint data and it also supports for open source tools. What is the major difference between SPFx web part and the SharePoint app? Both the development model supports client-side development but the major difference between these two is that the SharePoint app(add-in) runs on the iframe. What you can build with SPFx? Using SPFx framework we can customize the SharePoint pages. We can build things mentioned below using the SharePoint Framework(SPFx). Web parts, Extensions, Adaptive Card, Library Component How many types of extensions we can create using SPFx? SPFx has three extension types: Application Customizers: U...
2 comments
Read more

How to Upgrade SharePoint Web Parts to the Newest Version

Updating the SharePoint/SPFx web parts or other solution is very common requirement, Webparts we can add from the SharePoint store or can be uploaded by our organization. To update a SharePoint web part to the latest version, start by uploading the updated SPFx package to the App Catalog. Then, make sure to upgrade the web part on the site where it’s being used. In this blog will be discussing ways to upgrade both package from the SharePoint app store or the the custom uploaded from the organization Update the web part added from the SharePoint app store: Go to the tenant level app catalog site. Select the app which you want to upgrade. Once you select the app, go the top ribbon and select file and click on the "Upgrade Store App", updated version will be added on the appcatalog if the new version is available on the store. Note: If you built the custom webpart then upload it to the app catalog. Install the upgraded solution: Navigate to the site collection where you have ins...
Post a Comment
Read more

SharePoint Framework SPFx Node Version Compatibility

How to check the compatibility between the SPFx version and the Node.js version The SharePoint Framework (SPFx) is a client-side development platform used to develop web parts and extensions for SharePoint. The SharePoint Framework (SPFx) is compatible with the Node.js versions. Existing SPFx solutions may have different SPFx versions as compared to the current solutions. To make the SPFx solution run, Node.js is required, and in this blog, I am sharing steps to check the compatible node module for SPFx.  Find the SPFx version from the solution:  Open the project solution and navigate to the "package.json" file. In package.json file you will find  "@microsoft/sp-core-library" key and value of this particular key is the version of the SPFx.       Ex:    "@microsoft/sp-core-library": "1.14.0" Another way to find the SPFx version is by command, open the command prompt and run the command mentioned below: npm ls -g --depth=0 @microsoft/generator-s...
Post a Comment
Read more