Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Style
code {
    color: #c7254e;
    background-color: #f9f2f4;
    border-radius: 4px
}

This guide shows how to set up and use JQL search.

As far as you knowBy default, JQL helps to search issues in Jira. We've implemented issues search by the grid's contentWith Table Grid, you can search issues by the content of a grid. You can search by the whole string, part of the text, date, time or number. 

To search issues by the grid's data, you should set the grid's column to index data. In order to do that, please check the Index data checkbox in the column configuration. 

Info

To make the search issues by the grid's data, configure the column to index data.

How to set up index data

Prerequisites: configured grid with columns. 

In order to set up the column to index data, please do the following: 

  • Navigate to the Grids list (Add-ons - Grids);
  • Select desired Grid to edit
  • Click on the column to edit its settings;
  • Check the Index Data checkbox;
  • Save column and grid configuration changes.
    Data indexing in a grid will be performed only for configured columns. Please, be sure the column has Index Data checkbox checked
    Note
    Note
    You can search data only for indexed columns. To index data in a column check the Index data checkbox when configuring a column.

    JQL search helper 

    We've implemented a special button that helps you to search by the grid's content.

    Click plugin's icon in the top right corner of the issue navigator page to open the JQL search helper.


     The window pops up and you can type the query.

    Tip

    Make sure that pop-ups are not blocked form displaying in your browser settings.


    Info
    titleJQL search helper query format

    The format of the query in JQL search helper is following: "GRID_NAME"."COLUMN_TITLE" <operator> "search value"


    You can use various JQL operators depending on the data format:

    Column typeData typeOperator
    Date, Time, and DateTimedate

    = , != , > , >= , < , <=, IS , IS NOT , IN , NOT IN

    UserList, String, Formula, TextArea, Sequence text

    ~ , !~

    SingleSelectstring

    = , !=, IS, IS NOT, IN, NOT IN

    Number, Integer 
    number

    = , != , > , >= , <, <=, IS , IS NOT, IN , NOT IN



    The query starts with "GRID NAME"."COLUMN_TITLE" ... As you type, Jira will offer a list of "auto-complete" suggestions based on the context of your query.

    The query looks like this:

    This query will find issues with the status 'Open' in Grid2.  Where Grid2 is "GRID NAME"; Statusis COLUMN_TITLE; = is an operator and Open is a search value.


    Note

    Grid default data and data from an external data source is not indexed until you re-save grid from the issue view.


    Check an example below. It shows how to search by the column value, located in the grid.


    Congratulations! Now you know how to set up and use JQL to search by the grid's column content.  

    Table of Contents