This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Metadata Supplier for ServiceRocket Reporting App

The features described below require the ServiceRocket Reporting App.

Overview

Sets up the Metadata Supplier for Reporting Plugin versions 6.15.25 and above. The Workflow Supplier provides metadata information attached to pages, blog posts etc to third-party apps, such as the Reporting for Confluence app, using the Confluence Suppliers for Reporting Library.

This sets up the Metadata Supplier for Reporting Plugin versions 6.15.25 and above.

Compatibility

ServiceRocket Reporting requires

  • Reporting app v6.15.25 in Confluence 7.13.11

  • Reporting app v6.18.7 in Confluence 8.1.0*

*Use of Reporting app v6.18.7 will require you to install Comala Metadata 4.2.12+.

Details

Name 

Metadata Supplier 

Prefix 

metadata (required) 

Supported content 

Pages, Blog Posts, Spaces, Users 

Provided By 

Confluence Metadata App 3.5+

Keys Supported

Key 

Content Types 

Return Type 

Description 

Key 

Content Types 

Return Type 

Description 

no key

Any 

List of Entries

Returns the list of all Metadata 

Metadata name

Any 

Text

Returns the metadata value associated with the current element. 

Any value from Columns available in Report macros

Any 

Text 

This works too, but most of those values return uninterpreted wiki syntax, requiring additional effort to utilize the returned values

Usage and Examples

The ServiceRocket Reporting macros will retrieve the metadata provided by Comala Metadata App using the “metadata:” key.

For example

  • if the following Comala Metadata metadata list macro is added to a number of pages with different values on each page for the three metadata references city; province; country.

ServiceRocket Reporting macros can be added to one of the pages to report on these metadata values.

Each Report Column macro utilizes the metadata: supplier to report on the metadata created in the metadata list macro.

  • for example using metadata:city

The data is updated when the metadata on each page is modified.

Replacement for metadata-report macro

The Reporting Plugin can be used to replace the  metadata-report macro. 

For instance, the following metadata-report:

{metadata-report:Page,Metatest,Excerpt|link=Excerpt|label=meta}

Displays:

Page 

Metatest 

Excerpt 

Page 

Metatest 

Excerpt 

P1 (http://) 

ABC 

Excerpt for P1 

Home (http://) 



Test Excerpt 

P2 (http://) 





This can be replaced with:

{report-table} {content-reporter:types=page|labels=+meta}{content-reporter} {report-column:title=Page}{report-info:title|link=true}{report-column} {report-column:title=Metatest}{report-info:metadata:Metatest}{report-column} {report-column:title=Excerpt (column header)}{report-info:excerpt|link=true}{report-column} {report-table}

Displays:

Page 

Metatest 

Excerpt (column header) 

Page 

Metatest 

Excerpt (column header) 

P1 (http://) 

ABC 

Excerpt for P1 (http://) 

Home (http://) 



Test Excerpt (http://) 

P2 (http://) 





Reporting App syntax is more verbose, but more powerful.

For further examples, see: ServiceRocket Reporting for Confluence app

Related Comala Metadata macros

Related documentation