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

Events

event triggers and actions

Overview

Events

As content producers interact with content, and the workflow itself, internal notifications called Events are generated within the Comala Document Management app.

The workflow can use one or more Triggers to listen for an event.

And, upon detecting one, perform one or more Actions.

This process, of an event triggering an action, 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

  • start a remote publishing process when content is approved

  • add or remove labels when a document changes the workflow state

  • add an on-screen message notification to inform your editing team of reviewer decisions or other document workflow activity

Events

Event

Notes

Ver

Event

Notes

Ver

Assignee

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

Macros: approval

pageapprovalassigned

Page reviewer assigned

Filter by label

There are no items with the selected labels at this time.

Note: the pageassigned event was deprecated in v4.0.0. For any triggers using this event in legacy workflows please replace with {trigger:pageapprovalassigned|approval=approvalname}



newsapprovalassigned

Blog post reviewer assigned



approvalunassigned

Reviewer unassigned



Attachments

Only for content that the workflow is applied to.

attachmentadded

Attachment created



attachmentschanged

Attachment created, updated or removed



attachmentupdated

Attachment updated (eg.new version uploaded)



attachmentremoved

Attachment removed



attachmentversionremoved

Attachment version removed



Content changes

Only for content that the workflow is applied to.

pagecreated

Page created

Only works in Space Mode.



newscreated

Blog post created

Only works in Space Mode.



pageupdated

Page edited

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



newsupdated

Blog post edited

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



pagemoved

Page moved

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



newsapproved

Blog post approved



pagerejected

Page rejected



newsrejected

Blog post rejected



Comments

These events occur when a Confluence comment is created, updated, removed or resolved, either at the bottom of any page or blog post, or as an inline comment by highlighting specific text on the page.

pagecommentcreated

Comment created



pagecommentupdated

Comment updated



pagecommentremoved

Comment removed



inlinecommentcreated

Inline comment created



inlinecommentresolved

Inline comment resolved



pdf export

These are ONLY for export events that occur when using the pdf-export macro and K15t Scroll PDf Exporter app.

Macros: pdf-export



pdf-export-success

pdf export success



pdf-export-error

pdf export failure



Labels

Only for content that the workflow is applied to.

Macros: set-label, remove-label

labeladded

Label added



labelremoved

Label removed



The labeladded and labelremoved events allow the workflow author, the versatility to execute actions when a label has been added or removed like sending an e-mail or adding the same label again.

 

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



pagestatechanged

Page state changed



newsstatechanged

Blog post state changed



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.

See also: Expiry Dates



stateexpiryupdated

State due date updated



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



taskassigned

Task assigned



taskcompleted

Task completed



taskexpired

Task expired

See also: Expiry Dates



Read Confirmation

These events occur when a read confirmation is added to a workflow final state, a read confirmation is confirmed or read confirmation set due date expires.

confirmationdue

Read confirmation hits the set due date and becomes overdue



confirmationrequested

Read confirmation is added to a final state in a workflow

User is assigned as a reader to a read confirmation

New read confirmation request is sent



confirmationcompleted

Read confirmation overall status reaches status = complete



confirmationacknowledged

User confirms reading the content



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)

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