0% found this document useful (0 votes)
218 views32 pages

Advanced Search On JIRA and Confluence

This document provides guidance on searching for issues in JIRA, including defining search criteria, viewing and working with search results, and advanced searching techniques. Key points include: - Users can search for issues using the quick search, basic search, or advanced search, with advanced allowing the most complex queries via JQL. - Search results can be viewed and filtered in different ways, including changing the view, working with individual issues, sharing results, and exporting. - Advanced topics cover running saved searches, the syntax and operators available for text searches, and constructing cron expressions to subscribe to search updates.

Uploaded by

Mauro D. Escobar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
218 views32 pages

Advanced Search On JIRA and Confluence

This document provides guidance on searching for issues in JIRA, including defining search criteria, viewing and working with search results, and advanced searching techniques. Key points include: - Users can search for issues using the quick search, basic search, or advanced search, with advanced allowing the most complex queries via JQL. - Search results can be viewed and filtered in different ways, including changing the view, working with individual issues, sharing results, and exporting. - Advanced topics cover running saved searches, the syntax and operators available for text searches, and constructing cron expressions to subscribe to search updates.

Uploaded by

Mauro D. Escobar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 32

How to Use the Search on JIRA and

Confluence

Sumario
Searching for issues..............................................................................................................................4
1. Define your search criteria......................................................................................................4
2. Change your view of the search results...................................................................................5
3. Working with the search results..............................................................................................5
4. Save your search.....................................................................................................................5
Good to know..............................................................................................................................6
Advanced searching..............................................................................................................................7
Advanced searching....................................................................................................................7
Understanding advanced searching.............................................................................................8
Constructing JQL queries..................................................................................................8
Precedence in JQL queries.................................................................................................9
Setting the precedence..............................................................................................9
Restricted words and characters......................................................................................10
Reserved characters................................................................................................10
Reserved words......................................................................................................10
Performing text searches..................................................................................................11
Reference..................................................................................................................................11
Running a saved search.............................................................................................................14
Search syntax for text fields...............................................................................................................15
Query terms...............................................................................................................................15
Term modifiers..........................................................................................................................16
Exact searches (phrases)..................................................................................................16
Using special characters to create phrases.............................................................16
Wildcard searches: ? and *..............................................................................................16
Fuzzy searches: ~............................................................................................................17
Prefix and Suffix search...................................................................................................17
Proximity searches...........................................................................................................18
Boosting a term: ^.....................................................................................................................18
Boolean operators.....................................................................................................................18
OR....................................................................................................................................18
AND.................................................................................................................................19
Required term: +..............................................................................................................19
NOT.................................................................................................................................19
Excluded term: -..............................................................................................................19
Grouping...................................................................................................................................20
Special characters......................................................................................................................20
Reserved words.........................................................................................................................20
Word stemming.........................................................................................................................21
Limitations................................................................................................................................21
Whole words only............................................................................................................21
Working with search results...............................................................................................................21
Changing your view of the search results.................................................................................22
Working with individual issues.................................................................................................23
Sharing your search results.......................................................................................................24
Displaying your search results in Confluence...........................................................................24
Displaying your search results as a chart..................................................................................24
Exporting your search results....................................................................................................24
Printable views..........................................................................................................................29
Subscribing to your search results............................................................................................30
Bulk modifying issues in your search results............................................................................30
Constructing cron expressions for a filter subscription......................................................................31
Constructing a cron expression.................................................................................................31
Special characters......................................................................................................................31
Examples...................................................................................................................................32
Searching for issues
Can't find the issue that you are looking for? This page will show you how to search for issues in
Jira. Any user can search for issues, although they will only see issue results from projects where
they can view issues (i.e. 'Browse Project' permission).You'll find a step-by-step guide below that
will show you how to run a search and use the search results. If you want more details on anything
described on this page, see the related topics at the bottom of the page.

1. Define your search criteria


The first step in searching for issues is to define the criteria for your new search. You can define
your search criteria in three different ways: using the quick search, using the basic search, or using
the advanced search.
The quick search is the fastest way to define search criteria. However, it is less precise than other
search methods for complex queries (e.g. project = Jira AND status = Open AND
priority = High). It is most useful when your search criteria is not complex, for example, you
know the project key and some key words for an issue.
Quick
search To use the quick search: Enter your search criteria in the search box in the header bar of Jira and
press Enter.
Tip: If you know the issue key or project key, enter it before other search terms, e.g. "JRA help link is
broken".

The basic search is more precise than the quick search, but easier to use than the advanced search. It
provides a user-friendly interface that lets you define complex queries, without needing to know how
to use JQL (advanced searching).

To use the basic search: Navigate to Issues (in header) > Search for issues, then enter your search
criteria.
Basic
Tip: If the advanced search is shown instead of the basic search, click Basic next to the icon.
search

The advanced search is the most powerful of the three search methods. You can specify criteria that
cannot be defined in the other searches (e.g. ORDER BY clause). However, you need to know how to
construct structured queries using the Jira Query Language (JQL) to use this feature.

To use the advanced search: Navigate to Issues (in header) > Search for issues, then enter your
search criteria.
Tip: If the basic search is shown instead of the advanced search, click Advanced next to the icon.
Advanced
search
2. Change your view of the search results
You have crafted the perfect search criteria and run the search. Your search results will be displayed
in the issue navigator. The issue navigator allows you to change how the search results are
displayed. For example, you may want to bring high priority issues to the top or hide certain fields.

 Change the sort order: Click the column name.


 Show/hide columns: Click Columns and choose the desired columns.

3. Working with the search results


You've got the search results displaying the way that you want. Now you can work with the actual
issues in the search results. The issue navigator lets you action individual issues, as well as the
entire set of issues returned by your search.
Individual issues:

 View the issue: Click the issue key or name.


 Action individual issues: Click the cog icon next to the issue row and select an option.
