Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r096

D toc

D s ed
rtrue
editionsgdpent,gdppro,gdppr,awsent,awspro,awspr

Excerpt

Within a flow, you can create and manage flow parameters, including specifying override values. From the flow menu, select Parameters.

  • flow parameter is a reference token that can be invoked from within the flow.
  • A flow parameter can be one of the following types:
    • Variable flow parameter, which can be: 
      • A string value
      • D s item
        itemparameter
      • A regular expression
    • Selector flow parameter.
      • A selector type parameter is a set of one or more permitted values. 
  • 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.

...

Info

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.

When Parameters for plans: When reviewing parameters for your plan, you may notice that a parameter has multiple values:

  • Parameter values that do not conflict are ok. For example, if the parameter is applied to an imported dataset and to an output object which are attached to different recipes, these values are not in conflict.
  • If the parameter values are in conflict, then a warning icon is displayed. For example, if a parameter is applied to an imported dataset and to an output object attached to the same recipe, then the conflicting parameter values must be overridden to fix them.
Info

NOTE: When a parameter has conflicting values from objects in a plan task, you must fix them by applying a single override value. If these values are not fixed, then the plan fails to execute.

...

  • To create a new parameter, click Add parameter.
    • Specify the parameter details as needed. Additional information is below.
    • Click Save.
  • To edit a parameter's default value, hover over its entry, and click the Pencil icon.
  • Additional options are available in the context menu.
    • Select Edit description to modify the Description value.
    • (Selector type only) Select Edit choices to modify the Name parameterpermitted values for the parameter. 
  • To delete a parameter, hover over its entry and click the Trash icon.

    Warning

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

    Tip

    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.

Variable type parameters

Variable type parameters are single values. Values can be specified as String values, 

D s item
itempatterns
, or regular expression patterns.

Image Added

D caption
Specify a flow parameter of variable type
  • Specify the Name value and optional Description value

    Info

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

  • For type, select Variable.
  • Specify the default Value for the parameter. Examples by parameter type:

    • String literal:

      Code Block
      This is my string.
      Info

      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.

    • D s lang
      itempattern
      : Patterns can be used to find matches in your recipes. The following pattern matches for two consecutive digits:

      Code Block
      `{digit}{digit}`

      For more information on 

      D s lang
      itempatterns
      , see Text Matching.

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

      Code Block
      /[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

After you create a parameter

...

To delete a parameter, hover over its entry and click the Trash icon.

Warning

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

...

, you can insert it into your recipes using the following type of reference:

Code Block
${myRecipeParameterName}

For more information, see Create Flow Parameter.

Selector type parameters

Image Added

D caption
Specify a flow parameter of Selector type
  • Specify the Name value and optional Description value. 

    Info

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

  • For type, select Selector.
  • For Choices, type or paste the permitted values for your selector type parameter. 

    Tip

    Tip: The first value that you add is the default value.

    • Each value must be added separately.
    • Click the X next to a value to remove it from the permitted list.

After you create a parameter, you can insert it into your recipes using the following type of reference and then selecting a value from the list of permitted values:

Code Block
${myRecipeParameterName} == <selected_value>

For more information, see Create Flow Parameter.

...

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

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

...

You can also specify parameter overrides at the plan level. For the recipes in your plan, you can pass in parameter overrides values, which are used during plan runs.

D s ed
editionsgdpent,gdppro,gdppr,awsent,awspro,awspr

D caption
Manage Parameters Dialog for plans

...

  • Parameter: The name of the parameter
  • From: The source flow in your plan for the parameter
  • Created in: The object in the source flow where the parameter is defined
  • Value: The current value for the parameter

...

Manage Parameters for Plans

See Manage Parameters Dialog for Plans.

D s also
inCQLtrue
label((label = "flow_ui") OR (label ="parameter_ui"))