Apply Configuration

Apply Configuration

To create a configuration request and add it to the queue, a configuration must first be applied. To do this, navigate to the ‘Apply configuration’ page (Figure 2).

Figure 2: Apply configuration

Figure 2: Apply configuration screen overview

Creating a Template

You have two options for creating the configuration template to be applied here:

  • Use the ‘Make configuration’ page.
  • Create a template yourself.

Note: For the system to be able to select your template on this page, the file must be named configuration.xml or playlist.xml .

The Make Provisioning interface offers a standardized way to utilize your templates and start provisioning and configuring your SharePoint environment. It is important to note that this is not the only method for starting Make tasks. For more information on custom-made solutions for putting Make Provisioning into action, please contact your Rapid Circle consultant.

Select a Configuration

An existing configuration can be selected using this dropdown menu. To view or edit these existing configurations, navigate to the View configurations page.

Once a configuration is selected, Make will display a form where you can specify where the template will be applied on your SharePoint tenant. Additionally, any template-specific parameters (variables) will also be displayed in the form.

Configuration Location

The Configuration location is the starting point where Make will begin applying the template.

If you are using Make engine templates or Playlists use the following configuration.

For Site Collections

Parameter Sample Value
Url https://tenant.sharepoint.com/sites/newsite
Configuration location https://tenant-admin.sharepoint.com

The start object type of the template should be Tenant.

For Webs (Subsites)

Parameter Sample Value
Url newsubweb
Configuration location https://tenant.sharepoint.com/sites/newsite

The start object type of the template should be Web.

PnP Engine Template Configuration

For Site Collections

Parameter Sample Value
Url /sites/newsite
Configuration location https://tenant.sharepoint.com/

The start object type of the template should be Site.

For Webs (Subsites)

Parameter Sample Value
Url newsubweb
Configuration location https://tenant.sharepoint.com/sites/newsite
Parameter Sample Value
Url newsubweb/sub
Configuration location https://tenant.sharepoint.com/sites/newsite

The start object type of the template should be Site.


Note: This document is published for early access. Below sections are still in draft and will be completed in a future update.
  • If you are creating new site collections, this location should be the root of your tenant or web application.
  • For subsites, you must specify the absolute URL of the parent site.
NOTE If this field is not visible, check your web.config.js file. The setting may be set to AutoFill, which can be convenient if you are only creating site collections and Teams.

Figure 3: Auto Fill Configuration Location

Additional Parameters

When a configuration is selected, additional input fields will appear. These fields correspond to the parameters defined within the configuration and are used when the template is applied. Each input field must be assigned a value.

Regular Expressions

It is possible to use Regular Expressions (regex) to validate user input when applying a new configuration.

To implement this functionality, add a "regex" property with the regular expression string to the parameter field within your parameters JSON.

For example, if you want to use a regular expression to validate that a user enters an email address, you would use the following JSON structure:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
   "d":{
      "parameters":[
         {
            "id":"Title",
            "title":"Group Title",
            "inputType":"text",
            "required":true,
            "sampleValue":" RegexExample",
            "value":" RegexExample"
         },
         {
            "id":"mailNickName",
            "title":"Mailbox",
            "inputType":"text",
            "required":true,
            "sampleValue":" RegexExample",
            "value":" RegexExample"
         },
         {
            "id":"url",
            "title":"Url",
            "inputType":"text",
            "required":true,
            "sampleValue":"https://tenant.sharepoint.com/sites/RegexExample",
            "value":"https:// tenant.sharepoint.com/sites/RegexExample"
         },
         {
            "id":"owner",
            "title":"Group Owner 1",
            "inputType":"text",
            "required":true,
            "sampleValue":"person@tenant.onmicrosoft.com",
            "regex":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$"
         },
         {
            "id":"security",
            "title":"security",
            "inputType":"text",
            "required":true,
            "sampleValue":"Public",
            "value":"Public"
         }
      ]
   }
}
NOTE Be sure to escape characters to maintain valid JSON syntax. As shown in the example below, the backslash (\) must be escaped by using an additional backslash (\\). Using an (online) JSON validator is highly recommended.
IMPORTANT Do not use leading and trailing slashes in your regex string within the JSON. For example, following regex will not work.
^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$

When applying this configuration through the Make UI, a valid email address must be inserted into the “Group Owner 1” input box. If the provided input is invalid, an Invalid message will appear, and the configuration will be prevented from being submitted.

Figure 4: Regular expression validation

Figure 4: Regular expression validation