Looking for the reporter for use with ServiceRocket Reporting for Confluence app? See workflow-reporter macro.

Overview

Generate custom reports for states, reviews and tasks

The {workflowreport} macro is used to create custom reports on workflow states, reviews and tasks.

Where to use it?

Optional.

One or more {workflowreport} 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 documentation for details):

Parameters

Only use with approvals report

Only use with states report

Parameter

Required

Default

Notes

Ver

type

(tick)


What type of report should be displayed?


approval

(info)


(info) The name of a content review is required for the type=approvals report to work.

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


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

filter†‡


pending

For type=approvals, 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

For type=states, you can provide a comma-separated list of CQL filters in the form FieldName:Value – the values must be indexed.


hideheader


false

Should the report header be hidden?

  • Only applies to type=dashboard report
  • true – hide the header
  • false – don't hide the header

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.


maxentries


20

The number of results to show per page.


order


descending

What order should results be sorted in?

  • ascendingA→Z
  • descendingZ→A

parent



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

sort


modified

Which report column of the report should results be sorted by?

  • modified – the most recent date on which the content (page or blog post) was modified
  • created – when the review, state or task was created
  • duedate – the task or state expiry date
  • pagestate – the current workflow state
  • statechanged – the most recent date on which the state was changed
  • statechangedby – the user that most recently changed the state

spacekeys


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 – but you must also specify approval or state parameter, depending on the report type

state



Should the report be filtered to specific state(s)?

  • Leave empty to report on all states
  • Specify one state name to report on that state
  • List multiple state names, separated by commas, to report on specific states

user



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 the specified user can review
  • Specify @self to filter to results that the current user can review

App configuration

SettingWhereNotes
Workflow Activity and Drafts Visibility

Who can access the report?

For report-specific details, see:

All examples

See also

Workflow Authoring Guide:

Reporting Guide:

Integration Guides:

Developer Guides: