Augments - Cloud
Overview
Augments are a set of macro parameters that provide the ability to augment the data found in the table with additional columns derived from other available information. More capabilities are planned for the future. Augments are supported in the CSV (Comma Separated Values) macro and the JSON Table macro.
Sometimes, users have little control over how data is produced, for example, when importing CSV files generated by external processes. This affects the way data is displayed in Confluence as the format may not be optimal. However, use of both augments and replacement keys can improve the look of such data in Confluence. The use of replacement keys that can be used with augments are explained in a subsequent section.
Parameters
Macro Browser Label | Description | Parameter |
|---|---|---|
Augments to data row values | Enter a comma-separated list of augments to the data row values, one for each column. Specify double quotes for values with a comma. | augments |
Augments to heading row values | Enter a comma-separated list of augments to heading row values, one for each column. | headingAugments |
Augments to footing row values | Enter a comma-separated list of augments to footing row values, one for each column. | footingAugments |
Columns to show | Enter a comma-separated list of comma separated list of column names or numbers in any order. By default, all columns are displayed in its existing order. Note that columns are indexed beginning at "1" and exclude any auto-numbered columns. For augment support, use * to represent an augmented column to be added. | columns |
Replacement keys
Replacement keys enclosed in % can have replacements as indicated in the table. For example, a %#% key is replaced with the current row number.
Confluence Cloud does not support macros inside a macro (nested macros). So, a replacement key such as %json-table% is not supported.
Key | Replacement | Difference if heading or footing row? |
|---|---|---|
* | original value |
|
empty | original value |
|
blank | blank |
|
# | row number (starting at 1 for the first data row) | blank |
number | value of the column identified by column number (1-based count) |
|
name | value of the column identified by column name lookup, if valid |
|
! | | (can be needed when using wiki markup) |
|
[ | { (can be needed when using wiki markup) |
|
] | } (can be needed when using wiki markup) |
|
Examples
This section lists examples of using augments with the CSV (Comma Separated Values) and JSON Table macros. In addition to the augment examples, also look at the Confluence CLI output examples and Jira CLI output examples that use augments.
Additional references
Example output with augments - Jira CLI output examples
Example output with augments - Confluence CLI output examples