null


Skip to end of banner
Go to start of banner

final 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 Next »

Overview

One or more conditions can be set for a trigger for a named event in the workflow.Adding the "final":true condition to a trigger listens for the trigger event when the document is in the final state.

  • the condition is a boolean condition with a value of true or false

When the named workflow event occurs the trigger checks that any required condition is met and sets one or more actions if met.

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


JSON Condition

JSON Code

Note

"final": (boolean true/false)

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


The trigger action occurs if the state for the event is the final state.

For example, 

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

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

The final parameter value is a boolean condition

  • "final":true

  • "final":false

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

Example on-change-state event

"triggers":
[
    {"event": "on-change-state",
    "conditions":
    [
        {"final":true}
    ],
    "actions":
    [
        {"action": "clean-messages"}
    ]}
]

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 clears any existing messages on the content

  • "actions":[{ "action":"clean-messages"}],

The messages are only cleared on the change of state to the final state in the workflow

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

JSON trigger conditions

Related Pages

  • No labels