Configuring Workflow settings

After creating a Workflow, you need to configure it. Follow the steps below to configure a Workflow.

Prerequisites

1. You must have the Edit Workflows permission.

2. An existing Workflow. If you haven't yet created a Workflow, refer to Creating a Workflow.

Configuring Workflow settings

1. In the Workflow information pane, do the following:

   1. Optionally, edit the Workflow name.

   2. Optionally, change the slug. The slug auto-populates based on the Workflow name and is made up of letters, digits, and hyphens. If you previously used a template, be sure to update the prepopulated slug when you use the template again.

   3. Under Description, enter a brief description of the workflow.

   4. Click Edit to change the display icon. This makes the workflow easier to identify.

   5. Under Run response template, enter a message to be displayed to the user upon run completion. This message can reference values from the run using Cortex's templating syntax. Refer to the Blocks documentation for more information.

   6. Under Failed run response template, enter a message to be displayed to the user upon run failure. This message can reference values from the run using Cortex's templating syntax. Refer to the Blocks documentation for more information.

   7. From the Scope drop-down menu, select one of the following:

      • Entity - The Workflow is tied to a specific entity type such as Services or Teams. If selected, configure the following:

        • Entity type - Select a built-in or custom entity. Entities must be already defined to appear in the list.

        • Include groups - Select a group or groups. Groups must be already defined to appear in the list.

        • Exclude groups - Exclude a group or groups. Groups must be already defined to appear in the list.

        • User relation to entities - Select All to allow any user in your organization to run the workflow. Select Owner to limit it to the owner of the entity.

      • Global - The Workflow is not tied to a specific entity and can be run from the main Workflows page.

   8. Optionally, toggle on Restrict to initiator to ensure that only the user who initiated the workflow can provide required input during the run.

   9. Optionally, declare variables that can be referenced from each block. Variable slugs declared here can be set at runtime by callers of the Workflow Runs API using the initialContext field. In the Variables section, click Add variable. Enter the following:

      • Slug - Enter a unique slug for the variable. It must be unique and can only contain letters, numbers, or hyphens.

      • Description - Enter a description of the variable.

      • Variable type - Select the variable type.

        • Boolean - A true or false value.

        • Number - A numeric value, such as an integer or decimal.

        • Object - A structured value containing one or more key-value pairs.

        • String - A sequence of characters, such as a word or phrase.

        • … is array - If toggled on, the variable is treated as a list of values of the selected type.

      • Default value - Enter a default value. This must be a valid JSON.

      • Click Add.

   10. Click Save.

Next step: Adding blocks to the Workflow