This page describes JQL functionality in the Table Grid Next Generation.
Excerpt | ||
---|---|---|
| ||
JQL search allows you to search for issues by the grid's content. |
You can refer to the table grid data with the help of Jira advanced search. The query returns all issues having a grid with the specified data.
You can search for specific issues by their grid values with Jira advanced search. Table Grid Next Generation is configured to index grid columns by default starting from 1.3.0 version.
Excerpt | ||
---|---|---|
| ||
JQL search allows you to search for issues by the grid's content. |
Note |
---|
If the grid was created in earlier versions 1.20 or lower, you should manually set columns indexing in the configuration. |
...
Note |
---|
To make a column searchable you need to check the Index data checkbox when configuring a column. |
Table of Contents | ||||
---|---|---|---|---|
|
Syntax
Use IN GRIDS as Use in grids
as a JQL function to search by the grid's content. Check Check the syntax below.
Note |
---|
All search values are case sensitive. So, if you have a grid named Grid1 with a column named Column 1, the query and column name in your search query should look like this:
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
issue |
...
in |
...
grids("<grid |
...
custom |
...
field |
...
name>", |
...
"<column |
...
name> |
...
<operator> |
...
<search |
...
value>") |
...
Search by 2 parameters:
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
issue in grids("<grid custom field name>", "<column name> <operator> <search value>","<column name> <operator> <search value>") |
search Search by 2 parametersgrids:
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
issue in grids("<grid custom field name>", "<column name> <operator> <search value>") and issue in grid("<grid custom field name>", "<column name> <operator> <search value>") |
Warning |
---|
All search values are case sensitive. You need to specify it in the same case as it is inside the grid. |
Restricted words and characters
JQL search has a set of reserved characters:
...
If you want to use these characters in your search queries, you need to to:
surround them with quote-marks (you can use either single quote-marks (
'
) or double quote-marks ("
)). For example:Code Block issue in grids(“Grid quotes”, version = "[example]")
if you are searching a text and the character is on the list of reserved characters for text searches, surround them with two backslashes( \\ ). For example:
Code Block issue in grids(“Grid quotes”, ”Summary = \\[Jul 10]\\ - Invoice pending review”)
You can't search for many special characters in text fields using this method.
Reference
Below you find a detailed description of the operators that are used for advanced searching within the grid's content. Each column type supports a set of the operators detailed in the table below.
Column type | Supported operators |
---|---|
String, Textarea |
|
; |
; |
; |
; |
; | |
Integer, Number |
|
; |
; |
; |
; |
; |
; |
; | |
Date, Time, DateTime |
|
; |
; |
; |
; |
; |
; |
; | |
Single Select List, Multi Select List |
|
; |
; |
; |
| |
Checkbox |
|
; |
; |
; |
Userlist |
| |
Formula |
|
; |
; |
|
Examples
Search issues by empty grids
You can search for all issues which contain a grid that is empty or is not empty. The grid is considered empty when it has not been modified.
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
"Grid 1" IS EMPTY |
Search issues by data from the grid
Find all issues which have grid Checklist with a column called Summary and text Onboarding
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Checklist", "Summary~Onboarding") |
...
Find all issues which have grid Shopping order with the column What sandwich that includes text Chicken
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Shopping order", "What sandwich=Chicken") |
...
Find all issues which have grid Testing with the column Summary that equals test and task;
Panel | ||||
---|---|---|---|---|
| ||||
issue |
...
in |
...
grids("Testing", |
...
"Summary=test", |
...
"Summary=task", |
...
"status='open'") |
...
AND |
...
issue |
...
in |
...
grid("Grid2", |
...
"Summary=task") |
Find all issues which have grid Checklist with the checked checkboxes(column name is Done; checked checkbox equals true)
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Checklist", "Done=true") |
...
Find all issues with the Checklist grid which have checkbox column and values are unchecked.
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Checklist", "Done=false") |
Find all issues which have grid Shopping order with the Price greater than 10
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Shopping order", "Price>10") |
Find all issues with Team Workload grid which includes Sales team data. The query helps to find all the workload for a specific team.
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("Team Workload", "Team=Sales") |
...
Find all issues that have a TGE Field grid with the currently assigned user picked in the Assignee column.
Panel | ||||
---|---|---|---|---|
| ||||
issue in grids("TGE Field", "Assignee=currentUser()") |
...