All issues in the search results:

 Export the search results to different formats, like Excel and XML: Click Export and
select the desired format.
 Share the search results: Click Share, then enter the recipient's details.
 Create an RSS feed: Click Export > RSS (Issues) or RSS (Comments).
 Bulk modify issues in search results: Click Tools and select all <n> issue(s) under Bulk
Change.

4. Save your search


If you frequently run the same search, you can save the search criteria as a filter. This saves you
from having to manually redefine the search criteria every time. Jira applications also include a
number of predefined system filters for common queries, such as 'My Open Issues', 'Reported by
Me', 'Recently Viewed', and 'All Issues'.
To save your search as a filter: On the search results page, click Save as and enter a name for the
filter. Your new filter will be shown in the left panel with your other favorite filters, filters shared
with you, and the system filters. To run a filter, just click it.

Good to know
Keep in mind that your search won't include issues that have been archived. These are removed
from Jira's index, and can't be searched for like other issues.
Advanced searching
The advanced search allows you to build structured queries using the Jira Query Language (JQL) to
search for issues. You can specify criteria that cannot be defined in the quick or basic searches (e.g.
ORDER BY clause).

 If you don't have complex search criteria, you may want to use quick search instead.
 If you are not comfortable with the Jira Query Language (JQL), you may want to use basic
search instead.
Note, JQL is not a database query language, even though it uses SQL-like syntax.
Screenshot: Advanced search

Advanced searching
1. Navigate to Issues (in header) > Search for issues.
 If there are existing search criteria, click the New filter button to reset the search
criteria.
 If the basic search is shown instead of the advanced search, click Advanced (next to
the Search button).

 Why can't I switch between basic and advanced search?


In general, a query created using basic search will be able to be translated to advanced
search, and back again. However, a query created using advanced search may not be able to
be translated to basic search, particularly if:

 the query contains an OR operator (note you can have an IN operator and it will be
translated, e.g. project in (A, B))
 i.e. even though this query: (project = JRA OR project = CONF)
is equivalent to this query: (project in (JRA, CONF)), only the
second query will be translated.
 the query contains a NOT operator
 the query contains an EMPTY operator
 the query contains any of the comparison operators: !=, IS, IS NOT, >, >=, <, <=
 the query specifies a field and value that is related to a project (e.g. version,
component, custom fields) and the project is not explicitly included in the query (e.g.
fixVersion = "4.0", without the AND project=JRA). This is especially
tricky with custom fields since they can be configured on a Project/Issue Type basis.
The general rule of thumb is that if the query cannot be created in the basic search
form, then it will not be able to be translated from advanced search to basic search.

 Enter your JQL query. As you type, Jira will offer a list of "auto-complete" suggestions
based on the context of your query. Note, auto-complete suggestions only include the first
15 matches, displayed alphabetically, so you may need to enter more text if you can't find a
match.
2. Why aren't the auto-complete suggestions being shown?
 Your administrator may have disabled the "JQL Auto-complete" feature for your Jira
instance.
 Auto-complete suggestions are not offered for function parameters.
 Auto-complete suggestions are not offered for all fields. Check the fields reference to
see which fields support auto-complete.
3. Press Enter or click Search to run your query. Your search results will display in the issue
navigator.

Understanding advanced searching


Read the following topics to learn how to get the most out of advanced searching:
Constructing JQL queries | Precedence in JQL queries | Restricted words and characters |
Performing text searches

Constructing JQL queries


A simple query in JQL (also known as a 'clause') consists of a field, followed by an operator,
followed by one or more values or functions. For example:
project = "TEST"

This query will find all issues in the "TEST" project. It uses the "project" field, the EQUALS
operator, and the value "TEST".

A more complex query might look like this:


project = "TEST" AND assignee = currentuser()

This query will find all issues in the "TEST" project where the assignee is the currently logged in
user. It uses the "project" field, the EQUALS operator, the value "TEST",the "AND" keyword
and the "currentuser()" function.
For more information on fields, operators, keywords and functions, see the Reference section
below.

Precedence in JQL queries


Precedence in JQL queries depends on keywords that you use to connect your clauses (a clause
being e.g. project = “Teams in Space”). The easiest way to look at this is to treat the
AND keyword as the one grouping clauses, and OR as the one separating them. The AND keyword
takes precedence over other keywords, because it groups clauses together, essentially turning them
into one combined clause.
Example 1
status=resolved AND project=“Teams in Space” OR assignee=captainjoe

This query will return all resolved issues from the “Teams in Space” project (clauses grouped by
AND), and also all existing issues assigned to captainjoe. The clause after the OR keyword is
treated as separate.
Example 2
status=resolved OR project="Teams in Space" AND assignee=captainjoe

This query, on the other hand, will return captainjoe’s issues from the “Teams in Space” project
(clauses grouped by AND), and also all existing resolved issues (a clause separated by OR).
Example 3
status=resolved OR projects="Teams in Space" OR assigne=captainjoe

When you only use the OR keyword, all clauses will be treated as separate, and equal in terms of
precedence.
Setting the precedence
You can set precedence in your JQL queries by using parentheses. Parentheses will group certain
clauses together and enforce precedence.
Example 1
As you can see below, parentheses can turn our example JQL query around. This query would
return resolved issues that either belong to the “Teams in Space” project, or are assigned to
captainjoe.
status=resolved AND (project="Teams in Space" OR assignee=captainjoe)

Example 2
If you used parentheses like in the following example, they wouldn’t have any effect, because the
clauses enclosed in parentheses were already connected by AND. This query would return the same
results with or without the parentheses.
(status=resolved AND project="Teams in Space") OR assignee=captainjoe

Restricted words and characters


Reserved characters
JQL has a list of reserved characters:

space (" ") + . , ; ? | * / %^ $ # @ [ ]


