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
trigger macro
Overview
The trigger macro listens for Events, then, after filtering and confirming any prerequisite requirements, performs the actions contained in the macro body.
Where to use it?
Optional.
One or more trigger macros can be put in a workflow macro.
can be added as markup in workflow builder
if added using the markup editor, the trigger(s) must be placed after the state macro(s)
Parameters
Parameter | Required | Default | Notes | Ver |
|---|---|---|---|---|
unnamed first parameter |
|
| The event to listen to – see: Events |
|
macro body |
|
| One or more actions to process when the trigger is activated – see: Actions |
|
|
|
| The description for the trigger:
| 5.7+ |
|
| Optionally apply further conditions to filter events – see: Conditions |
| |
|
|
| Required for all events relating to the approval macro. Filter to a specific If you have more than one approval with same name but in different states, you can also filter to a specific state using the |
|
|
|
| Only applies to
The primary use of this parameter is to perform one-time initialisation actions for a given piece of content. For example, on the first review of a piece of content you might want to send out additional emails, or set some metadata. | 3.0.1+ |
|
|
| Only applies to Value is the name of the label that was added or removed. |
|
|
|
| If this value is set, then a custom event identified by this value will be published when the actions are executed, and will contain a flag |
|
|
|
| Required for the The name of the parameter to monitor. |
|
|
|
| Only applicable to for the following events:
|
|
|
|
| Should actions be queued?
If there is a chance that actions will take a long time to process, for example when remote publishing content, they should be queued so the end user doesn't have to wait for them to finish before continuing with their work. |
|
|
|
| Required for the following events:
Filter to a specific active state of the workflow. Only a single state can be specified, and it can't be negated. |
|
|
|
| This setting is used to listen for the outcome of a custom event (set by the |
|
|
|
| If not specified, the trigger will listen for all tasks rather than a specific task. Filter to a specific |
|
Example
The workflow has two triggers with each trigger is listening for a different approval event for the Content Review approval in the Review state.
These are
a
pageapprovedevent triggera
pagerejectedevent trigger
{workflow:Example Trigger Workflow}
{state:Editing|submit=Review}
{state}
{state:Review|approved=Published|rejected=Editing}
{approval:Content Review}
{state}
{state:Published|final=true|updated=Editing}
{state}
{trigger:pageapproved|approval=Content Review}
{set-message:style=success}This page has been approved!{set-message}
{trigger}
{trigger:pagerejected|approval=Content Review}
{set-message:style=error}This page was rejected, please make requested changes.{set-message}
{trigger}
{workflow}You can view and edit a workflow in workflow builder.
In workflow builder, the trigger is added to the workflow using markup.
Once added to the workflow each trigger is displayed as a non-editable workflow Rule.
Rules simply displays the event and event filter for each trigger. To change a trigger you must edit the trigger markup.