Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


Excerpt

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

When the named workflow event occurs the trigger will check that any required condition is met, and if met set one or more actions.

Conditions

A conditionmust be met for the trigger to perform the specified action(s). Available conditions are

  • "state": "(string value)"

  • "initial": (boolean true/false)

  • "final":(boolean true/false)

If "final" condition is added together with another condition to an event, the condition is evaluated as an OR function.


JSON ConditionJSON CodeNote

"state": "(string value)"


Code Block
"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  can be added as a condition for each event

"initial": (boolean true/false)


Code Block
"conditions":
[
	{"final":true}
],


The trigger action will occur if the state for the event is the final state.

For example, 

  • "event":"on-change-state", "conditions":[{"final":true}],

This "on-change-state event " event condition is met on the the change to the final state in the workflow.

The final parameter value is boolean

  • "final":true
  • "final":false

If final condition is added to an event with a state condition, the conditions are evaluated as an OR condition.

"final":(boolean true/false)


Code Block
"conditions":
[
	{"initial":true}
],


The trigger action will occur if the current state is the initial change to a state.

The initial condition can be constrained to a named state

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

The initial parameter value is boolean

  • "initial":true
  • "initial":false



Example on-change-state event

Insert excerpt
"on-change-state" event
"on-change-state" event
nopaneltrue

Example on-approve event

Insert excerpt
"on-approve" event
"on-approve" event
nopaneltrue