Reporting Tools
Overview
Users can view workflow events and actions for a page, using the page activity or document activity (data center v2.0+) reports; the Document Report for the space and; use CQL to search and report on workflow activity and information. Users can also see their Document Actions report in their user profile to view their pending assigned approvals.
The document activity report is only available after installing Comala Document Control v2.0+ for data center for pages created in new spaces and legacy spaces (prior to update to v2.0+)with data upgraded to use document activity. Page activity is available in Comala Document Control Server and for legacy spaces in Comala Document Control v2.0+ Data Center that have not been upgraded to use document activity.
Page Activity
To view the record of who has approved or rejected the current page select Page Activity from the Page Tools menu or the workflow popup. All approvals and rejections together with comments and expirations will be recorded in the page workflow activity history.
The report can be filtered using the tabs and exported as a CSV format file. It is also available from blog post content as well as for page content.
The pageactivity macro can also be added to content.
Document Activity DATA CENTER v2.0+
To view the record of who has approved or rejected the current page select Document Activity from the Page Tools menu or the workflow popup. All approvals and rejections together with comments and expirations will be recorded in the page workflow document activity report.
The document activity report is only accessible in data center instances with at least Comala Document Control 2.0+ for Data Center only installed. Existing spaces with workflow events and actions in the instance (prior to installation of v2.0+) will need to upgraded to use document activity. These existing spaces will access the page activity report until the space data is upgraded using the Document Activity Upgrade console.
My Document Actions Report
The current user can view their pending approval actions in the Comala Document Management Actions report.
The report is can be viewed by a user accessing their User Profile.
It is also displayed for the current user on the Confluence dashboard.
Document Control Report
Confluence Search Filters
The workflow status and assignees can be used as filters in the default Confluence search or macros that support CQL.
Confluence Search
In the Confluence general search screen, you can add filters to perform an advanced search. Comala Document Control adds filters for "Workflow state" or "Assigned approver".
Macros
Confluence provides some macros that support CQL filters, like the Content by label macro or the Page properties report macro.
REST API CQL fields
If you are searching with your own app using the Confluence REST API the following field names should be used:
Field | Field name |
|---|---|
Workflow state | cw_state |
Assigned approver | cw_approver |
!NB cw_state search is case sensitive
1 |
|
Related pages
Reporting tools
Report page macros