Use workspace-level parameters

Background

A scheduling parameter is a variable used in DataWorks task scheduling. Based on your configured rules, DataWorks automatically substitutes its value each time the task runs. For more information about scheduling parameters, see Scheduling parameters.

Prerequisites

• A workspace must already exist. Workspace-level parameters must be used within a specific workspace. For more information about how to create a workspace, see Configure a workspace.

• To create workspace-level parameters, you must have the Workspace Administrator role in the workspace. For more information, see Add workspace members and manage their roles.

• This feature requires DataWorks Professional Edition or a more advanced edition. For more information about how to purchase an edition, see Purchase or upgrade a DataWorks edition.

Limitations

• This feature is only available for exclusive resource groups for scheduling.

• If you purchased an exclusive resource group for scheduling after January 1, 2024, you can use this feature. If you purchased it before this date, contact technical support for an upgrade.

Create a workspace-level parameter

1. Go to the page for creating workspace-level parameters.

   1. Go to the Operation Center page.

      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 O&M > Operation Center. On the page that appears, select the desired workspace from the drop-down list and click Go to Operation Center.

   2. In the left-side navigation pane of Operation Center, click Others > Scheduling Configuration, and then click the Workspace-level Parameters tab.

2. Create a workspace-level parameter.

   1. On the Workspace-level Parameters tab, click Create Workspace-level Parameter and configure the parameter.

      Note

      To create multiple parameters at once, click Batch Create Workspace-level Parameters.

      Parameter	Description
      Parameter Name	Specify a custom name for the parameter. The name must be prefixed with workspace. and must be unique.
      Owner	Specify the owner of the workspace-level parameter. Note A Workspace Administrator can specify any workspace member as the parameter owner. Only a Workspace Administrator can modify or delete workspace-level parameters. If you need to perform these management operations, you can add a user to the workspace and grant the required role. For more information, see Add workspace members and manage their roles.
      Applicable Workspace	Select the workspace where this parameter will be used. After configuration, all tasks in the workspace can reference the parameter. Note The list shows only workspaces for which the current user is a Workspace Administrator. A workspace-level parameter can be used in only one workspace.
      Parameter Type and Parameter Value	This setting defines the value that replaces the parameter when a task runs. The following parameter types and values are supported: Constant (Plaintext): A fixed value that is visible to all users. Example: 123. Constant (Ciphertext): A fixed value that is masked (displayed as ****** by default). Use this type for sensitive data. For example, if you enter 123, the value is displayed as ******. Variable: A value that is dynamically generated based on a system variable. For example, you can set the value to $[yyyy-mm-dd] to get the scheduled time of a task, or to ${yyyy-mm-dd} to get the data timestamp for a task run. For more supported formats, see Supported formats for scheduling parameters. Note The Parameter Value can be set to some special characters. For details, see the prompts on the UI. You cannot reference another workspace-level parameter in a parameter's value. In a standard mode workspace, you can configure different values for the same parameter in the development environment and production environment. For more information about workspace modes, see Differences between workspace modes.

   2. Click OK to create the parameter.

Use workspace-level parameters

After creating a workspace-level parameter, use it in a node within the authorized workspace. You use a workspace-level parameter in the same way as a standard scheduling parameter:

1. Define a variable in the node's code.

2. On the node configuration page, go to the Scheduling > Scheduling Parameters section and assign the workspace-level parameter to the variable.

After you configure the parameter, you can preview its value to verify the output and make adjustments if necessary. For more information about using scheduling parameters, see Configure and use scheduling parameters.

Manage workspace-level parameters

On the Workspace-level Parameters page, you can perform the following operations on workspace-level parameters:

• View parameters: View parameter details, its associated workspace, and the tasks that reference it. You can navigate to a task by its ID to perform development operations.

• Modify parameters:

  • You can modify only the parameter's owner, value, and description. Each modification creates a new version.

  • If a parameter is referenced by tasks, modifying it will affect those tasks. Proceed with caution.

  • The changes take effect within 10 minutes.

• Compare and roll back versions: You can view a parameter's version history, compare versions, and roll back to a previous version.

• Delete parameters:

  • You cannot delete a parameter if it is referenced by other tasks.

  • Deleting a parameter causes the related tasks to fail. Proceed with caution.

  • Although the deletion is immediate on the Workspace-level Parameters page, tasks that reference the parameter may still retrieve its value at runtime for up to 10 minutes.