Searching checklists

To find particular checklists or checklist items, you can use Jira's powerful search feature.

Using Jira’s built-in search tool

Using Jira’s built-in basic searching, you can search for specific text or fields. With advanced searching, you can create JQL queries using more advanced functions.

For more information, see Basic Searching and Advanced Searching in the Atlassian Jira documentation.

To access the search tool:

  1. In the header, go to Issues > Search for Issues.

     

  2. Enter search text in the Contains text field, or click Advanced to enter an advanced search.

Searching checklists using special JQL functions

With Checklist, you also have access to additional search functions to help you find checklists or checklist items that meet advanced criteria.

In the Advanced search bar, a list of possible functions will pop up as soon as you start typing. For details about all the special functions that are available, see the sections below. And remember — if you are searching for text that contains more than one word, make sure to enclose it in double quotes ("")!

If these special functions do not appear, your installation may not have Checklist Searcher set as the search template. For more information, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951629351.

allItemsChecked()

Returns the checklists that have all their items checked (or not).

Operators

Example

Operators

Example

=

DoD = allItemsChecked()

!=

DoD != allItemsChecked()

This alternative returns the checklists in which a particular section has all its items checked (or not).

Operators

Example

Operators

Example

=

DoD = allItemsChecked("## Section heading name")

!=

DoD != allItemsChecked("## Section heading name")

Section heading filters are case sensitive and must include all Markdown syntax.

allItemsUnchecked()

Returns the checklists that have all their items unchecked (or not).

Operators

Example

Operators

Example

=

DoD = allItemsUnchecked()

!=

DoD != allItemsUnchecked()

This alternative returns the checklists in which a particular section has all its items unchecked (or not).

Operators

Example

Operators

Example

=

DoD = allItemsUnchecked("## Section heading name")

!=

DoD != allItemsUnchecked("## Section heading name")

Section heading filters are case sensitive and must include all Markdown syntax.

allMandatoryItemsChecked()

Returns the checklists that have all their mandatory items checked (or not).

Operators

Example

Operators

Example

=

DoD = allMandatoryItemsChecked()

!=

DoD != allMandatoryItemsChecked()

This alternative returns the checklists in which a particular section has all its mandatory items checked (or not).

Operators

Example

Operators

Example

=

DoD = allMandatoryItemsChecked("## Section heading name")

!=

DoD != allMandatoryItemsChecked("## Section heading name")

Section heading filters are case sensitive and must include all Markdown syntax.

checklistCompletion(%)

Returns the checklists that fall within a particular percentage range in terms of completion.

Operators

Example

Operators

Example

<

DoD < checklistCompletion("50")

>

DoD > checklistCompletion("25")

<=

DoD <= checklistCompletion("75")

>=

DoD >= checklistCompletion("50")

This alternative returns the checklists in which a particular section falls within a particular percentage range in terms of completion.

Operators

Example

Operators

Example

<

DoD < checklistCompletion("50", "## Section heading name")

>

DoD > checklistCompletion("25", "## Section heading name")

<=

DoD <= checklistCompletion("75", "## Section heading name")

>=

DoD >= checklistCompletion("50", "## Section heading name")

Section heading filters are case sensitive and must include all Markdown syntax.

itemAssignedToMe()

Returns the checklists in which an item is assigned to you.

Operators

Example

Operators

Example

=

DoD = itemAssignedToMe()

itemDueDate()

Returns the checklists in which an item is due on a particular date or within a particular time range.

Only the ISO date format is supported.

Operators

Example

Operators

Example

=

DoD = itemDueDate(2021-12-01)

<

DoD < itemDueDate("1w 2d")

>

DoD > itemDueDate("2w")

<=

DoD <= itemDueDate("1m")

>=

DoD >= itemDueDate("3d")

itemSearch()

Returns the checklists in which an item meets the specified criteria.

Operator

Fields

Description

Example

Operator

Fields

Description

Example

=

assignee

The user to whom the item is assigned.

DoD = itemSearch("assignee = ")
DoD = itemSearch("assignee = Lucy")
DoD = itemSearch("assignee = currentUser()")

You can use the currentUser() variable to search for an item that is assigned to you as shown above.

completion

The completion status of the item.

DoD = itemSearch("completion = true")

dueDate

The due date of the item, either as a specific date or a length of time in relation to today’s date.

DoD = itemSearch("dueDate = 2020-05-01")
DoD = itemSearch("dueDate = -1w 2d")
DoD = itemSearch("dueDate = 3d")

name

The name of the item.

DoD = itemSearch("name = Do testing")

Name filters are case sensitive and must include all Markdown syntax.

priority

The priority of the item.

DoD = itemSearch("priority = High")

status

The status of the item.

DoD = itemSearch("status = In Progress")

header

The item’s section heading.

DoD = itemSearch("header = ## Section heading name")

Section heading filters are case sensitive and must include all Markdown syntax.

You can string multiple criteria together using commas. For example, the following returns all issues in which at least one item in the checklist meets all three criteria:

DoD = itemSearch("name = Submit work", "dueDate = 2010-05-01", "assignee = ")

Although this functions as an “AND”, the itemSearch() function is different than combining JQL functions with the AND operator. Using the AND operator searches for entire checklists that meet all the criteria, while itemSearch() searches for individual items that meet your criteria.


SERVER documentation (On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.