This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

workflow-report macro

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

Overview

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 the following macro documentation for details:

The workflowreport macro is planned to be deprecated by 2024 and will be replaced with a number of new reporting macros with additional functionality.

Currently released new reporting macros are listed below:

Parameters

Only use with approvals report

Only use with states report

Parameter

Required

Default

Notes

Ver

Parameter

Required

Default

Notes

Ver

type



What type of report should be displayed?



approval



 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 a specific parent page and the child pages of the specific page?

  • Leave empty to include all content in the space

  • Specify a page title to include the specified page and its child pages

  • Specify @self to specify the current 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



 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

See also

Workflow Authoring Guide

Reporting Guide

Integration Guides

Developer Guides