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


> Macro (excerpt-include)

 

## Overview

> Macro (excerpt)
> 
> Generate custom reports for states, reviews and tasks

The `workflowreport` macro is used to create custom reports on workflow states, reviews and tasks.

> ℹ️ Looking for the reporter for use with the **Appfire Reporting for Confluence **app (formerly ServiceRocket) app? See [workflow-reporter macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650316754).

## Where to use it?

Optional.

One or more `workflowreport` macros can be used in

- wiki pages
- blog posts
- and, in some cases, comments

The macro can also be used in any macro which supports **wiki content** in its *macro body*. Check the following macro documentation for details:

> Macro (contentbylabel)

> 📝 The `workflowreport` macro will be deprecated in[2024]. This reporting macro is replaced with several new reporting macros with additional functionality.

Currently released new reporting macros are listed below:

> Macro (contentbylabel)

## Parameters

<sup>†</sup> Only use with `approvals` report

<sup>‡</sup> Only use with `states` report

| **Parameter** | **Required** | **Default** | **Notes** | **Ver** |
| --- | --- | --- | --- | --- |
| `type` | :check_mark: |  | What type of report should be displayed?<br>- `approvals` – [Workflow Report Macro - Approvals](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650120822)
  - The `approval` parameter must also be specified for this report to work
- `dashboard` – [Workflow Report Macro - Dashboard](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649891836)
- `states` – [Workflow Report Macro - States](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650349253)
- `stats` – [Workflow Report Macro - Stats](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649532393)
- `tasks` – [Workflow Report Macro - Tasks](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649760530) |  |
| `approval`<sup>†</sup> | :info:<sup>†</sup> |  | :info:** **The name of a content review is required for the `type=approvals` report to work.<br>The name is defined by the [approval macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649662337), and is shown in the [workflow popup](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649659846) during [content reviews](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650313809). |  |
| `approver`<sup>†</sup> |  |  | Should the report be filtered to content that the specified user can currently review?<br>- Leave empty to include all content
- Specify a username to filter to results which that user can review
- Specify `@self` to filter to results that the current user can review |  |
| `filter`<sup>†‡</sup> |  | `pending`<sup>†</sup> | <sup>† </sup>For `type=approvals`, which stage of the content review should the content be in?<br>- **pending** – the review is not yet complete
- **approved** – the review was approved
- **rejected** – the review was rejected<br><sup>‡ </sup>For `type=states`, you can provide a comma-separated list of CQL filters in the form `FieldName:Value` – the values must be indexed.<br>- [Workflow CQL Fields](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650250829)
- [Advanced Searching Using CQL](https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/) (Atlassian)
- [CQL Field Reference](https://developer.atlassian.com/server/confluence/cql-field-reference/) (Atlassian)
- [CQL Function Reference](https://developer.atlassian.com/server/confluence/cql-function-reference/) (Atlassian)
- [CQL Keywords Reference](https://developer.atlassian.com/server/confluence/cql-keywords-reference/) (Atlassian)
- [CQL Operators Reference](https://developer.atlassian.com/server/confluence/cql-operators-reference/) (Atlassian)
- [Performing Text Searches with CQL](https://developer.atlassian.com/server/confluence/performing-text-searches-using-cql/) (Atlassian) |  |
| `hideheader` |  | `false` | Should the report header be hidden?<br>- Only applies to `type=dashboard` report
- `true` – hide the header
- `false` – don't hide the header |  |
| `label` |  |  | Should the report be filtered by content label(s)?<br>- Leave empty to include all content
- Specify one label name to filter to a specific label
- List multiple label names, separated by commas, to filter to content with any of those labels<br>If using a list of labels, you can prefix the list with `&` (ampersand) to require that content has all the labels. |  |
| `maxentries` |  | 20 | The number of results to show per page. |  |
| `order` |  | `descending` | What order should results be sorted in?<br>- `ascending` – `A→Z`
- `descending` – `Z→A` |  |
| `parent` |  |  | Should the report be filtered to a specific parent page and the child pages of the specific page?<br>- Leave empty to include all content in the space
- Specify a page title to include the specified page and its child pages
- Specify `@self`** **to specify the current page |  |
| `sort` |  | `modified` | Which report column of the report should results be sorted by?<br>- `modified` – the most recent date on which the content (page or blog post) was modified
- `created` – when the review, state or task was created
- `duedate` – the task or state expiry date
- `pagestate` – the current workflow state
- `statechanged` – the most recent date on which the state was changed
- `statechangedby` – the user that most recently changed the state |  |
| `spacekeys` |  | current space | Which space(s) should be included in the report?<br>- Leave empty to report on the current space
- Specify one [space key](https://confluence.atlassian.com/doc/space-keys-829076188.html) to report on a specific space
- List multiple [space keys](https://confluence.atlassian.com/doc/space-keys-829076188.html), separated by commas, to report on multiple spaces
- Specify `any` to report on all spaces – but you must also specify `approval` or `state` parameter, depending on the report `type` |  |
| `state`<sup>‡</sup> |  |  | Should the report be filtered to specific state(s)?<br>- Leave empty to report on all states
- Specify one state name to report on that state
- List multiple state names, separated by commas, to report on specific states |  |
| `user`<sup>‡</sup> |  |  | Should the report be filtered to content that the specified user can currently review?<br>- Leave empty to include all content
- Specify a username to filter to results which the specified user can review
- Specify `@self` to filter to results that the current user can review |  |
| > ℹ️ <span style="color: #172b4d">The macro has a 500-page limit for each report. If a larger report is required it may be useful to use the </span>[CQL REST API](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649921636)<span style="color: #172b4d">.</span> |

## App configuration

| **Setting** | **Where** | **Notes** |
| --- | --- | --- |
| **Workflow Activity and Drafts Visibility** | - [Configuration - Space Tools](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649956239)
- [Configuration - Global](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649889951) | Who can access the report?<br>For report specific details, see:<br>- [Workflow Report Macro - Approvals](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650120822)
- [Workflow Report Macro - Dashboard](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649891836)
- [Workflow Report Macro - States](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650349253)
- [Workflow Report Macro - Stats](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649532393)
- [Workflow Report Macro - Tasks](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649760530) |

## See also

[Workflow Authoring Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/648611901)

- [Reviews](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650153766)
- [States](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649595551)
- [Tasks](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649694408)

[Reporting Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649070833)

- [Report on states](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650216427)
- [Report on tasks](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649661358)

[Integration Guides](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649396230)

- [Workflow Supplier](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726882)
- [ServiceRocket Reporting for Confluence app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759324)
- [ServiceRocket Scaffolding Forms and Templates app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650315581)

[Developer Guides](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649330694)

- [CQL REST API](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649921636)