Info |
---|
Looking for the reporter for use with ServiceRocket Reporting for Confluence app? See workflow-reporter macro. |
Overview
Excerpt | ||
---|---|---|
| ||
Generate custom reports for states, reviews and tasks |
The {workflowreport}
macro macro is used to create custom reports on workflow states, reviews and tasks.
Where to use it?
Optional.
One or more {workflowreport}
macros macros can be used in wiki pages, blog posts, and, in some cases, comments.
It can also be used in any macro which supports wiki content in its Macro body (check macro body. Check the following macro documentation for details):
Filter by label (Content by label) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The workflowreport
macro is planned to be deprecated by
Status | ||
---|---|---|
|
Currently released new reporting macros are listed below:
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
Parameters
† Only use with approvals
report
‡ Only use with states
report
Parameter | Required | Default | Notes | Ver |
---|---|---|---|---|
| What type of report should be displayed?
| |||
| † |
The name of a content review is required for the The name is defined by |
{approval}
macrothe approval macro, and is shown in |
the workflow popup during content reviews. | ||||
| Should the report be filtered to content that the specified user can currently review?
| |||
|
| † For
‡ For
| ||
|
| Should the report header be hidden?
| ||
| 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. | ||
|
| What order should results be sorted in?
| ||
| Should the report be filtered to a specific parent page and the child pages of the specific page?
| |||
|
| Which report column of the report should results be sorted by?
| ||
| current space | Which space(s) should be included in the report?
|
|
| ||||
| Should the report be filtered to specific state(s)?
| |||
| Should the report be filtered to content that the specified user can currently review?
| |||
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. |
App configuration
Setting | Where | Notes |
---|---|---|
Workflow Activity and Drafts Visibility | Who can access the report? For report |
specific details, see: |
All examples
...
...
showLabels | false |
---|---|
max | 100 |
showSpace | false |
sort | title |
excerptType | simple |
cql | label = "macro-workflowreport" and label = "example" and space = currentSpace() |