We have a new documentation site. Please go here to see the latest.

Search & JQL

Owned by Jennifer Choban
Last updated: Feb 05, 2024
4 min read

 

Checklist for Jira 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

 

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.

Checklist for Jira 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.

Empty checklists

"Checklist Text" is EMPTY

All issues without checklist items

Containing given text

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

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

All items in a Skipped status

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

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

Items with the current user mentioned

"Checklist Text[Paragraph]" ~ currentUser()

All issues with items in which the current user is mentioned

All complete items with given text

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

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

 *Assumes statuses are disabled.

All complete items with given text in a given status

"Checklist Text[Paragraph]" ~ "\"* [done] abc\""

All issues with an item that contains "abc" in a DONE status.

Different items in different statuses

"Checklist Text[Paragraph]" ~ "\"* [done] abc\"" AND "Checklist Text[Paragraph]" ~ "\"* [open] def\""

All issues with an item "abc" that is a DONE status and an item "def" that is an OPEN status. 

 

 

Search Checklist Items with User Mention

  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:

    "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