Read Confirmation

Owned by
Robert Alexander Marshall
Last updated: Dec 19, 2023
4 min read

Overview

Pages and blog posts can have a read confirmation function added. The read confirmation feature allows workflow authors to request that users confirm they have read certain content.

A standalone read confirmation can be added to a page or blog post. 

  • a read confirmation status icon is added to the page. This is a link to the read confirmation popup.
  • a read confirmation breadcrumb is added to the page footer. This is contextualized to the user and will include a link to confirm reading the content if the user is assigned as a reader.


If the approval workflow is added to the content, a workflow read confirmation can be enabled by the reviewer for the final state. 


The read confirmation is added to the final state on the workflow Approve decision transition. The read confirmation status icon is displayed on the page in the final state.


As a user, if you have been assigned to read a page, you will see a Confirm option link at the bottom of the page.


One or more users can be assigned to read a specific page or blog post and confirm when they have read the content. A due date can be set for the completion of the read confirmation.


The read confirmation for the content is PENDING until all assigned users (readers) have confirmed.

A read confirmation with an added due date that has expired will add the OVERDUE lozenge to the popup if all assigned readers have not confirmed.

The read confirmation on-page breadcrumb is contextualized for the current user, the overall progress of reader confirmation. It is color-coded in respect of any added due date (green/red tick).


When all readers confirm, the read confirmation status is changed to CONFIRMED.


If an individual reader read confirmation is undertaken after a due date has expired it is identified in the popup with a green tick. Mouse-over the tick and a message will confirm the read confirmation was undertaken after the duedate.


Read confirmations that have been confirmed by all assignees (readers) are recorded in the page activity report. The current read confirmation status (PENDING, CONFIRMED or OVERDUE) is recorded in the space document approval report.

A workflow read confirmation will override an existing standalone read confirmation. If the workflow is subsequently removed from the content, the previous standalone read confirmation will become active again.

Using the read confirmation popup:

If the read confirmation status is CONFIRMED, a new read confirmation must be added to edit readers, reset or change the due date.

If the read confirmation is added by the Basic Approval workflow on the transition to the final state, all confirmed reader read confirmations will be undertaken on the same version - the current final state version as changes to the content will transition the content to another state and reset the read confirmation.

If a standalone read confirmation is added then individual reader read confirmations may be completed on different content versions as edits to the content do not reset the read confirmation.