Overview
The {document-states-report}
macro is used to create custom reports on workflow states, reviews and tasks.
Where to use it?
Optional.
One or more {document-states-report}
macros can be used in wiki pages, blog posts, and, in some cases, comments - see Reporting Guide > Reporting Macros > Document States Report Macro
It can also be used in any macro which supports wiki content in its Macro body (check relevant macro documentation for details).
Parameters
Parameter | Required | Default | Notes | Ver | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| all | The name of a content review.
The name is defined by the | ||||||||||||||||||||||||||||||||||||||
| all | Should the report be filtered to content that the specified user(s) has been assigned to review? Value is one or more usernames separated by a comma..
| ||||||||||||||||||||||||||||||||||||||
approvalStatus | all | Only applies if an approval name filter is specified, which stage of the content review should the content be in?
| ||||||||||||||||||||||||||||||||||||||
columns |
| The report columns displayed in the UI on the content can be set to be one or more of:
Columns are displayed in the order the items are added in the macro editor. The following column headings are sortable in the UI of the report (from v6.16.6+)
| v6.13+ v6.16+ | |||||||||||||||||||||||||||||||||||||
content-title | all | Filter report for specific named content. | ||||||||||||||||||||||||||||||||||||||
| all | You can provide a comma-separated list of CQL filters – the values must be indexed.
Other Atlassian CQL resources
| ||||||||||||||||||||||||||||||||||||||
| v6.16.7+ | |||||||||||||||||||||||||||||||||||||||
| Should the report be filtered by content label(s)?
If using a list of labels, you can prefix the list with | |||||||||||||||||||||||||||||||||||||||
| 20 | The number of results to show per page. | ||||||||||||||||||||||||||||||||||||||
| Should the report be filtered to a specific parent page and the child pages of the specific page?
| |||||||||||||||||||||||||||||||||||||||
| current space | Which space(s) should be included in the report?
| ||||||||||||||||||||||||||||||||||||||
| all | Should the report be filtered to specific state(s)?
| ||||||||||||||||||||||||||||||||||||||
workflow | all | Should the report be filtered to states in a specific workflow(s)?
|
All examples