document-states-report macro

columns

title⁺, state, changed, updated by, updated

The report columns displayed in the UI on the content can be set to be one or more of the following:

From Comala Document Management 6.13.0 the following columns are available

• Title (column parameter in macro - title)⁺

• State (column parameter in macro - state)

• Approval (column parameter in macro - approvals)

• Approval Status (column parameter in macro - approval status)

• Changed By (column parameter in macro - changed by)

• Updated By (column parameter in macro - updated by)

• Updated (column parameter in macro - updated)

v6.13+

From Comala Document Management 6.16.0 the following additional columns are also available

• Approved Version (column parameter in macro - last final version)

• Approved ver. approved by (column parameter in macro - last final version approvers)

• Approved ver. date (column parameter in macro - last final version date)

• Created (column parameter in macro - created)

• Due date (column parameter in macro - due date)

• Read Confirmation (column parameter in macro - readack status)

• Space (column parameter in macro - space)

• Workflow (column parameter in macro - workflow)

6.16.0+

Columns are displayed in the order the items are added in the macro editor.

The following column headings are sortable in the UI of the report (from v6.16.6+)

• Title

• Created

• Due date

• Read Confirmation

• State

• Updated

• Created by

• Workflow

content-title

all

Filter report for specific named content.

filter

all

You can provide a comma-separated list of CQL filters – the values must be indexed.

• Workflow CQL Fields (Comalatech)

• CQL Field Reference (Atlassian)

Other Atlassian CQL resources

• Advanced Searching Using CQL (Atlassian)

• CQL Function Reference (Atlassian)

• CQL Keywords Reference (Atlassian)

• CQL Operators Reference (Atlassian) 

• Performing Text Searches with CQL (Atlassian)

v6.16.7+

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.

maxItems

20

The number of results to show per page.

order

descending

What order should results be sorted in?

• ascending – A→Z

• descending – Z→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

title

Defines the value to sort by with the following options

• Title

• Updated

• Created

• Created by

v7.2.1

sort order

ascending

Defines the order of the sorting as either

• ascending

• descending

v7.2.1

space

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

state

all

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

workflow

all

Should the report be filtered to states in a specific workflow(s)?

• leave empty to report on all states in all workflow

• specify one workflow name to report on states in that workflow

• list multiple workflow names, separated by commas, to report on specific states in those workflows