...
...
| Excerpt | ||||
|---|---|---|---|---|
| ||||
 |
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
The macro can be configured to display
...
the approval in the specified state (or in the case of a state with multiple approvals a list of approvals)(s) in a state
the overall status of the approval
the list of reviewers assignees for each approval including
details of the
reviewers (name and avatar)
status of the approve/reject action that each reviewer has undertaken for that specific approval
date of when that action has taken place
comment added, if any, to that action
...
assignee decision
Several separate document approval macros can be added to content to display information for different approvals in different states. If the named approval does not exist (mis-spelt, renamed or removed) the macro will ignore that approval.
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.
...
The State dialog box is empty by default and the macro will display the approval information for the current workflow state
...
state
With no checkboxes completed the macro only lists the name of the approvals for the state.
...
A separate column is added for each selected checkbox in the macro editor to display information for each approval.
...
...
| Info |
|---|
When the approval |
...
is configured to require a minimum number of reviewers |
...
, a separate unassigned reviewer row is displayed |
...
for each required reviewer. These are populated as |
...
a user(s) is assigned or |
...
undertakes a review |
...
decision. |
Transitioning the content
...
Display approvals in a named state
Approvals Approval information can be displayed for a single named state added to the macro editor.
...
The macro will display the current approval information for this state irrespective of the current workflow state for the content.
...
Display approvals reviewer and status information
...
Check the boxes macro editor checkboxes to display one or more of the following
the overall status for each approval in the state (Pending, Rejected, Approved or Approved and Signed)- Show status
the reviewers for each approval by checking one or both
Show reviewer avatar
Show reviewer 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
...
...
If Show status is checked, both the status of the overall approval and (if reviewer avatar or reviewer name is checked) the current decision for each reviewer is displayed.
Display approvals reviewer and status information for the current workflow state
Leave the State dialog box empty to display approval information for the current workflow state.
...
The approvals for the current workflow state will be displayed.
...
If a workflow transition occurs the approvals macro will display approval information for the new workflow state.
Multiple approvals in a state
...
If there is more than one approval in a state each approval is listed in a separate row.
...
...
Approval information is displayed for multiple approvals in a state by alphabetical order of approval names.
Each reviewer(s) for an approval is displayed in a separate row.
To limit or set an order for the display for of selected approvals in a state, add the name of each approval as a comma-separated list (with no spaces) in the Approvals order option dialog box.
...
Approvals are displayed in the order that they are appear added in the comma-separated list.
...
Use with other macros
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Tip | ||||||
The document approvals macro is compatible with the Confluence Page Properties macro and the Page Properties Report macro. |
On the draft page, add one or more document approvals macro as a table values value in the page properties macro.
...
The approvals macro table of information is included when exporting to pdf or Word.
...
Reviewer avatars are not exported.
...
In the pdf and Word export the date (if included in the macro configuration) is in UTC format.
Reviewer avatars are not included in the pdf or Word export.