Administrator's Guide

In this Guide, we will provide you with an overview of the additional Metadata functionalities and how to configure them.

This Plugin is an extension for Communardo Metadata for Confluence. For further information concerning Metadata functionalities, you can check out https://communardo.atlassian.net/wiki/spaces/METADATA/overview.


Dynastatus

Displays a predefined number of configurable values out of which the user can pick one. Background and (optionally) text colors can be assigned to each value to give it a clearer representation.

Key-value pairs can be defined, one per line. The format must match: key1~value1

Additionally you can specify the two color codes or names, first being the background color, second being the foreground or text color.

There are several requirements for the values and keys. Keys must be alphanumeric and must begin with a character between a and z. Keys should not change once the field is in use as this can cause data loss and values no longer being displayed. It is however possible to add entries to the list in any place as long as the previously-existing keys do not change.

A global default for the field type can be specified by prefixing the key in the respective line with “>” (greater than). This should only be done in one of the lines. This causes the entry to be the default value whenever the field is initially shown, for instance on a new page where the field is assigned for the first time.

Dynastatus is also compatible with the standard way of assigning default values through metadata sets. If a default value for a Dynastatus-typed field is defined in a metadata set, this default will override the global one defined in the field type confguration.

Please take a look at https://beyondsolutions.atlassian.net/wiki/x/IYDXV for some example configurations and the visual outcome.

 

 

Here you can see an example of how the key-value pairs are displayed for the users.


Email address

This Metadata type allows you to configure how many e-mail addresses can be entered into the field. You may choose either single or multiple. The user-input will be checked via a regEx-validation accordingly.


Numeric

A field which only accepts integer numbers as input.

In the future, the field can also support the input of decimal numbers as well as upper and lower limits.


PatternText

A regular expression (RegEx) defines the format of the allowed input. RegEx itself is not visible for users while editing a page which includes a PatternText Metadata Field. You can write your own “Invalid content warning” which will appear near the input field in case the input does not match the RegEx. This text should explain comprehensibly what is expected so users can understand how they need to form their input.

A Test field is presented in the configuration page to swiftly check whether your RegEx works as intended. You can input test values there to see whether the RegEx matches or not.

A helpful RegEx generator can be found here: https://regex101.com/

 

TimePeriod

Basically a text field with a RegEx that validates the input against the ISO 8601 Duration Format (see here: ). There is no configuration available yet. In the future, it will be possible to set lower and upper boundaries, and to define how the field is shown in views. A macro might also be added to add more flexibility to documents where dates based on a time span are shown.

 


Comala Workflow State

Shows the state the current page workflow is in (if any). Configuration is not needed as this field gets its info from the environment, i.e. the active page and the workflow that was assigned. For this reason, the field is read-only.

 

Requires Comala Document Management plugin. The field type will not appear in the type choice dropdown if Comala Document Management could not be found.