---
title: "Document Actions Report macro"
canonical: "https://support.appfire.com/space/CDALS/943194359/Document%20Actions%20Report%20macro"
format: markdown
---
> Macro (aura-html)
> Macro (excerpt)
>
> Report page macro displays pending approvals information for a given user - from v2.2.0+
## Overview
[V2.2.0+]
The **Document Actions Report Macro** displays details about pending workflow approvals for a given user in one or more spaces on each page.
The default report displays **Document Actions** (pending approvals) in the current space for the user viewing the page.
The report includes
- the user name (in the report title: **<*****username*****> Document Actions**)
- each document action name (approval name*)
- page name link to the page (and the space name) with the document action assigned to the user
The report includes a **Task **option in the dropdown **Type** filter. However, workflow tasks are a feature that is only available in the Comala Document Management app.
> ℹ️ * The approval name is **Review this page** in both Comala Document Approval workflow states with a review (the **Review** state and the **Rejected** state).
## Permissions
Anyone can see the report, but the information displayed is filtered using your Confluence permissions for the pages and the workflow state.
> 📝 **View-only** users see only results for content that has reached the Approved state - the final workflow state for approved content. This occurs even if there are subsequent draft state edits to that page. A page that has not yet been published or a page with an applied workflow that does not define a published state is not shown.
Admins can make all results available to everyone by changing the [Workflow Activity and Drafts Visibility](https://appfire.atlassian.net/wiki/spaces/CDALS/pages/649822586)** **settings.
## Adding the report macro
To add the report to a page, choose the **Document Actions Report **macro on the draft page either by
- using the macro editor
- choose **> Other Macros > Reporting > Document Actions Report**
- choose **Insert** in the macro editor to add the default report to the draft page
- type **{Document Actions …**
- select **Document Actions Report**
Publish the page to view the default report.
> ℹ️ The report displayed is for the current user in the current space.
## Editing the macro
On the draft page
- in the macro browser, choose the **Document Actions Report** macro
- choose **Edit** macro
In the macro editor, scroll down in the left-hand panel to customize the report and configure the macro filters.
The default macro settings are
- **Assignee - **default value **@self**
- pending document approval actions assigned to the current user
- **Space(s)** - default value @space
- limits report to the current space
The pending approvals assigned to the current user in the current space are displayed in the default report.
## Customizing the report
#### Customize the number of items displayed
Set the number of entries displayed in the report on the page.
The default setting displays 20 items.
Any additional items over this value paginate the report.
For example,
- **Number of items to display** is set to 2
- space has 3 pages with pending document actions for the specified user
Displays a report with multiple pages.
The total number of report pages is appended to the bottom right of the report.
Mouse over the report to navigate to other report pages.
### Filter the report
In the macro editor, select one or more options to filter the report. These include options to filter the report. Filters include document action assignee, state(s), parent page, ancestor page, space key(s), label(s), workflow(s), or CQL filter (see [Report filters](https://appfire.atlassian.net/wiki/spaces/WLSD/pages/942473850) below).
For example, filter report to the **Assignee** - user **Elle Bracus**
## Report filters
One or more filters can be set for the report in the macro editor.
- scroll down in the left panel to add one or more filters
- use the **Preview** option to preview the report information
| | | | |
| --- | --- | --- | --- |
| Filters | Default | Notes | Version |
| **Assignee** | @self | User assigned to a document action
- approval
Filter displays pending approvals assigned to the user
> ℹ️ The default value displays the document actions report for the user viewing the page.
> 📝 If you have previously used a workflow from either [Comala Document Management](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649663089) or [Comala Document Control](https://appfire.atlassian.net/wiki/spaces/COMALACDCLS/pages/650253251) and retained the document activity., the report might display pending document actions (including pending workflow tasks added when using Comala Document Management) added using these apps. | **Document Actions Report Macro** is available from
- v7.5.0+ [DATA CENTER] |
| **CQL Filter** | *Blank* | A comma-separated list of CQL filters - the values must be indexed.
> 📝 The CQL format is `Fieldname1=Value 1, FieldName2=Value2`
For CQL field references
- [Workflow CQL Fields (Comala Document Management)](https://appfire.atlassian.net/wiki/spaces/AWPD/pages/617497107)
> 📝 The only workflow CQL searchable fields are those listed in the [Comala Document Management CQL Rest API](https://appfire.atlassian.net/wiki/spaces/AWPD/pages/617497100) page and [Atlassian Confluence CQL fields](https://developer.atlassian.com/server/confluence/cql-field-reference/). | |
| **Label(s)** | *Blank* | Should the report be filtered by content label(s)?
- leave empty to include all content
- specify one label name to filter to that label
- list multiple label names, separated by commas, to filter to content with any of those labels
If using a list of labels, you can prefix the list with `&`** **(ampersand) to require that a page has all the labels. O*therwise, it reports pages containing any of the listed labels.* | |
| **Number of items to display** | 20 | The maximum number of results to show per page
- max is 200
> 📝 One item is defined as a page. Each item is shown as a separate line in the rendered report. | |
| **Parent page** | *Blank* | Specify a page title to filter the report to its child pages
- the report includes the parent page if there is no parent page set
> ℹ️ The** parent **parameter accepts the @self value reference. | |
| **Ancestor page** | blank | The report is limited to the descendant pages of the specified page.
- use **@self** to report on the descendant pages of the current page
- specify a page title to include only its descendant pages
> 📝 If specifying an ancestor page, you cannot list multiple space keys. The report defaults to the descendant pages of the added page. | v2.4.0+ [DATA CENTER] |
| **Space(s)** | @self | The comma-separated list of space keys to filter.
- default is **@self** for the current space
- list multiple [space keys](https://confluence.atlassian.com/doc/space-keys-829076188.html), separated by commas, to report on multiple spaces
- use **@all** to search all spaces
Specifying more than one space or all spaces disables live filtering. | |
| **State(s)** | *Blank* | Comma-separated list of state names to filter
- filters report to the current workflow state of the page | |
| **Workflow(s)** | *Blank* | A comma-separated list of workflows to be displayed.
> ℹ️ Comala Document Approval only includes one workflow. This filter may be useful if you have previously used a workflow from either [Comala Document Management](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649663089) or [Comala Document Control](https://appfire.atlassian.net/wiki/spaces/COMALACDCLS/pages/650253251) and retained the document activity. The report displays any pending workflow tasks included in the retained document activity as well as pending Comala Document Approval approvals for assignees.
> 📝 You can only filter this column by space workflow names; there is no option to filter using a page workflow name. | |
## Reporting columns
All columns are displayed by default. There is no configuration option for the display of columns in the report.
The displayed columns are not named, but the report displays the
- ***assignee user name***
- displayed in the report title: **<*****username> *****Document Actions**
- ***pending document actions*** for the specified user
- **approval name** - approval icon and approval name
- ***page name*** for each included document action
- link to page
- name of space containing the page
## Exporting the page
The document actions report macro is rendered when a page that includes the macro is exported to PDF, Word, or HTML.
> 📝 The document tasks report is also supported when exporting a page using another app, for example:
> 📝
> 📝 - [Snapshot Publishing](https://appfire.atlassian.net/wiki/spaces/AHP/pages/650215885) feature in [Appfire Comala Publishing](https://marketplace.atlassian.com/apps/143/comala-publishing?hosting=datacenter&tab=overview)
When rendering the exported table for the macro the document actions report macro filter settings are used to display the report.
| Title - Rendered Report Column | Export render |
| --- | --- |
| **Action** | Displays text string for the pending document action type and name of the workflow action for the user specified in the document actions report macro
- (APPROVAL) <*approvalname*>
> ℹ️ The approval icons are not displayed. |
| **Assigned by** | The user who assigned the user to the approval |
| **Assignment date** | Date the pending document action was assigned to the user |
| **Due date** | The due date for completion of the pending document action (if added) |
| **Appears on** | Page or blog post on which the pending document approval action was added
- page name with a link to the page
- space name |
| > 📝 The report title is not rendered on the exported page. The report title includes the assignee username. |
An example of the document actions report on a page exported to HTML is displayed below:
> 📝 By default, exporting to PDF or Word exports the last approved version of a page with an applied workflow with a final state.
## Related pages
- [Document Actions Report - Profile](https://appfire.atlassian.net/wiki/spaces/CDALS/pages/649789865)
- [Document Approvals Report Macro](https://appfire.atlassian.net/wiki/spaces/CDALS/pages/742326668)