Versions Compared

Old Version 5

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 6

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Child pages (Children Display)pageJSON Trigger actions
Table of Contents
minLevel1
maxLevel6
outlinefalse
typeflat
separatorpipe
printabletrue

Overview

The change state action in a workflow trigger is

When the workflow trigger event occurs, the trigger checks that any required conditions are met, and if they are met, the "change-state" action forces a change of the state.

Info

One or more trigger actions can be set for a named event in the workflow.

"change-state"

Excerpt

The trigger action "change-state" causes a change of the state to the specified state if the provided parameters are valid.

parameter and its

  • action (change-state)

  • state (string) ❗️ State to move into

❗️ indicates a mandatory parameter - the "state"

  • state❗️ destination workflow state for the action

    • state must be a state in the workflow

    • state names are case-sensitive

❗️ Mandatory parameter

state parameter

  • state parameter must be included with a valid value for the destination state

must be added for the trigger action

Example trigger code

Code Block
"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"final":true}
	],
	"actions":
	[
		{"action": "change-state",
			"state": "ReviewArchive"}
	]}
]
Info

If When adding the JSON trigger using the workflow builder visual editor, there is no need to include the opening "triggers": JSON markup notation, ; it is added automatically by the workflow builder.

The example trigger listens for the workflow's change of state to the final state and immediately moves the workflow to the Archive state.

 The destination state must be included for in the "change-state" action.

Trigger actions

Another use of the trigger action is to move from the workflow Review state, which contains an approval, immediately on a reviewer rejection, to the Editing state. This can be used to fast-track a single rejected decision, for example, when multiple reviewers are assigned to an approval.

Code Block
"triggers":
[
	{"event": "on-reject",
	"conditions":
	[
		{"state":"Review"}
	],
	"actions":
	[
		{"action": "change-state",
			"state": "Editing"}
	]}
]

Related Pages