Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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).

Reviewers

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

...

The settings of the {approval} macro determine

  • if anyone can review
  • who can review

...

  • who must undertake the review (and is pre-assigned by the workflow on transition into the content review state)
  • if users are allowed to assign reviewers

...

  • and if the review is assignable you can limit who can be assigned

...

All assigned reviewers must reach the same decision (all be in agreement) before the review will be considered approved or rejected.

You can use Events to change this behavior, for example, to facilitate fast-tracked rejections.

Anyone can review

You can set the approval so that Anyone (with edit and view permission) can undertake the review.

Image Added

A single reviewer decision will action the approved or rejected transition.

Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review}
{state}

Assignable review

The approval can be set to allow one or more users to be assigned to the review.

Image Added

Once a user is assigned, only that user can undertake the review. But additional users can be assigned if the transition has not taken place.

Image Added

If more than one user has been assigned, all users must agree for a transition to occur.

Users who have not yet undertaken a decision can be unassigned.

Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review|assignable=true}
{state}

Minimum reviewers

You can set a minimum number of reviewers to agree on the approved decision for the transition to occur.

Image Added

A minimum can be required when the approval is set so

  • anyone can approve
  • the content review is assignable
  • reviewers are limited
Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review|minimum=3}
{state}

Limiting who can be assigned

You can also limit who can be assigned.

Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review|assignable=true|user=elle,suni|group=assigners}}
{state}

Limiting reviewers

You can simply the limit users who can review. Only these users will be able to undertake the review.

Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review|user=elle,suni|group=assigners}
{state}

All other users will simply see the Approved and Rejected options disabled (greyed out) in the workflow popup.

Requiring users to undertake a review

Reviewers can be mandated to undertake a review. On transition into the content review state, the user avatar will be appended to the workflow popup.

Image Added

All reviewers must agree for a transition to occur.

Code Block
languagetext
themeRDark
{state:Draft|approved=Approved|rejected=Rejected}
	{approval:Review|user=&milo,simone|group=&review_leaders}
{state}


(info) If the workflow reviewers are changed whilst in a state with assigned reviewers, the changes will only take effect for the content review on the next transition into that content review state.

Multi-group reviews

In cases where more than one team of reviewers is required, rather than adding the teams to a single approval, 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)and use a different approval for each team.

You can also use conditions to set the order in which the approvals in a state are undertaken.

Credentials

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

...