Page Comparison

Overview | Triggers | Example | Related pages

Multiple

triggers can be added to a workflow

. A trigger for an event must include at least one or more actions.

You can add a workflow trigger using the code editor

Image Added

The code editor includes

• color coding to easily distinguish property names, values, and different data types

• autocomplete features

• dropdown selectors for workflow trigger events, conditions, and action properties

Image Added

• code validation

Or add the trigger JSON code directly to your workflow using the visual editor.

Image Added

You can toggle between the code editor and the visual editor. Changes made in one editor are automatically updated in the other editor.

Example

In a 4-state workflow, you might want the workflow to move immediately from a Rejected state to a more proactively named Triage state , rather than waiting for a user to manually transition the content.

Image Removed

Image Added

You can use a trigger to listen for the state change event to the Rejected state and set the trigger action to immediately transition to the Triage state.

Image Removed

The trigger can be added to a workflow using workflow builder but it must be added in JSON markup notationis created using JSON code.

"triggers":
[
	{"event":"on-change-state",
	"conditions":
	[
		{"state":"Rejected"}
	],
	"actions":
	[
		{"action":"change-state",
			"state":"Triage"}
	]}
]

There are a number of workflow events that can be

added to a trigger

. For each

trigger, you can set one or more conditions

Each action is enclosed in a pair of curly brackets { ... }. Multiple actions are added as a comma-separated list. This list of actions is then enclosed in a pair of square brackets [ ...].

For example:

• "actions":[{"action":"action1"}, { "action": "action2"}]

• "actions":[{"action":"change-state", "state":"Triage"}, {"action":"set-message", "type":"warning", "body":"Rejected content, triage actions required", "mode":"autoClose"}]

, for example, to constrain a trigger to listen for an event that occurs in a particular state. One or more actions can be added to a workflow trigger undertaken when the event occurs.

Trigger action and page workflow document activity

For audit purposes, both the rejected decision transition to the Rejected state and the subsequent trigger transition to Triage are recorded in the page document activity.

Image Removed

"triggers":
[
   {
      "event":"on-change-state",
      "conditions":[
         {
            "final":true
         }
      ],
      "actions":[
         {
            "action":"publish-page"
         },
         {
            "action":"send-email",
            "recipients":[
               "@document_user_reviewers@",
               "@document_group_reviewers@"
            ],
            "notification":{
               "subject":"${content.title} is in Review State",
               "title":"${content.title} is in Review State",
               "body":"Hello, ${content.link} in the ${content.space} space needs to be reviewed"
            }
         }
      ]
   }
]

 If adding the JSON trigger using workflow builder there is no need to include the opening "triggers”: JSON markup notation, since it will be added by workflow builder.

The example above has one trigger, the trigger uses a generic event - a state change event - but the added condition sets the trigger to only listen for the state change event to the final state in the workflow.

Trigger One

Trigger event 

WHEN the document changes state

"event":"on-change-state"

Trigger condition for the event

AND the new state is the final state 

"conditions":[ { "final":true } ]

Trigger action†

• THEN the page is published to a new space*

"actions":[ { "action":"publish-page" }, ...

Trigger action†

• AND an email is sent

... { "action":"send-email", "recipients":[ "@document_user_reviewers@", "@document_group_reviewers@" ], "notification":{ "subject":"${content.title} is in Review State", "title":"${content.title} is in Review State", "body":"Hello, ${content.link} in the ${content.space} space needs to be reviewed" }}]

_{* This publishing action using} "publish-page" _{is only available when the Comala Publishing for Cloud app is installed and the current space has been enabled as a draft space for publishing to target public space.}

_{† Multiple trigger actions are added as a comma-separated list, each action enclosed in curly "{" brackets. The list of actions is then enclosed in square brackets e.g.} "actions":[{"action":"action1"}, { "action": "action2"}]

A trigger contains three different properties.

Events

The event name the trigger will listen for. These include:

• "on-change-state"

• "on-approve"

• "on-reject"

• "on-assign"

• "on-unassign"

• "on-expire"

When creating a workflow JSON trigger

• you can add multiple events to a JSON "trigger"

• you can only use each event type once in a JSON "trigger"

Conditions

One or more conditions that must be met for the trigger to perform the specified action(s) for an event.

• "state": "(string value)"

• "initial": (boolean true/false)

• "final":(boolean true/false)

"conditions":[{"state": "Review"}]

You can add more than one different condition in a comma separated bracketed list.

The following is evaluated as an AND condition when using "initial" and "state" conditions.

"conditions":[{"state": "Review" },{"initial":true}]

The following is evaluated as an OR condition when using "final" and "state" conditions.

"conditions":[{"state": "Review" },{"final":true}]

• comma-separated list of conditions are enclosed in square brackets

• each individual condition is enclosed in a set of curly brackets

For "state" condition only one state name value can be entered. Multiple state name values are not accepted.

Actions

A list of actions to perform once the event has occurred and the conditions are fulfilled. These actions include

"actions":[{"action":"change-state","state":"Review"}]

There are two elements that must be present for the change-state action

Related pages

Triggers

Using Workflow Builder

• Add a JSON trigger using workflow builder