By using the QC Read & Understood for Confluence Cloud app, the user gets to choose the page version strategy.
There are three strategies to choose:
- based on the built-in Confluence page version control
- based on QC Revision Value, and
- based on the page property macro.
Based on Confluence page version control
This option does not require any more configuration. Users can just start to review pages and R&U their content.
The native Confluence page version number will be tracked by the app.
Based on QC Revision Value
The based on QC Revision Value versioning option combines the use of both the QC Read & Understood and the QC Documents apps. So, in order to use it, you have to have installed the QC Documents app first.
How to use based on QC Revision Value version strategy
When choosing this versioning option, make sure you have assigned QC Revision Value to your pages via the QC Page Revision Overview.
The steps to use it are simple:
- Install the QC Documents app
- Go to the QC Page Revision Overview
- Assign QC Revision Value
If you want to learn more about how to assign QC Revision Value to your document pages, click here and read the article.
Based on Page Property macro
The Page Property macro can be used so you can keep track of your page version.
Learn how to use the “Based on Page Property macro” version strategy by watching the following tutorial video or keep reading this article.
Adding the Page Property to your page
The Page Properties macro uses key/value pairs.
To add the Page Properties macro to a page:
- In the editor, choose Insert > Other Macros > Page Properties.
- In the macro body create a two-column table.
- In the left column, list your keys, these will be the column headings in your report table.
- In the right column, list the value for each key, these will populate the rows in your report table.
- Save your page.
Here’s how the macro looks on your page:
Setting up the parameters
Back to the Space Settings page
In this page we define:
- The page property ID, this is optional in case you have more than 1 page property macros within your pages.
- The page property header, this is mandatory in order for the page property macro to work.
- The version format.
The Version format field , will allow you to define two things:
- how many numbers your version would have [3 (Major.Minor.Revision), 2 (Major.Minor), 1 (Major)]. This could be useful, if you decide that the page version will have, in our case, 3 version numbers i.e. Major.Minor.Revision (such as 3.5.4) where:
- Major number, to be increased when there are changes to a document that require the document to be re-approved(either by an individual or a group)
- Minor number, to be increased whenever there are minor document amendments, and
- Revision number, to be increased whenever there are spelling or grammar corrections,
- for which numbers the users would require to re-confirm that they have read and understood the page.
The field gives the user the following options:
- The user will require to re-confirm changes in all numbers
- The user will require to re-confirm changes only when Major and Minor changes occur. Revision changes will not affect the user’s page R&U approval status.
- The user will require to re-confirm changes when Major or Minor changes occur.
- The user will require to re-confirm changes only when Major changes occur. Minor changes will not affect the user’s page R&U approval status.
- The user will require to re-confirm changes only when Major changes occur. Minor and Revision changes will not affect the user’s page R&U approval status.
- The user will require to re-confirm changes when Major changes occur.