Skip to main content
Version: 8.9 (unreleased)

Cluster variables

Use Admin to manage cluster variables, which store configuration values centrally across your cluster and make them available in FEEL expressions.

About cluster variables​

Cluster variables allow you to maintain environment-specific configurations, API endpoints, feature flags, and other shared values without hardcoding them into individual process definitions. Variables can be defined at the global (cluster-wide) or tenant level.

tip

To learn more about cluster variables, including scope resolution, data types, and FEEL expression usage, see the cluster variables overview.

You can manage cluster variables through the Admin UI or the Orchestration Cluster API.

Manage global cluster variables​

Global cluster variables are available to all processes across the entire cluster.

Create a global cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Click Create variable.
  3. Provide the following details:
    • Name: A unique identifier for the variable.
    • Value: The value of the variable, which can be a string, number, boolean, or JSON object.
  4. Click Create variable.

The variable is created and immediately available for use in FEEL expressions across all processes in the cluster using camunda.vars.cluster.<name> or camunda.vars.env.<name>.

Update a global cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Click the pencil icon next to the variable you want to update.
  3. Update the variable value.
  4. Click Save.

The updated value takes effect for new evaluations of FEEL expressions that reference this variable.

Delete a global cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Click Delete next to the variable you want to delete.
  3. Confirm the deletion by clicking Delete in the confirmation dialog.

The variable is deleted and is no longer available in FEEL expressions.

note

Deleting a cluster variable does not affect process instances that have already resolved the variable value.

Manage tenant cluster variables​

When multi-tenancy is enabled, you can define tenant-specific cluster variables that override global variables with the same name for processes running in that tenant.

Create a tenant cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Select the tenant for which you want to create a variable.
  3. Click Create variable.
  4. Provide the following details:
    • Name: A unique identifier for the variable.
    • Value: The value of the variable.
  5. Click Create variable.

The variable is created and available in FEEL expressions for processes running in the selected tenant using camunda.vars.tenant.<name> or camunda.vars.env.<name>.

note

If a global variable with the same name exists, the tenant-level variable takes precedence for processes running in this tenant. See scope resolution for details.

Update a tenant cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Select the tenant for which you want to update the variable.
  3. Click the pencil icon next to the variable you want to update.
  4. Update the variable value.
  5. Click Save.

Delete a tenant cluster variable​

  1. Log in to Admin in your cluster, and select the Cluster Variables tab.
  2. Select the tenant for which you want to delete the variable.
  3. Click Delete next to the variable you want to delete.
  4. Confirm the deletion by clicking Delete in the confirmation dialog.

See also​