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

## Overview

One or more **document approvals **macros can be added to a page to display information on the approvals for the workflow on a page. Each macro can be configured to display the approval information for a different state in the workflow.

![image](media://620fc4b0-e6d1-4714-af33-ee4dab63aab0)

The document approvals macro information for a workflow state is displayed on the page as a table with one header row per approval and one row per reviewer (if present for the approval).

![image](media://43d86b56-ea8a-43bf-9613-8e59598880d3)

The macro can be configured to display the current approval status and each reviewer status; the reviewer name; the reviewer avatar; the date of reviewer decision; and any reviewer comment.

> ℹ️ The default macro configuration only displays the approval name.

## Adding the macro to a page

Edit the page and type <span style="color: #4c9aff">/doc</span> and select the document approval macro option.

![image](media://9dd14477-13b3-4169-86a2-391ac5bf7d37)

Choose **Document Approvals** to add the macro to the draft page.

![image](media://499dbbd0-bc17-4a57-8304-4516322e3a7e)

> ℹ️ By default, the macro displays the current workflow state name and the approval in the state.

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

![image](media://54ddae2e-ab4d-4b7d-b575-fb5fe34778e0)

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

![image](media://b3c8d17c-bf7d-48e4-ad59-4e7e66da74c4)

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

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

![image](media://1f620658-349e-4dd7-985d-86d08395e5f7)

A separate row is added for each reviewer for the approval with a separate column for checkboxes completed for each of the approval/reviewer status, date of any action and reviewer comment.

![image](media://f5dde342-108d-4556-afe4-2980d549dd76)

> ℹ️ The following macro option is redundant when using the macro to display approval information for an applied Comala Document Control workflow
> ℹ️ 
> ℹ️ - **Approvals order** - the **Review** and **Rejected** states in the approval workflow only have one approval
> ℹ️ 
> ℹ️ Multiple approvals in a state can be added to a custom workflow in the [Comala Document Management for Cloud app](https://appfire.atlassian.net/wiki/spaces/CDMC).

## 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 workflow to a different state will display the approval information for the new current state.

![image](media://f3f1dd5e-86bd-4af0-aa8b-07ec54401669)

#### No approval in state

If there is no approval in the current state the document approvals macro will display the following message for the state.

![image](media://9dbcee56-8c1c-495c-b05f-5c1edb16b31e)

#### State specified

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

![image](media://05369ba6-d550-47be-923f-546e74048dc5)

## Configuring the macro

The macro can be configured to display approval information on the page.

#### Display approval information in a named state

Approval information can be displayed for a single named state added to the macro editor.

![image](media://c0628917-bee2-4ae9-8cf8-9356312a63f4)

The macro will display the current approval information for this state irrespective of the current workflow state for the content.

![image](media://f9b7fbca-5c53-406d-94f8-2e6984498241)

#### Display approvals reviewer and status information

Select the checkboxes to display approval information.

![image](media://24c1580c-f37e-4f34-95de-1ce4931740e3)

- the overall status for each approval in the state (***Pending****, ****Rejected****, ****Approved**** or ****Approved and Signed***)* *- **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 each reviewer’s last action (if any) - **Show date**
- any comment added by the reviewer on undertaking their last recorded action

![image](media://de24ab45-f987-4dec-a8b5-2cca6d99495b)

> 📝 If **Show status** is checked, both the status of the overall approval and (if reviewer avatar or reviewer name is checked) the current decision for each reviewer are displayed.

## Use with other macros

> ℹ️ The document approvals macro is compatible with the Confluence Page Properties macro and the Page Properties Report macro.

On the draft page, add one or more **document approvals** macro as table values in the **page properties** macro.

![image](media://c594f720-c69e-425b-a071-537b27b50a19)

The page properties report macro can then be added to a page to report on the added values.

![image](media://319bb204-9eb4-4c42-8a96-25017b4f358a)

## Exporting pages to pdf and Word

The approvals macro table of information is included when exporting to pdf or Word.

![image](media://a203cafd-425a-4348-aacd-69c3fe77a514)

> 📝 Reviewer avatars are not exported.

> ℹ️ In the pdf and the Word export the date (if included in the macro configuration) is in UTC format.