Set instance name

Use the Set instance name action A tool for building the processes, logic, and direction within workflows.to display custom instance names for instances of workflows. Setting a custom instance name provides more context for users viewing the Instances page and enables users to easily identify instances of the workflow.

For example, if your workflow uses a Zendesk - New ticket start event The connector and event for triggering the workflow to run, including required configuration. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder., you can add the Set instance name action to your workflow and configure the custom instance name to include the Zendesk Priority and Ticket ID start event variables. When users view the list of instances on the Instances page, the custom instance name provides the context of the priority of the Zendesk ticket associated with the workflow, and users can find the ticket ID without clicking on instances and viewing the Instance start data.

Note: If you add multiple Set instance name actions to your workflow, the instance name displayed in the Instances page will be the last updated custom instance name for the instance of the workflow.

Before you begin: 

Jump to:

Configure the Set instance name action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  2. Type text and insert variables in the Custom instance name field.

Set instance name fields and settings

Field

Description

Variable types
Custom instance name

The unique name of the workflow instance which appears in the Instances page.

Tip: Insert start event variables to provide users viewing the Instances page with useful context for identifying unique workflow instances.

Note: If you add multiple Set instance name actions to your workflow, the instance name displayed in the Instances page will be the last updated custom instance name for the instance of the workflow.

Text, Decimal, Integer, Boolean, DateTime, Collection