1. Home
  2. QC Read & Understood for Confluence Cloud
  3. Documentation for QC Read&Understood for Confluence Cloud

Documentation for QC Read&Understood for Confluence Cloud


Configuration


At site level

At site level, you are able to enable/disable the app across all your Spaces.

Disable the app in all spaces or in some, by following the steps:

  1. As a site administrator, click on Apps->Manage apps
  2. From the CONFIGURATION section, click on QC – R&U Site Admin
  3. Select from the list in which spaces you would like to enable the app. 
configuration at site level

At space level

At space level, you are able to:

  1. Switch on/off the app
  2. Disable the “Revoke” button
  3. Choose your Version Control Strategy, either to be

To find out more about, how to setup the Page Property macro, please check this page Choosing your version strategy .

To find the app’s space level space settings :

  1. Click on Space Settings 
  2. Navigate to Add-ons > QC R&U 
configuration at space level
configuration at space level

Looking at the Space Settings


At page level

Choose to enable/disable QC Read and Understood in a specific Page, by following the steps:

  1. Click on the Page menu >QC – R&U Page Overview
  2. Navigate to Settings tab
configuration at page level


Macros



QC R&U my overview table

The QC R&U my overview table macro displays a table with all the pages the current user has reviewed within each space.

The table contains the page title, the version of the page, the review status and the date of the review.

qc r&u my overview macro displayed

Attributes

ParameterDefaultDescription
qc-spacesAutocomplete field. Select one or more spaces. All spaces will be selected, if it is left empty.The spaces within the Confluence site

Wiki markup example

{read-understood-macro-my-overview}



QC R&U by page

The QC R&U by page macro displays a table with all the users who reviewed a page.

The table contains the reviewer’s name, review status, last reviewed version and reviewed date.

qc r&u by page macro displayed

Attributes

ParameterDefaultDescription
qc-contextAutocomplete field. The current page will be returned if it is left empty. The current page context
qc-table-formatSimple, AdvancedThe table’s format
qc-user-groups[Optional] Filter the table against users belonging to user group(s) e.g. confluence-users,confluence-administrators. If left empty, this filter will be ignored and all the assigned users will be returned.The user groups within the site

Wiki markup example

{qc-read-and-understood-macro-table}



QC R&U by user

The QC R&U by user macro displays a table with all the pages a user reviewed.

The table contains the page title, the review status, the last reviewed version and the reviewed date.

qc r&u by user macro displayed

Attributes

ParameterDefaultDescription
qc-user-account-idAutocomplete fieldThe user’s unique account ID
qc-user-space-keyAutocomplete fieldThe space key
qc-labelsE.g. done,feature. If it is left empty, this field is ignored.The page’s labels
qc-table-formatSimple, AdvancedThe table’s format

Wiki markup example

{qc-read-and-understood-macro-table-per-user}



QC R&U by label

The QC R&U by label macro displays a table with all the pages containing a specific label .

The table contains the page title, the review status, the reviewer’s name (reviewed by), last reviewed version and the date of the review.

qc r&u by label macro displayed

Attributes

ParametersDefaultDescription
qc-labelE.g. done,featureThe page’s label
qc-user-space-keyAutocomplete fieldThe space key
qc-table-formatSimple, AdvancedThe table’s format

Wiki markup example

{qc-read-and-understood-macro-table-per-label}



QC R&U by user group(s)

The QC R&U by user group(s) macro displays a table with all the pages reviewed by one or more specific user groups.

The table contains the page title, review status, the reviewers’ names (users), the latest reviewed version and the reviewed date.

qc r&u by user groups macro displayed

Attributes

ParametersDefaultDescription
qc-user-groupsE.g. confluence-users, confluence-administratorsThe groups every user belongs to
qc-user-space-keyAutocomplete fieldThe space key
qc-labelsE.g done, featureThe page’s labels
qc-table-formatSimple, AdvancedThe table’s format

Wiki markup example

{qc-read-and-understood-macro-table-per-user-group}



Signature Box for QC Read & Understood

The Signature Box for QC Read & Understood macro displays the QC R&U Signature Box so that the user can use this macro instead of the byline to review a certain page.

signature box for qc r&u macro

Wiki markup example

{qc-read-and-understood-signature-box}



Report Pages



Site Overview

To find the QC R&U Site Overview report page simply click on Apps and then QC R&U Site Overview. Here you can see the “by user list” report which shows how many pages from the site each user approved, and the “by page list” report which show how many of the users approved each page.


The page should look like this:

qc site overview displayed by page list
qc site overview displayed by users list

The tables in both cases contain 4 columns: the name (of the user or the page), the status (of the review), the progress and the details.


The user has the ability to export the reports as CSV and PDF files.


This page cannot be visible to users that do not have site access, even when the space is publically visible.



Space Overview

To find the QC R&U Space Overview report page follow the steps below:

  1. Click on Space Settings
  2. Click on Add-ons
  3. Select the QC R&U Space Overview tab
  4. Done!

The page you are looking should look like this:

qc space overview

There are two available reports, the “by user list” report and the “by page list” report. The “by user list” report shows how many pages, from a specific space, each user has reviewed. The “by page list” shows how many of the users reviewed each page, from this space.


The tables in both cases contain 4 columns: the name (of the user or the page), the status (of the review), the progress and the details.


The user has the ability to export the reports as CSV and PDF files.


This page cannot be visible to users that do not have site access, even when the space is publically visible.



Page Overview

The Page Overview report shows the users who reviewed each specific page. To find the report: when on a page click the three dots on the upper right corner and then select the QC R&U Page Overview.


The Page Overview should look like this:

qc r&u page overview

The displayed table contains the name of the reviewer, the status of the review, last reviewed version, reviewed date and an action button (remove).


The user has the ability to export the report as CSV and PDF files.


This page cannot be visible to users that do not have site access, even when the space is publically visible.



My Overview

The QC R&U My Overview report shows the pages that the user reviewed as well some stats, i.e. how many pages the user has accepted, how many older versions of pages he/she has accepted, the not accepted pages and the revoked ones. The steps to find the report are the following:

  1. Click on profile icon on the upper right corner
  2. Click on the “QC R&U My Overview”
  3. Done!

The page should look like this:

qc my overview

The displayed table contains the page title, the last reviewed version, the status and the reviewed date.


The user has the ability to export the report as CSV file.


This page cannot be visible to users that do not have site access, even when the space is publically visible.

Updated on September 22, 2020

Was this article helpful?

Related Articles