Working with parameters for node properties

Define reusable parameters for node properties. After you add parameters to your flow, you can specify values at run time rather than hardcoding them.

Only some of the values for node properties can be parameterized. These properties are marked with the Edit icon. The parameters that you create are local to the flow, which means they cannot be used in another flow.

Adding parameters

To create parameters for your flow:

  1. Open the flow canvas.
  2. Click the Parameters icon on the toolbar.
  3. Click Create local parameter.
  4. Provide parameter details and click Save.

Parameter details

  • Name

  • Prompt (Optional) - Provide a description for the parameter that can then be displayed as a prompt.

  • Type - Select the type for the parameter. The following types are available:

    • String
    • Integer
    • Float
    • Boolean
    • Date
    • Double
    • JSON object
    • Instance(CRN)
    • Time
    • Timestamp

  • Input type - The parameter can accept a single value (default), or a list of values.

  • Default value (Optional) - Provide a default value for the parameter. If the input type is a list, you can add more than one default value.

Using parameter sets

You can also create parameter sets to collect multiple parameters that can be reused when running Unstructured Data Integration flows within a project. For each parameter set you can create multiple value sets. Parameter sets must be associated with the flow before they can be used for it.

To create a parameter set:

  1. Open a project and click the Assets tab.
  2. Click New asset and select Define reusable sets of parameters.
  3. Provide a name and description for your set.
  4. Add parameters:
    1. Click the Parameters tab and then Create parameter.
    2. Enter the required information.
    3. Click Create.
  5. Add value sets for the parameters.
    1. Click the Value sets tab. Then, click Create value set.
    2. Enter a name, and provide a value for each parameter in the set. You can create multiple value sets.
    3. Click Save.

Once you create a parameter set, associate it with the flow where you want to use it:

  1. In the flow canvas click the Parameters icon.
  2. Go to the Parameter sets tab and click Add parameter set.
  3. Select the sets that you want to use and click Add.

You can view all your parameter sets by opening the Assets tab and clicking Configurations.

Running flows with parameters

  1. Open the flow canvas.
  2. Double click a node to view its properties. When the value for the property can be replaced with a parameter, you will see an edit icon.
  3. Click the icon and select one of the options:
    • Enter value - Default option, you enter the value for the property manually.
    • Assign parameter - In the Assign parameter tearsheet, select an already defined parameter or create a new one. Information on what type of parameter is accepted by the given property is displayed at the top of the tearsheet. The list of available parameters is filtered by the allowed type.
  4. Click Run flow.
  5. In the Define run flow window, review the assigned parameters and provide values where necessary. Each parameter lists the node that uses it and the default value. When done, click Run.

The flow runs with the paramaters you specified.

Note that for any scheduled future runs default values for parameters are used. Make sure you provide default values.

Restrictions

The Annotation filter criteria list only accepts parameters of type String List.