issueMatrix JQL Function

Owned by Rosen Marinkov
Feb 17, 2023
2 min read

 

On this page:

Overview

As part of the Issue Matrix for Jira features, you can use the issueMatrix JQL function. It will return all issues shown by a given Issue Matrix field for a particular issue.

The issueMatrix function takes two parameters - the issue key and the name of the Issue Matrix field:

Syntax

issueMatrix(issuеKey, issueMatrixFieldName)

Supported fields

Issue

Supported operators

IN , NOT IN

Unsupported operators

= , != , ~ , !~ , > , >= , < , <= IS , IS NOT , WAS , WAS IN , WAS NOT , WAS NOT IN , CHANGED

Examples

  • Find all issues from the Documentation Tasks matrix for the issue with key "CLOUD-1"

    issue in issueMatrix("CLOUD-1", "Documentation Tasks")



  • Find all open issues from the Development Tasks matrix for the issue with key "CLOUD-1"

    issue in issueMatrix("CLOUD-1", "Development Tasks") AND status = Open

 

Use Cases

Let's explore some of the use cases of this Matrix-specific JQL function.

Advanced Searching

You can use the issueMatrix function in advanced Jira search operations with JQL. For more information, check the Advanced searching Atlassian document.

 

Bulk Operations

A great way to leverage the issueMatrix benefits is to use it with Jira Issue Navigator's Bulk Change (Bulk Operations) feature. With Bulk Operations, you can Edit/Move/Transition/Delete/Watch/Stop Watching multiple issues simultaneously in your Jira (for more information on Bulk Operations read Modifying Multiple (Bulk) Issues Atlassian document).

Go to the Issue Navigator in your Jira and switch to Advanced search (check the Advanced searching Atlassian document). For example, you can filter all the open Documentation Tasks/Development Tasks/QA Tasks from a story (if you have such a Matrix in the story) in Jira advanced searching and then apply Bulk Change to all the tasks simultaneously. 

 

Confluence→Jira Integration

If you would like to show issues from Issue Matrix on a page in your Confluence site, you can use the Confluence Jira Issue/Filter Macro in combination with the issueMatrix JQL function. First, make sure that your Confluence site is connected to your Jira server (for more information on the Confluence→Jira integration, read the Jira Issue Macro Atlassian document).

When you use the issueMatrix function in the Jira Issues Macro, all issues from the given Issue Matrix table for the specific issue, are visible in your Confluence page.

Insert a Jira Issue/Filter Macro in a Confluence page and then use the issueMatrix function like the example on the screenshot.

Â