All Products
Search

This Product

    DataWorks:Use workflow parameters

    Document Center

    DataWorks:Use workflow parameters

    Last Updated:Mar 26, 2026

    Workflow parameters let you set a single value that propagates to the same parameter across all supported nodes in a workflow — so you update it once, not node by node.

    When you run a workflow that has workflow parameters configured, DataWorks prompts you to assign a value to each parameter before the run starts. That value overwrites the corresponding parameter value on every supported node in the workflow.

    Prerequisites

    Before you begin, ensure that you have:

    Supported node types

    Workflow parameters work with the following node types:

    Node typeCategory
    ODPS SQL nodesODPS
    EMR Spark Shell nodesEMR
    EMR Spark nodesEMR
    EMR Shell nodesEMR
    EMR Hive nodesEMR
    EMR MR nodesEMR
    EMR Presto nodesEMR
    EMR Trino nodesEMR
    EMR Spark SQL nodesEMR
    EMR Spark Streaming nodesEMR
    EMR Streaming SQL nodesEMR
    Hologres SQL nodesHologres

    Usage notes

    BehaviorDetails
    Value overwriteIf a workflow parameter shares the same name as a node parameter but has a different value, the workflow parameter value overwrites the node parameter value.
    Auto-load on openAfter you save a workflow parameter, opening any supported node in that workflow automatically loads the latest configuration into the node's parameter list and makes the node editable.
    Scheduling requires deploymentFor the workflow parameter to apply in scheduled runs, commit and deploy the workflow after configuration.
    Restricted value formatDo not use the ${English word}: format for parameter values or expressions — for example, var:1 and ${var}:1 are not valid.

    Configure a workflow parameter

    This example replaces the value 20230613 of the ReplaceMe parameter with 20230615 on an ODPS SQL node in an auto triggered workflow.

    Step 1: Open the workflow parameter configuration

    1. Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Development and Governance > Data Development. Select the desired workspace from the drop-down list and click Go to Data Development.

    2. In the Scheduled Workflow pane, find the desired workflow and double-click its name.

    3. In the right-side navigation pane of the workflow configuration tab, click Workflow Parameters.

      Workflow Parameters entry

    Step 2: Set a parameter on the node

    1. Double-click the ODPS SQL node to open it.

    2. On the Properties tab, go to the Parameters section. Enter ReplaceMe as the parameter name and set its value to 20230613. For details on configuring node parameters, see Configure scheduling parameters.

      ODPS SQL

    Step 3: Set the workflow parameter

    1. On the workflow configuration tab, click Workflow Parameters in the right-side navigation pane.

    2. On the Workflow Parameters tab, set Parameter Name to ReplaceMe and Value/Expression to 20230615. To add more workflow parameters, click Add.

      Workflow parameter configuration

    3. Save the configuration. The ReplaceMe parameter value on the ODPS SQL node is now overwritten with 20230615.

      Node parameter replacement result

    Verify the configuration

    Run the workflow to confirm the parameter replacement works.

    1. In the top toolbar of the workflow configuration tab, click the 运行 icon.

    2. In the Enter parameters dialog box, assign 20230615 to ReplaceMe and start the run.

    3. After the run completes, right-click the ODPS SQL node and select View Log. Confirm that the value of the ReplaceMe parameter of the ODPS SQL node has changed from 20230613 to 20230615. For more run options, see Debugging procedure.

      Run result

    Apply in production (commit and deploy)

    After verifying the configuration, commit and deploy the workflow so the parameter applies in scheduled runs.

    1. Commit the workflow: Click Submit in the toolbar. In the Commit dialog box, select the nodes to commit and fill in the Change Description.

      Note

      If code review is enabled, the selected nodes must pass review before deployment.

      Commit workflow

    2. Deploy the workflow: For workspaces in standard mode, click the Deploy icon in the upper-right corner after committing. See Deploy nodes for details.

    What's next