Add a workflow trigger using the visual editor
- Robert Alexander Marshall
Overview
One or more workflow triggers can be added to a custom workflow to listen for a workflow event. These triggers can be used to undertake actions, such as sending a custom notification.
Comala Document Management workflow triggers are added to a custom workflow using the workflow builder visual editor.
An event for the trigger to listen for is selected using the dropdown menu. An optional event condition can also be selected using a dropdown menu. One or more actions for the trigger are added using the Add Action dialog box.
Triggers added to the workflow are displayed in the workflow panel in the visual editor.
Add a workflow trigger
To add a workflow trigger to a custom workflow, in the app space settings
open workflow builder visual editor for the custom workflow
open the trigger editor by choosing either
Add Trigger in the left-hand workflow panel
the + Trigger button in the right-hand navigator panel
Event
The trigger only listens for a single event.
select a single event for the trigger using the Event dropdown menu
Scroll down to view the available workflow trigger events.
Condition
One condition for the event can be added. Adding a condition is optional.
if required, add an event condition using the Condition dropdown menu
When adding the State condition, you must add the value of the workflow state. A workflow state for the current workflow is selected using the dropdown menu option.
The Is Initial State and Is Final State are each a condition with a boolean value of true or false.
Actions
A workflow trigger must have at least one action undertaken when the event occurs and any set condition is met.
You can add one or more trigger actions using the Add Action option.
choose Add Action to open a dialog box to select a trigger action
select a trigger action using the Actions dropdown menu
Some actions, such as Set Message and Send Email, include mandatory parameters that must be specified for the action to function correctly. These parameters are configured using the dialog box.
add any parameter values for the action
Mandatory parameters are marked with a red asterisk *. To add the action to the workflow trigger, you must add the values for these parameters.
add the values for any parameters
choose Add to include the action in the workflow trigger
choose Add to add the trigger to the workflow
You can view the JSON code for the added trigger by toggling from the visual editor to the code editor.
Editing a trigger
A trigger can be edited to change the event, condition, or add or remove actions.
select the trigger in the workflow panel to open the Edit trigger dialog box
For example, the On state changed trigger listening for the change to the Approved state.
In the above trigger, additional actions have been added:
Clean Messages
Remove Restrictions
Actions are executed in the listed order.
You can drag each action to change the order of the actions in the list.
You can highlight an added action and choose X to remove it from the trigger.
Adding multiple triggers
Choose +Triggers to open the trigger editor to add an additional trigger to listen for a different event or event and condition.
This workflow trigger actions a change of state on a reviewer rejected decision. When there are multiple approvers, the trigger fast-tracks a rejected decision from a single reviewer.
All workflow triggers added to a workflow are displayed in the workflow panel.