Overview
Use the {approval}
macro to add content-focussed 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 – either on Approve or Reject – 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. Can not be used if the {state}
has a {state-selection}
macro.
Parameters
Parameter | Required | Default | Notes | Ver |
---|---|---|---|---|
unnamed first parameter |
| Name of the content review.
Content by label
There is no content with the specified labels | ||
Conditions | Optionally define additional requirements which must be met prior to content approval – see: Conditions. If one or more conditions are not met, the Approve/Reject buttons will be disabled. However, reviewer assignment will still be possible.
Content by label
There is no content with the specified labels | |||
Reviewers / AssigneesSpecify if, who and how reviewers are assigned to the content review. † Parameters ‡ Prefixing the list with | ||||
assignable | false | Can the user assign reviewers?
Note: Assignees must have permission to edit the content and also be member of
Content by label
There is no content with the specified labels | 3.2+ | |
credentials | 0 | To what extent do reviewers need to confirm their identity when reviewing?
The requirements stack, so a value of
Content by label
There is no content with the specified labels | ||
exclude | 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
Content by label
There is no content with the specified labels | 4.16+ | ||
group † | 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.
Content by label
There is no content with the specified labels | |||
minimum | 0
| Define the minimum number of reviewers required for the content review to be approved.
Content by label
There is no content with the specified labels | ||
selectedapprover or selectedapprovers parameters, the minimum defaults to 1 . | ||||
| false | Remember the assignees for reviews with this name?
Content by label
There is no content with the specified labels | 4.14+ | |
selectedapprover † | A single reviewer must be assigned from the list:
Note: Users who do not have Edit content permission will not be allowed to review.
Content by label
There is no content with the specified labels | |||
|
| 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.
Content by label
There is no content with the specified labels | ||
DEPRECATED This parameter is likely to be deprecated in the near future. Use the | ||||
|
| Reviewers must be in the specified list:
Note: Users who do not have Edit content permission will not be allowed to review.
Content by label
There is no content with the specified labels | ||
User InterfaceThese parameters are used to customise the user interface of the Workflow Popup. | ||||
approvelabel | Approve | Set the caption of the Approve button.
Content by label
There is no content with the specified labels | 5.1+ | |
rejectlabel | Reject | Set the caption of the Reject button.
Content by label
There is no content with the specified labels | 5.1+ | |
|
| When using multiple
Content by label
There is no content with the specified labels | ||
Deprecated ParametersThe following parameters should no longer be used. | ||||
final | OBSOLETE Use the | |||
label | DEPRECATED Use the Require that the page or blog has the specified label before a review can be made. |
App configuration
Setting | Where | Notes |
---|---|---|
Approval – Assignee | While enabled, assignees will receive email notifications about events during the content review. | |
Approval Comment | While enabled, reviewers will be forced to comment when they Approve or Reject during content reviews. | |
Page Update Reset Approval | While enabled, if the content is edited whilst it is under active review then any approvals made during that active review will be reset. | |
Workflow Activity and Drafts Visibility | Who can see and interact with the Workflow Popup |
Example
{workflow:name=Example} {state:Editing|submit=Review} {state} {state:Review|approved=Published|rejected=Editing} {approval:Review Content|assignable=true} {state} {state:Published|final=true|updated=Editing} {state} {workflow}
Events
Content reviews generate the following Events:
approvalunassigned
newsapproved
newsapprovalassigned
newsrejected
pageapproved
pageapprovalassigned
pagerejected
Related macros
The following Macros are related to Reviews:
{approve-page}
{approve-children}
{reject-page}
{reject-children}
{state}
–approved
andrejected
parameters
All examples
There is no content with the specified labels