Overview

Use the read-ack macro to add read confirmation functionality to your workflow.

Where to use it?

Within a workflow macro.

The read-ack macro can be used in two ways:

In a workflow macro with a final state to provide read confirmation functionality when the document is in the workflow final state
In a workflow macro with no states to provide read confirmation functionality without an approval workflow. Workflow parameters and filters can be used to determine which content should have a read confirmation

Parameters

Parameter	Required	Default	Notes
`user`			Comma-separated list of user names to be assigned to the read confirmation Supports value references
`group`			Comma-separated list of groups whose members are assigned to the read confirmation. Supports value references
`duedate`			The date by which the read confirmation should be completed. This shows as overdue in reports if it is beyond this date. The due date can be one of the following: Period from the time the state holding this read-ack macro is entered. Fixed date Value reference The macro supports the use of ISO 8061 for duration periods.
`approverOptionalReset`		`true`	When `approverOptionalReset=true` or is not specified, the user sees a "Require read confirmation" checkbox in the workflow dialog box before approving a page (or transitioning to a final state). In the workflow state dialog box, when Require read confirmation is Checked - a new read confirmation is sent to all the users (users and groups set in the read confirmation parameters and any manually added users) NOT checked - any previous read confirmation is retained and is not reset. Existing readers also retain their read confirmation status
`changeduedate`		true	When `changeduedate=false,` users cannot add, change, or remove the due date specified by the `duedate` parameter.

You can enable and edit a read confirmation using the workflow builder:

Make the read confirmation active for the workflow to automatically add a read confirmation on the transition to the workflow's final state.

The read confirmation can be edited to let the editor choose whether or not to add the read confirmation on the transition to the final state.

workflowstatedialogbox_rveiewerreadconfirmationoption_checked.png

Events

Read confirmations generate the following events:

confirmationrequested
confirmationcompleted
confirmationdue
confirmationacknowledged

By default, read confirmation assignee(s) receive notifications for all read confirmation events. However, read confirmation notifications can be disabled in global administration or in the space tools.

Examples

With no states

With an optional filter to limit workflow to content with a read-confirm label.

{workflow:name=Read Confirmation|label=read-confirm}
	{read-ack:user=admin}
{workflow}

With states

{workflow:name=Simple Approve & Read Confirmation workflow}
 	{state:Review|approved=Approved|taskable=true}
 		{approval:Approve|assignable=true}
 	{state}
 	{state:Approved|final=true|updated=Review|hideselection=true}
 	{state}
	{read-ack:user=admin}
{workflow}

read-ack macro