Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Looking for the Comala Document Management report macro? See workflow-report macro and the Reporting Guide.

Overview

The {workflow-reporter} macro is used to generate a collection of Pages and News (blog posts) objects to use with the Appfire Reporting for Confluence app version 6.0 or above.

Tip

Using the Reporting add-on is an alternative to using the 

...

workflowreport macro. It allows you to create more advanced and

...

customizable reports using

...

the Reporting app reporting framework.

Where to use it?

Optional.

This is an optimised alternative to the content-reporter which provides access to workflow-related information.

The workflow-related information can be accessed through the {report-info} macro by using the Workflow Supplier.

Info

For further documentation,

...

refer to the Appfire (formerly ServiceRocket) Reporting app documentation

Parameters

Parameter

Required

Default

Notes

space


@self

Which spaces should be included in the report?

  • @self – current space

  • @all – all spaces

Or
  • or specify a comma-separated list of space keys for a collection of spaces

label



Should the report be filtered by content label(s)?

Leave
  • leave empty to include all pages and blog posts

Specify
  • specify one label name to filter to a specific label

List
  • 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.

filter



A comma-separated list of CQL filters in the form FieldName:Value – the values must be indexed.

state



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

Leave
  • leave empty to report on all states

Specify
  • specify one state name to report on that state

List
  • list multiple state names, separated by commas, to report on specific states

max


100

Maximum number of entries in the report

sort


+modified

The sort order:

  • + for ascending, A→Z

  • - for descending, Z→A

And the sort field:

  • modified – the most recent date on which the content was modified

  • created – the date on which content was created

  • pagestate – the current workflow state of the content

  • statechanged – the date on which the state most recently changed

  • statechangedby – user who most recently changed the state

Example

The Reporting app report below will generate a report similar to the states report of the {workflowreport } macro:.

Code Block
languagetext
themeRDark
{report-table}
 {workflow-reporter:spaces=@self|state=Published}
 {workflow-reporter}

 {report-column:title=Page}{report-info:content:title|link=true}{report-column}
 {report-column:title=Last Updated By}{report-info:content:modifier>name|link=true}{report-column}
 {report-column:title=Updated}{report-info:content:modification date}{report-column}
 {report-column:title=State}{report-info:workflow:state>name}{report-column}
 {report-column:title=State changed on}{report-info:workflow:state>date}{report-column}
 {report-column:title=State changed by}{report-info:workflow:state>user>name|link=true}{report-column}
{report-table}

All examples

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-workflow-reporter" and label = "example" and space = currentSpace ( )

See also

Reporting Guide

Integration Guides:

Workflow Authoring Guide:

Developer Guides: