Creating new input and output parameters
From the Parameters tab, you can create new parameters for Input parameter and Output parameters.
Procedure
-
From the drop-down menu, select Provision action or Bind action or Custom actions.
Notes:
- Based on the selection, the parameters change in the Input parameters section, Activity parameters section, and Output parameters section.
- If you do not have any Bind action flow created in the Composition tab, then you cannot find it in this drop-down list.
-
Click Create parameter to add a new input or output parameter. See Creating parameter.
- Click Add. The parameter is added to the appropriate input or output section. You can edit and delete an existing parameter from the Actions overflow menu. You can also verify the parameters in the Source code tab.
Creating parameter
-
In the Create parameter page, enter the Parameter key.
Note: The naming convention for a parameter key is as follows:
- Alphanumeric, underscore, and hyphen
- Starts with an alphabet
-
Select End-user permission.
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 sharedparameters.
- Display name - The label or display name of the parameter.
- Description - The description appears as a tooltip when the customer orders this 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-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-write permission:
- Editable - If checked, this parameter can be edited while editing a service instance.
- Parameter type - Select a type. It determines the type of parameter. The available parameters are string, stringlist, password, list, boolean, counter, map, connection, and sharedparameters.
- 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. It is not available for other data types.
- Display name - The label or display name of the parameter.
- Description - The description appears as a tooltip when the customer orders this service.
-
Dynamic - Enables an input parameter to fetch possible values dynamically in real time depending on the selected values of the dependent parameters.
-
Pass by name - Check this if the name should be used instead of the value. If not checked, parameter value is used.
Note: Parameter of asset type
regions
should not be defined as pass by name. A region should always be passed by a value as per provider implementation. -
Source - A collection of dynamic input parameter implementations. Each source is associated with a cloud provider type.
For more information about supported providers, see Dynamic parameters supported providers
-
Asset type - Select the required asset type from this drop-down list. The asset type list is based on the selection of the Source.
-
Depends on - These input fields change based on the Asset type selection and should be linked to the appropriate input parameters.
Notes:
- Two plans with dynamic parameters are not supported yet. They are only supported with the one, standard plan only.
- Dynamic input parameters must be created sequentially as connection, region, vpc and a subnet.
-
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.+). This is not applicable if Dynamic if selected.
-
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. This is not applicable if Dynamic is selected.
Note: For more information about regex, see regexlib.com
.
-
Default value - Enter a 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. This is not applicable if Dynamic is selected.
-