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 support@appfire.com
Reporting Tools
- Robert Alexander Marshall
- Alain Martínez
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.
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
To see a report for the entire space choose the Document Report link in the left sidebar.
The report lists the current space content by page title and details of each page:
the current workflow state
the user who most recently updated the page
the date of last page update
the current workflow state
the time the transition occurred to move to the current state
The report can be filtered by the current state.
Administrators can customize the report viewed by all users.
Choose the Settings menu.
scroll and check or uncheck the required columns to display.
drag and drop checked column items to set the display order.
The Settings menu is only displayed on the report for an admin user. An admin user can also access the space document report in space tools.
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