Issue List Macro

Jump to a Topic

What is the Issue List macro?

Issue List is a new Custom Charts macro that allows users to generate a list of Jira issues on their Confluence page.

 

Adding the Issue List Macro to a Page

Custom Charts Issue List is a separate macro from the Custom Charts macro and the Custom Charts Simple Search macro. To add it to your page:

  1. Edit your Confluence page by typing “e” on your keyboard, or, by clicking the pencil icon at the top of your Confluence page

  2. Type “/” on your keyboard or click the + dropdown in the page header and search for Custom Charts. Select Custom Jira Charts - Issue List

  3. In the pop-up, adjust the following settings to customize the Issue List:

    1. Source: Controls the Jira issues that appear in the Issue List

    2. Columns: Controls the fields that appear for each Jira issue in the Issue List. Fields will appear as separate columns on the Issue List (similar to their appearance in the Issue Navigator in Jira)

      1. Fields will be selected by default, but you can add additional fields by clicking + Add Another Field at the bottom of the list of fields

Setting up Issue List

To see how your configuration will look once the macro is published, use the Live Preview on the left side of the Editor

Source

The Source controls the Jira issues that appear in the Issue List macro.

  1. Projects: allows you to choose specific Jira project(s) to pull issues in from

  2. Saved filters: allows you to pull in issues based off any Jira filters you’ve already created

  3. Advanced (JQL): allows you to pull in issues based off custom JQL written directly within the macro

  4. Simple Search macro: allows you pull in issues based of criteria set in a Simple Search macro - you must have already inserted and customized the Simple Search macro on the page for it to be an available option

Columns

Columns control the fields that appear for each Jira issue in the Issue List. Fields will appear as separate columns on the Issue List (similar to their appearance in the Issue Navigator in Jira). Jira system fields and custom fields can be added, including 3rd party application fields (full list of integrations here).

 

Adding Fields (Columns)

  1. Once in Edit mode in the macro, navigate to the Columns section on the right. At the bottom of the “Columns” section, click + Add another field

  2. In the “Select field” dropdown, type the name of the Jira field you wish to add. Click the field to add it to your chart and see it in the Live Preview on the left

  3. Click Save, then publish your Confluence page. The field will be added as a new column in the macro.

Removing Fields

 

  1. Once in Edit mode in the macro, navigate to the Columns section on the right. Find the name of the field you want to remove

  2. To the far right of the field, click the trash can icon

  3. Click Save to lock in your changes

  4. Republish the page and the field no longer appears in the macro

Renaming Fields

 

  1. Once in Edit mode in the macro, navigate to the Columns section on the right. Find the name of the field you want to rename

  2. To the far right of the field, click the pencil icon and type in the name you want to be shown for the column

  3. Click Save to lock in your changes

  4. Republish the page and the field displays with the new name

Issue List Display Options

Chart options

 

  • Results per page dropdown: Adjusts the amount of issues that appear on each page of the Issue List macro

Description Options

(Only visible when the description is not empty)

Description

Description Options

(Only visible when the description is not empty)

Description

Show description

Hide the description from displaying

This can be used to keep notes on the configuration or design without showing it to users on the saved list

Description position

Choose where the description is displayed

  • Top

  • Bottom

The Live Preview in the editor always shows Bottom

User Impersonation Options (Confluence only)

Description

User Impersonation Options (Confluence only)

Description

Show impersonation user under chart

Hide the "Data loaded as" label at the bottom of the macro

Allow click-through (requires Jira access)

Allow users to click through to the underlying Jira issues

This requires the user to have access to Jira as all Jira permissions are respected

General Options

Description

General Options

Description

Number format

Choose the number format to display

  • 123456.78

  • 123,456.78

  • 123.456,78

  • 123'456.78

  • 123'456,78

Decimal places

Choose the decimal places to display

  • 0

  • 1

  • 2

  • 3

  • 4

Auto refresh every <x>

When selected, the issue data will automatically refresh at the time interval set in the Custom Charts admin settings

Show options menu button

  • Allow direct export to PNG, PDF & CSV

When selected, a vertical set of 3 dots will appear in view mode that, when clicked, shows a menu with the following options:

  • Refresh data

  • Dark mode

  • *Export PNG

  • *Export PDF

  • **Export CSV

*Only shows these options if “Allow direct export to PNG, PDF & CSV” is enabled. If this is disabled, it removes the export options from the list in view mode

**Not available on Issue List

Dark Mode

Changes the theme to dark mode.

Show chart border (Confluence only)

Displays a border around the Confluence macro