Overview
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 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; you could start a remote publishing process when content is approved; add or remove labels when a document changes workflow state or add an on-screen message notifications to inform your editing team of reviewer decisions or a document activity.
Events
Event | Notes | Ver |
---|---|---|
AssigneeThe | ||
| Page reviewer assigned Filter by labelThere are no items with the selected labels at this time. Note: the | |
| Blog post reviewer assigned | |
| Reviewer unassigned | |
AttachmentsOnly for content that the workflow is applied to. | ||
| Attachment created | |
| Attachment created, updated or removed | |
| Attachment updated (eg.new version uploaded) | |
| Attachment removed | |
| Attachment version removed | |
Content changesOnly for content that the workflow is applied to. | ||
| Page created Only works in Space Mode. Filter by labelThere are no items with the selected labels at this time. | |
| Blog post created Only works in Space Mode. | |
| Page edited For simple state transitions, you can also use the | |
| Blog post edited For simple state transitions, you can also use the | |
| Page moved Filter by labelThere are no items with the selected labels at this time. | 3.1+ |
Content reviewsThe 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 For simple state transitions, you can also use the Macros: approval, state, approve-page, reject-page, approve-children, reject-children | ||
| Page approved | |
| Blog post approved | |
| Page rejected | |
| Blog post rejected | |
CommentsThese 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. | ||
| Comment created | |
| Comment updated | |
| Comment removed | |
| Inline comment created | |
| Inline comment resolved | |
pdf exportThese are ONLY for export events that occur when using the pdf-export macro and K15t Scroll PDf Exporter app. | ||
| pdf export success | |
| pdf export failure | |
LabelsOnly for content that the workflow is applied to. | ||
| Label added | |
| Label removed | |
The | ||
StateThese events occur when a workflow transitions to a new state, or when a state expires. Note: You must specify the | ||
| Page state changed | |
| Page state changed | |
| Blog post state changed | |
| State expired States can be set to expire using the For simple state transitions, you can also use the See also: Expiry Dates | |
| State due date updated | |
TasksIn the | ||
| Task created Filter by labelThere are no items with the selected labels at this time. | |
| Task assigned Filter by labelThere are no items with the selected labels at this time. | |
| Task completed Filter by labelThere are no items with the selected labels at this time. | |
| Task expired Filter by labelThere are no items with the selected labels at this time. 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. | ||
| Read confirmation hits the set due date and becomes overdue | |
| 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 | |
| Read confirmation overall status reaches | |
| User confirms reading the content | |
Workflow parameterThe | ||
| Workflow parameter updated Only applies to page-level parameter changes (set Filter by labelThere are no items with the selected labels at this time. | 4.15+ |
Custom events
The events listed above can be used to trigger custom events.
Triggers can be configured to create their own events, which can then be processed by other triggers. This is achieved using the In the example above, the first two triggers both listen to the the first trigger is filtered to the First state the second trigger is filtered to the Second state Both of these triggers will create a The third trigger listens for that FirstAndSecond event and then displays a message containing the name of the current workflow state (using the pre-defined In essence, we are routing the Event-specific Event references are not available in custom event triggers. For example, the newevent
parameter, for example:{workflow:name=Custom Events}
{state:First}
{state}
{state:Second}
{state}
{trigger:statechanged|state=First|newevent=FirstAndSecond}
{trigger}
{trigger:statechanged|state=Second|newevent=FirstAndSecond}
{trigger}
{trigger:FirstAndSecond}
{set-message:duration=PT1M}
Current state is: @state@
{set-message}
{trigger}
{workflow}
statechanged
event.newevent
of the same name: FirstAndSecond.@state@
value reference). statechanged
events for two states, First and Second, into a single FirstAndSecond trigger, and then using that trigger to perform the action.@comment@
reference, which would be available in the first two triggers, would not be available in the third trigger.
For more information, see: Triggers.