Versions Compared

Old Version 10

changes.mady.by.user Alina Kachan

Saved on

compared with

New Version Current

changes.mady.by.user Olena Brazhko

Saved on

Key

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


...

Insert excerpt
Get Started
Get Started
namecontent-at-the-top
nopaneltrue

Tip

Smart Checklist supports JQL as an approach for searching checklist items values and checklist progress 🚀

Info

To use this functionality you may need to set

-

up "Checklists"

custom field,

or "Smart Checklist Progress" custom field. It depends on what main criteria you'd like to search for.

Smart Checklist supports JQL as an approach for searching checklist items values and checklist progress.

If you set up "Checklists" (multi-line text field) and "Smart Checklist Progress" (single-line text field) which are both custom fields - you can easily apply all JQL search patterns.

Search examples

...

Contents 👇🏻

Table of Contents

Guide to set up custom fields:

🏢 Company-managed projects:

👥 Next-gen projects:

Panel
bgColor#DEEBFF

☝🏼 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)

...


Status
colourBlue
titleSmart cHECKLISt progress
Status
colourBlue
titleFIELD required

"Smart Checklist Progress" ~ "-Done"

Image Removed

...

Issues with ALL completed checklists

...


Status
colourBlue
titleSmart cHECKLISt progress
Status
colourBlue
titleFIELD required

"Smart Checklist Progress" ~ "Done"

...

Image Removed

  • To search for all issues that contain checklists on your instance:
    • Type in in JQL: "Checklists" (or cf[CustomFieldID]) is not EMPTY 

Image Removed

  • To search for checklists containing specific items:
    • Type in in JQL: "Checklists" (or cf[CustomFieldID]) ~ "your item value":

Image Removed

...

Issues where there is at least one completed (checked) checklist item

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].hasClosedChecklistItems = 'true'

Issues where all checklist items are open (unchecked)

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].hasClosedChecklistItems = 'false'

Issues where there is at least one open checklist item

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].hasOpenChecklistItems = 'true'

Issues where all checklist items are completed

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].hasOpenChecklistItems = 'false'

🗒 Search by checklist items:

JQL Search option

You type

Search for checklists containing specific items

Status
colourBlue
titlecHECKLISts FIElD required

"Checklists" ~ "your item value"
or
"cf[Checklists CustomFieldID] ~ "your item value"

Search for an exact phrase in the checklist items or exact checklist items

Status
colourBlue
titlecHECKLISts FIElD required

"Checklists" ~ "\"your item value\""
or
cf[Checklists CustomFieldID] ~ "\"your item value\"

Search by number of items

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].totalChecklistItems > 5

☝🏼 Note: Available operators could be used: >, >=, <, <=, =, !=.

Search by not empty or empty checklists

Status
colourBlue
titlecHECKLISts FIElD required

"Checklists" is not EMPTY

or

"Checklists" is EMPTY

Search by a specified due date

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].itemsDates ~ '2022-11-11'

☝🏼 Note:
Allowed formats: YYYY-MM-DD, YYYY/MM/DD, DD/MM/YYYY, DD-MM-YYYY.

Panel
bgColor#DEEBFF

Date format used in JQL search should match the date format in the checklist item.

If you are searching for a date: '2022-11-11', it will only match for '2022-11-11', not for '2022/11/11', '11/11/2022' or any other.

Search by checklist items in the particular status

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].itemsStatus ~ 'Todo'

☝🏼 Note:
The query returns all the issues where there is at least one checklist item in Todo status.

Use default status (Todo, Done, Skipped, and In Progress) or custom statuses.

Panel
bgColor#DEEBFF

Text is case insensitive, so DONE, Done, or done will return the same results.

🙋🏽‍♂️ Search by checklist assignees:

JQL Search option

You type

Search by currently logged user

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].assignees ~ currentUser()

Search by any user

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].assignees ~ UserId

☝🏼 Note: don’t use “@” symbol

Search by custom mention

Status
colourPurple
titleno fields required

issue.property[SmartChecklist].assignees ~ HRTeam (or your 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

"Smart Checklist Progress" ~ "-Done" AND issue.property[SmartChecklist].totalChecklistItems > 5

Search for not competed checklists with a specific due date

"Smart Checklist Progress" ~ "-Done" AND issue.property[SmartChecklist].itemsDates ~ '2022-11-11'

Search for not completed checklists which contains specific items

"Smart Checklist Progress" ~ "-Done" AND "Checklists" ~ "your item value"

Search for checklists with mentioned current logged user and due date

issue.property[SmartChecklist].assignees ~ currentUser()
AND issue.property[SmartChecklist].itemsDates ~ '2023-08-01'

Search for checklists with items in the particular status and due date

issue.property[SmartChecklist].itemsStatus ~ 'Todo' AND issue.property[SmartChecklist].itemsDates ~ '2023-08-01'

OR

Search for checklists with items in particular statuses

issue.property[SmartChecklist].itemsStatus ~ 'Todo' OR issue.property[SmartChecklist].itemsStatus ~ 'In progress'

will return checklists that includes items with

Status
colourBlue
titlein progress
or
Status
titletodo
statuses

Search for checklists with mentions of current logged user and somebody else

issue.property[SmartChecklist].assignees ~ currentUser()
AND issue.property[SmartChecklist].assignees ~ UserId

will return checklists that includes mentions of the current logged user or somebody else

Panel
bgColor#FFFAE6

☝🏼 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 checklists items are found based on the search criteria (one contain date, another is in needed status, another has assignee) - the issue will be returned in the search results.

Panel
panelIconId02bb3914-523b-462e-b664-308e4c1684f6
panelIcon:jira:
panelIconText:jira:
bgColor#DEEBFF

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 +. 

...

Code Block
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: https://confluence.atlassian.com/jirasoftwareserver0712/search-syntax-for-text-fields-959315338.html

Hope everything works for you! 🚀

Insert excerpt
SupportSupport
Get Started
Get Started
namesupport-email
nopaneltrue