This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email

document-states-report macro


The document-states-report macro is used to create custom reports on workflow states, reviews and tasks.

Where to use it?


One or more document-states-report macros can be used in wiki pages, blog posts, and, in some cases, comments - see Reporting Guide > Reporting Macros > Document States Report Macro.

It can also be used in any macro which supports wiki content in its Macro body (check relevant macro documentation for details).









The name of a content review.

  • leave empty to include all content

The name is defined by the approval macro and is shown in the workflow popup during content reviews.



Should the report be filtered to content that the specified user(s) has been assigned to review? Value is one or more usernames separated by a comma..

  • leave empty to include all content
  • specify a username to filter to results which that user is assigned to review
  • secify @self to filter to results that the current user is assigned to review


Only applies if an approval name filter is specified, which stage of the content review should the content be in?

  • pending – the review is not yet complete
  • approved – the review was approved
  • rejected – the review was rejected


title+, state, changed, updated by, updated

The report columns displayed in the UI on the content can be set to be one or more of the following:

From Comala Document Management 6.13.0 the following columns are available

  • Title (column parameter in macro - title)+
  • State (column parameter in macro - state)
  • Approval (column parameter in macro - approvals)
  • Approval Status (column parameter in macro - approval status)
  • Changed By (column parameter in macro - changed by)
  • Updated By (column parameter in macro - updated by)
  • Updated (column parameter in macro - updated)

(blue star) +title item is always displayed in the report.


From Comala Document Management 6.16.0 the following additional columns are also available

  • Approved Version (column parameter in macro - last final version)
  • Approved ver. approved by (column parameter in macro - last final version approvers)
  • Approved ver. date (column parameter in macro - last final version date)
  • Created (column parameter in macro - created)
  • Due date (column parameter in macro - due date)
  • Read Confirmation (column parameter in macro - readack status)
  • Space (column parameter in macro - space)
  • Workflow (column parameter in macro - workflow)

Columns are displayed in the order the items are added in the macro editor.

The following column headings are sortable in the UI of the report (from v6.16.6+)

  • Title
  • Created
  • Due date
  • Read Confirmation
  • State
  • Updated
  • Created by
  • Workflow

allFilter report for specific named content.



You can provide a comma-separated list of CQL filters – the values must be indexed.

(info) The only workflow CQL searchable fields are those listed in Comala Document Management CQL Rest API page together with the Atlassian Confluence CQL fields

Other Atlassian CQL resources

(info) from v.6.16.7+  filters can be added using Confluence CQL format and can include OR and comparison operators

(warning) prior to v6.16.7 CQL filter must be in the form FieldName:Value



Should the report be filtered by content label(s)?

  • 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

If using a list of labels, you can prefix the list with & (ampersand) to require that content has all the labels.



The number of results to show per page.



What order should results be sorted in?

  • ascendingA→Z
  • descendingZ→A


Should the report be filtered to a specific parent page and the child pages of the specific page?

  • 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



Which report column of the report should results be sorted by?

  • modified – the most recent date on which the content (page or blog post) was modified
  • state – the current workflow state
  • changed – the most recent date on which the state was changed
  • title - the content title
  • approval status - pending, approved, rejected
  • approvals - approval name


current space

Which space(s) should be included in the report?

  • leave empty to report on the current space
  • Specify one space key to report on a specific space
  • list multiple space keys, separated by commas, to report on multiple spaces
  • specify any to report on all spaces



Should the report be filtered to specific state(s)?

  • 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


Should the report be filtered to states in a specific workflow(s)?

  • leave empty to report on all states in all workflow
  • specify one workflow name to report on states in that workflow
  • list multiple workflow names, separated by commas, to report on specific states in those workflows

(info)  You can only specify space workflow names. There is no option to specify a page workflow name.

All examples

See also

Workflow Authoring Guide

Reporting Guide

Developer Guides