CQL filters in Document States report macro

Overview

The CQL Filter parameter of the document states report macro now accepts Confluence CQL format functions, keywords, and can include OR and comparison operators (from v.6.16.7+).

Using CQL filters in the document states report macro can create focused bespoke reports your users and teams. For example

  • report dynamically on the pending approvals for the current day or a time period prior to the current day

  • report on workflow information filtered to the current user viewing the page with the report macro

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

Using CQL filters in the document states report macro

Simply add the CQL format filter (see - Confluence CQL keywords) to the CQL filter dialogue box in the document states report macro editor.

Prior to v6.16.7 CQL filter in report macros must be in the form FieldName:Value

For example, the following pages all have the label hr in a space.

But our added CQL filter will cause the report to display only the page(s) that have both the label hr and were created by the user matilde.

You can use functions in the CQL, for example, the following includes an OR function.

This will display content that has either

  • the label hr

OR

  • has been created by the user matilde

Filters are additive. If there are any logical clashes then no results will be returned.

Other compatible CQL filters include

  • contributor=username

  • creator=username

  • label=labelname

  • title=pagetitle

Currently, date based CQL filters are not compatible with the document states report macro.

CQL filter examples


Related links

Comala Document Management documentation

Atlassian documentation