View Configurations
On this page, you can view all existing configurations in a table (Figure 7).
Interacting with the List
-
Search and Sort: You can search the collection using the search input field, and you can sort the configurations by pressing on the table headers of the corresponding columns.
-
Manage in SharePoint: If you click on ‘Manage’, you will navigate to the same list within SharePoint. All changes to configuration properties made here can also be made directly in SharePoint.
-
View Properties: Clicking on the title of a configuration will navigate you to the Configuration properties page.
Figure 7: View configurations screen overview
Creating a New Configuration Manually
To create a new Configuration without using the export feature, you must first navigate to SharePoint by clicking on ‘Manage’ button. This button redirects you to the SharePoint library that holds the templates.
Installation Steps
-
Create a Folder: Each configuration is grouped in a folder. The first step is to create a new folder as you would in any library. Give the folder an identifiable name for your template and open it.
-
Upload the XML Definition File: Upload an XML file that contains the template definition. The file name must adhere to the following conventions:
- Regular configurations:
configuration.xml - Playlists:
playlist.xml
Files with names other than these will be ignored. Renaming the XML file will result in users being unable to apply the template.
- Regular configurations:
-
Set Properties:
- Provide a Title.
- Set the Version to
1.0.0.0. - Provide a Description for your users.
- Set the Start object type. This object type depends on the template:
- Tenant: For new site collections, created with Make engine templates or the use of playlist.xml
- Web: For subsites, created with Make engine templates or the use of playlist.xml
- Site: For modifying existing site collections, created with PnP engine templates.
- Set the configuration parameters accordingly.
-
Upload Assets:
- Upload any other configuration files, such as page layouts, images, or master pages.
- Ensure you use the same relative path as specified in your configuration file.
- If you did not build the template yourself, you must adhere to the settings and folder structure provided by the template supplier.
Using the Template
You have now installed the template. Navigate back to the Make interface and click “Apply configurations” in the menu on the left-hand side to start using it.
Configuration Properties
Click on the title of a configuration to see the configuration properties.
On this screen, the configuration properties are visible (Figure 8). These values can also be altered here.
-
Title: The title of the configuration.
-
Version: The version of the request. For example
1.0.0.0. -
Start object type: Depending on the template, the Start object can be:
- Tenant: For new site collections, created with Make engine templates or the use of playlist.xml
- Web: For subsites, created with Make engine templates or the use of playlist.xml
- Site: For modifying existing site collections, created with PnP engine templates.
-
Description: A description can be used to provide more information.
Figure 8: Configuration properties
Configuration Parameters
The additional parameters listed below differ from configuration to configuration. The values for these parameters will be included in the XML template where the corresponding keys are present.
IMPORTANT |
If you choose to alter these parameters in SharePoint, ensure the format is correct. |
Example:
|
|