This documentation relates to the 4.3 release of Ad hoc Workflows

 Documentation for other versions of Comala Workflows is available too.

Generates an approvals, states or dashboard report.

Parameters

Mandatory

Default

Description

space, spaces,
spacekey or spacekeys

No

current space

The space keys to filter. if set to any then the report will include any space but a state or approval filter must be provided

maxentries or entries

No

20

The maximum number of entries

type

No

approvals or states depending on the type of workflow in the space

The type of report (states, approvals, dashboard or stats)

filter

No

pending

For approvals report, pending will filter the pages which have pending approvals, approved pages which have been approved or rejected for rejected pages

approval

No

 

The approval name to filter

state or states

No

 

the state name or names to filter

label

No

 

the labels to filter. If prefixed with & then all the labels must match, otherwise it will report pages containing any of the listed labels

sort

No

modified

Sort the entries by modified, created, pagestate, statechanged, statechangedby

order

No

descending

sets the ascending or descending order

parent

No

 

Limits the report to child pages of the given parent page title

approver

No

 

Show only the content for which the given user name (or @self for current user) has been selected for the given approval. Requires that the Approvals are defined with the selectapprover parameter is set)

user

No

 

Show only the content that is ready for approval and that the given user name (or @self for the current user) can approve.

hideheader

No

false

set to true to hide the report header

filter
or filters

No

 

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

Examples

Generate an approval report of pages that have received the Author approval, listing five pages per page:

{workflowreport:approval=Author|filter=approved|max=5}

Generate a states report, for pages in the Completed state:

{workflowreport:type=states|state=Completed}

Generates a report of all pages that the current user could approve or reject:

{workflowreport:user=@self}

Generates a report of all pages on which user emendator has been selected as approver:

{workflowreport:approver=emendator}

Generates a report of all pages containing the metadata value country equals to USA and license is Commercial in all space and the page state is Follow Up

workflowreport:type=states|space=any|state=Follow Up|filter=country:USA,license:Commercial}

 

 

  • No labels