Overview

The {get-metadata} macro is used on wiki pages (or content rendered to wiki pages) to retrieve and display Value References, including:


Where to use it?

Optional.

One or more {get-metadata} macros can be used in wiki content (pages, blog posts).

It can also be used in macros that render wiki content in the context of pages and blog posts.

It can also be used in page templates and blueprints.

Parameters

Parameter

Required

Default

Notes

Ver

name

(tick)


The metadata or value reference to display

Note

  • do not enclose the value reference in @ ("at") symbols
  • use awpState value reference to retrieve the current workflow state name
3.0.3+

Example

To retrieve a value reference called @Project Lead@,  add the {get-metadata} macro to content using the macro editor to add the metadata name (note: no @ symbols).

A simple way to display the value is to add the macro to a table cell.

On the content, this retrieves and displays the current value of the metadata.

In code notation:

{get-metadata:name=Project Lead}


(info) Metadata values created with the {set-metadata} macro are only indexed by Confluence and appear in the Confluence search if the Comala Metadata app is installed.

Metadata retrieval logic

The following may cause problems when trying to retrieve a metadata value using the get-metadata macro.

For example

  • in Comala Document Management versions prior to v6.18.8 using a get-metadata macro to define a page property value where the metadata being retrieved is the value of another get-metadata macro

The retrieval logic of the get-metadata macro may also have problems returning a value if there is any coincidence (or overlap) in a metadata name and another metadata or property name. To avoid any problem simply try to ensure the use of unique names for each of your metadata names.

Suppose duplication of a value reference name occurs, for example, a page property and metadata set with the Comala set-metadata macro. In that case, the get-metadata macro will resolve the value in the following priority.

  1. Confluence page properties macro
  2. Comala Metadata which includes workflow parameters with edit=true that have been saved and metadata set using Comala Document Management set-metadata macro
  3. Communardo Metadata
  4. Workflow parameters saved at the space level - without edit=true
  5. Page references
  6. Suppliers (ServiceRocket, Workflows, Metadata)

All examples

There is no content with the specified labels

See also

Workflow Authoring Guide:

Integration Guides: