Reviews

Overview

Content reviews are a crucial part of most workflows.

Often called "Approvals", they are characterised by a decision to Approve or Reject the content and, based on that decision, the workflow will generally transition to another state.

Defining reviews

One or more reviews can be added to a state using the {approval} macro:

{workflow:name=Reviews}
   {state:In Progress|submit=Review}
   {state}
   {state:Review|approved=Approved|rejected=In Progress}
      {approval:Technical Review|assignable=true}
   {state}
   {state:Approved}
   {state}
{workflow}

The approved and rejected parameters on the {state} macro determine which states to transition to if the review is Approved or Rejected/

Reviewers

The people who make decision to Approve or Reject are called Reviewers.

The settings of the {approval} macro determine who can review, or, if users are allowed to assign reviewers, who can be assigned.

All the reviewers must reach agreement before the review will be considered Approved or Rejected. You can use Events to change this benaviour, for example to facilitate Fast-tracked Rejections.

Multi-group reviews

In cases where more than one team of reviewers is required, just add more {approval} macros to the state.

Permissions

By default, a user must have Edit or Admin permissions in order to take part in a content review.

However, if the App configuration is set to allow anyone to view Workflow Activity and Drafts then users with View permission, so long as they are logged in to Confluence, will be able to take part in reviews (since version 4.6).

Credentials

Reviewers can optionally be required to verify their credentials before making a review.

See: Reviewer Authentication, Credentials prompt

Notifications

By default, assignees and page watchers will receive notifications about the review progress, and all interactios will be tracked in the Activity Report - Content.

Macros

Content by label

There is no content with the specified labels

Events

All asoects of the review process generate Events, which can be used to Trigger Actions.

Reviewer assignment events:

pageapprovalassigned
newsapprovalassigned
approvalunassigned

Approval events:

pageapproved
newsapproved
pagerejected
newsrejected

App configuration

Setting	Where	Notes
Workflow Activity and Drafts Visibility	Configuration - Global Configuration - Space Tools	Who can see the workflow and draft content? If set to Everyone, then View-only users can also participate in the review.
Page Update Reset Approval	Configuration - Global Configuration - Space Tools	During an active review, if the content is updated should existing approvals be reset?
Approval Comment	Configuration - Global	Should comments be mandatory when participating in a content review?
Approval – Assignee	Notifications - Global Notifications - Space Tools	Should assigned reviewers receive email notifications about the content review?
`.approval.minquery`	System Properties	Set how many characters must be typed when searching for reviewers

Examples