get-metadata macro

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.

Page:

add-comment macro — Comment on a page or blog post
Page:

increment-metadata macro — Increment a metadata value to support custom versions (available from v6.11+)
Page:

pagefooter macro — Add content to page footer
Page:

pageheader macro — Add content to page header
Page:

send-email macro — Send an email
Page:

set-message macro — Add/remove a page message
Page:

workflow macro — Defines a workflow template

It can also be used in page templates and blueprints.

Parameters

Parameter

Required

Default

Notes

Ver

name

The metadata or value reference to display

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.

Do not include the @ symbols when adding the value reference name to the macro editor.

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 the markup notation:

{get-metadata:name=Project Lead}

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

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

All examples

Page:

Using set-message and metadata to display different information for the draft and published content — Using the view parameter of the set-message macro to display a different metadata when users view the draft or published versions