JQL Search
Smart Checklist supports JQL as an approach for searching checklist items values and checklist progress ๐
To use this functionality you may need to set up "Checklists" or "Smart Checklist Progress" custom field. It depends on what main criteria you'd like to search for.
ย
Contents ๐๐ป
ย
Guide to set up custom fields:
๐ข Company-managed projects:
๐ฅ Next-gen projects:
โ๐ผ NOTE: If you are using the next-gen project, make sure that the added custom fields has a global context. To add global context to your custom fields, follow the official Atlassian guide.
ย
Search examples:
๐ Search by checklist progress:
JQL Search option | JQL query |
|---|---|
Issues with opened checklists (not all checklist items completed) |
ย |
Issues with ALL completed checklists |
|
Issues where there is at least one completed (checked) checklist item |
|
Issues where all checklist items are open (unchecked) |
|
Issues where there is at least one open checklist item |
|
Issues where all checklist items are completed |
|
๐ Search by checklist items:
JQL Search option | You type |
|---|---|
Search for checklists containing specific items |
|
Search for an exact phrase in the checklist items or exact checklist items |
|
Search by number of items |
|
โ๐ผ Note: Available operators could be used: >, >=, <, <=, =, !=. | |
Search by not empty or empty checklists cHECKLISts FIElD required |
or
|
Search by a specified due date or related dates |
|
โ๐ผ Note: Date format used in JQL search should match the date format in the checklist item. | |
Search by checklist items in the particular status |
|
โ๐ผ Note: Use default status (Todo, Done, Skipped, and In Progress) or custom statuses. Text is case insensitive, so DONE, Done, or done will return the same results. | |
Search by particular checklist items in the particular status |
|
โ๐ผ Note: Search works only for an exact match of the value in To search for the same item in different statuses use OR operator: Text is case sensitive, so only Done, Todo, Skipped, In Progress will return the same results. |
ย
๐๐ฝโโ๏ธ Search by checklist assignees:
JQL Search option | You type |
|---|---|
Search by currently logged user |
|
Search by any user |
|
โ๐ผ Note: donโt use โ@โ symbol | |
Search by custom mention |
|
ย
๐ JQL combinations for more accurate searches:
Operator | JQL Search option | You type |
|---|---|---|
AND | Search for not competed checklists with specific number of items |
|
Search for not competed checklists with a specific due date |
| |
Search for not completed checklists which contains specific items |
| |
Search for checklists with mentioned current logged user and due date |
| |
Search for checklists with items in the particular status and due date |
| |
OR | Search for checklists with items in particular statuses |
|
will return checklists that includes items with in progress or todo statuses | ||
Search for checklists with mentions of current logged user and somebody else |
| |
will return checklists that includes mentions of the current logged user or somebody else |
โ๐ผ NOTE: If you use combinations of search options (for dates, assignees, and statuses) - search will be done for the whole checklist not for the specific checklists items. If checklist items are found based on the search criteria (one contains the date, another is in needed status, another one has the assignee) - the Issue will be returned in the search results.
ย
NOTE: At this moment, searching for Jira issues where a specific checklist item has completed/ incompleted status is unavailable.ย This happens due to the following limitation:ย Jira does not index the special character of - and +.ย
Special characters
+ - & | ! ( ) { } [ ] ^ ~ * ? \ :
Special characters aren't stored in the index, which means you can't search for them. The index only keeps text and numbers, so searching for "\\[Jira Software\\]"ย andย "Jira Software"ย will have the same effect - escaped special characters ([]) will be ignored in the search.Source:ย Search syntax for text fields | Atlassian Support | Atlassian Documentation
ย
Hope everything works for you! ๐