Adding parameters

Parameters can be added through multiple avenues: from existing Parameter Context and from a Process Group.

Add to existing Parameter Context:

To add or create parameters within an existing Parameter Context, follow the steps below.

1. Select Parameter Contexts from the Global menu.

2. Click Edit for the desired context.

3. In the Edit Parameter Context window, click the Add (+) icon.

4. Add the following details:

   1. Name: Name of the parameter. Only alphanumeric characters, hyphens, underscores, periods, and spaces are allowed.

   2. Value: the value that will be used when the Parameter is referenced. If a Parameter makes use of the Expression Language, it is important to note that the Expression Language will be evaluated in the context of the component that references the Parameter.

   3. Set empty string: Check to set the value of the Parameter to an empty string.

   4. Sensitive Value: Set to “Yes” if the value should be considered sensitive. If sensitive, the value of the Parameter will not be shown in the UI once applied. Sensitive Parameters can only be referenced by sensitive properties and Non-Sensitive Parameters by non-sensitive properties.

   5. Description: Optional field. Explanation of what the parameter is or how it is used.

5. Click OK to add the new parameter.

6. From the Parameter Context window, click Apply to complete the process and save the Parameters.

Add from Process Group:

If a Process Group is referencing a Parameter Context, new parameters can be from that group’s canvas view, without having to go to the Global menu.

To add parameters to an existing Parameter Context within a Process group, follow the steps below:

1. Navigate to the Process Group which requires new parameters.

2. Right-click the canvas.

3. Select the Parameters option from the context menu

4. In the Parameter Context window, click the Add (+) button.

5. In the Parameters screen, complete the following settings:

• Name: Name of the parameter. Only alphanumeric characters, hyphens, underscores, periods, and spaces are allowed.

• Value: the value that will be used when the parameter is referenced. If a parameter makes use of the Expression Language, it is important to note that the Expression Language will be evaluated in the context of the component that references the parameter.

• Set empty string: Check to set the value of the parameter to an empty string.

• Sensitive Value: Set to Yes if the value should be considered sensitive. If sensitive, the value of the parameter will not be shown in the UI once applied. Sensitive Parameters can only be referenced by sensitive properties and Non-Sensitive Parameters by non-sensitive properties. Once a parameter is created, its sensitivity flag cannot be changed.

• Description (optional): Explanation of what the parameter is or how it is used.

To complete the process, select Apply from the Parameter window. Operations are performed to validate all components that reference the added or modified parameters, including: Stopping/Restarting affected Processors, Disabling/Re-enabling affected Controller Services, Updating Parameter Context.