spaces-report macro

Overview

The spaces-report macro lets you generate a report detailing multiple space metadata attached to the matching spaces.

Any metadata created with the Comala Metadata app space-metadata and the space-metadata-list macros can be displayed in the report.

The macro can also retrieve values for any Confluence internal space metadata, such as Space, alongside custom metadata created with the app.

Parameters

Parameter	Required	Default	Notes	Version

Parameter

Required

Default

Notes

Version

Fields

The list of fields (columns) to be included in the report. This can include added metadata and internal metadata.

sort

modified

Specifies which column in the report should be sorted by.

You can also include a hint for the sort method before the sort direction.

For example, "Name as istring asc" or "Name as istring" applies a case-insensitive comparison, considering values as strings.

Other choices include

"as date"
"as number"
"as string" (case-sensitive)

Default is case-insensitive comparison.

maxResults

Specifies the maximum number of results in a report.

The default is 500

Usage

To retrieve multiple metadata values from spaces in the instance

Choose the Spaces Metadata Report macro from the Confluence macro browser:

The macro editor lets you configure the macro before adding the macro to the page. At least one metadata name is required.

Macro editor - Spaces Metadata Report macro

For each space with none of the specified metadata, the report displays an empty row.

If required, simply sort on an appropriate column and set maxResults to only show the spaces with a value for the attached space metadata.

A null value in the report may indicate that no metadata name is attached rather than a null value for the metadata value for the space.

In the example, three spaces have space metadata attached - with the results sorted on one column and results restricted:

No content can be added to the macro placeholder. The report displays the space metadata and values in a tabular format.

The name of the space is displayed using the Space internal metadata
Galaxy Base, G-Type, and Lead Commander are all space metadata created using the Comala Metadata app
The table column order depends on the order of the fields entered using the macro editor

Reference Markup

{spaces-report:Space,Owner,Purpose,Galaxy Base, Lead Commander, Last Time Changed|sort=Owner desc|maxResults=4}

The example above displays the following report:

The sort and maxResults have been chosen so only spaces with the added space metadata Owner, Purpose, Galaxy Base, and Lead Commander are shown on the page with the internal metadata Space and LastTimeChanged.

Usage with the Comala Document Management app

The spaces-report macro is supported by the Comala Document Management app and works at the workflow level.

{spaces-report:Space,User,metpiece|maxResults=4}