...
As content producers interact with content, and the workflow itself, internal notifications called Events are generated within the Comala Document Management app.
...
This process, of an event triggering actionsan 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
...
...
notification to inform your editing team of reviewer decisions or
...
other document workflow activity
...
Events
Event | Notes | Ver |
|---|
AssigneeThe approval parameter must be set on the trigger for these events to work. Macros: approval |
pageapprovalassigned
| Page reviewer assigned | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pageapprovalassigned" and label = "example" and space = currentSpace ( ) |
|---|
|
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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newsapprovalassigned" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
approvalunassigned
| Reviewer unassigned | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-approvalunassigned" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
AttachmentsOnly for content that the workflow is applied to. |
attachmentadded
| Attachment created | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-attachmentadded" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
attachmentschanged
| Attachment created, updated or removed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-attachmentschanged" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
attachmentupdated
| Attachment updated (eg.new version uploaded) | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-attachmentupdated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
attachmentremoved
| Attachment removed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-attachmentremoved" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
attachmentversionremoved
| Attachment version removed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-attachmentversionremoved" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
Content changesOnly for content that the workflow is applied to. |
pagecreated
| Page created Only works in Space Mode. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pagecreated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
newscreated
| Blog post created Only works in Space Mode. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newscreated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pageupdated
| Page edited For simple state transitions, you can also use the updated parameter on the state macro. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pageupdated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
newsupdated
| Blog post edited For simple state transitions, you can also use the updated parameter on the state macro. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newsupdated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pagemoved
| Page moved | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pagemoved" and label = "example" and space = currentSpace ( ) |
|---|
|
| 3.1+ |
Content reviewsThe 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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pageapproved" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
newsapproved
| Blog post approved | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newsapproved" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pagerejected
| Page rejected | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pagerejected" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
newsrejected
| Blog post rejected | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newsrejected" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "event-comment-created" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pagecommentupdated
| Comment updated | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "event-comment-updated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pagecommentremoved
| Comment removed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "event-comment-removed" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
inlinecommentcreated
| Inline comment created | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "event-inline-comment-created" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
inlinecommentresolved
| Inline comment resolved | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "event-inline-comment-resolved" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pdf exportThese 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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pdfexportsuccess" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pdf-export-error
| pdf export failure | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pdfexporterror" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
LabelsOnly for content that the workflow is applied to. Macros: set-label, remove-label |
labeladded
| Label added | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-labeladded" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
labelremoved
| Label removed |
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
cql | label = "event-labelremoved" and label = "example" and space = currentSpace ( )
|
| Tip |
|---|
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. |
| |
StateThese 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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label in ( "event-statechanged" , "event-pagestatechanged" ) and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
pagestatechanged
| Page state changed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label in ( "event-pagestatechanged" , "event-statechanged" ) and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
newsstatechanged
| Blog post state changed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-newsstatechanged" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
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. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-stateexpired" and label = "example" and space = currentSpace ( ) |
|---|
|
See also: Expiry Dates |
|
stateexpiryupdated
| State due date updated | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-stateexpired" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
TasksIn 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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-taskcreated" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
taskassigned
| Task assigned | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-taskassigned" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
taskcompleted
| Task completed | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-taskcompleted" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
taskexpired
| Task expired | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-taskexpired" and label = "example" and space = currentSpace ( ) |
|---|
|
See also: Expiry Dates |
|
Read ConfirmationThese 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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-confirmationoverdue" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
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 | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-confirmationrequested" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
confirmationcompleted
| Read confirmation overall status reaches status = complete | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-confirmationcompleted" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
confirmationacknowledged
| User confirms reading the content | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-confirmationacknowledged" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
Workflow parameterThe 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) | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "event-pageparameterupdate" and label = "example" and space = currentSpace ( ) |
|---|
|
| 4.15+ |
Custom events
The events listed above can be used to trigger custom events.
| Insert excerpt |
|---|
| Triggers |
|---|
| Triggers |
|---|
| name | custom_events_trigger |
|---|
| nopanel | true |
|---|
|
For more information, see: Triggers.
...