Versions Compared

Key

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

...

Excerpt
hiddentrue

Increment a metadata value to support custom versions (available from v6.11+)

The increment-metadata macro increments a numeric metadata value. 

...

Where to use it?

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

...

ParameterRequiredDefaultNotes
metadata name(tick)none

The metadata item. The metadata item value is numeric and can be:

  •  simple (e.g. whole number)
  • composite (eg 2.1 or 2.1.1)

A non-numerical character can be used to separate "-" the metadata numeric values e.g. 1__2-4. The separator can be any non-numeric character.

A suffix may be used after the last numeric element e.g. 2.1.1-BETA. This can be any set of characters (including letters, symbols, and numbers).

increment
increment last numeric element by 1

The increment expression, if specified, is a numeric expression to increment element(s) of the numeric value.

If no increment value is specified the last numeric element of the current metadata value is incremented by 1.

The expression can be:

  • a simple integer number (e.g. 2)
  • composite number (e.g. 1.2  or 1.2.3)

A composite number cannot be more than 3 numeric elements e.g. 1.2.3.4 is not supported.

When defining the increment expression the format MUST match the metadata item value format including any separators and suffix identifiers.

  • increment or a change for non-numeric elements is not supported.
  • incrementing a single higher-order element of a composite numeric value will reset any lower-order elements to zero e.g. a metadata value of 1.2.3 with an increment expression of 1.0.0 will update the value to 2.0.0.

...

Metadata ValueIncrement ExpressionResulting Value
1<empty>2
1.0<empty>1.1
1.00.11.1
1.01.02.0
3.5.1<empty>3.5.2
3.5.10.0.13.5.2
3.5.10.2.03.7.0
3.5.10.2.13.7.2
3.5.11.0.04.0.0
3.5.11.1.14.6.2
3.5.1-Beta1.0.0-Beta4.0.0-Beta


An <empty> increment expression simply includes the name of the metadata value to increment.

...

Code Block
languagetext
themeRDark
{workflow:name=Simple Increment Metadata}
    {state:Draft|submit=Review}
    {state}
    {state:Review|approved=Approved}
        {approval:Review|assignable=true}
    {state}
    {state:Approved|final=true|submit=Draft}
    {state}
    {trigger:pagecreated}
        {set-metadata:my-version}
            0
        {set-metadata}
    {trigger}
    {trigger:statechanged|state=Approved}
        {increment-metadata:my-version}
    {trigger}
{workflow}


The This example shown uses the increment-metadata macro to support the custom versioning of a page using a simple numeric metadata value.

...

A version change will occur : on a state change to the Approved state.

{increment-metadata:my-version}

(green star) The metadata is associated with the page. At any one point in time, the metadata value will be the same in any workflow state.

  • for in our example, the metadata value when a user viewing previously published content in on the last transition to the workflow final state whilst content is currently in the a draft state

The metadata for the Confluence version may however  may be different if the page has been updated or edited in one of the workflow states.

...

The Confluence version value is currently 9. This reflects that there have been multiple edits on the content.

(star) A metadata value is linked to a page not a page version. Viewing a previous page version will show the current metadata value.

Other examples

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-increment-metadata" and label = "example" and space = currentSpace ( )

...