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


> ℹ️ Looking for the **Comala Document Management** report macro? See [workflow-report macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649891099) and the [Reporting Guide](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649070833).

## Overview

The `workflow-reporter` macro is used to generate a collection of **Pages** and **News** (blog posts) objects to use with the [Appfire Reporting for Confluence app](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649759324)** version 6.0 or above**.

> ✅ Using the Reporting add-on is an alternative to using the [workflowreport macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649891099). It allows you to create more advanced and customizable reports using the Reporting app reporting framework.

## Where to use it?

Optional.

This is an optimised alternative to the [content-reporter](https://appfire.atlassian.net/wiki/spaces/REPS/pages/472914774) which provides access to workflow-related information.

The workflow-related information can be accessed through the [report-info](https://appfire.atlassian.net/wiki/spaces/REPS/pages/472915000) macro by using the [Workflow Supplier](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726882).

> ℹ️ For further documentation, refer to the [Appfire (formerly ServiceRocket) Reporting app documentation](https://appfire.atlassian.net/wiki/spaces/REPS)

## Parameters

| Parameter | Required | Default | Notes |
| --- | --- | --- | --- |
| `space` |  | `@self` | Which spaces should be included in the report?<br>- `@self` – current space
- `@all` – all spaces
- or specify a comma-separated list of [space keys](https://confluence.atlassian.com/doc/space-keys-829076188.html) for a collection of spaces |
| `label` |  |  | Should the report be filtered by content label(s)?<br>- leave empty to include all pages and blog posts
- 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. |
| `filter` |  |  | 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) |
| `state` |  |  | 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 |
| `max` |  | `100` | Maximum number of entries in the report |
| `sort` |  | `+modified` | The sort order:<br>- + for ascending, `A→Z`
- - for descending, `Z→A`<br>And the sort field:<br>- `modified` – the most recent date on which the content was modified
- `created` – the date on which content was created
- `pagestate` – the current workflow state of the content
- `statechanged` – the date on which the state most recently changed
- `statechangedby` – user who most recently changed the state |

## Example

The Reporting app report below will generate a report similar to the `states` report of the [workflowreport macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649891099).

```plaintext
{report-table}
 {workflow-reporter:spaces=@self|state=Published}
 {workflow-reporter}

 {report-column:title=Page}{report-info:content:title|link=true}{report-column}
 {report-column:title=Last Updated By}{report-info:content:modifier>name|link=true}{report-column}
 {report-column:title=Updated}{report-info:content:modification date}{report-column}
 {report-column:title=State}{report-info:workflow:state>name}{report-column}
 {report-column:title=State changed on}{report-info:workflow:state>date}{report-column}
 {report-column:title=State changed by}{report-info:workflow:state>user>name|link=true}{report-column}
{report-table}
```

## All examples

> Macro (contentbylabel)

## See also

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

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

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

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

- [Supplier References](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649532510)

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

- [CQL Fields](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650250829)