set-metadata macro

Overview

The set-metadata macro is used to define metadata key=value pairs stored at the content level (page or blog post).

The values can later be retrieved using the get-metadata macro, or any other third-party app capable of reading metadata.

In addition, the values can be used as value references in any macro or feature that supports them.

Where to use it?

Optional.

One or more set-metadata macros can be used in a workflow trigger macro.

Parameters

Parameters	Required	Default	Notes

Parameters	Default	Notes
first unnamed parameter		The metadata key (name by which the value can be accessed). Check character restrictions
macro body		The metadata value Check character restrictions Supports value references
`trim`	`true`	Should the macro body contents be trimmed (remove whitespace)? `true` – yes, trim (recommended) `false` – no, leave as is
`page`	current page	Where should the metadata be stored (default = current page)? `@parent` – store on the parent page, not the current page `@children` – store on child pages, not the current page This parameter only works on pages. It does not work for blog posts.

Basic trigger example

{workflow:name=Store metadata}
   {state:Test}
   {state}
   {trigger:pagecreated}
      {set-metadata:Document Author}
         @user@
      {set-metadata}
   {trigger}
{workflow}

For a trigger using the pagecreated event to work, the workflow must be applied as a space workflow.

...retrieving later

You can either:

Use the get-metadata macro, for example, by adding the get-metadata macro directly to the page, or in a page properties macro:

pagepropertiesmacro_get-metadatamacro_docuemntauthor_metadta_value.png

Retrieve it as a value reference, in any workflow macro or third-party app that supports value references

0.. using Confluence Search

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

Examples

Page:

Add workflow review information to a header for inclusion in a page export — Use the workflow to add a header containing details of the workflow review to comply with a records retention policy for exported approved page PDFs
Page:

Dynamic page header using a metadata value and triggers — Use a trigger to display a different page header for each state in the workflow. Page header content is set as a metadata value.
Page:

Use blog post events in a workflow trigger — Workflow events associated with blog posts
Page:

Use metadata to increment composite major, minor, patch content version on an approval decision requiring a parameter — Use the increment-metadata macro to increment the major, minor, and patch metadata values for a single approval using three triggers.
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