Legacy Workflows Documentation

Looks like you followed an old link.  We have revamped our Comala Workflows Documentation, check it out here: Welcome to Workflows

This space is no longer being updated.

The {workflow-reporter} macro is used to generate a collection of Pages and Blog Posts to use with the Reporting add-on. Using the Reporting add-on is an alternative to using the {workflowreport} that allows you to create customizable and more sophisticated reports.

This macro requires the Reporting add-on version 6 or above.

For further documentation, please see ServiceRocket's Reporting documentation.

Usage

This macro is similar to the content-reporter but it has been optimized and allows to filter workflow-related information.

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

Parameters

Name

Required

Default

Description

space

No

@self

A comma-separated list of spaces. Use @self for the current's page Space, @all to include all spaces

label

No

 

A comma-separated list of labels to be filtered. Pages/Blog posts containing any of the labels will be included in the report. If the list starts with & then only Pages/Blog posts containing all the labels will be included

filter

No

 

a comma separated list of lucene/search terms queries in the form FieldName:Value. The values must be indexed

state

No

 

the states to filter

max

No

100

Maximum number of entries

sort

No

-modified

The sort for the report which can be modified, created, pagestate, statechanged or statechangedby. The order is determine by prefixing + (default) for ascending or - for descending

Examples

Here is a report which simulates the report generated by the {workflowreport} macro:

{report-table}
{workflow-reporter:spaces=@all|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}
  • No labels