approval macro
Overview
Use the approval
macro to add content-focused reviews to workflow states.
Content has to be approved before it can progress to the next state, or it can be rejected to send it back for more edits. Once all reviewers agree on the review decision – either reviewers all have Approved or all have Rejected – the workflow will transition to the state defined by the approved
or rejected
parameter on the parent state macro.
Where to use it?
Optional.
One or more approval
macros can be put in a state macro.
Within a state, each approval
must be uniquely named.
An approval
cannot be used in a state if the state has a state selection macro.
Parameters
Parameter | Required | Default | Notes | Ver |
---|---|---|---|---|
unnamed first parameter |
| Name of the content review.
|
| |
|
|
| The description for the approvals:
| 5.7+ |
|
|
| Requires that the content has the specified label for the approval to be active.
If the content does not have the specified label:
If the addition of the specified label is a requirement (condition) for the the approval to be undertaken then use the |
|
|
| Optionally define additional requirements (conditions) which must be met prior to content approval . If one or more conditions are not met, the Approve/Reject buttons will be disabled. However, reviewer assignment will still be possible. |
| |
Reviewer/Assignee ParametersParameters to specify if, who and how reviewers are assigned to the content review. † Parameters ‡ Prefixing the list with If there are 15 or fewer possible assignees (as specified by the The default number (15) of possible assignees listed on the Assigning reviewers screen can be changed in Advanced Global Configuration. | ||||
|
|
| Can the user assign reviewers?
Note: Assignees must have permission to edit the content and also be member of confluence-users group as a minimum. Other parameters relating to reviewers may enforce further restrictions. | 3.2+ |
|
|
| To what extent do reviewers need to confirm their identity when reviewing?
The requirements stack, so a value of The method of authentication can be configured globally. The options above for the credential password can be set to be based on either:
Filter by labelThere are no items with the selected labels at this time. |
|
|
|
| List users who are not allowed to review.
Note: While excluded users are not able to be assigned or Approve/Reject, they can still assign other users as reviewers where applicable (eg. if the | 4.16+ |
|
|
| Reviewers must be a member of the specified user group(s):
Note: Users who do not have Edit content permission will not be allowed to review. |
|
When You can prefix the first list item with the | ||||
|
| Define the minimum number of reviewers required for the content review to be approved.
If more than the minimum number of users are assigned as reviewers then all assignees must undertake and agree the approval. |
| |
If using the | ||||
|
|
| Remember the assignees for reviews with this name?
| 4.14+ |
|
|
| Enable approval roles feature
| 6.4+ |
|
|
| A single reviewer must be assigned from the list:
Note: Users who do not have Edit content permission will not be allowed to review. |
|
|
|
| One or more reviewers must be assigned from the list:
Note: Users who do not have Edit content permission will not be allowed to review. |
|
|
|
| Reviewers must be in the specified list:
Note: Users who do not have Edit content permission will not be allowed to review. |
|
When You can prefix the list (not items in the list) with | ||||
|
|
| Assigners must be in the specified list:
Note
|
|
|
|
| Assigners must be a member of the specified user group(s):
Note
|
|
User Interface ParametersThese parameters are used to customise the user interface of the Workflow Popup. | ||||
|
|
| Set the caption of the Approve button. | 5.1+ |
|
|
| Set the caption of the Reject button. | 5.1+ |
|
|
| When using multiple
|
|
Deprecated ParametersThe following parameters should no longer be used. | ||||
|
|
| Published Use the |
|
Example
{workflow:name=Example}
{state:Editing|submit=Review|colour=#ffab00}
{state}
{state:Review|approved=Published|rejected=Editing}
{approval:Review this page|assignable=true|roles=true}
{state}
{state:Published|final=true|updated=Editing}
{state}
{workflow}
o
When roles=true
is added to the approval macro, users assigned to the content review can be assigned a role.
A reviewer role can be created when adding the assignee or chosen from a dropdown menu listing of previously added roles for other assignees.
Roles for assignees can be enabled for each individual approval by editing the approval in the workflow builder.
Events
Content reviews generate the following Events:
approvalunassigned
newsapproved
newsapprovalassigned
newsrejected
pageapproved
pageapprovalassigned
pagerejected
Related macros
The following macros are related to reviews:
state –
approved
andrejected
parameters