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

Overview

User Profile Reports

In their User Profile, each user can view

  • their pending assigned approvals in the Document Actions report

     

  • their pending Read Assignments in the My Read Assignments report

Page Activity History

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 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 is displayed in data center instances with Comala Document Approval v2.0+ for spaces using document activity to record and track workflow events and actions.

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

Document Approval Report

To see a report for the entire space choose the Document Approval Report link in the left sidebar.

The report lists the current space content by page title and details of each page including

  • Updated by displays the user who most recently updated the page

  • the current workflow State

additional columns can be set for the report including

  • the Date of last page update

  • the time the transition occurred to move to the current state

  • the Read Confirmation status (if any)

The Settings dropdown menu will only be displayed for administrators who can customize the report columns 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.

The report can be filtered by the current state and the display can be sorted using each column title header option.

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 Approval 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

Field

Field name

Workflow state

cw_state

Assigned approver

cw_approver

!NB cw_state search is case sensitive

1

cql=cw_approver="John" and cw_state="Approved"