Comala Workflows is now Comala Document Management. Click here for the latest documentation.

Overview

The approvals report is used to display lists of content review information. It's great for keeping track of the content reviews taking place across multiple spaces.

Permissions

By default, this report is only available to users who can Add content (pages or blog posts) to the space.

Admins can make it available to everyone by changing the Workflow Activity and Drafts Visibility setting.

Adding the report

To add the report to a page:

  1. In the editor, choose Insert → Other Macros → Reporting → Workflow Report
  2. Set the Type setting to approvals
  3. Choose Insert

Here's how the macro looks on your page:

Customising the report

You can customise the report with the following macro settings:

SettingDefaultNotes
Space Key(s)Current space

Which space(s) should be included in the report?

  • Leave empty to report on the current space
  • Specify one space key to report on a specific space
  • List multiple space keys, separated by commas, to report on multiple spaces
  • Specify any to report on all spaces.
Approval

(warning) You must specify the name of a content review for this report to work.

The name is defined by the {approval} macro, and is shown in the Workflow Popup during Content reviews.

Max Entries20The number of results to show per page.
Filterpending

Which stage of the content review should the content be in?

  • pending – the review is not yet complete
  • approved – the review was approved
  • rejected – the review was rejected
Label

Should the report be filtered by content label(s)?

  • Leave empty to include all content
  • Specify one label name to filter to a specific label
  • List multiple label names, separated by commas, to filter to content with any of those labels

If using a list of labels, you can prefix the list with & (ampersand) to require that content has all the labels.

Parent Page Filter

Should the report be filtered to child pages of a specific page?

  • Leave empty to include all content
  • Specify a page title to only include children of that page
Approver

Should the report be filtered to content that the specified user can currently review?

  • Leave empty to include all content
  • Specify a username to filter to results which that user can review
  • Specify @self to filter to results that the current user can review
Sortmodified

Which column of the report should results be sorted by?

Sort OrderdescendingShould the sort be in ascending or descending order?

See also

User Guide:

Workflow Authoring Guide: