Managing an existing activity parameter
In the Activity Parameters section, you can update, link, or create a new parameter.
Edit an existing parameter
In the Edit Parameters page, you can update values of an existing parameter.
Procedure
- Go to Activity parameters section.
- Expand the individual activity parameters and search for your parameter record within it.
- From the overflow menu of the parameter record, click Edit.
- In the Edit parameters page, select the default Update tab.
- Enter or select a new value to update the parameter.
- Click Save.
Link parameter
In the Edit Parameters page, link the value to a parameter.
Procedure
- Go to Activity parameters section.
- Expand the individual activity parameters and search for your parameter record within it.
- From the overflow menu of the parameter record, click Edit.
- In the Edit parameters page, select the Link tab.
-
Select a linking option. You can map parameter values using the Input parameters and Templates menu options in the Link parameters dialog box:
Note: Not all options are available for a parameter. It varies based on the activities used in the service.
- Input parameters - The Input parameters menu option lists all of the parameters that are available in the Input parameters section of the main Parameters tab of a service.
-
Shared parameters
Note: If you link the attribute of a shared parameter, then an input parameter is automatically created. During service deployment, select the dataobject for the datatype. The data attribute value of the selected dataobject is used during provisioning.
- Templates
- Helm Charts
- Business Process Manager - If you have configured a Business Process Manager connection, then all Business Process Manager activities are available for association.
-
Map values with the parameter:
-
Click to select an option. The values displayed change based on the options that you select and the activities that you have used in your service workflow.
Notes: For example, if there are two templates A and B placed in sequence in the Provision action of the Composition tab, then parameters of both the templates are available in the Activity parameters section of the Parameters tab. If you want to link a parameter of template B, then a list of all parameters of the template A and shared parameters are available for association. If your service involves Business Process Manager activities and helm charts, then they are also available for linking. For the very first activity, template A, you can only link input parameters and shared parameters.
-
Expand the parameter menu and hover over the parameters to see a plus icon.
- Click the plus icon to select it. A green tick mark indicates your selection and also the Value is refreshed. You can also use the Search Parameter to filter and find a parameter.
-
Create a new parameter
In the Edit Parameters page, you can create service parameter and link to it at the same time.
Procedure
- Go to Activity parameters section.
- Expand the individual activity parameters and search for your parameter record within it.
- From the overflow menu of the parameter record, click Edit.
- In the Edit parameters page, select the Create new tab.
- Enter a value for the Parameter key.
-
Enter or select values for the new parameter.
Notes:
- You can only use the End-user permissions value of the parameter record from which you opened the Create new tab. You cannot change the value.
- You cannot change the Parameter type value. It is dependent on the parameter record type from which you opened the Create new tab.
The three different types of permissions are as follows:
-
Invisible - During parameter creation, enter a value for the Default value. This parameter is not visible while creating an instance of the service.
Note: For the Invisible parameter, if you enter incorrect data in the default value field, then the Service instance deployment of the content run time fails.
-
Read-only - During parameter creation, enter or select the following values:
- Parameter type - Select a type. It determines the type of parameter. The available parameter types are string, password, list, boolean, counter, map, connection, and shared parameters.
- Display name - The label or display name of the parameter.
- Description - The description appears as a tooltip when the you order the service.
- Default value - The default value of the parameter. When you create the service instance, this parameter is visible to you in read-only format.
- For list data type, you can click Add new to add a list of values.
- For map data type, you can click Add new to add a list of Key Value pairs. Click cross icon to delete a value record.
- For password data type, toggle between Show and Hide to view or hide the password characters.
-
Read and Write - When you create a service instance, you can make changes to the values that were defined during creation. Enter or select the following values for Read and Write permission:
- Parameter type - Select a type. It determines the type of parameter. The available parameters are string, stringlist, password, list, boolean, counter, and map.
- Value required - Determines whether a value is required for the parameter.
- Specify options - For string data type, you can select this option for a drop-down list of string values.
- Display name - The label or display name of the parameter.
- Description - The description appears as a tooltip when the customer orders this service.
- Validation rule - The validation rule is a non mandatory field that is available only if you select "string" or "password" value in Parameter type drop-down list. Validation Rule (regex) provides an ability to the service composer to restrict the values of an input parameter. If regex is provided during service composition, then the value of the string input parameter must satisfy the regex criteria during service deployment. For example, (\w+?@\w+?\x2E.+).
-
Validation rule description - Validation Rule Description (regexdesc) provides information about the validation rule. For example, "Enter a valid email address". Here, (\w+?@\w+?\x2E.+) is the regular expression for an email address. If you try to enter “abc.xyz.com” as the value for string input parameters, then service deployment fails due to invalid email address.
Note: For more information about regex, see regexlib.com
.
- Default value - If you select, Specify options, then enter values for Label and Value pair fields. Select a record to mark it as default value. You can click the cross mark icon to delete a value record.
-
Click Save to create and save the new parameter.