Overview
One or more document approvals macros can be added to a page to display information on the approvals for the workflow on a page. Each macro can be configured to display the approval information for a different state in the workflow.
The document approvals macro information for a workflow state is shown as a table, with one header row per approval and one row per assignee of each approval.
The macro can be configured to display
the state for the required approvals
the approval in the specified state (or in the case of a state with multiple approvals a list of approvals)
the overall
status of the approval
the list of assignees that belong to each approval
assignee (name and avatar)
status of the approve/reject action that this specific assignee has undertaken for that specific approval
date of when that action has taken place
comment added, if any, to that action
The document approvals macro is only displayed on the page if a workflow is applied.
Adding the macro to a page
Edit the page and type /doc and select the document approval macro option.
Choose Document Approvals to add the macro to the draft page.
Select the macro and choose the pencil icon to open the macro editor.
If the State dialog box is left empty the macro will display the approval information for the current workflow state. With no checkboxes completed the macro only lists the name of the approvals for the state.
Select the Show status checkbox in the macro editor to display the overall status of the approval.
a separate row is added for each approval in the state
a separate column is added for each checkbox ticked to display the required information for each approval
Transitioning the content
The information displayed by the macro is dynamic. If a state is not specified in the macro editor, transitioning the workflow to a different state will display the approval information for the new current state.
Setting a state in the document approvals macro editor displays the approval information for that state, irrespective of the current state. On a transition from the specified state, the macro table displays the individual approval status with a separate row displaying the overall status for the approval in the specified state.
If there is no approval in the specified state the document approvals macro will display the following message for the state..
Configuring the macro
The overall status is displayed for each approval in the state (Pending, Rejected, Approved or Approved and Signed).
If there is more than one approval in the state, add the name of the approval to be displayed in the Approvals order option. Multiple approvals in a case will be listed in the comma separated order (with no spaces) that they are added to this option box.
Check the required boxes to configure the macro to display one or more of
the users assigned to each approval as reviewers by checking one or both
Show assignee avatar
Show assignee name
the current status of each reviewer’s decision for the approval (Pending, Rejected, Approved, Approved and Signed, Unassigned) - Show Status
the date each reviewer’s last action (if any) - Show date
any comment added by the reviewer on undertaking their last recorded action
Selected macro options are previewed in the macro on the draft page.
Publish the page to view the document approvals macro displayed in the page subtitle on the content.
Example use of the document approvals macro
The document approvals macro is compatible with the Confluence Page Properties macro and the Page Properties Report macro.
On the draft page, add the document approvals macro as a table value in the page properties macro.
This is displayed on the published page in a table.
The page properties report macro can be added to a page to report the value of the example page property we created - Comala Management App - Approvals details.