Searching and Reporting

Document report

See the Document report page for further details.

Document state macro

Add the document state page macro to display the current workflow state, the date of the change to the state, and the state expiry date (if a state expiry has been added).

cdx_documentsatemacro_onpage_utcformat.png

The document state macro is compatible with the Confluence page properties macro, and the page properties report macro.

The document state macro is added to a table in the page properties macro.

Example - using the document state macro with the page properties macro

See the Document state macro page for further details.

Document approvals macro

Add the document approvals page macro to display information for approvals in a selected workflow state.

The macro can be configured to display one or more of

  • the overall status of the approval

  • the approval assignees

  • the latest approval decision for each assignee

  • the date of the reviewer's decision

  • the reviewer comment

The document approvals page macro is compatible with the Confluence page properties and page properties report macros.

The document approvals macro is added to a table in the page properties macro.

Document activity macro

Add the document activity page macro to display information for the document activity for the page.

Configure the macro to display one or more of the following for each document activity entry

  • User - user related to the workflow event or action

  • Action - workflow event or action

  • State - workflow state

  • Comment - comment added for the document activity

  • Date - date and time of the workflow event or action

  • Version - Confluence version

The document activity page macro is compatible with the Confluence page properties macro, and the page properties report macro.

Confluence Search filters for macros

Confluence provides macros that support CQL filters. These include the content by label macro and the page properties report macro.

For example, Comala workflow state.

Other workflow filters are:

  • Comala workflow enabled

    • use boolean true to filter pages with an applied active workflow

  • Comala workflow final state

    • use boolean true to filter pages in the final state of the applied workflow

  • Comala state expiration

    • filter by state expiration by date options

REST API CQL fields

If you are searching with a separate reporting/scripting tool, for example, Reporting for Confluence from Appfire or ScriptRunner for Confluence from Adapatavist, using the Confluence REST API the following field names are used:

Field

Field name

Field

Field name

Workflow state

cw_state

Assigned approver

cw_approver

Workflow final state (boolean: true; false)

cw_final

Workflow enabled (boolean: true; false)

cw_enabled

cql=cw_approver="userID" and cw_state="Approved"