Searching and Reporting
- Robert Alexander Marshall
Document Activity Report for the page
To view the record of the workflow events and actions on the current page, for example, who has approved or rejected the current document
From the page tools menu (ellipsis menu) on the page with an applied workflow
select Document Activity
All approvals and rejections together with comments and expirations are recorded in the document activity.
If a user has been disabled or deleted the document activity will display the users username and the default avatar. The username name is the stored user display name for the instance.
The current document activity can also be viewed by
choosing the page tools menu Attachments option
choose Custom Contents
choose the added Document Report tab
No attachment is displayed when
the document activity was removed (Clear Document Activity)
no workflow had been previously applied
If there is no active workflow on the content but document activity was retained
the page tools document activity option is not available but any previous document activity can still be viewed in this Document Report tab (after opening the page tools menu Attachments>Custom Contents option)
A user with edit or admin permission can clear the workflow history for a page by deleting the document activity attachment.
A space admin can choose to remove workflow document activity for all content in the space using the Clear workflow history option in the space settings Document Control dashboard.
Document Report for the space
To see a report for the entire space choose the Document Report link on the left sidebar.
The report can be filtered using the filter button options by
current workflow state
My pending approvals for the current user viewing the report
My Pending Approvals
You can see the approvals that are assigned to you in the current space in the document activity report.
If there are multiple approvals in a state the reviewer avatars are replaced by the named approval avatar.
choose the approval icon to view the assigned reviewers for an approval.
When there are multiple approvers assigned choose a reviewer to view details of all the reviewers for the approval.
The approver list is read-only. You can sort and filter the display.
You can also use a search filter on the Confluence search to find pages that are assigned to a specific person (see below).
Document state macro
Add the document state page macro to display the current workflow state, the date of change to the state, and the state expiry date (if an expiry is added).
The document state macro is compatible with the Confluence
page properties macro
page properties report macro
Document approvals macro
Add the document approvals macro page macro to display information for approvals in a selected workflow stat. The macro can be configured to display the overall status of the approval; the approval assignees; the latest approval decision for each assignee; the date of the reviewer decision and the reviewer comment.
The document approvals macro is compatible with the Confluence
page properties macro
page properties report macro
Document activity macro
Add the document activity page macro to display dynamic information for the document activity for the workflow on a page.
The macro can be configured to display one or more of the following for each document activity entry
user
workflow action
workflow state
comments added in the workflow popup for approvals
date
version
The document activity macro is compatible with the Confluence
page properties macro
page properties report macro
Confluence Search Filters for workflow macros
Confluence provides macros that support CQL filters, like the Content by label macro or the Page properties report macro. Comala Document Management adds a filter for "Workflow state".
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 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 |
Workflow final state | cw_final |
Workflow enabled | cw_enabled |
cql=cw_approver="John" and cw_state="Approved"