set-metadata macro

Overview

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

The values can later be retrieved via the get-metadata macro, or any other plugin capable of reading metadata. In addition, the values can be used as Value References in any macro or feature which supports them.

Where to use it?

Optional.

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

Parameters

Basic example

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

Note: This example requires space mode for the pagecreated event to work.

...retrieving later

You can either use the get-metadata macro, or a macro that supports such content.

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 Comala Metadata app is installed.

All examples

• Page:
  Blog Post Events — Workflow events associated with blog posts
• 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 metadata to increment composite major, minor, patch content version on an approval decision requiring a parameter — Use the {increment-metadata} macro to increment major.minor.patch metadata value 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

See also

Workflow Authoring Guide:

• Value References – Metadata references
• Conditions
• Events
• Triggers
• Actions

Integration Guides:

• Comala Metadata app