null


Skip to end of banner
Go to start of banner

state condition

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Overview

One or more conditions can be set for a trigger for a named event in the workflow.Adding the "state" condition to a trigger listens for the trigger event that occurs when the document is in the state specified in the condition. Only one state can be set for the condition.

When the named workflow event occurs the trigger checks that the "state" condition is met, and if met set one or more actions.

If the "state" condition is used with "final" condition, the condition is evaluated as an OR condition. If "state" is used with the "initial" condition, the condition is evaluated as an AND condition.


JSON Condition

JSON Code example

Note

"state": "(string value)"

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

The trigger action will occur if the condition matches the provided "state".

  • specified state name must exist in the current workflow

  • only one state can be specified

  • only one "state": "statename" can be added as a condition for each event

Example on-approve event

"triggers":
[
	{"event": "on-approve",
	"conditions":
	[
		{"state":"Review"}
	],
	"actions":
	[
		{"action":"change-state",
			"state":"Published"}
	]}
]

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

The trigger action causes a change of state

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

The trigger action occurs on the approve event but ONLY if the current state is the Review state

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

If a JSON condition is present this can include one or more conditions but only ONE state condition can be used for each event.


  • No labels