QC Read and Understood for Confluence Cloud is a confluence add-on available from the Atlassian marketplace .
One of the simplest and most effective ways of verifying training on procedures is to confirm that a user has read and understood an authorised document.
This plugin enables the users to confirm that they have read and understood a document.
It’s ideal for businesses that need a record of employee acceptance for compliance and auditing purposes.
Installation
The plugin can be installed from the Atlassian marketplace .
The plugin in only available for Confluence Cloud instances.
Usage
The users can use the byline control button QC – RnU. The user have the option to approve the page by ‘Read and Understood’ or to ‘Revoke’ the approval.
It is possible to review all the approvals of a page by either clicking from the page menu ‘QC – Read and Understood Overview‘ or by using the macro qc-read-and-understood-macro-table .
The plugin records the time and the version of the page that the user reviewed.
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:
- As a site administrator, click on Confluence Application Settings
- From the CONFIGURATION section, click on QC – R&U Administration
- Select from the list in which spaces you would like to enable the app.
At space level
At space level, you are able to:
- Switch on/off the add-on
- Disable the “Revoke” button
- Choose your Version Control Strategy, either to be
- based on the built-in Confluence page version control, or
- based on the page property macro
To find out more about, how to setup the Page Property macro, please check this page QC – R&U – Choosing your version strategy .
To find the add-on’s space level space settings :
- Click on Space Settings
- Navigate to Add-ons > QC Read and Understood
At page level
Choose to enable/disable QC Read and Understood in a specific Page, by following the steps:
- Click on the Page menu >QC – Read and Understood Overview
- Navigate to Settings tab
Macro commands
qc-read-and-understood-macro-table
The {qc-read-and-understood-macro-table} displays a table with all all the users who accepted a page .
The table contains the Approver’s name, Approval Status, Approval date and last approved version.
Attributes
- qc-content : Page Title . Autocomplete field for search on page titles.
Example
{qc-read-and-understood-macro-table:qc-content=Password+Policy} |
qc-read-and-understood-macro-table-by-user
The {qc-read-and-understood-macro-table-by-user} displays a table with all all the pages a user accepted .
The table contains the Page Title, the page latest version, the user’s last accepted version, and the approval status .
Attributes
- qc-user-account-id: The user’s unique account ID. Autocomplete field.
- qc-user-space-key: The space key
Example
{qc-read-and-understood-macro-table-by-user:qc-user-account-id=557058:3daf8f68-c94f-4c8f-8419-86592028a877} |
qc-read-and-understood-macro-table-by-label
The {qc-read-and-understood-macro-table-by-label} displays a table with all all the pages containing a label .
The table contains the Page Title, the page latest version, the user’s last accepted version, the user’s name, and the approval status .
Attributes
- qc-label: Page label e.g. done, feature
- qc-user-space-key: The space key
