Skip to main content

v26.04: Working with Parameters

Workflows support global parameters that allow users to define reusable values at the workflow level. Parameters resolve at runtime and propagate to all referencing nodes within a workflow.

Two types of parameters are available in the Global Parameters panel:

  • Automated Parameters — System-defined parameters that resolve automatically at runtime without user input:

    • Time

    • Account

    • Execution Date

    • Execution Period

    • Execution User

  • User Parameters — Custom parameters created by the user. Each user parameter includes:

    • Name: Parameter identifier

    • Type: Data type (Text, etc.)

    • Source: Value source (Constant, etc.)

    • Value: The parameter value

Configuring Parameters

To configure parameters:

  1. Open the Workflow Designer and select a workflow.

  2. Select Params from the L2 header toolbar.

  3. The Global Parameters panel opens on the right side, displaying Automated Parameters and User Parameters sections.

  4. To add a user parameter, enter the parameter name in the New parameter name field under User Parameters.

  5. Select the + button to add the parameter.

  6. Configure the parameter properties: Name, Type, Source, and Value.

  7. Select Publish to save the workflow with the new parameters.

Using Parameters in Nodes

Parameters can be referenced in node configurations using the ${parameter_name} syntax. When a workflow executes, the system resolves all parameter references before processing begins.

Parameter support extends to the following node types:

Parameters in SQL Script Nodes

In the Advance View mode, an Available Parameters section displays below the Query field. Users can select parameter tags (such as Time, Account, Execution Date) to insert them into the SQL query. The system resolves parameter values before executing the SQL script. Parameters can be referenced in node configurations using the ${parameter_name} syntax.

Parameters in Remote Table Read Nodes

Users can include workflow parameters within remote table read configurations to dynamically filter or parameterize data retrieval from external sources.

v26.10: Parameters in Sheet and Transaction Table Nodes

In Read Sheet nodes, Read Transaction Table nodes, and the Overwrite based on section of Write Sheet and Write Transaction Table nodes, the member selector of a global dimension has a collapsible Parameters group above the member list. The group lists every workflow parameter, with user-defined parameters first and automated parameters last. Select parameters, members, or both for the same dimension.

For a local dimension in a Read Transaction Table node or in the Overwrite based on section of a Write Transaction Table node, the filter icon opens a list of parameters only. A dimension with selected parameters shows a chevron that lists them, and you can clear a parameter from that list.

At runtime, the selection for a dimension is its fixed members plus the members that each selected parameter resolves to, without duplicates. A Write node clears only the rows inside the resulting overwrite scope before it writes.

Note: Parameter selections take effect at runtime only after you publish the workflow. A parameter value that is not a member of the dimension adds nothing to the selection and does not cause an error.

Note: A Read node that returns no rows for the selection still succeeds, and the workflow continues with an empty dataset. If the overwrite scope of a Write node matches no rows in the target, the node fails with the message Overwrite failed. Returns 0 records., the write is aborted, and the workflow stops.

v26.10: Parameters in Master Data Read Nodes

In a Read Master Data node, each property that is not localized has a filter icon to the left of the kebab menu. The icon opens a list of workflow parameters. Select one or more parameters to return only the rows whose property value matches the members that the parameters resolve to. With no parameter selected, the property returns all values. A property with selected parameters shows a chevron that lists them. Localized properties do not have a filter icon.

When a parameter resolves to several members, all of them apply. When you select more than one parameter on a property, the resolved values are combined without duplicates.

Note: Parameter selections take effect at runtime only after you publish the workflow.

Recently Viewed