Search & JQL

Issue Checklist offers following built-in search functions from the … menu on the checklist. These functions redirects to Issue Search page and can be combined with other JQL clauses (see examples below).

 

Built-in search includes:

Function

JQL Expression(s)

Returns

Function

JQL Expression(s)

Returns

Any items

hasChecklistItems = "true"

or

checklistItemsCount > 0

All issues with checklists items

Complete items

hasActiveChecklistItems = "true"

or

activeChecklistItems > 0

All issues with incomplete checklists items

Item text

checklistItems ~ "example checklist item text you want to search for"

All issues with items that match inputted text

 

Note that the built-in Item text search will not work if the View Checklist permission is enabled. In that case, go directly to the issue search screen and insert the appropriate JQL.

Issue Checklist uses issue entity properties to provide perform JQL searches. Therefore, if a jira.permission.* workflow property is set on a workflow step, the search will fail.

Example JQL Expressions

You can use the following fields and functions to search for issues using JQL:

  • activeChecklistItems

  • checklistItemsCount

  • hasActiveChecklistItems

  • Checklist Text custom field

Read more about searching for issues in Jira.

A JQL query can be saved as a filter and displayed in a dashboard using the Filter Results Gadget

Function

JQL Expression(s)

Returns

Function

JQL Expression(s)

Returns

A given number of checklist items

checklistItemsCount = 3

All issues with a 3 checklist items

A relative number of incomplete checklist items

activeChecklistItems > 3

All issues with more than 3 incomplete checklist items

Completed or deleted checklists

hasActiveChecklistItems = "false"

All issues with completed checklists or checklists that have been deleted.

The expressions below use the Checklist Text custom field. Therefore the Save checklist data to Jira custom fields global setting must be enabled. 

Empty checklists

"Checklist Text" is EMPTY

All issues without checklist items

Containing given text

"Checklist Text" ~ "abc"

All issues with a checklist item(s) containing “abc”

All items in a Skipped status

"Checklist Text" ~ "\\[skipped\\]"

All issues with a checklist item(s) in a skipped status.

*Assumes statuses are enabled.

Due to a bug in Jira bug, the queries below return broader results than expected. Vote for a fix at JRACLOUD-21372

All complete items with given text

"Checklist Text" ~ "\\[x\\] abc"

All issues with a completed item that contains "abc".

 *Assumes statuses are disabled.

All incomplete items with given text

"Checklist Text" ~ "\\[\\] abc"

All issues with an incomplete item that contains "abc".

 *Assumes statuses are disabled. 

Complete items with given text AND incomplete items with alternative text

"Checklist Text" ~ "\\[x\\] abc" and "Checklist Text" ~ "\\[\\] def"

All issues with an item "abc" that is checked (complete) and an item "def" that is unchecked (incomplete). 

 *Assumes statuses are disabled. 


Search Checklist Items with User Mention

User Account ID is a unique non-PII identifier of a user. Read how to find user account ID or read more about GDPR and Atlassian Account ID.

  1. Open the user’s profile page and copy the Atlassian Account ID from the browser address URL

  2. Go to the Advanced tab of the Jira Search page.

  3. Type following JQL statement in the search box (replacing user-account-id) and press Enter:

    1 "Checklist Text" ~ "\"@user-account-id\""

 

Show Checklist Progress in Search Issues View

You can also show Checklist Progress (or another checklist custom field such as Checklist Progress % or Checklist Completed) in your Jira search results.

  1. From the Search view, click on the Columns dropdown.

  2. Select Checklist Progress or whichever checklist field you want to include.

  3. Click Done.

Troubleshooting