JQL Table macro - 8.x

JQL Table macro - 8.x

Overview

The JQL Table macro helps users to connect to Jira, query, and display relevant project data in tables. This macro works similar to the native Jira Issues macro and provides the advantages that Advanced Tables for Confluence offers to users.

  • Connect to Jira instances using application links

  • Use JQL to perform basic as well as advanced searches on the specified Jira instance

  • Choose the Jira issue fields to be displayed or use the default set of fields

  • Display Jira issues fields along with images as required

  • Download or export the Jira issues

  • Apply filters to view only the relevant information

  • Leverage the same table styling capabilities as specified in common table capabilities



Available since version 8.3.0.

Basic use

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

Selected from the macro browser

Advanced Tables - JQL Table

Markup shortcut

{jql-table}

Screenshot

Parameters

JQL settings

Macro editor label

Default

Description

Macro parameter

Macro editor label

Default

Description

Macro parameter

Data source

Jira application links



Specify an application link from the list to connect to the required Jira instance. This is a mandatory field!

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 this article to know more about configuring application links to multiple Jira instances.

jiraApplinks

Jira advanced search



Specify a JQL query to search for issues in the selected Jira instance. This is a mandatory field!

  • In this parameter, only JQL statements are allowed unlike the native Jira Issues macro that also allows other variants.

  • 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.".



jiraAdvanceSearch

Data settings

Columns to display



Specify list of Jira issue field names to be displayed in any order. By default, few Jira issue fields are already preselected once Jira application links is specified. The order of the fields and the fields themselves can be removed or changed.

columns

Rows to display

50

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.

rowsToDisplay

Output format

html

Specify how the output is formatted. The options are as follows:

  • html - data is entered as standard HTML directly in the macro body.

  • wiki - data in the table rendered using the wiki renderer.

output

Show result as a table

On

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.

table

Capitalize first character of generated headings

On

Enable this option to make table heading columns look better by capitalizing leading character of names generated. 

capitalize

Show non-formatted version of generated wiki

Off

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.

showWiki

Escape special characters in wiki

Off

Enable this option to allow few special characters to be escaped so that the formatting is unaffected. When wiki output is requested (Output format is set to wiki), some special characters (like '|', '[', ']', '{', '}') in data can cause undesirable formatting of the table. By default, data that has wiki markup is  rendered correctly.

escape

Render wiki style

On

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.

applyWikiStyle

Augment parameters

The Data format tab in JQL settings menu of the editor contains parameters for augments. See Augments for details for modifying column headings and column data.

Common parameters

Example

Other macros

Additional reference

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.

OSZAR »