Versions Compared

Key

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

...

JQL function

Usage Example

allItemsClosed()

Search for issues where ALL checklist items are Closed

"Smart Checklist" = allItemsClosed()

allItemsOpen()

Search for issues where ALL checklist items are Open

"Smart Checklist" = allItemsOpen()

progress(operator,percent)

Status
colourRed
titlewill be deprecated soon

Search for checklists by Progress

"Smart Checklist" = progress(">","15")

Available operators: >, <, >=, <=, =

Use percent value from 0 to 100

Panel
bgColor#FFFAE6

☝🏼NOTE: Smart Checklist all available operators: >, <, >=, <=, = will be put out of the brackets soon. We will notify you via email about JQL changes but recommend to already use the following syntax:
"Smart Checklist" > progress("80")

progress(percent)

Status
colourGreen
titlenew syntax

itemStatus(item name, status) using = operator

Search for particular checklist items in a particular status

"Smart Checklist" = itemStatus("PR review completed", "DONE")

Search for particular checklist items in a particular statuses

"Smart Checklist" = itemStatus("PR review completed", "DONE, IN PROGRESS")

Search for checklists that contain particular checklist item

"Smart Checklist" = itemStatus("PR review completed", "*")

itemStatus(item name, status) using ~ operator

Since version 6.1.0 Smart Checklist “~“ (LIKE operator) could be used for search with this function.

  • Search for checklist items containing search term for the item name in a particular status

"Smart Checklist" ~ itemStatus("requirements", "TO DO") - will find all checklist items containing this search term in status TO DO (It will find e.g. Requirements update, Follow the requirements, test Cases should include verification of requirements specified in this documentation, Security Requirements)

  • Search for checklist items containing search term for the item name in a particular statuses

"Smart Checklist" ~ itemStatus("requirements", "DONE, IN PROGRESS") - will find all checklist items containing this search term in status DONE and IN PROGRESS (It will find e.g. Requirements update, Follow the requirements, test Cases should include verification of requirements specified in this documentation, Security Requirements)

  • Search for checklist items containing search term for the item name in any status

"Smart Checklist" ~ itemStatus("Requirements", "*") - will find all checklist items containing this search term in any status (It will find e.g. Requirements update, Follow the requirements, test Cases should include verification of requirements specified in this documentation, Security Requirements)

  • Search for checklist items could include in item name - simple text, data, assignee

"Smart Checklist" ~ itemStatus("YYYY-MM-DD @username", "DONE") - will find all checklist items containing specified due date and assignee in status DONE

itemAssignee(name)

Search for Assignee(s) mentioned in checklist item

  • example: "Smart Checklist" = itemAssignee("john","john.smith","currentUser()")

Allowed parameters

  • username - as defined in Jira User’s profile, e.g. “john”

  • display name - Full name from User’s profile, e.g “john.smith”

  • currentUser() - currently logged user. You can use it to create a shared filter with a JQL function that users of your instance could benefit of.

itemDate(Date)

Search for:

  • fixed Date, indicated in checklist item

  • example in format yyyy-mm-dd

Example: "Smart Checklist" = itemDate("2020-01-01")

Allowed formats

  • yyyy-mm-ddJira date functions: StartOfDay(), endOfDay(), now(), startOfMonth(), endOfMonth(), startOfWeek(), endOfWeek(), startOfYear(), and endOfYear()

Example: "Smart Checklist" = itemDate("now()") - find issues with checklist items with today’s due date

Note

The “itemDate” function accepts dates entered in ISO format only

itemDate(RelativeDate)

Search by Relative Date

  • example "Smart Checklist" <= itemDate("0d")

    • read: item has date set (due date) for tomorrow

Allowed parameters: [n]d, [n]w, -[n]d, [-n]w

  • ItemDate("0d") - today

  • ItemDate("1d") - tomorrow

  • ItemDate("-1d") - yesterday

  • ItemDate("1w") - 1 week since now

  • ItemDate("2w 4d") - 2 weeks and 4 days since now

  • ItemDate("-3w 2d") - 3 weeks and 2 days ago

Search for date in between of time range:

"Smart Checklist" >= itemDate("0d") AND "Smart Checklist" < itemDate("2w")

read: search for the checklist item that has date set between today and 2 week ahead

itemStatusDateAssignee(status, date, name)

Status
colourGreen
titleNEW

Search for checklist items with assignee, date and in a particular status

Allowed parameters:

  • assignee - can be username or display name:

    • username - as defined in Jira User’s profile, e.g. “john”

    • display name - Full name from User’s profile, e.g “john smith”

    • currentUser() - currently logged user.

  • status - case-sensitive, for proper search you should use uppercase letters, e.g. TO DO

  • date - can be a due date with a specific format or a Jira date function

    • yyyy-mm-dd - exact date in format

    • StartOfDay(), endOfDay(), now(), startOfMonth(), endOfMonth(), startOfWeek(), endOfWeek(), startOfYear(), and endOfYear() - supported functions

Examples:

  • "Smart Checklist" = itemStatusDateAssignee("IN PROGRESS", "now()", "currentUser()") - find issues with checklist items assigned to the logged-in user in "IN PROGRESS" status due by today

  • "Smart Checklist" = itemStatusDateAssignee("TO DO", "2024-11-28", "john")- will find all checklist items where john user is mentioned, date 2024-11-28 is set and item status is TO DO

  • "Smart Checklist" = itemStatusDateAssignee("TO DO", "*", "john smith") - will find

all
  • issues with TO DO checklist items

where
  • assigned to john user is mentioned

, any or no date is set and item status is TO DO
  • "Smart Checklist" = itemStatusDateAssignee("TO DO, DONE", "2024-11-28", "*")- will find all checklist items where any or no user is mentioned, date 2024-11-28 is set and item status is TO DO

Allowed parameters

  • assignee - can be username or display name:

    • username - as defined in Jira User’s profile, e.g. “john”

    • display name - Full name from User’s profile, e.g “john smith”

  • status - case-sensitive, for proper search you should use uppercase letters, e.g. TO DO"Smart Checklist" = itemStatusDateAssignee("TO DO", "startOfDay(-1)", "currentUser()")- will find issues with overdue checklist items assigned to the logged-in user as having a due date before the current day.

For versions 4.16.0 and below

...