Add a JSON trigger using workflow builder visual editor

Overview

Triggers that listen for workflow events can be added to a workflow. These triggers can be used to create actions, for example, custom notifications.

Triggers are used in the Content Expiry workflow and the Quality Management System workflow.

Comala Document Control triggers are created using JSON code and can be added to a workflow using the workflow builder visual editor or the code editor.

Related pages

Trigger JSON code format requirements when adding to visual editor

Example Trigger notation

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"state": "Rejected"}
	],
	"actions":
	[
		{"action": "set-message",
			"type": "info",
			"title": "Hey My Wonderful design and Tech Team",
			"body": "We have some work to do ... it was rejected!!!"}
	]}
]

Only one overall "triggers": will be required in the JSON code if added to a workflow using the code editor. When adding the JSON trigger notation in workflow builder visual editor you do not have to add the "triggers": JSON element. Workflow builder will add this automatically after saving the workflow.

Adding a trigger using workflow builder

The trigger JSON code is added using the workflow builder visual editor.

Open workflow builder in the space settings Document Control dashboard

choose Edit Workflow
select Use Visual Editor

The workflow builder visual editor will open for the current space workflow.

choose the workflow name in the workflow panel to open the Edit Workflow panel

expand the Advanced tab in the Edit Workflow panel

Example JSON triggers can be copied, pasted and edited to the Triggers dialog box.

copy and paste the JSON code trigger markup to the Triggers dialog box

Workflow builder visual editor does not allow the workflows installed with the app to be overwritten. All edits will be saved as a (Copy) of the original workflow and you may need to edit/amend the workflow name to save changes.

Do not add the opening JSON "triggers": notation when adding the JSON trigger in workflow builder. This will be automatically added to the workflow JSON template on saving the workflow in workflow builder.

choose Apply to save the added JSON code trigger
choose Save to update the workflow in workflow builder
choose Exit to return to the space settings

The edited custom workflow is

added to the dashboard as the current space workflow
available for selection in the workflow picker when choosing Manage Workflows

A custom workflow can also be deleted permanently from a space using the Remove Workflow option in the Edit Workflow dropdown menu.

Elements of the custom message notification trigger

In this example, the added trigger will

Listen for a state change event to the named state in the event condition - the Rejected state

For example, a reviewer choosing to reject the content causing a workflow approval transition to the Rejected state.

Action a custom notification once the event occurs, displaying an on-screen message for users who view the content

Related Pages

User Guide

Reviewing Content

Using Workflow Builder

Notifications