Manage Parameters Dialog

Within a flow, you can create and manage flow parameters, including specifying override values.

  • A flow parameter is a reference token that can be invoked from within the flow. A flow parameter can be:
    • A string value
    • A Cloud Dataprep parameter
    • A regular expression pattern
  • Where it is invoked, the default value for the parameter is applied or, if an override value has been set, the override value is applied.
  • For more information, see Overview of Parameterization.

You specify flow parameters at the flow level. They can be invoked in any recipe within the flow.

Tip: Override values apply to all parameters in the flow that share the same name, even if they are output object parameters.

Tip: Flow parameters can be inherited from upstream flows. For example, if you create a reference dataset that references flow parameters from its flow, those parameters are passed to the downstream flow. While you cannot change the default value for the downstream instance of the parameter, you can apply override values for all recipes in the downstream flow.

Parameters Tab

In the Parameters tab, you can manage the flow parameters in your flow.

NOTE: Non-flow parameters cannot be edited or deleted from the Parameters tab. These parameters must be modified in the interface for the object to which they apply. Overrides can be applied to these types of parameters through the Overrides tab.

Figure: Parameters tab

  • To create a new parameter, click Add parameter.
    • Specify the Name parameter.

      NOTE: Name values are case-sensitive. After saving a parameter, you cannot change its name.

    • Specify the default Value for the parameter. Examples by parameter type:

      • String literal:

        This is my string.

        NOTE: Flow parameter values that are literal values are String values. You can convert them to other data types after they have been referenced in your recipe.

      • Cloud Dataprep pattern: Patterns can be used to find matches in your recipes. The following pattern matches for two consecutive digits:

        `{digit}{digit}`

        For more information on Cloud Dataprep patterns, see Text Matching.

      • Regular expression patterns: These patterns also can be used for finding matches. The following pattern matches for two consecutive digits:

        /[0-9][0-9]/

        Regular expressions are a standard method for identifying patterns in data. The syntax is based on RE2 and PCRE regular expressions.

    • Click Save.
  • To edit a parameter's default value, hover over its entry, and click the Pencil icon.
  • To delete a parameter, hover over its entry and click the Trash icon.

    Deleting a parameter cannot be undone. When you delete a parameter, all recipe steps that reference it are broken.

    Tip: If you accidentally delete a flow parameter, you can recreate it with the same case-sensitive name. All references to it should work again.

After you create a parameter, you can insert it into your recipes using the following type of reference:

${myRecipeParameterName}

For more information, see Create Flow Parameter.

Overrides Tab

In the Overrides tab, you can apply override values to any parameters referenced in your flow, including:

  • Flow parameters
  • output object parameters
  • Dataset parameters
  • Parameters that are available through reference datasets

NOTE: The parameters listed in this tab have override values applied to them. Parameters that are using their default values in this flow are not listed.

Figure: Overrides tab

All of the available parameter overrides are listed.

  • To apply an override to all references of a parameter within the flow, click Add override.
    • Select the name of the parameter.
    • Enter its override value. Click Save.
  • To edit a parameter override, hover over its entry and click the Pencil icon. Enter a new value.

    NOTE: The override value is applied to all subsequent operations in the platform. When a job is submitted to the job queue, any overrides are applied at that time. Changes to override values do not affect jobs that are already in flight.

  • To delete an override, hover over its entry and click the Trash icon.

A note on upgraded parameters

If you have upgraded from a version of the product before Release 7.1, any parameters that were defined in the previous version appear grayed out in the Parameters tab.

  • The Parameters tab is used for defining new flow parameters, which is a new type of parameter. These parameters can be referenced inside your recipe steps. See above.

    NOTE: Parameters that are not of flow parameter type cannot be edited in the Parameters tab. You can apply override values to these parameters through the Overrides tab.

  • The Overrides tab is used to specify overrides to the default values for parameters, including parameters defined outside of Flow View.
    • If you add an override using the name of the parameter that was upgraded, the override is applied, based on the matching name.