---
title: "JQL Table macro - 8.x"
canonical: "https://support.appfire.com/space/atdc/2911505388/JQL%20Table%20macro%20-%208.x"
format: markdown
---
> Macro (aura-html)

# <span style="color: #000000">Overview</span>

<span style="color: #000000">The </span>*<span style="color: #000000">JQL Table</span>*<span style="color: #000000"> macro helps users to connect to Jira, query, and display relevant project data in tables. This macro works similar to the native </span>*<span style="color: #000000">Jira Issues</span>*<span style="color: #000000"> macro and provides the advantages that </span>*<span style="color: #000000">Advanced Tables for Confluence</span>*<span style="color: #000000"> offers to users.</span>

- <span style="color: #000000">Connect to Jira instances using application links</span>
- <span style="color: #000000">Use JQL to perform basic as well as advanced searches on the specified Jira instance</span>
- <span style="color: #000000">Choose the Jira issue fields to be displayed or use the default set of fields</span>
- <span style="color: #000000">Display Jira issues fields along with images as required</span>
- <span style="color: #000000">Download or export the Jira issues</span>
- <span style="color: #000000">Apply filters to view only the relevant information</span>
- <span style="color: #000000">Leverage the same table styling capabilities as specified in</span> [common table capabilities](https://appfire.atlassian.net/wiki/spaces/atdc/pages/2911505649)

> ✅ <span style="color: #000000">Available since version 8.3.0.</span>

# <span style="color: #000000">Basic use</span>

<span style="color: #000000">This macro can be deployed using one of the following methods:</span>

| <span style="color: #000000">Selected from the macro browser</span> | *<span style="color: #000000">Advanced Tables - JQL Table</span>* |
| --- | --- |
| <span style="color: #000000">Markup shortcut</span> | *<span style="color: #000000">{jql-table}</span>* |

<span style="color: #000000">Screenshot</span>

![Advanced Tables for Confluence Data Center JQL Table macro configuration](media://2287044d-0b49-4f11-b48a-221c8c951309)

# <span style="color: #000000">Parameters</span>

### **<span style="color: #000000"><u>JQL settings</u></span>**

| Macro editor label | Default | Description | Macro parameter |
| --- | --- | --- | --- |
| **<span style="color: #000000"><u>Data source</u></span>** |
| <span style="color: #000000">Jira application links</span> |  | <span style="color: #000000">Specify an application link from the list to connect to the required Jira instance. </span>*<span style="color: #000000">This is a mandatory field!</span>*<br><span style="color: #000000">Application links are used to create a direct link to an Atlassian application (in this case, Jira) with Confluence to render appropriate data on Confluence pages. Refer to </span><span style="color: #000000">[this article](https://appfire.atlassian.net/wiki/spaces/atdc/pages/2911505066)</span><span style="color: #000000"> to know more about configuring application links to multiple Jira instances.</span> | jiraApplinks |
| <span style="color: #000000">Jira advanced search</span> |  | <span style="color: #000000">Specify a JQL query to search for issues in the selected Jira instance. </span>*<span style="color: #000000">This is a mandatory field!</span>*<br>> ⚠️ - <span style="color: #000000">In this parameter, </span>*<span style="color: #000000">only JQL statements are allowed</span>*<span style="color: #000000"> unlike the native </span>*<span style="color: #000000">Jira Issues</span>*<span style="color: #000000"> macro that also allows other variants.</span>
> ⚠️ - <span style="color: #000000">If incorrect JQL is provided, an error is shown as "The Jira server did not understand your search query. If you entered JQL, please ensure that its correctly formed.</span><span style="color: #172b4d">".</span> | jiraAdvanceSearch |
| **<span style="color: #000000"><u>Data settings</u></span>** |
| <span style="color: #000000">Columns to display</span> |  | <span style="color: #000000">Specify list of Jira issue field names to be displayed in any order. By default, few Jira issue fields are already preselected once </span>*<span style="color: #000000">Jira application links</span>*<span style="color: #000000"> is specified. The order of the fields and the fields themselves can be removed or changed.</span> | <span style="color: #000000">columns</span> |
| <span style="color: #000000">Rows to display</span> | *<span style="color: #000000">50</span>* | <span style="color: #000000">Specify the number of Jira issues to be displayed in the table. If the Jira issues to be displayed exceed this number, a message below the table that shows the total number of issues that were fetched, and also displays a link that opens the JQL query in Jira directly.</span> | rowsToDisplay |
| <span style="color: #000000">Output format</span> | *<span style="color: #000000">html</span>* | <span style="color: #000000">Specify how the output is formatted. The options are as follows:</span><br>- *<span style="color: #000000">html</span>*<span style="color: #000000"> - data is entered as standard HTML directly in the macro body.</span>
- *<span style="color: #000000">wiki</span>*<span style="color: #000000"> - data in the table rendered using the wiki renderer.</span> | <span style="color: #000000">output</span> |
| <span style="color: #000000">Show result as a table</span> | <span style="color: #000000">On</span> | <span style="color: #000000">Disable this option to display the data as plain text without any whitespace or column delimiters. By default, the Jira issues data is rendered in a tabular format. </span> | <span style="color: #000000">table</span> |
| <span style="color: #000000">Capitalize first character of generated headings</span> | <span style="color: #000000">On</span> | <span style="color: #000000">Enable this option to make table heading columns look better by capitalizing leading character of names generated. </span> | <span style="color: #000000">capitalize</span> |
| <span style="color: #000000">Show non-formatted version of generated wiki</span> | <span style="color: #000000">Off</span> | <span style="color: #000000">Enable this option 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 the data to Confluence markup by cut and paste.</span> | <span style="color: #000000">showWiki</span> |
| <span style="color: #000000">Escape special characters in wiki</span> | <span style="color: #000000">Off</span> | <span style="color: #000000">Enable this option to allow few special characters to be escaped so that the formatting is unaffected. When wiki output is requested (O</span>*<span style="color: #000000">utput format</span>*<span style="color: #000000"> is set to </span>*<span style="color: #000000">wiki</span>*<span style="color: #000000">), some special characters (like '</span>**|**<span style="color: #000000">', '</span>**[**<span style="color: #000000">', '</span>**]**<span style="color: #000000">', '</span>**{**<span style="color: #000000">', '</span>**}**<span style="color: #000000">') in data can cause undesirable formatting of the table. By default, data that has wiki markup is  rendered correctly.</span> | <span style="color: #000000">escape</span> |
| <span style="color: #000000">Render wiki style</span> | On | <span style="color: #000000">Enable this option to render the wiki markup for Jira multi-line text fields. Render wiki style resolves the display format of the value of Jira multi-line text fields.</span> | <span style="color: #000000">applyWikiStyle</span> |

## <span style="color: #000000">Augment parameters</span>

<span style="color: #000000">The </span>*<span style="color: #000000">Data format</span>*<span style="color: #000000"> tab in </span>*<span style="color: #000000">JQL settings</span>*<span style="color: #000000"> menu of the editor contains parameters for augments. See</span> [Augments](https://appfire.atlassian.net/wiki/spaces/atdc/pages/2911506473) <span style="color: #000000">for details for modifying column headings and column data.</span>

## <span style="color: #000000">Common parameters</span>

> Macro (include)

# <span style="color: #000000">Example</span>

> Macro (children)

# <span style="color: #000000">Other macros</span>

> Macro (children)

# <span style="color: #000000">Additional reference</span>

- <span style="color: #000000">[Link to specific Jira instances using application links](https://appfire.atlassian.net/wiki/spaces/atdc/pages/2911505066)</span>