Versions Compared

Old Version 1

changes.mady.by.user Maxime Lefebvre

Saved on

compared with

New Version Current

changes.mady.by.user Pascal Perreault [Okapya]

Saved on

Key

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

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

On this page:
Table of Contents
minLevel3
maxLevel3

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.

Info

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 specialJQLfunctions

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 table sections below. And remember — if you are searching for text that contains more than one word, make sure to enclose it in double quotes ("")!

Image Removed InfoCombining JQL functions with the AND operator is different from using the itemSearch() function. Using the AND operator searches for entire checklists that meet all the criteria, while itemSearch() searches for individual items that meet your criteria.Image Added
Note

If these special functions do not appear, your installation may not have Checklist Searcher set as the search template. For more information, see Making checklists searchable.

allItemsChecked()

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

FunctionOperators

Example

Returns all issues in which…

=

DoD = allItemsChecked()

!=

DoD != allItemsChecked()The DoD checklist

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

Operators

Example

=

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

!=

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

Note

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

allItemsUnchecked()

The DoD checklist does not

Returns the checklists that have all their items

checked

unchecked (or not).

Operators

Example

=

DoD = allItemsUnchecked()

!=

DoD != allItemsUnchecked()The DoD checklist

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

Operators

Example

=

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

!=

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

Note

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

allMandatoryItemsChecked()

The DoD checklist does not

Returns the checklists that have all

items unchecked.

their mandatory items checked (or not).

Operators

Example

=

DoD = allMandatoryItemsChecked()

!=

DoD != allMandatoryItemsCheckedThe DoD checklist ()

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

Operators

Example

=

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

!=

DoD != allMandatoryItemsCheckedThe DoD checklist does not have all mandatory items checked("## Section heading name")

Note

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.

DoD <=

Operators

Example

<

DoD > < checklistCompletion("50")

>The DoD checklist has more than 50% of its items checked.

DoD > checklistCompletion("25")

<=

DoD <= checklistCompletion("5075")

The DoD checklist has fewer than 50% of its items checked.>=

DoD >= checklistCompletion("50")

The DoD checklist has more than or exactly 50% of its items checked.

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

Operators

Example

<

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

>

The DoD checklist has fewer than or exactly 50% of its items checked.

itemAssignedToMe()

DoD = itemAssignedToMe()

The DoD checklist has an item assigned to you.

itemDueDate()

DoD = itemDueDate(2021-12-01)

The DoD checklist has an item due on December 1, 2021 (only DoD > checklistCompletion("25", "## Section heading name")

<=

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

>=

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

Note

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

=

DoD = itemAssignedToMe()

itemDueDate()

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

Note

Only the ISO date format is supported

)

.

itemSearch(

Operators

Example

=

DoD = itemDueDate(1d2021-12-01)

The DoD checklist has an item due tomorrow.<

DoD = < itemDueDate("-1w 2d")

The DoD checklist has an item that was due one week and two days ago.>

DoD > = itemDueDate("0d2w") AND

<=

DoD <= itemDueDate("1w1m")

The DoD checklist has an item that is due within the next week (the >, <, >= and <= operators are supported for relational searches).

itemPriority()

DoD = itemPriority(High)

The DoD checklist has an item set to High priority.

>=

DoD >= itemDueDate("3d")

itemSearch()

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

Operator

Fields

Description

Example

=

assignee

The user to whom the item is assigned.

DoD = itemSearch("assignee = ")
DoD = itemSearch("assignee = lucyLucy")
The DoD checklist has an item assigned to LucyDoD = itemSearch("assignee = currentUser()")

Info

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 DoD checklist has an item marked as completedue 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")The DoD checklist has an item due on May 1, 2020.
DoD = itemSearch("dueDate = 1d-1w 2d")The DoD checklist has an item due tomorrow.
DoD = itemSearch("dueDate = -1w 2d3d")

name

The DoD checklist has an item that was due one week and two days ago (within itemSearch, only the = operator is supported for relational searches)name of the item.

DoD = itemSearch("name = Do testing")The DoD checklist has an item named “Do testing”

Note

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

priority

The priority of the item.

DoD = itemSearch("priority = highHigh")

The DoD checklist has an item set to High prioritystatus

The status of the item.

DoD = itemSearch("status = In Progress")

header

The DoD checklist has an item with the “In Progress” status.item’s section heading.

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

Note

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

  • The name “Submit work”;

  • A due date of May 1, 2015;

    • Nobody assigned to it (since the assignee property is blank)
    Info

    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 = ")

    The DoD checklist has an item with ALL of the following:

    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.

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