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@).
Predefined references
Value name | Event | Description |
|---|---|---|
| The label added | |
| The label removed | |
| The label added or removed | |
| pageapproved, pagerejected,approvalassigned, or | The name of approval check, either approved or rejected |
| the user that approved or rejected the page | |
| the comment provided in the approval or rejection | |
duedate | statechanged or any task event | the duedate of the state or task |
comment | statechanged | the comment provided when changing the state |
| any | the current user |
| any | a link to the current (published) page or blog post |
| any | a link to the latest version of a page or blog post (not the version that is currently published). |
| any | The error message generated while executing an action |
date | any | The date the event occurred (format defined in the Date Format setting in Confluence admin) |
datetime | any | The 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 |
|---|---|
| a comma-separated list of the users that have been selected to approve the document |
assignee | user who is being assigned in pageapprovalassigned or newsapprovalassigned or unassigned in approvalunassigned triggers |
| a comma-separated list of the users that approved the document |
| a comma-separated list of the users that rejected the document |
| the comment from the latest approver |
Task attributes references
Named task attributes can be accessed in all task triggers, otherwise specified otherwise.
| Attribute name | Description |
|---|---|
| name of the task |
| the user who the task is currently assigned to |
| the user who assigned the task |
| the user who completed the task, valid for |
| the user who created the task |
| the comment when assigning or completing the task depending on if it is the |
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 |
|---|---|
| The attachment's file name |
| The attachment size |
| 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}
