Custom Variables

Content on this page is for a product or feature in controlled release (CR). If you are not part of the CR group and would like more information, contact your Account Representative.

Custom Variables are user-defined data fields that allow users to capture and store specific values relevant to their workflows and tasks. These values are essential for:

  • Reporting (USD earned per workflow, customer satisfaction rate)

  • Optimization (identifying trends or improvements)

  • Visualization (heatmaps, widgets)

They support the following data types:

  • String

  • Numeric (Float, Integer) - with increment/decrement selector

  • Boolean (true/false toggle)

  • List (user-defined options)

Key Actions Available

  • Creating a New Variable

    Use the New Variable button at the top-right corner to create a new variable.

  • Editing and Deleting Variables

  • Click the stacked dots icon next to a variable entry and select Edit/Delete as needed.

Variables Table Overview

The variables are displayed in a tabular format with the following columns:

Column Name

Description

Variable Name The name of the variable.
Type The data type associated with the variable.

Default Value

Default value set for the variable.

# of Workflows

Number of Workflows the variable is used in.

To create a new variable, click the New Variable button. For more details, refer to the section, Creating a Custom Variable.

Creating a Custom Variable

To create a custom variable:

  1. Click the app selector icon of app selector and select Orchestrator.

  2. From the left navigation panel, click the Custom Variables tab. This tab displays all existing variables associated with the application.

  3. Click the New Variable button located at the top-right corner.

  4. A form appears to define the new variable. Enter the following details:

    1. Variable Name: Provide a unique and descriptive name for the variable. The name is prepended by a $. The $ indicates that it is a custom variable and is non-editable.

    2. Variable Description: Provide a description for the variable

    3. Data Type: Select the appropriate data type (e.g., String, Integer, Boolean, etc.) from the dropdown. If you choose the List data type, you can select multiple entries.

    4. Default Value (optional): Enter a default value if applicable.

  5. Click the Save Variable button. The new variable appears in the list under the Custom Variables tab.

  6. Review the newly created variable in the list. To edit it, click the stacked dots icon next to the variable entry and select Edit. You can update the variable description and default values.

    Note: The Variable Name and Type fields cannot be modified

  7. After making the necessary changes, click Update Variable to save your changes.

  8. To delete a variable, click the stacked dots icon and select Delete from the menu.