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

Parameters	Default	Notes
first unnamed parameter		The metadata key (name by which the value can be accessed). Character restrictions?
macro body		The metadata value 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 Note: This parameter only works on pages, not blog posts.

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:

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 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

Comala Document Management for Data Center