Reporting

Owned by Robert Alexander Marshall
Last updated: Mar 12, 2024
3 min read
1 Document Report | 2 Document Activity | 3 Custom Contents | 4 Document state macro | 5 Document approvals macro | 6 Document activity macro

Document Report

A report for the approvals activities in the entire space can be accessed by choosing Document Report in the left-hand sidebar navigation.

The Document Report is for all documents with an applied workflow in the space. The report includes filters to show content in each of the three states or those with pending approvals.

The report can be filtered by state or the pending approvals for the current user using the filter option buttons.

Document Activity

The document activity report listing the the approval document activity for a page is accessed using the page tools menu.

The report is a chronological listing of the workflow document activity on the individual page.

The report can also be accessed from the Document Activity Report link in the approval workflow popup in the Approved state.

This is only available if a workflow is currently applied to the page or blog post.

Custom Contents

Document Activity can also be viewed in the Custom Content by

  • choosing the page tools menu  Attachments option for the document

  • choosing Custom Contents

  • choose the added Comala Document Approval tab

When a workflow is removed, if there was no active workflow on the content but document activity was retained

  • the page tools option for document activity will not be available but the Document Activity will still be available in the Custom Contents tab

If there is no active workflow on the content and document activity was removed, there will be no entry listed in Custom Contents.

If the page is copied the Document Activity is copied and listed in the Custom Contents tab when viewing Attachments.

A user with edit or admin permission can clear the approval history for the page by deleting the Document Activity in this tab.

A space admin can use the Clear option in the space settings Document Approval dashboard to remove document activity for pages and blog posts in the space.

Document state macro

Add the document state page macro to display one or both of

  • the approval workflow state

  • the date of change to the state

The document state macro is compatible with the Confluence page properties macro and page properties report macro.

Document approvals macro

Add the document approvals page macro to display the approval information for a workflow approval state.

The document approvals macro is compatible with the Confluence page properties macro and page properties report macro.

Document activity macro

Add the document activity page macro to 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

  • any comment added for the document activity

  • date

  • version

The document activity macro is compatible with the Confluence page properties macro and page properties report macro.