---
title: "read-ack macro"
canonical: "https://support.appfire.com/space/CDML/650347654/read-ack%20macro"
format: markdown
---
> Macro (aura-html)


# <span style="color: #003366">Overview</span>

> Macro (excerpt)
> 
> Request user read confirmation of content

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:

1. In a [workflow macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649662219) with a final state to provide read confirmation functionality when the document is in the workflow final state
2. In a [workflow macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649662219) 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.<br>This shows as overdue in reports if it is beyond this date.<br>The due date can be one of the following:<br>- Period from the time the state holding this read-ack macro is entered.
- Fixed date
- Value reference<br>> ℹ️ 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).<br>In the workflow state dialog box, when **Require read confirmation** is<br>- **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:

![workflowbuilder_editreadconfirmation.png](media://547a16f7-7830-40bc-b601-d34e6d771b19)

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

![workflowbuilder-enablereadconfirmation.png](media://c8bfbeba-ce11-4c8a-8d96-7f247e8ce748)

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](media://484687aa-262a-4d56-bcfe-694042ef27e3)

## Events

Read confirmations generate the following [events](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759655):

- `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](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649530054) or in the [space tools](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650119000).

## Examples

### With no states> Macro (anchor)



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

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

### With states

```plaintext
{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}
```

## Related pages

- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649791545](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649791545)
- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649827501](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649827501)
- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/650218328](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650218328)
- [https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956579](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956579)