---
title: "Document approvals macro"
canonical: "https://support.appfire.com/space/CDACL/689602838/Document%20approvals%20macro"
format: markdown
---
> Macro (aura-html)

 

## Overview

You can add one or more **document approvals **macros to a page to display approval information for the applied approval workflow. You can configure the macro to display the approval information for an approval workflow state.

![image](media://61fdea61-6731-4ec0-ac0b-36bac4a659a9)

The document approvals macro information for a workflow state is shown as a table with one header row per approval and one row per reviewer of the approval.

By default, the current approval workflow state and the approval name.

![image](media://f4dcb9c0-9bb1-4499-8dd0-d9008919b4a1)

You can edit the macro in the macro editor to display additional approval information.

![image](media://90011dae-afcd-41b4-b02d-6a681fc59d2b)

The display options include

- the current approval status
- the reviewer’s name and the user avatar
- reviewer status
- the date of the last approval decision and reviewer decision

## Adding the macro to a page

- edit a Confluence page
- type <span style="color: #4c9aff">/doc</span>
- select the document approval macro option

![image](media://07f9df8f-f6c8-43e9-827f-3ebb25c49b85)

By default, the macro displays the current approval workflow state name and the name of any approvals.

![image](media://f4dcb9c0-9bb1-4499-8dd0-d9008919b4a1)

Select the macro and choose the pencil icon to open the macro editor.

![image](media://a1e2d1f2-2526-4851-9b7e-dd6fcdc8f5cf)

If the **State** dialog box is left empty, the macro displays the approval information for the current state of the approval workflow.

![image](media://610100db-16b6-424a-bc05-7323c0b3e12b)

With no checkboxes completed, the macro only lists the name of the approval in the state.

Select the **Show status** checkbox in the macro editor to display the overall status of the approval.

![image](media://30e83f6c-91bf-4147-986c-ef5f7c644a20)

A separate row is added for each reviewer assigned to the approval.

![image](media://90011dae-afcd-41b4-b02d-6a681fc59d2b)

You can configure the displayed columns by checking options in the macro editor.

> ℹ️ Several macro options are redundant when using the macro to display approval information for Comala Document Approval:
> ℹ️ 
> ℹ️ - **Approvals order**
> ℹ️ - **Show comment**
> ℹ️ 
> ℹ️ Adding multiple approvals to a workflow state is only available in the [Comala Document Management Cloud](https://marketplace.atlassian.com/apps/142/comala-document-management?hosting=cloud&tab=overview) app. Adding reviewer comments is available in [Comala Document Management Cloud](https://marketplace.atlassian.com/apps/142/comala-document-management?hosting=cloud&tab=overview) and [Comala Document Contro](https://marketplace.atlassian.com/apps/1215729/comala-document-control?hosting=cloud&tab=overview)l.

## Configuring the macro

You can use the macro editor to configure the display approval information on the page.

![image](media://cc3c745a-132e-4db1-8593-d9f3bc78b3fe)

If the State dialog box is left empty, approval information is displayed for the current state. Add the approval state name to the **State** option in the macro editor to display information for another state.

Check the macro editor checkboxes to display

- the overall status for each approval in the state (***Pending****, ****Rejected****, ****Approved***)* *- **Show status**
- the reviewers for each approval by checking one or both
  - **Show reviewer avatar**
  - **Show reviewer name**
- the current status of each reviewer’s decision for the approval (*Pending, Rejected, Approved, Approved and Signed, Unassigned*) - **Show status**
- the date of each reviewer’s last action (if any) - **Show date**

> 📝 **Show comment** does not display comments. Adding a reviewer comment is a feature only available in [Comala Document Control](https://appfire.atlassian.net/wiki/pages/createpage.action?spaceKey=CDCCL&title=Welcome%20to%20Comala%20Document%20Control%20for%20Confluence%20Cloud) and [Comala Document Management](https://appfire.atlassian.net/wiki/pages/createpage.action?spaceKey=CDMC&title=Welcome%20to%20Comala%20Document%20Management%20Cloud).

## Transitioning the content

The information displayed by the macro is dynamic.

#### No state specified

If a state is not specified in the macro editor, transitioning the approval workflow to a different state will display the approval information for the new approval state.

![image](media://324a3803-16df-4392-93d1-6157e70bd18f)

#### No approval in the state

The document approvals macro will display the following message when in the **Approved** state if no state is specified in the approvals macro.

![image](media://2bbc3e51-4d04-4dd5-b99c-41bf2812b35c)

#### State specified

Setting a state in the document approvals macro editor displays the approval information for that state, irrespective of the current approval state.

![image](media://43934c10-e928-470c-8a63-a00cd53b447b)

## Exporting content to PDF or Word

The approvals macro information table is included in a page export to PDF or Word.

![image](media://77d357f0-8dc3-47b9-8c57-bce448eb774c)

> ℹ️ Reviewer avatars are not included in a page export.

> 📝 The date (if included in the macro configuration) is in UTC format in the PDF and Word export.

## Use with other macros

> ℹ️ The document approvals macro is compatible with the Confluence **page properties,** and **page properties report **macros. You can add a **document approvals** macro as a table value in the **page properties** macro and report the value for the page using the **page properties report** macro.