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.

Comments

Post a Comment

Popular posts from this blog

Permission XML for SharePoint Add-in

In this article, we will be discussing the permission XMLs, which are used to provide permission to SharePoint add-in. You can set the App only permission, by setting "true" or "false" in  AllowAppOnlyPolicy=“true” in these permission XMLs.   If add-in granted permission to tenant scope, It includes all children in scope. Before granting access to the app, need to register an app. Follow this link for step by step guide to  How to register an app/add-in in SharePoint   Providing access to add-in at tenant level: To provide access at tenant level user must have the tenant admin level permission. To grant this permission tenant admin can use this URL   https://tenantName-admin.sharepoint.com/_layouts/appinv.aspx Search the App Id (Client ID) and it will fetch all the information which you provide at time of registration of app.   Assign full control at tenant level : <AppPermissionRequests AllowAppOnlyPolicy="true">   <AppPermissionRequest  Scop

How to register an app in SharePoint

In this article, we are going to learn how to register an app/add-in in SharePoint online. If you have created a Sharepoint provider-hosted add-in or other SharePoint solution and to access the SharePoint site or list using the app/add-in you need to register the add-in on SharePoint and to grant permission. Register app in SharePoint 1. Login into SharePoint and Navigate to register an app page. Use the URL mentioned below:          [Sitecollection URL]/_layouts/15/appregnew.aspx 2.  Once you navigate to the Register app page, a form will open. You need to fill all the fields on the form. Client Id and Client Secret  generated when we click on the generate button available next to the fields.  Title : Name of the add-in which you want to give. App Domain : Where your domain is hosted, for the local environment you can place             "www.localhost.com". Do not include HTTP or HTTPS in App Domain. Redirect URL :  Insert the redirect URL, for t

How to create list from template in sharepoint

In this article, we are going to learn how to create a list from list template or using(.stp) file or we can say create list from existing list. Once you save the list as a template, It appears into List template option under the web designer gallery on site setting page. Steps to create list from list template: 1 Move to the site setting section where you have saved the list template. 2. When you click on the List templates, you will redirect to the List template gallery and from the list template gallery. 3. Now click on the File in ribbon and click on the upload document. 4. Browse the location where your list template is downloaded. I am uploading the template of an address list. 5.  After browsing the template, now you can give the name what you want to give to the list template and click on save. 6. Now the list template file appears into the list template gallery. Now click on the gear  icon and click on the Add an app. 7. On clicking add an app,