Expand all   Collapse all

This documentation relates to the 5.2 release of Comala Workflows

 Documentation for other versions of Comala Workflows is available too.

Overview

As content producers interact with content, and the workflow itself, internal notifications called "Events" are generated within the Comala Workflows app. The workflow can use Triggers to listen for these events, and, upon detecting one, perform one or more Actions.

This process, of an event triggering actions, enables the workflow to react to a wide range of user interactions and workflow situations. For example, you could send custom emails when someone is assigned to a review, or you could start a remote publishing process when content is approved.

Events

Event

Notes

Ver

Assignee

The approval parameter must be set on the {trigger} for these events to work.

Macros: {approval}

pageapprovalassigned

Page reviewer assigned

Content by label

There is no content with the specified labels


newsapprovalassigned

Blog post reviewer assigned

Content by label

There is no content with the specified labels


approvalunassigned

Reviewer unassigned

Content by label

There is no content with the specified labels


Attachments

Only for content that the workflow is applied to.

attachmentadded

Attachment created

Content by label

There is no content with the specified labels


attachmentschanged

Attachment created, updated or removed

Content by label

There is no content with the specified labels


attachmentupdated

Attachment updated (eg.new version uploaded)

Content by label

There is no content with the specified labels


attachmentremoved

Attachment removed

Content by label

There is no content with the specified labels


Content changes

Only for content that the workflow is applied to.

pagecreated

Page created

Only works in Space Mode.

Content by label

There is no content with the specified labels


newscreated

Blog post created

Only works in Space Mode.

Content by label

There is no content with the specified labels


pageupdated

Page edited

For simple state transitions, you can also use the updated parameter on the {state} macro.

Content by label

There is no content with the specified labels


newsupdated

Blog post edited

For simple state transitions, you can also use the updated parameter on the {state} macro.

Content by label

There is no content with the specified labels


pagemoved

Page moved

Content by label

There is no content with the specified labels

3.1+

Content reviews

The approval parameter must be set on the {trigger} for these events to work.

By default, the {trigger} will only activate once all reviewers have agreed to Approve or Reject the content. To activate it for each individual Approve or Reject, set partial=true.

For simple state transitions, you can also use the approved and rejected parameters on the {state} macro.

Macros: {approval}, {state}, {approve-page}, {reject-page}, {approve-children}, {reject-children}

pageapproved

Page approved

Content by label

There is no content with the specified labels


newsapproved

Blog post approved

Content by label

There is no content with the specified labels


pagerejected

Page rejected

Content by label

There is no content with the specified labels


newsrejected

Blog post rejected

Content by label

There is no content with the specified labels


Labels

Only for content that the workflow is applied to.

Macros: {set-label}, {remove-label}

labeladded

Label added

Content by label

There is no content with the specified labels


labelremoved

Label removed

Content by label

There is no content with the specified labels


State

These events occur when a workflow transitions to a new state, or when a state expires.

Note: You must specify the state parameter in the {trigger} for these events.

Macros: {state}, {set-state}, {set-state-expiry}

statechanged

Page state changed

Content by label

There is no content with the specified labels


pagestatechanged

Page state changed

Content by label

There is no content with the specified labels


newsstatechanged

Blog post state changed

Content by label

There is no content with the specified labels


stateexpired

State expired

States can be set to expire using the duedate parameter on the {state} macro, or via the {set-state-expiry} macro.

For simple state transitions, you can also use the expired parameter on the {state} macro.

Content by label

There is no content with the specified labels

See also: Expiry Dates


Tasks

In the {trigger} macro, you can specify the task parameter to filter to events for a specific task, otherwise the trigger will apply to events for all tasks.

Macros: {task}, {complete-task}

taskcreated

Task created

Content by label

There is no content with the specified labels


taskassigned

Task assigned

Content by label

There is no content with the specified labels


taskcompleted

Task completed

Content by label

There is no content with the specified labels


taskexpired

Task expired

Content by label

There is no content with the specified labels

See also: Expiry Dates


Workflow parameter

The parameter parameter must be set on the {trigger} for this event to work.

Macros: {workflowparameter}

pageparameterupdate

Workflow parameter updated

Only applies to page-level parameter changes (set edit=true on the {workflowparameter} macro)

Content by label

There is no content with the specified labels

4.15+

Custom events

The events listed above can be used to trigger custom events. For more information, see: Triggers.

See also

Workflow Authoring Guide:

Developer Guides: