Searching Checklists

Use JIRA's powerful search feature to find specific checklist items or to see which checklists are completed.

Setting up the Checklist Searcher

Starting with Checklist 1.1.0, when creating a new Checklist custom field, the Checklist Searcher will be setup as the default Search Template. However, if you have previously installed Checklist 1.0.0 and created checklists, the custom field will have no associated search template. To make the checklist searchable, Edit the checklist custom field and change the Search Template to the Checklist Searcher.

It is very important to re-index JIRA is you want previously created checklists to be searchable.

Search items containing text

You can search for checklist's items containing specific words. By default, searching from the Basic Search view will look for items containing any of the specified words. This search is case insensitive and will also return items based on the root term of the words. JIRA does not support partial word searches. Refer to the article Performing Text Searches for more details.

Advanced Search

Switch to the Advance Search view to search for particular checklist's statuses. While in the advance search view, you can use the contains operator (~) to search for items containing text but you can also use the equal operator (=) to search for exact text. Notice that the equal operator is case sensitive. Therefore a search such as "Definition of Done" = "Peer Review" will return all issues with "Peer Review" but not the ones with "peer review". When searching for exact text containing more than one word, enclose them in double quotes ("").

Special functions

The Checklist Searcher offers some special functions to find checklists or checklist items with a particular status.

  • allItemsChecked: Use this function with the = and != operator to find all the checklist which have all their items checked. For example, "Definition of Done" = allItemsChecked() will return all the issues where all items of the definition of done have been checked.
  • allMandatoryItemsChecked: Use this function with the = and != operator to find all the checklist which have all their mandatory items checked.
  • checkedItem: Use this function with the = and in() operator to find if a specific item has been checked. For example, "Definition of Done" = checkedItem("Peer Review") will return all the issues where the definition of done has "Peer Review" checked. Note that this is an exact search so it is case sensitive. Also, using the != operator will not return the issues for which "Peer Review" is not checked. It will return the issues which does not contain a "Peer Review" item that is checked. If you want to search for an item which is not checked, use the uncheckedItem function instead.
  • uncheckedItem: Use this function with the = and in() operator to find if a specific item is still unchecked. For example, "Definition of Done" = uncheckedItem("Peer Review") will return all the issues where the definition of done has "Peer Review" still unchecked. Note that this is an exact search so it is case sensitive.