Searching and Reporting

Document Activity

The Document Activity is a report of the workflow-related events and actions for a page or blog post.You can view the Document Activity for a page or blog post by choosing Document Activity in the

page tools menu

workflow popup ellipsis menu

Document Activity is also displayed using the Activity Report button in the workflow popup if the page or blog post is in the workflow final state.

The page tools Document Activity option is only available when there is an active workflow on the page or blog post.

See the Document activity report page for further details.

Document report

The Document Report lists all the pages and blog posts in a space with an active workflow.

The report can be filtered by workflow state and pending approvals (for the user viewing the report).

If there is no active workflow in the space the report is empty.

To view the Document Report

choose the Document Report option in the Confluence sidebar menu

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).

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.

The macro on the published page is rendered in a table.
The page properties report macro can be added to a page to report the value of the example page property we created - Comala Management App - State details.

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

https://fast.wistia.com/embed/medias/ul0xvkxqyw.jsonp

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.

The page properties report macro can then be added to a page to report on the added values.

See the Document approvals macro page for further details.

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.

See the Document activity macro page for further details.

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.

Comala Document Management adds a filter for "Workflow state".

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
Workflow state	`cw_state`
Assigned approver	`cw_approver`

Note that cw_state search is case-sensitive

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