JQL Mode

Owned by Rosen Marinkov
Last updated: Jul 17, 2023 by Julver Petrova (Deactivated)
3 min read

 

On this page:

Overview

The Issue Matrix panel will show only the issues returned by the JQL script specified in the JQL Section in JQL mode.

The different configuration options in this mode are organized into the following groups:

  • Data

  • Display

  • Locations

Data

JQL Section

In the JQL section, you can specify a JQL script to return a list of issues. The Issue Matrix panel will show only issues returned by the JQL Script. No issues will be displayed if the JQL field is empty or the JQL script is not valid.

JQL Extension

JQL Extension is available since version 2.4.0.

The Issue Matrix JQL Extension can be used to compare issue fields with the values stored in the currently viewed issue. For a complete guide with examples, see the JQL Extension documentation page.

Column Selection

Any of the available issue custom fields can be added to the list of columns visualized in the Issue Matrix panel. The field value visualized will be the same as in the Issue Navigator.

Adding a progress bar

If you want to have a progress bar in your matrix, you should add the Σ Progress field as a column. If you don't see it in the field selector, you will need to enable time tracking for your Jira instance first. To do that, go to Settings > Issues > Time tracking and click the “Activate” button.

You can specify the width of the columns you add to the Issue Matrix table. See the Customizable Column Width page for more information.

Customizable Column Header (since v2.8.0): You can specify the header of each column you add to the Issue Matrix table. If you want to have column headers adapted to your use cases, set the headers when you configure the Issue Matrix columns. When you choose a field from the list to be added as a column to the Issue Matrix table, the column header is set by default to the custom field's name. If you want to revert to the default header of a column, delete the contents in the Header column of the configuration.

Sort By Selection

There isn't a Sort by configuration option for the JQL mode. If required, the sorting can be included in the JQL script.

Display

Visualization settings control how the Issue Matrix panel will be visualized. Additionally, the default Sub-task panel can be hidden to avoid showing the same sub-tasks twice.

Table Visualization

The visualization options for the Issue Matrix table are:

  1. Show Table Headers
    When this option is checked, the Issue Matrix panel will visualize the fields configured in the Column selection as Table Header.

  2. Show Empty Table
    When this option is checked, the Issue Matrix will be shown even if there are no issues. This allows adding new sub-tasks directly to the issue.

Limit the number of shown issues (since v2.1)

Set the number of issues shown by default in an Issue Matrix table. After clicking on the "Show more..." link, the remaining issues will be shown. To remove the limit, choose All or set the Selected entry to 0.

Jira Panels

The visualization options for the Jira panels are:

  1. Hide Sub-Tasks
    When this option is checked, the default Sub-Task panel will be hidden on the Issue View screen.

  2. Hide Issue Links
    When this option is checked, the default Linked Issues panel will be hidden on the Issue View screen.

  3. Hide Issues in Epic
    When this option is checked, the default panel showing all stories linked to an issue of type Epic will be hidden on this Epic issue View screen.

Locations

You can configure the locations in Jira where you want to show the Issue Matrix. Configure the visualization of the Issue Matrix in the Issue Navigator and Agile Boards.