This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

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

Overview

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

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

  • "state": "(string value)"

  • "final":(boolean true/false)

  • "initial": (boolean true/false)

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

"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

"final": (boolean true/false)

"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 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)

"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

"triggers":
[
    {"event": "on-change-state",
    "conditions":
    [
        {"initial":true},{"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, since it will be added by workflow builder.

The trigger action will clear any existing messages on the content

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

The action will occur on the change of state event if the current state is either the initial state OR the final state in your workflow.

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

If a JSON condition is present this can include one or more conditions.

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, since it will be added automatically by workflow builder.

The trigger action will cause a change of state

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

The trigger action will occur 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