...
The metadata value must have been already set e.g. at page creation using the set-metadata macro.
Parameters
| Parameter | Required | Default | Notes |
|---|---|---|---|
| metadata name |  | none | The metadata item. The metadata item value is numeric and can be:
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 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 expression examples
...
The increment expression format including any separator characters and the suffix identifier MUST match the metadata item value being incremented.
| Metadata Value | Increment Expression | Resulting Value |
|---|---|---|
| 1 | <empty> | 2 |
| 1.0 | <empty> | 1.1 |
| 1.0 | 0.1 | 1.1 |
| 1.0 | 1.0 | 2.0 |
| 3.5.1 | <empty> | 3.5.2 |
| 3.5.1 | 0.0.1 | 3.5.2 |
| 3.5.1 | 0.2.0 | 3.7.0 |
| 3.5.1 | 0.2.1 | 3.7.2 |
| 3.5.1 | 1.0.0 | 4.0.0 |
| 3.5.1 | 1.1.1 | 4.6.2 |
| 3.5.1-Beta | 1.0.0-Beta | 4.0.0-Beta |
An <empty> increment expression simply includes the name of the metadata value to increment.
...
The metadata is associated with the page. At any one point in time, the metadata value will be the same in any workflow state.
- in our example, the
my-versionmetadata value when for a user viewing previously published content the content currently in a draft state (if that content has been previously published), is the value set by theincrement-metadataaction on the last transition to the workflow final state whilst content is currently in a draft state
...
- , Approved. It will be the same metadata value seen for the content by a view-only user when viewing the final state content
The Confluence version metadata value may be different if the page has been updated or edited in one of the workflow states.
In the simple increment example, this can be seen if you use one one get-metadata macro to display the metadata my-version and a second get-metadata macro to display the Confluence version on a page.
...
The Confluence version value is currently 9. This reflects that there have been multiple edits on the content .
A metadata value is linked to a page not a page version. Viewing a previous page version will show the current metadata valuebut only one version has been approved in the workflow.
Other examples
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The metadata value set and updated using these macros is linked to the page not a page version. Viewing a previous page version will show the current metadata value.
See also
...