document-approvals-report macro

1 Overview | 2 Where to use it? | 3 Parameters | 4 See also

Overview

V7.3.0 Data CENTER

The document-approvals-report page macro creates a report that displays workflow approvals including approval workflow state, approval name, approval status, approvers, pending approvers, and last page update

Where to use it?

One or more document-approvals-report macros can be used in wiki pages, blog posts, and, in some cases, comments - see Reporting Guide > Report Macros > Document Approvals Report Macro.

It can also be used in any macro that supports wiki content in its Macro body (check relevant macro documentation for details).

If a workflow approval is completed and a transition to a new state occurs, the document approvals report does not display information for this approval.

Approvals shown in the report belong to the current state of a page.

For instance, if no approval transition has been added for the state, or if multiple approvals are required for the transition to happen.

Parameters

Parameter	Required	Default	Notes	Ver 7.3.0

Parameter	Required	Default	Notes
`approvalName`	Required when `approvalStatus` is set	blank	Which approval should be displayed in the report? leave empty to include all approvals The approval name is that defined in the approval macro. The approval name is shown in the workflow popup during content reviews. A value for the approval name must be entered if the Approval Status filter is set.
`approvalStatus`	No	ANY	Report on approval with the selected status. default is ANY reports all approvals irrespective of status Approval status is set as one of Pending Rejected Approved The macro does not list pages with approvals in the Rejected or Approved status if a transition from the workflow state containing the approval has occurred.
`approvalsAssignedto`	No	blank	Filter report to a named user assigned as an approval reviewer. default (blank) all users assigned as reviewers and users who have undertaken an approval decision single user @self for the current user displays the report listing approvals for the current user viewing the page with the included document approvals report macro
`columns`		Default - see notes.	The report columns in the rendered report on the page. Default report macro columns displayed are Page Name - includes a link to the page with the applied workflow with the approval State - workflow state containing the approval Last page update - an avatar for the user last updated the page, the date of the last page update Approval name - the name of the workflow state approval Approvers - avatars of users who have approved or rejected the named approval appended with an icon for their most recent approval decision Pending Approvers - avatars of users assigned to the approval as a reviewer and are yet to undertake an approval decision Status - the approval status and the page version of the latest approved version (if this currently exists) linking to the latest approved page version The following columns are always displayed as first three columns of the report Page Name State Last page update One or more of the remaining listed columns can be added or omitted for display in the rendered report.
`filter`	No	blank	You can provide a comma-separated list of CQL filters – the values must be indexed. Workflow CQL Fields (Comalatech) CQL Field Reference (Atlassian) Filters can be added using Confluence CQL format and can include OR and comparison operators. Other Atlassian CQL resources Advanced Searching Using CQL (Atlassian) CQL Function Reference (Atlassian) CQL Keywords Reference (Atlassian) CQL Operators Reference (Atlassian) Performing Text Searches with CQL (Atlassian)
`label`	No	blank	Filter the report by content label(s) default empty include approvals in all pages with an applied workflow specify one label name to filter to that label list multiple label names, separated by commas, to filter to content with any of those labels Prefix the label list with & (ampersand) to require that pages have all the labels. Otherwise, report includes pages containing any of the listed labels.
`maxItems`		20	The number of results to show per page.
`parent`	No	blank	Parent page of pages included in the report default empty if a space filter is specified space, then filter to parent page of specified space(s) single parent page filter to children of added parent page if left blank and a single space key is listed then the report defaults to the child pages of the specified space home page use @self for child pages of the current page
`space`	No	blank (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
`state`	No	blank (all)	Reports on the approvals in the added workflow state(s) in the applied workflows. default blank approvals on pages with an applied workflow in any state comma-separated list of state names
`workflow`	No	blank	The approvals in pages for a named workflow or workflows (in the scope of the macro parameters is listed). default blank page in any state of ALL workflows in the space comma-separated list of workflow titles If no workflow title value is added the approvals for all states for all workflows in the current space is reported including pages where the workflow has been removed, but workflow document activity history has been retained.