This documentation relates to the 4.6 release of Comala Workflows

 Documentation for other versions of Comala Workflows is available too.

Predefined values, page properties, or metadata can be referred in Conditions, certain macro parameters and within Action Macros. Some of the predefined values are available only on specific events.

Value references must start and end with @ (i.e. @approvalcomment@).

On this Page

 

Predefined references

Value name

Event

Description

addedlabel

labeladded

The label added

removedlabel

labelremoved

The label removed

label

labeladded or labelremoved

The label added or removed

approvalname

pageapproved, pagerejected,
approvalassigned, or approvalunassigned

The name of approval check, either approved or rejected

approvaluser

pageapproved or pagerejected

the user that approved or rejected the page

approvalcomment

pageapproved or pagerejected

the comment provided in the approval or rejection

duedate
statechanged or any task eventthe duedate of the state or task
commentstatechangedthe comment provided when changing the state

user

any

the current user

page

any

a link to the current (published) page or blog post

pagelatest

any

a link to the latest version of a page or blog post (not the version that is currently published).

errormessage

any

The error message generated while executing an action

date
anyThe date the event occurred (format defined in the Date Format setting in Confluence admin)
datetime
anyThe date and time the event occurred (format defined in the Date Time Format setting in Confluence admin)

Approval attributes references

Named-approval attributes can be accessed in triggers. The reference must be in the form ApprovalName>AttributeName where the attributes name can be:

Attribute name

Description

approvalassignees

a comma-separated list of the users that have been selected to approve the document

assigneeuser who is being assigned in pageapprovalassigned or newsapprovalassigned or unassigned in approvalunassigned triggers

approvaluser or user
or approver or approvers

a comma-separated list of the users that approved the document

rejector or rejectors

a comma-separated list of the users that rejected the document

approvalcomment

the comment from the latest approver

Task attributes references

Named task attributes can be accessed in all task triggers, otherwise specified otherwise.

Attribute nameDescription

taskname

name of the task

taskassignee

the user who the task is currently assigned to

taskassigner

the user who assigned the task

taskcompleter

the user who completed the task, valid for taskcompleted triggers only

taskcreator

the user who created the task

taskcomment

the comment when assigning or completing the task depending on if it is the taskassigned or taskcompleted trigger

Workflow Supplier

You can also access Workflow Supplier data.

Supplier References

Version 3.0.2 of the plugin allows allows making references to Supplier Data and the can be used to retrieve values or for conditions. See examples below.

Access to Supplier Data requires the corresponding plugins to be installed. For example the Reporting Plugin.

Attachment attributes references

Attachment attributes can be accessed for actions of triggers attachmentschanged, attachmentadded, attachmentremoved, attachmentupdated:

Attribute name

Description

name or filename

The attachment's file name

size

The attachment size

comment

the comment on the attachment

Metadata references

The reference can include the space and/or page in the form <Space>:<Page Title>:<Value Name>.
Metadata values are retrieved as if there were referred to using the {metadata-from} macro. This includes the existing Internal Metadata.

Page Properties

Confluence Page Properties can also be used as value references.

Examples

In this example, only the user defined in the metadata Editor in Chief of the page Workflow in the WF space, can give the Editor in Chief approval or rejection.

 
{approval:Editor in Chief|user=@WF:Workflow:Editor in Chief@} 

Other examples:

 
{trigger...} 
{set-message:user}You cannot remove the label @labelremoved@{set-message} 
{trigger} 
 
{trigger...} 
{send-email:@user@|Subject=Your recent @approvalname@ approval} 
Thank you for approving @page@ which was created by @Author@ 
{send-email}
{trigger} 


Trigger will fire if the updated page has children (requires the Reporting Plugin to be installed) :

{trigger:pageupdated|state=Approved|@content:children > size@=!0}
     {set-message}Make sure child pages are reapproved{set-message}
{trigger}