Versions Compared

Old Version 2

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 3

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3
minLevel2
absoluteUrltrue
excludeSee also
typeflat
separatorpipe

Overview

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

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

The macro will also retrieve values for any Confluence internal space metadata, such as Space alongside metadata created with the Comala Metadata App.

Parameters

Parameter

Required

Default

Notes

Version

Fields

(tick)


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 instance "Name as istring asc" or "Name as istring" will apply a case-insensitive comparison, considering values as string.

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. Default is 500.


Usage

Excerpt

To retrieve multiple metadata values from spaces in the instance, choose the  Spaces Metadata Report macro from the Confluence macro browser:

Image Modified

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

Image Modified

For each space with none of the specified metadata the report will display an empty row.

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

(info) Be aware that a null value in the report may indicate that there is no metadata name 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.

Image Modified

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

Image Modified

  • 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

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

...