If you wish to use these characters in queries, you need to:
 surround them with quote-marks (you can use either single quote-marks (') or double quote-
marks ("));
and,

 if you are searching a text field and the character is on the list of special characters in text
searches, precede them with two backslashes. This will let you run the query that contains a
reserved character, but the character itself will be ignored in your query. For more info, see
Special characters in Search syntax for text fields.

For example:
 version = "[example]"

 summary ~ "\\[example\\]"

Reserved words
JQL also has a list of reserved words. These words need to be surrounded by quote-marks (single or
double) if you wish to use them in queries.
"abort", "access", "add", "after", "alias", "all", "alter", "and", "any", "as", "asc", "audit", "avg",
"before", "begin", "between", "boolean", "break", "by", "byte", "catch", "cf", "char", "character",
"check", "checkpoint", "collate", "collation", "column", "commit", "connect", "continue", "count",
"create", "current", "date", "decimal", "declare", "decrement", "default", "defaults", "define",
"delete", "delimiter", "desc", "difference", "distinct", "divide", "do", "double", "drop", "else",
"empty", "encoding", "end", "equals", "escape", "exclusive", "exec", "execute", "exists", "explain",
"false", "fetch", "file", "field", "first", "float", "for", "from", "function", "go", "goto", "grant",
"greater", "group", "having", "identified", "if", "immediate", "in", "increment", "index", "initial",
"inner", "inout", "input", "insert", "int", "integer", "intersect", "intersection", "into", "is", "isempty",
"isnull", "join", "last", "left", "less", "like", "limit", "lock", "long", "max", "min", "minus", "mode",
"modify", "modulo", "more", "multiply", "next", "noaudit", "not", "notin", "nowait", "null",
"number", "object", "of", "on", "option", "or", "order", "outer", "output", "power", "previous",
"prior", "privileges", "public", "raise", "raw", "remainder", "rename", "resource", "return",
"returns", "revoke", "right", "row", "rowid", "rownum", "rows", "select", "session", "set", "share",
"size", "sqrt", "start", "strict", "string", "subtract", "sum", "synonym", "table", "then", "to", "trans",
"transaction", "trigger", "true", "uid", "union", "unique", "update", "user", "validate", "values",
"view", "when", "whenever", "where", "while", "with"
Note for Jira administrators: this list is hard coded in the JqlStringSupportImpl.java file.

Performing text searches


You can use Lucene's text-searching features when performing searches on the following fields,
using the CONTAINS operator:
Summary, Description, Environment, Comments, custom fields that use the "Free Text Searcher"
(i.e. custom fields of the following built-in custom field types: Free Text Field, Text Field, Read-
only Text Field).
For more information, see Search syntax for text fields.

Reference
Description Reference
A field in JQL is a word that
Fields
represents a Jira field (or a
Fields reference page
custom field that has already
been defined in Jira).
Show list of fields

 Affected version
 Approvals
 Assignee
 Attachments
 Category
 Comment
 Component
 Created
 Creator
 Custom field
 Customer Request Type
 Description
 Due
 Environment
 Epic link
 Filter
 Fix version
 Issue key
 Issue link type
 Labels
 Last viewed
 Level
 Original estimate
 Parent
 Priority
 Project
 Remaining estimate
 Reporter
 Request channel type
 Request last activity time
 Resolution
 Resolved
 SLA
 Sprint
 Status
 Summary
 Text
 Time spent
 Type
 Updated
 Voter
 Votes
 Watcher
 Watchers
 Work log author
 Work log comment
 Work log date
 Work ratio

An operator in JQL is one or


more symbols or words that
compare the value of a field
on its left with one or more Operators
Operators values (or functions) on its reference page
right, such that only true
results are retrieved by the
clause. Some operators may
use the NOT keyword.
Show list of operators

 EQUALS: =
 NOT EQUALS: !=
 GREATER THAN: >
 GREATER THAN
EQUALS: >=
 LESS THAN: <
 LESS THAN EQUALS:
<=
 IN
 NOT IN
 CONTAINS: ~
 DOES NOT
CONTAIN: !~
 IS
 IS NOT
 WAS
 WAS IN
 WAS NOT IN
 WAS NOT
 CHANGED

Keywords
A keyword in JQL is a word Keywords
or phrase that does (or is) any reference page
of the following:

 joins two or more


clauses together to
form a complex JQL
query
 alters the logic of one
or more clauses
 alters the logic of
operators
 has an explicit
definition in a JQL
query
 performs a specific
function that alters the
results of a JQL query.

Show list of keywords

 AND
 OR
 NOT
 EMPTY
 NULL
 ORDER BY

A function in JQL appears as


a word followed by
parentheses, which may
contain one or more explicit
values or Jira fields.

A function performs a Functions


Functions calculation on either specific reference page
Jira data or the function's
content in parentheses, such
that only true results are
retrieved by the function, and
then again by the clause in
which the function is used.

Show list of functions

 approved()
 approver()
 breached()
 cascadeOption()
 closedSprints()
 completed()
 componentsLeadByUser()
 currentLogin()
 currentUser()
 earliestUnreleasedVersion()
 elapsed()
 endOfDay()
 endOfMonth()
 endOfWeek()
 endOfYear()
 everbreached()
 futureSprints()
 issueHistory()
 issuesWithRemoteLinksByGlobalId()
 lastLogin()
 latestReleasedVersion()
 linkedIssues()
 membersOf()
 myApproval()
 myPending()
 now()
 openSprints()
 paused()
 pending()
 pendingBy()
 projectsLeadByUser()
 projectsWhereUserHasPermission()
 projectsWhereUserHasRole()
 releasedVersions()
 remaining()
 running()
 standardIssueTypes()
 startOfDay()
 startOfMonth()
 startOfWeek()
 startOfYear()
 subtaskIssueTypes()
 unreleasedVersions()
 updatedBy()
 votedIssues()
 watchedIssues()
 withinCalendarHours()

Running a saved search


Saved searches (also known as Saving your search as a filter) are shown in the left panel, when
using advanced search. If the left panel is not showing, hover your mouse over the left side of the
screen to display it.
To run a filter, e.g. My Open Issues, simply click it. The JQL for the advanced search will be set,
and the search results will be displayed.
Search syntax for text fields
This page provides information on the syntax for searching text fields, which can be done in the
quick search, basic search, and advanced search.
Text searches can be done in the advanced search when the CONTAINS(~) operator is used,
e.g.summary~"windows*".It can also be done in quick search and basic search when searching
on supported fields.
Acknowledgments: Jira uses Apache Lucene for text indexing, which provides a rich query
language. Much of the information on this page is derived from the Query Parser Syntaxpage of the
Lucene documentation.

Query terms
A query is broken up intotermsandoperators.There are two types of terms:Single
TermsandPhrases.
ASingle Termis a single word, such as "test" or "hello".

APhraseis a group of words surrounded by double quotes, such as "hello dolly".

Multiple terms can be combined together with Boolean operators to form a more complex query
(see below). If you combine multiple terms without specifying any Boolean operators, they will be
joined using AND operators.
Note: All query terms in Jira are not case sensitive.
Term modifiers
Jira supports modifying query terms to provide a wide range of searching options.
Exact searches (phrases) | Wildcard searches: ? and * | Fuzzy searches: ~ | Prefix and Suffix search |
Proximity searches

Exact searches (phrases)


To find exact matches for phrases, for example Jira Software, you need to enclose the whole
phrase in quote-marks ("). Otherwise, the search will return all issues that contain both words in no
particular order - this would include Jira Software, but also Jira is the best software!.
If you’re using advanced search, you need to additionally escape each of the quote-marks with a
backslash (\). For details, see the examples below or find your field in Advanced search - field
reference.

Examples

 Basic search: Find all issues that contain the phrase Jira Software:
Just type "Jira Software" into the search field.

 Advanced search: Find all issues that contain the words Jira and Software, in no particular
order.
text ~ "Jira Software"

 Advanced search: Find all issues that contain the phrase Jira Software.
text ~ "\"Jira Software\""

 Advanced search: Find all issues that contain the URL https://atlassian.com:
text ~ "\"https://atlassian.com\""

As you can see in the two preceding examples, the query contains two pairs of quote-marks. The
external ones are needed to meet the JQL rules and aren’t related to your search query. The same
pair of quote-marks would be automatically added by Jira in the basic search after running your
search.
Using special characters to create phrases
In previous versions of Jira, you could use some special characters to combine terms into phrases,
for example Jira+Software or Jira/Software. This is no longer the case, as the mechanism used for
searching has changed and the special characters surrounding terms are ignored.

Wildcard searches: ? and *


Jira supports single and multiple character wildcard searches.
To perform a single character wildcard search, use the "?" symbol.

To perform a multiple character wildcard search, use the "*" symbol.


Wildcard characters need to be enclosed in quote-marks, as they are reserved characters in
advanced search. Use quotations, e.g. summary ~ "cha?k and che*"

The single character wildcard search looks for terms that match that with the single character
replaced. For example, to search for "text" or "test", you can use the search:
te?t

Multiple character wildcard searches looks for 0 or more characters. For example, to search for
Windows, Win95, or WindowsNT, you can use the search:
win*

You can also use the wildcard searches in the middle of a term. For example, to search for Win95
or Windows95, you can use the search:
wi*95

You cannot use a * or ? symbol as the first character of a search. The feature request for this is JRA-
6218.

Fuzzy searches: ~
Jira supports fuzzy searches. To do a fuzzy search, use the tilde, "~", symbol at the end of a single
word term. For example, to search for a term similar in spelling to "roam", use the fuzzy search:
roam~

This search will find terms like foam and roams.


Note: Terms found by the fuzzy search will automatically get a boost factor of 0.2.

Prefix and Suffix search


Jira supports searching for parts of the words. To perform such search, include either a prefix or a
suffix of the word or phrase you're looking for. For example to look for a MagicBox issue, you can
use either of the two search patterns:

Prefix search
summary ~ "magic*"

Suffix search
summary ~ "*box"

Proximity searches
Jira supports finding words that are within a specific distance away. To do a proximity search, use
the tilde, "~", symbol at the end of a phrase. For example, to search for "atlassian" and "Jira"
within 10 words of each other in a document, use the search:
"atlassian Jira"~10

Boosting a term: ^
Jira provides the relevance level of matching documents based on the terms found. To boost a term,
use the caret, "^", symbol with a boost factor (a number) at the end of the term you are searching.
The higher the boost factor, the more relevant the term will be.
Boosting allows you to control the relevance of a document by boosting its term. For example, if
you are searching for
atlassian Jira

and you want the term "atlassian" to be more relevant, boost it using the ^ symbol along with
the boost factor next to the term. You would type:
atlassian^4 Jira

This will make documents with the term atlassian appear more relevant. You can also boost Phrase
Terms, as in the example:
"atlassian Jira"^4 querying

By default, the boost factor is 1. Although, the boost factor must be positive, it can be less than 1
(i.e. 0.2).

Boolean operators
Boolean operators allow terms to be combined through logic operators. Jira supports AND, "+",
OR, NOT and "-" as Boolean operators.
Boolean operators must be ALL CAPS.
OR | AND | Required term: + | NOT | Excluded term: -

OR
The OR operator is the default conjunction operator. This means that if there is no Boolean operator
between two terms, the OR operator is used. The OR operator links two terms, and finds a matching
document if either of the terms exist in a document. This is equivalent to a union using sets. The
symbol || can be used in place of the word OR.

To search for documents that contain either "atlassian Jira" or just "confluence", use the
query:
"atlassian Jira" || confluence

or
"atlassian Jira" OR confluence
AND
The AND operator matches documents where both terms exist anywhere in the text of a single
document. This is equivalent to an intersection using sets. The symbol && can be used in place of
the word AND.
To search for documents that contain "atlassian Jira" and "issue tracking", use the
query:
"atlassian Jira" AND "issue tracking"

Required term: +
The "+" or required operator requires that the term after the "+" symbol exists somewhere in the
field of a single document.
To search for documents that must contain "Jira" and may contain "atlassian", use the query:
+Jira atlassian

NOT
The NOT operator excludes documents that contain the term after NOT. This is equivalent to a
difference using sets. The symbol ! can be used in place of the word NOT.

To search for documents that contain "atlassian Jira" but not "japan", use the query:
"atlassian Jira" NOT "japan"

Note: The NOT operator cannot be used with just one term. For example, the following search will
return no results:
NOT "atlassian Jira"

Usage of the NOT operator over multiple fields may return results that include the specified
excluded term. This is due to the fact that the search query is executed over each field in turn, and
the result set for each field is combined to form the final result set. Hence, an issue that matches the
search query based on one field, but fails based on another field will be included in the search result
set.

Excluded term: -
The "-" or prohibit operator excludes documents that contain the term after the "-" symbol.

To search for documents that contain "atlassian Jira" but not "japan", use the query:
"atlassian Jira" -japan

Grouping
Jira supports using parentheses to group clauses to form sub queries. This can be very useful if you
want to control the boolean logic for a query.
To search forbugsand eitheratlassianorJira, use the query:
bugs AND (atlassian OR Jira)
This eliminates any confusion and makes sure thatbugsmust exist, and either
termatlassianorJiramay exist.

Do not use the grouping character '(' at the start of a search query, as this will result in an error. For
example,"(atlassian OR Jira) AND bugs" will not work.

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 ([]) won’t be included in the
search.
In previous Jira versions, you could use special characters to combine two separate terms into a
phrase, for example "Jira+Software" or "Jira/Software". This doesn’t apply to Jira 8.x.
If you’d like to search for phrases, see Exact searches (phrases).

Reserved words
To keep the search index size and search performance optimal in Jira, the followingEnglishreserved
words(also known as 'stop words') are ignored from the search index and hence, Jira's text search
features:
"a", "and", "are", "as", "at", "be", "but", "by", "for", "if",
"in", "into", "is", "it", "no", "not", "of", "on", "or", "such",
"that", "the", "their", "then", "there", "these", "they", "this",
"to", "was", "will", "with"

Be aware that this can sometimes lead to unexpected results. For example, suppose one issue
contains the text phrase "VSX will crash" and another issue contains the phrase "VSX will not
crash". A text search for "VSX will crash" will return both of these issues. This is because the
wordswillandnotare part of the reserved words list.

Your Jira administrator can make Jira index these reserved words (so that Jira will find issues
based on the presence of these words) by changing theIndexing
LanguagetoOther(underAdministration > System > General Configuration).

Word stemming
Since Jira cannot search for issues containing parts of words (see below), word 'stemming' allows
you to retrieve issues from a search based on the 'root' (or 'stem') forms of words instead of
requiring an exact match with specific forms of these words. The number of issues retrieved from a
search based on a stemmed word is typically larger, since any other issues containing words that are
stemmed back to the same root will also be retrieved in the search results.
For example, if you search for issues using the query term 'customize' on the Summary field, Jira
stems this word to its root form 'custom', and will retrieve all issues whose Summary field also
contains any word that can be stemmed back to 'custom'. Hence, the following query:
summary ~ "customize"

will retrieve issues whose Summary field contains the following words:

 customized
 customizing
 customs
 customer
 etc.

Please Note:

 Your Jira administrator can disable word stemming (so that Jira will find issues based on
exact matches with words) by changing theIndexing
LanguagetoOther(underAdministration > System > General Configuration).
 Word stemming applies toallJira fields (as well as text fields).
 When Jira indexes its fields, any words that are 'stemmed' are stored in Jira's search index in
root form only.

Limitations
Please note that the following limitations apply to Jira's search:

Whole words only


Jira cannot search for issues containing parts of words but on whole words only. The exception to
this are words which are stemmed.
This limitation can also be overcome using fuzzy searches.

Working with search results


Once you have run a search, your search results will be displayed in the issue navigator.You may
want to triage the entire list of issues or may be looking for just one. This page will show you what
you can do with your search results, from changing what you see in the issue navigator to
modifying the issues.
The following screenshot provides an overview of the key features of the issue navigator.
Screenshot: Issue navigator (Detail view)
1. Filter panel:Click<<to collapse the filter panel so you can have more space in the detail
view.
2. Issue:Select an issue from this panel to see the details in the detail view window.
3. Filters:Select a filter to see all the matching issues in the panel to the immediate right.
4. Views:Click to switch between the detail view and list view.
5. Detail view:Check out all the details about the selected issue in this detail view.

Changing your view of the search results


Click the Change view ( ) dropdown to switch between List view and Detail
view for your search results.

 List view: Shows your search results as a list of issues. This view is easiest
to scan and is best when you only need to know a few details about each
List view or
issue.
Detail view
 Detail view: Shows your search results as a list of issues, with the right
panel showing the details of the currently selected issue. This view is best
when you need more information about the individual issues, or you want to
quickly edit issues as you go (via inline edit for certain fields).

Click the column name. If you click the same column name more than once, the
sort order will switch between ascending and descending. Note:

 You cannot sort by the 'Images' column nor thesub-taskaggregate columns


Change the
(i.e. all columns beginning with '∑').
sort order
 If you sort the search results for anadvanced search, an 'ORDER BY' clause
will be added/updated for your JQL query to reflect the order of issues in
your search results.

Columns — You can create different column configurations for yourself and for specific filters.
show/hide and To switch between different column configurations, click Columns and select one
move of the following tabs:

 My Defaults: This is your default column configuration for search results.


 Filter: This is enabled if you are viewing the search results for a filter. It
will override your default column configuration.
 System (shows if you are a Jira administrator): This is the column
configuration that applies to all users. It will be overridden by a user's
default column configuration and filter-specific column configurations.

You can also modify any of these configurations. Make sure you have switched the
desired configuration, then do the following:

 Show/hide columns: ClickColumns, choose the desired columns, then click


Done.
 Move a column: Click the column name and drag it to the desired position.

Why can't I add a column to my column configuration?

If you cannot find a column, please make sure that you haven't run in to any of the following
restrictions:

 You can only see columns for issue fields that have not beenhiddenand that you
havepermissionsto see.
 It is possible to add any of the existingcustom fieldsto the column list, as long as the fields
are visible, and you have the right permissions.
 Some custom fields, even if selected, do not appear in the Issue Navigator for all issues. For
example, project-specific custom fields will be shown only if the filter has been restricted to
that project only. Issue type custom fields will only appear if the filter has been restricted to
that issue type.

Working with individual issues


You can action individual issues in your search results, directly from the issue navigator. Note that
the list of issues will remain constant even if you change an issue, so that it doesn't meet the original
search criteria.The advantage of this is thatyou have a constant set of search results that you can
work from when triaging issues.

Click the key or summary of the issue.

 If you are in List view, you will redirected to the issue (leaving the search
View an issue
results page).
 If you are in Detail view, the issue details will display in the right panel.

To action an issue (e.g. edit it, transition it, log work on it, etc):

 If you are in List view, click the cog icon and select from the options.
 If you are in Detail view, select the issue and action it the issue via the
Action an
details panel.
issue
You can also select an issue and action it via keyboard shortcuts in either views.
Tip: use the 'j' and 'k' keys to select the previous/next issue in the issue navigator.
Sharing your search results
ClickSharein the issue navigator toemail a link to asearch resultor shared filter.

 Recipients will receive an email with a link to the search result and the content of
theNotefield (if specified). The subject of the email will state that you (using yourusername)
shared the issue.
 If you share the results of a filter, rather than an ad-hoc search, recipients will receive a link
to the filter. Note, if the recipient does not have permission to view the filter, they will
receive a link to the search results instead.

Displaying your search results in Confluence


If your Jira applications are connected to Confluence, you can display your search results on a
Confluence page using the Jira issues macro. For instructions, see Jira issues macro.

Displaying your search results as a chart


ClickExport> Dashboard charts. Choose the desired chart from the dialog that is displayed, then
clickSave to Dashboard.
The chart will be added to your dashboard.For more information on what each chart shows, see
Reporting.

Exporting your search results


Click Export > CSV (All fields) or Export > CSV (Current fields), and choose a
delimiter to separate the values.

The CSV file will contain a header row with every applicable issue field, comment, and
attachment in your search result.

 CSV (All fields): this will include every issue field, comment and attachment. The
header row may contain multiple values of "Comment" and/or "Attachment" if
your issues have multiple comments and/or attachments.
CSV  CSV (Current fields): this will include only issue fields that are currently
displayed.

Note, large exports (e.g. many hundreds of issues) are not recommended. You can change
the number of issues that are exported, by changing the value of thetempMaxparameter in
the URL.

If you're making a lot of exports, your Jira admin can disable the extra dialog that asks
about delimiters. In this case, comma will be used as the default delimiter. Learn more

HTML Click Export > HTML (All fields) or Export > HTML (Current fields).

The HTML file will contain a header row with a value for every applicable issue field in
your search result.

 HTML (All fields): this will create an HTML file for every issue field (excluding
comments). This will only show the custom fields that areavailable for all of the
issues in the search results. For example, if a field is only available for one
project and multiple projects are in the search results then that field will not appear
in the HTML file. The same goes for fields that are only available for certain issue
types.
 HTML (Current fields): this will create an HTML file for the issue fields that are
currently displayed.

Note, large exports (e.g. many hundreds of issues) are not recommended. You can change
the number of issues that are exported, by changing the value of thetempMaxparameter in
the URL.

Click Export > XML.

You can use the URL of the XML view in a Confluence Jira issues macro. However, you
can also use the JQL or the URL of the issue search, which are easier to get.

To restrict which issue fields are returned in the XML export, specify thefieldparameter
XML in your URL. For example, to include only theIssue
keyandSummary,add&field=key&field=summaryto the URL. If
thefieldparameter is not specified, the XML output will includeallthe issue fields.
Otherwise, if one or morefieldparameters are specified, the XML output will contain
only theIssue keyplus your chosen field(s). See the "List of fields for field parameter"
below.

Click Export > Word.

The export will include the Description, Comments, and all other issue data, not just the
Word
issue fields that are currently configured in your Issue Navigator. Note, large exports (e.g.
hundreds of issues) are not recommended.

List of fields for field parameter (XML exports):

Value Sample XML output Notes

<title>[TEST-4] This is a
title test</title>

This is a 'permalink' to the


<link>https://extranet.atlassian
issue. For links between
link .com:443/Jira/browse/TEST-
4</link> issues, see * issuelinks
* (below).

<project id="10330"
project (or pid) key="TST">Test</project>

<description>This is a detailed
description description of the
issue.<description>
<environment>Sydney
environment network<environment>

key <key id="22574">TEST-4</key>

summary <summary>This is a test<summary>

<type id="3"
iconUrl="https://extranet.atlass
type (or issuetype) ian.com:443/Jira/images/icons/ta
sk.gif">Task</type>

<parent id="22620">TEST- Only relevant if the issue is


parent 5</parent> a sub-task.

<priority id="4"
iconUrl="https://extranet.atlass
priority ian.com:443/Jira/images/icons/pr
iority_minor.gif">Minor<priority
>

<status id="5"
iconUrl="https://extranet.atlass
status ian.com:443/Jira/images/icons/st
atus_resolved.gif">Resolved</sta
tus>

<resolution
resolution id="1">Fixed</resolution>

<labels>
labels <label>focus</label>
<labels>

<assignee username="jsmith">John
assignee Smith</assignee>

<assignee username="jsmith">John
reporter Smith</assignee>

Only relevant if a security


<security
security id="10021">Private</security> level has been applied to the
issue.

<created>Mon, 1 Sep 2008


created 17:30:03 -0500 (CDT)>/created>

<updated>Mon, 1 Sep 2008


updated 17:30:03 -0500 (CDT)>/updated>

resolved (or <resolved>Mon, 1 Sep 2008


resolutiondate) 17:30:03 -0500 (CDT)>/resolved>
<due>Mon, 1 Sep 2008 17:30:03
due (or duedate) -0500 (CDT)>/due>

version (or versions) <version>2.4.7</version>

fixfor (or
<fixVersion>2.6</fixVersion>
fixVersions)

component (or <component>Documentation</compon


components) ent>

votes <votes>1</votes>

<comments>
<comment id="39270"
author="jsmith" created="Tue, 24
Feb 2009 16:45:02 -0600
(CST)">this looks
comments (or comment) familiar</comment>
<comment id="39273"
author="jbrown" created="Tue, 24
Feb 2009 16:48:16 -0600
(CST)">to me too</comment>
</comments>

<attachments>
<attachment id="30318"
name="Issue Navigator -
Atlassian Jira-2.png"
size="16161" author="yoz"
created="Mon, 9 Feb 2009 Only available if your
attachments (or 13:32:58 -0600 (CST)"/>
attachment) <attachment id="30323" administrator has enabled
name="Windows XP (with Firefox attachments.
3.0).jpg" size="5802"
author="vbharara" created="Tue,
10 Feb 2009 00:30:11 -0600
(CST)"/>
</attachments>

timeoriginalestimat <timeoriginalestimate Only available if your


e
seconds="600">10 administrator has time
minutes</timeoriginalestimate> tracking enabled.

Only available if your


<timeestimate seconds="300">5
timeestimate minutes</timeestimate> administrator has time
tracking enabled.

Only available if your


<timespent seconds="300">5
timespent minutes</timespent> administrator has time
tracking enabled.

aggregatetimeorigin <aggregatetimeoriginalestimate Aggregate time for the issue


alestimate seconds="36000">10
plus all of its sub-tasks.
hours</aggregatetimeoriginalesti
Only available if your
mate> administrator has time
tracking enabled.

Aggregate time for the issue


<aggregatetimeremainingestimate plus all of its sub-tasks.
aggregatetimeestima seconds="18000">5
te hours</aggregatetimeremainingest Only available if your
imate> administrator has time
tracking enabled.

Aggregate time for the issue


<aggregatetimespent plus all of its sub-tasks.
aggregatetimespent seconds="18000">5 Only available if your
hours</aggregatetimespent> administrator has time
tracking enabled.

<timeoriginalestimate
seconds="600">10
minutes</timeoriginalestimate>
<timeestimate seconds="300">5
minutes</timeestimate>
<timespent seconds="300">5 This is a convenient
minutes</timespent> shorthand way of specifying
<aggregatetimeoriginalestimate all of the above six time
seconds="36000">10
timetracking hours</aggregatetimeoriginalesti tracking fields. Only
mate> available if your
<aggregatetimeremainingestimate administrator has time
seconds="18000">5 tracking enabled.
hours</aggregatetimeremainingest
imate>
<aggregatetimespent
seconds="18000">5
hours</aggregatetimespent>

<issuelinks>
<issuelinktype id="10020">
<name>Duplicate</name>
<inwardlinks
description="is duplicated by">
<issuelink>
issuelinks <issuekey
id="22477">INTSYS-
1009</issuekey>
</issuelink>
</inwardlinks>
</issuelinktype>
</issuelinks>

<subtasks>
<subtask id="22623">TEST-
subtasks (or subtask) 8</subtask>
</subtasks>

customfield_xxxxx <customfields> "xxxxx" is the id of a given


<customfield
custom field e.g. this output
id="customfield_10112"
key="com.atlassian.Jira.plugin.s is the result of specifying
ystem.customfieldtypes:select">
<customfieldname>Departm
ent</customfieldname>
<customfieldvalues>
&field=customfield_
<customfieldvalue>Ad
minstration</customfieldvalue> 10112
</customfieldvalues>
</customfield>
</customfields>

<customfields>
<customfield
id="customfield_10112"
key="com.atlassian.Jira.plugin.s
ystem.customfieldtypes:select">
<customfieldname>Departm
ent</customfieldname>
<customfieldvalues>
<customfieldvalue>Ad
minstration</customfieldvalue>
</customfieldvalues>
</customfield>
allcustom <customfield
id="customfield_10111"
key="com.atlassian.Jira.plugin.s
ystem.customfieldtypes:select">
<customfieldname>Expendi
ture Type</customfieldname>
<customfieldvalues>
<customfieldvalue>Op
erating</customfieldvalue>
</customfieldvalues>
</customfield>
</customfields>

Printable views
Click Export > Printable.

Creates a view of your search results in your browser that can be printed 'Landscape'.
Printable
This view only contains issue Type, Key, Summary, Assignee, Reporter, Priority,
Status, Resolution, Created date, Updated date, and Due date.

Click Export > Full content.

Full Creates a view of your search results in your browser that can be printed. This view
content contains all issue fields, comments, and a list of attachments (there is no preview) for
every issue returned by your search.

Subscribing to your search results


A subscription provides you with a periodic notification for all issues returned by the search. If you
want to be notified when a particular issue changes, you should watch the issue instead.

Email Your search must be saved as a filter, if you want to create an email subscription for it. You
can create a subscription of any frequency for yourself and/or other users. Note, only the
first 200 results of a filter are sent.

1. Run the filter that you want to subscribe to, then click Details (next to filter name).
2. Fill in the 'Filter Subscription form' and click Subscribe.

More information:

 If you choose 'Advanced' for your Schedule, see this page for help on constructing
Cron expressions.
 You can choose to specify a group as a recipient, however you can only select a
group that you are a member of:
 You must have the 'Manage Group Filter Subscriptions'global permission.
 Be aware that the emailed filter results will be specific to each recipient. For
example, if the filter uses the currentUser() function, the search results
will be evaluated with the recipient as the current user. This does not apply
to distribution lists (group email aliases).
 Be careful about sharing a subscription with a group with many members, as
it can take a long time to generate the emails to be sent, since the search
needs to be executed for each user (as per the previous point).

Click Export > RSS (Issues) or Export > RSS (Comments). The URL of the page that
shows can be used in your feed reader.

Tips:

 You can change the number of issues that are returned, by changing the value of
thetempMaxparameter in the URL.
RSS  If you only want to receive current comments in an RSS feed, use the Date Updated
field when doing a search. For example, to only receive comments created in the last
week, add the Date Update field and set it to updated within the last 1 week.
 You may need to log into your Jira applications to view restricted data in your feed.
If so, you can addos_authType=basicto the feed URL
(e.g.http://mycompany.com/anypage?os_authType=basic) to show a
login dialog when viewing the feed.

Bulk modifying issues in your search results


Bulk operations let you action multiple issues at once. These actions include transitioning issues,
deleting issues, moving issues, and watching/unwatching issues.
ClickTools> Bulk Change:all <N> issue(s)and follow the 'Bulk Operation' wizard.
For more information, see Editing multiple issues at the same time.

Constructing cron expressions for a filter


subscription
This page describes how to construct a cron expression. Cron expressions can be used when
creating a subscription to a filter, as described in Working with search results.
A cron expression gives you more control over the frequency, compared to the default schedules.
For example, you could define a cron expression to notify you at8:15 am on the second Friday of
every month.

Constructing a cron expression


A cron expression is a string of fields separated by spaces. The following table displays the fields of
a cron expression,in the order that they must be specified (from left to right):

Year
Second Minute Hour Day-of-month Month Day-of-week
(optional)
Allowed 1-12 or 1-7 or 1970-
0-59 0-59 0-23 1-31
values JAN-DEC SUN-SAT 2099
Allowed
special ,-*/ ,-*/ ,-*/ ,-*/?LWC ,-*/ ,-*/?LC# ,-*/
characters
Note, cron expressions are not case-sensitive.
Here is an example:
0 15 8 ? JAN MON 2014

This literally translates to 0 second, 15 minute, 8 hour, any day of the month, January, 2014.
In plain English, this represents 8:15am onevery Monday during January of 2014. Note, the ?
character means "no particular value". In this example, we've set the Day-of-month to no particular
value. We don't need to specify it, as we've specified a Day-of-week value. Read more about special
characters in the next section.
More examples of cron expressions are explained in the Examples sectionat the bottom of this page.

Special characters
Special
Usage
character

Specifies a list of values. For example, in the Day-of-week field, 'MON,WED,FRI'


,
means 'every Monday, Wednesday, and Friday'.

Specifies a range of values. For example, in the Day-of-week field, 'MON-FRI' means
-
'every Monday, Tuesday, Wednesday, Thursday and Friday'.

Specifies all possible values. For example, in the Hour field, '*' means 'every hour of
*
the day'.

Specifies increments to the given value. For example, in the Minute field, '0/15'
/
means 'every 15 minutes during the hour, starting at minute zero'.
Specifies no particular value. This is useful when you need to specify a value for one
?
of the two fields Day-of-month or Day-of-week, but not the other.

Specifies the last possible value; this has different meanings depending on context. In
the Day-of-week field, 'L' on its own means 'the last day of every week' (i.e. 'every
Saturday'), or if used after another value, means 'the last xxx day of the month' (e.g.
L
'SATL' and '7L' both mean 'the last Saturday of the month). In the Day-of-month
field, 'L' on its own means 'the last day of the month', or 'LW' means 'the last weekday
of the month'.

Specifies the weekday (Monday-Friday) nearest the given day of the month. For
example, '1W' means 'the nearest weekday to the 1st of the month' (note that if the 1st
W is a Saturday, the email will be sent on the nearest weekday within the same month,
i.e. on Monday 3rd). 'W' can only be used when the day-of-month is a single day, not a
range or list of days.

Specifies the nth occurrence of a given day of the week. For example, 'TUES#2' (or
#
'3#2') means 'the second Tuesday of the month'.

Examples
0 15 8 ? * * Every day at 8:15 pm.

0 15 8 * * ? Every day at 8:15 am.

0 * 14 * * ? Every minute starting at 2:00 pm and ending at 2:59 pm, every day.

0 0/5 14 * * ? Every 5 minutes starting at 2:00 pm and ending at 2:55 pm, every day.

0 0/5 14,18 * * ? Every 5 minutes starting at 2:00 pm and ending at 2:55 pm, AND every
5 minutes starting at 6:00 pm and ending at 6:55 pm, every day.

0 0-5 14 * * ? Every minute starting at 2:00 pm and ending at 2:05 pm, every day.

0 0/10 * * * ? * Every 10 minutes, forever.

0 10,44 14 ? 3 WED 2:10 pm and 2:44 pm every Wednesday in the month of March.

0 15 8 ? * MON-FRI 8:15 am every Monday, Tuesday, Wednesday, Thursday, and Friday.

0 15 8 15 * ? 8:15 am on the 15th day of every month.

0 15 8 L * ? 8:15 am on the last day of every month.

0 15 8 LW * ? 8:15 am on the last weekday of every month.

0 15 8 ? * 6L 8:15 am on the last Friday of every month.


0 15 8 ? * 6#2 8:15 am on the second Friday of every month.

0 15 8 ? * 6#2 8:15 am on the second Friday of every month during the years 2007,
2007-2009 2008, and 2009.

You might also like