/
Document States Report Macro


Document States Report Macro

Owned by Robert Alexander Marshall
Last updated: Jan 16, 2025 by Alain Martínez
10 min read
1 Overview | 2 Permissions | 3 Adding the report | 4 Editing the macro | 5 Customizing the report | 6 Report filters | 7 Reporting columns | 8 Exporting the page | 9 All examples | 10 Related pages

Overview

The Document States Report Macro displays pages and blog posts with an applied workflow and associated workflow state information. The displayed report includes live filter options to display pages by workflow and the workflow state.

cdcdc_documentstatesreport_onpage.png
Document States Report

The report macro is configured in the macro editor to

Once added to a page, the report macro dynamically updates the displayed information. This is great for tracking content workflow states across multiple spaces.

From v7.3.0, use the Document Approvals Report Macro to display approvals in the state and information about them, including reviewers and decisions. The document approvals report macro also provides approval information and filters for the approval name, approval status, and approval assignees.

Permissions

Anyone can see the report, but the information displayed is filtered by the user permissions for the pages and the workflow state.

View-only users see results only for content that has reached a Published ( final=true ) state, 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 are not shown.

Admins can make all results available to everyone by changing the Workflow Activity and Drafts Visibility setting.

Adding the report

To add the report to a page choose the Document States Report macro either

  • use the macro editor on the draf