This article provides an overview of workflow triggers and how to set them up.
Estimated Read Time: 4 minutes
Sections in this article:
For background information, see Kanban Workflow Engine - An Introduction.
What is a Workflow Trigger?
Workflow triggers are a powerful tool to automatically initiate a Workflow process. They are used to decide when a Workflow starts.
As standard, you can create a trigger from a number of data points including:
|
|
It is also possible to create triggers based on Custom Data fields, including the following field types:
- Dropdown
- Multi-pick dropwdown
- Yes/No
- Date
- Integer
For example, on a Contract Renewal workflow, you could create triggers with a condition of 'Contract End Date is less than 90 days' to ensure the workflow only starts when those conditions are met.
Create a Workflow Trigger
Note: To complete these steps, users must have the Workflow Administrator permission, or be assigned as a Local Workflow Administrator.
To add a trigger to a workflow:
- From the navigation menu, click Workflows.
- Expand the 3 dots on the relevant workflow, then select Workflow Triggers.
- Click Add Trigger.
- Enter a name, then click Create.
- Edit the trigger by clicking the Pencil icon next to each setting:
- Trigger Name
- Trigger Status:
- Live: The trigger is active. When the conditions are met, a card is automatically created on the workflow.
- Pipeline: The trigger is NOT active, but still saved against the Workflow. When the conditions are met, a card is not created on the workflow.
- Apply transitions on card creation:
- Yes: The card will be treated as submitted upon card creation, and therefore, any transitions that are based on card submission will take effect.
- No: The card will remain in the Workflow Start Phase, and the transition will not take effect until the card is manually submitted by the End User.
Note:
- Multiple triggers can be added to a Workflow.
- Each individual trigger operates on AND boolean logic. If you require OR logic, it's recommended to create a separate trigger.
If a workflow trigger is set to Pipeline, the following banner will display on the workflow kanban board:
Set Trigger Conditions
Once you've created a trigger, you need to define conditions that specify the exact criteria for activation.
- To set your Workflow Trigger conditions, click + ADD.
- Select the field that will trigger the workflow. For example, the Contract End Date field.
- Complete the additional fields as required. The fields available will depend on the field type you selected.
- Select the Trigger Condition's operator. For example, Less than, more than, equal to, etc.
- Select the data. For example, select the number of days if you selected a date-related field.
- Click Create. Repeat these steps if the trigger requires multiple conditions.
Note: When operating triggered contract renewal workflows, be aware of your trigger conditions.
For example, if a contract ends on December 24th but is added to Gatekeeper on November 1st, and your renewal workflow trigger is set to 90 days before the contract end date, no card will be created - because the contract has already missed the trigger window.
To avoid this issue, consider using a shorter trigger timeframe, such as 60 or 30 days.