...

Div

id	ProductTOC

Reading the JSON data from any of these sources:
1. Within your Confluence page.
2. From a file residing on the Confluence server (Server only).
3. From a Space Template (Server only).
4. From a page attachment.
5. From an external URL.
Allowing customizable access to fields.
Supporting inclusion of Wiki Markup macros within the JSON data.
Combining with the Chart macro to produce powerful data visualization.
Leveraging the same table styling capabilities as the Table Plus macro.

...

Tip
Available in plugin release 6.3 and above.

...

Note

title	Applicable upto app version 8.1:

To enable using HTML content with JSON data, you must enable the Stop encoding of html characters parameter. In such a case, it is recommended to contact your administrator to use Macro Security for Confluence with this app to provide an additional layer of security to your data and privacy. Refer to this documentation to for more information on the Macro Security for Confluence app.

From app version 8.2 onwards, if the Stop encoding of html characters parameter is enabled, use of Macro Security for Confluence is no longer needed as the macro itself provides additional security to your data.

Basic Use

This macro can be deployed using one of the following methods:

Selected from the Macro Browser	JSON Table
Markup Shortcut	{json-table}

Screenshot

Parameters

Click a column heading to toggle the sorting of that column.

Table plus

highlightColor	#ffffec
rowStyles	background:#f0f0f0;color:#222;font-size:14px;border-bottom:black 2px solid;border-top:black 2px solid;,
style	background-color:white;
autoNumber	true

Parameter

Default

Macro Browser Label

Description

paths

Paths to fields

Normally, specify a single path to generate a single table. Simple form is a dot separated list of field names to reach the specific field within the JSON string. Example: total.monthlies.

When a comma separated list of paths to fields is provided, a table will be produced for each valid field identified by the path. No table will be produced for references to fields that cannot be found, empty arrays, or similar.

Paths are expressed in JSONPath syntax.

fieldPaths

all fields

Paths to fields to be included

Comma separated list of paths to fields to be included in the output. Paths are relative to the JSON field specified in the paths parameter. If not specified, all fields found will be included.

Example for the issues field from the JIRA search REST API:
key, fields.summary, fields.issuetype.name, fields.issuetype.id, fields.fixVersions[*].name

fieldOrderRegexPatterns

Regex patterns for ordering fields

Comma separated list of regular expression (regex) patterns.

This parameter is used only when defaulting fieldPaths to all fields; otherwise the order specified by fieldPaths is used.

Useful when multiple tables are generated and column ordering is not ideal. Field order is not specific in JSON strings so when field order is important, these Regex patterns can be used to control the order.

Note: A field found by an earlier pattern is ordered before fields not found or fields found by a later pattern.

sortPaths

		Paths used to determine sort order	Comma separated list of path references to fields (simple only) to be used to determine how rows will be initially sorted. Paths are relative to the JSON field specified in the path parameter. If specified, JSON array elements will be sorted based on the comparison of field values represented by the paths. The first path is the primary sort value. Subsequent paths are used only if the first comparison is equal. The sort direction is ascending unless the sortDescending is selected. This sorting is done before the HTML is generated for display.
stripQualifiers	false	Strip leading qualifiers from generated headings	Since 6.5. Makes table heading columns look better by stripping leading qualifiers (using a . separator) for names generated as a result of fieldPaths. For example, field.type would be converted to type.
capitalize	true	Capitalize first character of generated headings	Since 6.5. Makes table heading columns look better by capitalizing leading character of names generated as a result of fieldPaths.
output	html	Output format	Determines how the output is formatted. Allowable values are 'html' and 'wiki'. Use 'wiki' to have the data in the table rendered by the wiki renderer.
script	macro body	Location of JSON data	JSON data is taken from the macro body data unless another location is specified by the script or url parameters. ^attachment - Data is read from an attachment to the current page. page^attachment - Data is read from an attachment to the page name provided. space:page^attachment - Data is read from an attachment to the page name provided in the space indicated. Additional options available for Server only. #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified. global page template name - Data is read from a global page template. Special note: How to deal with templates on Confluence 4.3 and later. space:page template name - Data is read from a space template.

^attachment - Data is read from an attachment to the current page.

page^attachment - Data is read from an attachment to the page name provided.

space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

url

		URL to JSON data	Specifies the URL to a JSON file. Use of this parameter may be restricted for security reasons. See your administrator for details.
user

	URL user	User name for URL access via basic authentication.
password

	URL user password	User password for URL access via basic authentication.
timeout

		URL connection timeout	Allows you to set the wait time for URL access for slower connections. Time is specified in milliseconds.
encoding

File encoding

File encoding for an external file if different from the system default handling. Since 4.1.0.

Example: UTF-8.

More ...

columns

	Columns to show	Comma separated list of column names or numbers in any order. Defaults to all columns in existing order. Columns are enumerated starting at 1.
showWiki	false	Show non-formatted version of generated wiki	Use true to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formatting issues. It can also be used to convert JSON to Confluence markup by cut and paste.
escape	false	Escape special wiki characters	When wiki output is requested (output=wiki), some special characters (like '\|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Use true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
macros	false	Render wiki markup macros in body	Set to true to render wiki markup macros found in the body prior to processing as JSON. This is useful to run macros from SCRP, CCLI, SQL, or similar that can produce JSON output.
disableAntiXss	false	Stop encoding of html characters	Server only. Set this parameter to true for csv tables that use output=html and have html content. Html content like <a href=http://google.com>google</a> will only display as a link if this parameter is enabled. Your administrator must grant specific users or groups to use this capability using Macro Security for Confluence.

Versions Compared

Old Version 23

New Version Current

Key

On this page

Basic Use

Screenshot

Parameters

Augment parameters

Common parameters

Page Comparison

Versions Compared

Old Version 23

New Version Current

Key

On this page

Basic Use

Screenshot

Parameters

Augment parameters

Common parameters