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
- In the page editor, choose Insert
→ Other Macros → Reporting → Workflow Report - Set the Type setting to approvals
- Choose Insert
Here's how the macro looks on your page:
Filters
Filters can be applied to the report by a user on the page.
| Filter | Description |
|---|---|
| View | View Pending, Approved or Rejected approvals |
| Approvals | Which approval (name) to filter by |
Report Columns
| Report Column | Description |
|---|---|
| Title | Page title |
| Last updated by | User who last modified the page |
| Updated | Timestamp of page modification |
| State | Workflow state page is currently in |
| Status | Displays one or more approval status icon(s) for approvals in the current state for each page and a hyperlink to the content version at the time when the approval became active. This is only shown when a named approval is selected in the filter options above the report header. Details for the status will also be displayed in the last (No name) column of the report. Status iconChoose the Pending filter along with the named Approvals filter
The active pending status icon will also include
If the approval is not active but pending (for example the approval limits reviewers to assignees and none have been assigned) the last approval decision will be displayed without the green tick. Choose the Approved or Rejected filter is along with the named Approvals filter
Version linkA link to the page version that existed when the approval became active. If no further edits have yet been made then the link will be to the (Current) version. If further edits have been made choosing the link displays a message warning the user that a more current version exists. |
| (No name) | Details of the Approval status showing any action required and recent activity related to the approval. Only shown when an approval is selected in options above header. |
(tick in circle)
(star) is displayed. This indicates awaiting approval or the last approval decision for this approval was approved
The report content can be customized by editing workflow report macro settings.
The on-page report filters will still be available for users unless the report macro is edited to Hide Headers.
Customizing the report
You can customize the report macro with the following macro settings.
These settings can be used to display a report that lists approvals
- for specific a space(s)
- on content with specific label(s)
- on content with a named parent
- by approval name
- that are pending, approved or rejected
- for a specific approver
| Setting | Default | Notes |
|---|---|---|
| Space Key(s) | Current space | Which space(s) should be included in the report?
|
| Approval |
The name is defined by the | |
| Max Entries | 20 | The number of results to show per page.† |
| Filter | pending | Which stage of the content review should the content be in?
|
| Label | Should the report be filtered by content label(s)?
If using a list of labels, you can prefix the list with | |
| Parent Page Filter | Should the report be filtered to a specific parent page and the child pages of the specific page?
| |
| Approver | Should the report be filtered to content that the specified user can currently review?
| |
| Sort | modified | Which column of the report should results be sorted by? |
| Sort Order | descending | Should the sort be in ascending or descending order? |
| † The macro has a 500-page limit for each report. If a larger report is required it may be useful to use the CQL REST API. | ||
You must specify the name of a content review for this report to work.