Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Using the Communardo metadata as value references in a workflow - including use in a custom condition for a trigger macro

Overview

...

This page describes how to access metadata from the Communardo Metadata for Confluence app in Comala Document Management Value References.

Image Removed

You will need Communardo Metadata for Confluence version 3.0 or above.

Info

If using Comala Document Management v6.7.14 or later this requires at least Confluence 7.13.11.

For this release you will need at least Communardo Metadata for Confluence v3.4.1 or above.

Benefits

The ability to utilize metadata in Comala Document Management gives Space administrators a flexible new tool for customising the approval process of their pages.

This integration connects Metadata for Confluence to Comala Document Management Value References, allowing you to create rich user interfaces for metadata management, advanced reports and more.

...

Users familiar with workflows markup language will find working with metadata easy to incorporate into their workflows.

...

Go to Space Tools → Metadata → Metadata fields tab and you'll see all the value references listed in the Key column as illustrated below:

...

Using the value references

You can now use those keys as the Value References in your workflows, simply by wrapping them with @ (at) symbols..

For example, to use the Deadline (metadatafield.deadline) and Main reviewer  (metadatafield.mainreviewer) metadata fields, highlighted in the screenshot above, in a content review:

Code Block
languagetext
themeRDark
{workflow:name=Metadata example}
  {state:Draft|submit=Review}
  {state}
  {state:Review|approved=Published|rejected=Draft|expired=Draft|duedate=@metadatafield.deadline@}
    {approval:Editor in Chief|user=@metadatafield.mainreviewer@}
  {state}
  {state:Published|final=true|updated=Draft}
  {state}
{workflow}

...

You can use the value references to create custom Conditions for the following macros:

Filter by label (Content by label)
showLabelsfalse
max500
showSpacefalse
sorttitle
cqllabel = "supports-conditions" and label = "macro" and space = currentSpace ( )

For example, you might want a Trigger that only fires when the main reviewer edits a page:

Code Block
languagetext
themeRDark
{workflow:Example}
   {state:Test}{state}
   {trigger:pageupdated|@metadatafield.mainreviewer@=@user@}
      {set-message}Main reviewer updated this page{set-message}
   {trigger}
{workflow}

(warning)

If using value references in the pagecreatednewscreated, pageupdated, or newsupdated events, metadata values might not be available if they are still being updated. 

Data types

The table below shows how Communardo Metadata data types should be mapped to the following Comala Document Management value reference types:

Metadata for Confluence Type

Comala Document Management Type

CHECKBOX

?

RADIOBUTTON

list

TEXT

string

GROUP

group

DATE

duration

USER

user

LINK

string
or list

DROPDOWN

list

Note: links (info) Links are treated as plain text, but any macro supporting wiki markup (eg. {pageheader}) can wrap the text in wiki link notation.

See also