Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Users can view workflow events and actions for a page, using for a page using

  • the page activity report or document activity

(data center v2.0+) reports; the Document Report for the space and; use 
  • report

  • the document report for the space

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

Table of Contents
maxLevel2
minLevel2
excludeOverview

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 pageactivity macro can also be added to content.

The page activity report is available in

  • Comala Document Control Server

  • legacy spaces in Comala Document Control v2.0+ Data Center that are yet not upgraded to use document activity

Document Activity
Status
colourGreen
titleDATA CENTER
Status
colourGreen
titlev2.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

...

installed

...

and legacy spaces (from before the of installation of v2.0+)

...

after the space is upgraded to use document

...

activity

...

My Document Actions Report

...

It is also displayed for the current user on the Confluence dashboard.

Space Document Tasks Report

The space tools Document Tasks Report lists all tasks in the current space and allows you to filter by assignee and task status.

Insert excerpt
Document Tasks Report - Space tools
Document Tasks Report - Space tools
namedocument_tasks_report_space
nopaneltrue

Document Control Report

Insert excerpt
Document Control Report
Document Control Report
nopaneltrue

...

The workflow status and assignees can be used as filters in the default Confluence search or macros that support CQL.

Macros

Confluence provides some macros that support CQL filters, like the Content by label macro or the Page properties report macro.

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

...

a workflow state and workflow properties.

For example

  • searching for pages and content currently in the applied workflow state named Draft

Code Block
http://<confluence_url>/rest/api/content/search?cql=state=Draft
  • searching for workflow metadata properties

Code Block
/rest/api/content/<pageid>?expand=metadata.properties.comalaworkflows

Search syntax is case sensitive.

Excerpt
hiddentrue
nameRest API_cdc_await

REST API

The following search returns the details of the workflow states

Code Block
rest/cw/1/content/<pageid>/status?expand=state,states,approvals,actions,tasks
Code Block
{"expand":"","workflowName":"Simple Approval Workflow","state":{"name":"Approved","nameTranslation":"Approved","initial":false,"colour":"#14892c","hideStates":false,"taskable":false,"changeDueDate":true,"transitions":{"updated":{"state":"Review"},"expired":{"state":"Review"},"select":[]},"final":true},"publishedState":{"name":"Approved","initial":false,"colour":"#14892c","hideStates":false,"taskable":false,"changeDueDate":false,"final":true},"approvals":[],"states":[{"name":"Review","nameTranslation":"Review","transitions":{"approved":{"state":"Approved"},"rejected":{"state":"Rejected"},"select":[]},"colour":"#ffab00","approvals":[{"name":"Review this page","approvers":{"minimum":"*"}}]},{"name":"Rejected","nameTranslation":"Rejected","transitions":{"approved":{"state":"Approved"},"updated":{"state":"Review"},"select":[]},"hideFromPath":true,"colour":"#ff5630","approvals":[{"name":"Review this page","approvers":{"minimum":"*"}}]},{"name":"Approved","nameTranslation":"Approved","transitions":{"updated":{"state":"Review"},"expired":{"state":"Review"},"select":[]},"changeDueDate":true,"colour":"#14892c","final":true}],"actions":[],"tasks":[],"messages":[],"displayProgressTracker":true,"displaySuppressReadConfirmation":false,"contributors":{"totalSize":-1,"result":[]}}

Several APIs used for reporting are available in the Comala Document Management for Data Center app. For information refer to the Comala Document Management Developer Guides.

Related pages

Reporting tools

...

Child pages (Children Display)
depth1
allChildrentrue
style
pageCOMALACDCLS:Report Macros
sortAndReverse
first0