In this blog, we will be learning how to create list templates under the tab From your organization.
When people in the organization create new lists, they need a template that can be used each time a new list is created.
Site Script
A site script is a collection of actions that SharePoint runs when creating a new site or list. Actions describe changes to apply to the new list, such as creating new columns, adding views, or content types. The actions are specified in a JSON script, which is a list of all actions to apply. When a script runs, SharePoint completes each action in the order listed.
Site Template (previously known as Site Design)
Site templates can be used each time a new site is created to apply a consistent set of actions. Site templates created using custom site scripts will display in the From your organization tab.
A site script is a JSON string that contains the actions to be taken on a site. A site template, on the other hand, is like a container for the site script. You can attach one or more site scripts to a site template, and when you apply the site template, you execute the actions defined in all of the site scripts. It's like the site template is the visible surface part that can group several site scripts together, and the site scripts are all the action underneath.
Currently, no list template is available From your organization tab.
- A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed.
- The former term for site templates may still appear in certain cmdlets and script labels as "site design".
- The schema is case-sensitive.
Create a Site script in JSON
Create the script in JSON that describes the action to be executed on the list. You can view and reference the latest JSON schema file here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json
In addition to constructing the JSON by hand, you can also use third-party tools with graphical user interfaces that generate the site scripts for you, such as sitedesigner.io by Mikko Punamäki or Site Template Studio by Yannick Plenevaux.
Exporting an existing list as a site script
In our scenario, we will be exporting an existing list configuration as a site script.
First, connect to the SPO admin site using the Connect-SPOService cmdlet. It can be achieved with the following script. The Get-SPOSiteScriptFromList cmdlet prints out the site script to the console. It can be saved into a variable, or you can copy and save it in a JSON file.
Deploy Site Script and Site Template
To use our site script, we need to deploy it to our tenant. We also need to create a site template where we can attach the deployed site script.
1) Add the site script
Each site script must be registered in SharePoint so that it is available to use. Add a new site script by using the Add-SPOSiteScript cmdlet.
After running the cmdlet, you get a result that lists the site script ID of the added script. Keep track of this ID, as it will be needed later when you create the site template.
2) Create the site template
Next, we will create the site template. Run the Add-SPOListDesign cmdlet to add a new site template. Use the script ID saved above when you added the site script. It can run one or more scripts that have already been added.
The JSON response displays the ID of the new site template. It can be used later on to update or modify the site template.
Get the existing Site Script and Site Template
After we have deployed our site script and site template to our tenant, we can see their properties and information about all other deployed site scripts and templates using the Get-SPOSiteScript and Get-SPOListDesign cmdlet.
Use the new site template
Now that we've added a site script and site template, we can use them to create a new list.
I hope this will help all of you! 🧲
Feel free to provide feedback.
🚀 "Happy Coding" 🚀
No comments:
Post a Comment