JIRACORESERVER071-03032016
JIRACORESERVER071-03032016
1
Documentation for JIRA Core 7.1 2
Contents
JIRA Core documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
JIRA Core overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
What makes up JIRA Core? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
See what's possible with JIRA Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Using JIRA Core for HR projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Using JIRA Core for Marketing projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Using JIRA Core for Operations projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Using JIRA Core for Finance projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Task management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Using JIRA Core for Legal projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Process management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Project management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tips and tricks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
How do I build the workflow I want? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Installing JIRA Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
JIRA applications overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Using JIRA applications with Confluence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Using JIRA applications with HipChat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Using JIRA applications with Portfolio for JIRA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting started with JIRA Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Getting started as an administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Setting up your site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Creating a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Adding new users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Managing permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Getting started as a project administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Customizing your project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Adding users to your project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Getting started as a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Accessing a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Creating and working with issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Searching for issues and filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Administering a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Editing a project's details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Managing project role memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Organizing work with versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Organizing work with components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Customizing the issues in a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Working in a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Managing your user profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Allowing OAuth access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Requesting add-ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Using keyboard shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Viewing a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Viewing a project's versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Viewing a project's components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Viewing a project's issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Project shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Working with issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Attaching files and screenshots to issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Creating issues and sub-tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Creating issues using the CSV importer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Editing and collaborating on issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Linking issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Editing multiple issues at the same time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 3
Scheduling an issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Moving an issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Logging work on issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Searching for issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Basic searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Quick searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Advanced searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Advanced searching - fields reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Advanced searching - keywords reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Advanced searching - operators reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Advanced searching - functions reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Search syntax for text fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Saving your search as a filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Working with search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Constructing cron expressions for a filter subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Configuring dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Adding and customizing gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Gadgets for JIRA applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 4
What's trending?
Everything you need to know Say hello to JIRA Core! Tips 'n tricks for JIRA Core
about JIRA Core How to set up business workflows Building workflow: a working
Say hello to JIRA Core! 2/2 the Make issues work for your team example
Q&A Project status at a glance What makes up JIRA Core: the
Helping Marketing and Software basics
teams work together Ideas and use cases for JIRA
3 steps to Marketing zen Core
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 5
through a workflow. JIRA Core can be customized to suit your needs, and
can also be extended and linked with other applications to provide you with
the perfect solution to track all your work in one place.
Understanding the basics of JIRA Core will help you get the most out of your
application. This page will explain the core terminology and functionality that
Sign up for Try me!
makes JIRA Core the application you need to help you manage your work
a free trial
efficiently.
Ready to get to grips with the basic concepts? Read on!
Issues
Issues are the work packets in JIRA Core. Each issue can be further defined by assigning the issue an issue
type. For example, if you're running a project in an office, issues could represent the tasks you need to do to
complete that project. Each issue type would be a type of task, like administration task, filing task, or create
document task. If you're using JIRA Core for asset tracking, an issue could represent an asset (or inventory
item) and the issue type could be the types of assets (laptops, monitors, printers etc.). Issues then progress
(or move) though JIRA Core via a associated workflow that dictates what can and can't (or more correctly,
what should and shouldn't!) happen to that issue.
So how do I group issues? What if I want a construction project, and I also want to track my assets for that
project in JIRA Core, how can I do that? Well, you use projects!
Projects
Projects are a way to group your issues, and apply a set of defaults. These defaults make sure all your
issues have the information that they need to be progressed and tracked through your workflow. Each project
can have an administrator, who is typically the project lead, and they're responsible for administering the
project.
JIRA Core users may work with issues in one or several projects, and would complete the work required to
progress the issues through their workflows.
Great! You now know issues are the work, and they're grouped in projects. But what's the workflow, and how
does it effect the issues?
Workflows
Workflow dictates how an issue can be progressed in a project. The workflows can be as simple or as
complex as you need them. Workflows are often modelled on existing processes, and are made up of
statuses (or steps) and transitions (movements between statuses). When you create an issue, it will
automatically be assigned a workflow and a status on that workflow. Where it can move to is defined by the
transitions that exit that status. An example of the default workflow that ships with JIRA Core is shown below:
JIRA Applications
JIRA Core is one of several JIRA applications. Each application has its own distinct features that makes it
suitable for servicing the market it's designed for. For example, JIRA Software is designed for agile software
developers, and its features include agile boards, software specific project types, and better integration points
with other developer tools.
You may have access to more than just the JIRA Core application, and you can view this list of applications
and feature access to gain a better understanding of the power of JIRA!
So that's the basics. JIRA Core is functional straight 'out of the box', but if you think you'll need to know a little
more, to get some ideas on what you could do, take a look at this guide to see what's possible with JIRA
Core.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 6
give you some ideas of how you may want to customize your projects so that they suit your needs. We'll also
give you some tips on how to get the most out of your projects and issues.
Task management
The Task management template sets you up with a simple workflow, easy to understand issue types, and the
right set of fields on your issues to help you get your work from To Do to Done in the quickest way possible.
Learn more about the default configuration and specific use cases...
Project management
The Project management template has a slightly more complex workflow, and is great for projects that require a
little more work. Including an In Progress status allows you to work on tasks over longer periods and show work
in progress.
Learn more about the default configuration and specific use cases...
Process management
The Process management template ships with our most complex workflow, designed to give you an idea of
what you can create with JIRA Core to mimic your own business process or work flow.
Learn more about the default configuration and specific use cases...
HR
If you're working in HR, you may want to have a look at a few ideas of how you can use JIRA Core for your
projects, and configure them further to suit your needs.
Learn more about using JIRA Core for HR...
Marketing
If you're a marketing whiz and looking to move to the next level by managing your work more efficiently, making
sure all your I's are dotted and T's crossed, have a look at how you can use JIRA Core to help you work smarter
and more effectively.
Learn more about using JIRA Core for marketing...
Operations
Thinking about trying to set up some workflows for operations? Wondering how JIRA Core could help you keep
things in one place while still letting you apply the workflow you need? Take a look at our operations example for
some ideas.
Learn more about using JIRA Core for operations...
Finance
If you work in finance and struggle to keep tabs on everything required for reporting, budgeting, invoicing.... you
know what you do better than we do! Have a look at how you could potentially leverage JIRA Core to make sure
all your reports are done on time, all your invoices are issued and followed up, and you can check up on where
you stand at any given time.
Learn more about using JIRA Core for finance...
Legal
Keeping tabs on everything you're working on can be hard, and when you also need to make sure things are
reviewed and approved by the relevant parties, things can get harder to manage. JIRA Core can help you
manage your work and keep tabs on it at each stage through the workflow.
Learn more about using JIRA Core for legal...
Using JIRA Core for HR projects
So you're thinking about using JIRA Core for your HR tasks? Maybe you're
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 7
Use case Onboarding - setting up your new starters for success from day one, week one.
What Business Task Management - This gives you a straightforward workflow of To do and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How would
this look?
Can I make You may be thinking, "Hold on a minute, I don't want to have to create a bunch of sub
this easier? tasks every time I need to onboard someone!" Well, you don't. Set up a task with all the
associated sub-tasks, and name it Onboarding. Whenever you need to onboard a new
employee, find the task and use JIRA Core's clone functionality to make a brand new
task with all the associated sub-tasks. By renaming the task you'll know which new
employee each task belongs to. You can even assign the sub-tasks to the relevant
people, so that when you clone the task, JIRA Core will make sure the relevant people
are assigned to their tasks automatically.
Other You may decide that your onboarding should be more extensive, you may decide that
customizations instead of just getting the physical bits and pieces together for a new employee, you
may want to also ensure that in their first week the get to have lunch with their team,
sign off on all your statutory training, or get a building tour. You can customize your
projects workflow to suit your needs, assigning the parent task to the person
responsible for each step. You could decide to customize the fields available on the
task, to make sure you record the information you need along the way (scores in
training, asset numbers of any equipment that's been provided). You set up JIRA Core
to mimic how you do onboarding. It can be as complex or as basic as you like!
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 8
Got the hang of how JIRA Core can be used? Let's take a look at another HR example, let's see how you
could potentially set up a project to track job applications you receive.
Use case Application tracking - You advertise for a role that's become available, and you start
receiving applications in the mail, through your website, and via email.
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each candidate applying for a role.
this? 2. Add any accompanying CV's, resumès or paperwork as an attachment to the task.
3. Depending on your hiring process, if the candidate is unsuccessful they may go
directly to Done, or if you need to perform further tasks, like back ground checks,
interviews, or wait for additional paperwork, the candidate may go to In progress.
4. Once you have a successful candidate, move them to Done and add a comment or
label to say they've been successful.
How would
this look?
Can I make Yes, you can! If you've integrated JIRA Core with your email system, you can make
this easier? sure that incoming emails regarding job applications are automatically created as tasks.
Any accompanying attachments on the email will also be added as attachments to the
task. Ever wondered why some job advertisements ask for your name, the position
you're applying for and job reference in the email subject line? It's because this is
exactly what they're doing, taking those emails and automatically converting them to
"something" they can track and process! Why not use JIRA Core to do it for you.
Other We know that processing a candidate for a role is never as easy as it sounds.
customizations Depending on the role, and any requirements you may need to do several interviews,
background checks, make sure you've got the correct paperwork signed and returned...
the list goes on! JIRA Core allows you to customise the workflow to suit this, and you
can assign the task to the relevant person at each stage.
Want to use the same project for all your job applications, but worried after a while it'll
get too large with too many tasks open? Well you can help sort your issues by
assigning them defined labels for each open role. This will help you search the tasks
easily and pick out the tasks that relate to the role you're hiring for. You could also add
components to the project, which are like a grouping for your tasks. You can use
components to automatically assign someone to each task that's placed within that
component.
These are just some ideas of how JIRA Core can help you with your process, and make it more visible and
manageable.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 9
There's a lot of work that needs done for each contract, and it can vary
greatly! You're starting to lose visibility and need the ability to bring
everything together and track the work that needs done, who's responsible,
and when it's due by. You've heard of JIRA Core and you decide to give it a
whirl... but where to start?!
Sign up for Try me!
a free trial
Use case Marketing campaign - you need assets, locations booked, websites created, approval to go
live... the list goes on!
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a new task for each item of work that needs done. Give it a descriptive title to
this? make sure everyone knows at a glance what it's for.
2. Add sub-tasks for any additional work that may need done, making sure you break big
chunks of work into more manageable pieces.
3. When the sub-tasks are done, you can complete the parent task. And your work is done!
How would
this look?
Can I make Don't forget you can add comments to your tasks, and mention people in the comments by
this easier? using the "@" mention. This makes sure everyone is aware of the work and tasks that are
needed. When using tasks and sub-tasks to track your work, it's also useful to remember you
can view the Activity and Statistics page for your project by clicking on the project name in
your sidebar. These views give you a breakdown of the issues in your project so you always
know where you stand. If you need more detailed info, you can also create you own
dashboard with all the statistics you need, and add a link to the dashboard in your sidebar.
Other Marketing tasks can be very diverse and very specific in their requirements. You can
customizations customize your issues and make various fields 'required' to ensure they're always completed
correctly. You can set the fields in various ways (drop-down, multi-select, free text etc.) to
make sure whoever creates the tasks can only select from your pre-defined selections, or
can complete the information as they see fit. Notifications can also be customized so that the
right people are always updated when they need to be. Make sure the tasks and project are
set up they way you work.
Getting the hang of how JIRA Core can be used? Talk to your administrator about more ways you can
customize your project to make sure it suits how you work.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 10
Sound a little complicated? Let's look at an example, say you run a small manufacturing business making
bespoke metal parts. Some metal parts are simple, and all they require is one process, such as simple
cutting with a laser, to complete the part, and some metal parts are more complex, requiring a series of
operations to produce the finished part. How could you control these in one project?
What Business Project Management - This gives you a straightforward workflow of To do, In progress
project and Done, and accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each new piece of work that comes in.
this? 2. Add a description that states what's needed in terms of raw material, and add any
supporting drawings as attachments.
3. Create a sub-task for everything that needs to be done separately. You may need
other parts cut and folded, or special parts ordered in.
4. Assign each sub-task to the relevant person responsible for making sure it's done.
They can complete the sub-task when they've completed their task. Make sure you
have these sub-tasks completed before advancing the main task.
5. Once all these sub-tasks have been completed, you can progress the parent task,
and mark it as done once you have completed the work!
How would
this look?
Can I make Well in this case, the flow is pretty straightforward. While work's in progress, the task is
this easier? in progress, and when it's complete the work is done. Adding comments would be a
great way keep track of the work, and where it is in the process. Assigning tasks and
sub-tasks to the relevant parties helps make sure everyone knows when they have
something to do!
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 11
Other JIRA Core's workflows can be configured to suit your process, so in this case you may
customizations want to track all the work on one task. You could add statuses of all the main stages in
metal fabrication, like Cut, Laser, Punch, Fold... right through to Paint, Inspection and
then Done. If any stage isn't required, you can simply transition the task straight through
to the next required stage. You could also customize the issue types, making a different
sub-task for each stage, as some parts could probably progress through fabrication
independently. You can even set up separate workflows for different issue types in the
project! It's all about how you work, and how your team likes to do things. JIRA Core
just lets you do it and keep track of it.
Use case Invoice tracking - make sure you know when to generate your invoices, and when to chase
them.
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each invoice that needs to be generated.
this? 2. Once you've generated the invoice and sent it, move the task to In progress, and add any
details that need to be recorded to the comments of the task.
3. You can set a due date for when the invoice should be paid, or a date for when you want to
chase it.
4. Once the invoice has been paid in full, you can move the task to Done!
How would
this look?
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 12
Can I make If you need to make sure you record specific information for each invoice, such as the invoice
this easier? number, add a field to the issue type Task called 'Invoice number'. This gives you a field you can
search by when filled in, so it's easy to find the issue related to the invoice number you have. You
can also add any attachments or emails to the issue to record any correspondence. You can add
these along with any required comments. If you have one person who controls your invoicing,
you can set them as the project lead to ensure they always get alerted when an issue is created.
Other While you can add a field to the issue type to make sure you have a specific field to record your
customizations invoice number in, you can go one step further and make that field required when you want to
move the task from To do to In progress. That means without a valid invoice number being
issued, you can't move the task to In progress. You could do something similar to record when
the payment has been made, you may decide you need to have a copy of the credit to your
company account to close the task off as Done.
What about something a little bit more complex? Do you have a simple purchasing flow like Order item > Item
received? Then you'll be happy with a simple workflow like Task management where a task is either To do or
Done. But what if your process is more complex, like Item requested > Business case created > Business
sent for review > Approval received > Purchase order created? Using JIRA Core's Process Management
project will give you an initial workflow to get started, and when your process matures, you can mature your
workflow to make sure it always does what you need.
Use case Purchasing - Creating and submitting a business case for approval
What Business Process Management - This gives you a workflow of Open > In Progress > Under Review >
project Approved > Done, and accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each new business case for approval.
this? 2. Populate the task with all the relevant details, attaching any documents, spreadsheets or
additional information that you think will support the business case.
3. Moving the task to Under Review and assign it to your approver (this could be your manager, or
maybe a member of the purchasing department).
4. Once approved, the final stage could be to either raise a purchase request, or possibly transfer
the data to another system to get the purchase completed. Either way, the issue is Done and
completed!
How would
this look?
Can I make Yes! You can use a lot of JIRA Core's functionality, especially comments and mentioning other
this easier? people (collaboration is alive and well!), to make sure you have all the information you need to
complete the business case. Assigning the task to the relevant people at the right time as it moves
through the workflow makes sure it'll always appear on their to do lists, and if notifications are set up,
they'll even receive an email to let them know it's ready for them.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 13
Other You may decide to change the workflow. You may need to add in a second approver. You may also
customizations want to consider assigning the task automatically to the correct person as it progresses through the
workflow. You may consider adding different issue types for each type of business case that you
accept, and assigning each issue type a specific, custom workflow (with the correct assignees per
status of course!). JIRA Core allows you to achieve this.
Think of anything else you may need to make sure you have everything recorded for your financials? Check
out the Administering a project section of the docs for some ideas on other customizable areas of JIRA Core.
Task management
The task management project template sets you up with the most basic
workflows, and is designed to allow you to create issues and get them
completed with the minimal of fuss. Using JIRA Core's functionality you can
involve the members of your team that you need to, and track your work
using your built in reporting, your dashboard, and custom filters based on
your searches.
Sign up for Try me!
a free trial
Issue types Task and sub-task. A sub-task must belong to a parent task.
Issue fields Summary, Issue Type, Reporter, Attachment, Due Date, Description, Assignee, Priority,
Resolution and Labels
There's a lot you can do with a task management project, and with a few customizations, there's a lot more
you can do to! Have a look at the example for a few ideas of how you can use it, and customize it to suit your
needs.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 14
Use case Documentation requests - get your documentation requests in one place, to be
actioned when required.
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each document you need create.
this? 2. Attach the document to the task. Remember to keep the document versioned in
your word processing package!
3. Once the document is put together, get feedback in the comments section of the
task.
4. When approved, transition the task to Done and finalise the document!
How would
this look?
Can I make You may think there's something missing here, there's no review process? Well you can
this easier? achieve this in 2 ways. You can modify the workflow to add an 'In review' status, or you
could add a resolution to the 'Done' status of 'Rejected'. That means that the person
who prepared the document would need to transition the task back to In progress to
work on it again.
Other Legal documents are very important, and need to be accurate and applicable to each
customizations case. It's also important to make sure the correct person reviews and approves the
documentation. Your workflow needs to make sure this happens. You could add a
condition to the workflow transition that means only a specific person can transition it.
That could be your approver. Remember, JIRA Core allows you to define your process.
It can be as complex or as basic as you like!
Process management
The process management project is an example of a project with a slightly
more complex workflow that you could set up in JIRA Core. The workflow
shows an example of how you could create your work, progress it, have it
reviewed, approved, and eventually completed. If you're interested in getting
more from your workflows, you should review Working with workflows for
some ideas on what you could do with your workflows to get the most out
of JIRA Core. Sign up for Try me!
a free trial
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 15
Workflow In a perfect world, your work would move from Open > In Progress > Under Review >
Approved > Done, but there's options for the work to be returned to previous statuses via
Rejected and Cancelled.
Issue types Task and sub-task. A sub-task must belong to a parent task.
Issue fields Summary, Issue Type, Reporter, Attachment, Due Date, Original Estimate, Remaining
Estimate, Description, Assignee, Priority, Resolution and Labels
Processes can be as complicated or as simple as you need them to be, and JIRA Core allows you to achieve
just that. For more ideas on what you could do, check our example for some pointers.
Use case Purchasing - Creating and submitting a business case for approval
What Business Process Management - This gives you a workflow of Open > In Progress > Under Review >
project Approved > Done, and accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each new business case for approval.
this? 2. Populate the task with all the relevant details, attaching any documents, spreadsheets or
additional information that you think will support the business case.
3. Moving the task to Under Review and assign it to your approver (this could be your manager, or
maybe a member of the purchasing department).
4. Once approved, the final stage could be to either raise a purchase request, or possibly transfer
the data to another system to get the purchase completed. Either way, the issue is Done and
completed!
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 16
How would
this look?
Can I make Yes! You can use a lot of JIRA Core's functionality, especially comments and mentioning other
this easier? people (collaboration is alive and well!), to make sure you have all the information you need to
complete the business case. Assigning the task to the relevant people at the right time as it moves
through the workflow makes sure it'll always appear on their to do lists, and if notifications are set up,
they'll even receive an email to let them know it's ready for them.
Other You may decide to change the workflow. You may need to add in a second approver. You may also
customizations want to consider assigning the task automatically to the correct person as it progresses through the
workflow. You may consider adding different issue types for each type of business case that you
accept, and assigning each issue type a specific, custom workflow (with the correct assignees per
status of course!). JIRA Core allows you to achieve this.
Project management
The project management project offers a slightly more robust workflow,
allowing you to work on bigger items by offering a workflow that has an In
Progress status. This allows you to start work on a task, and keep working in
it until it's complete. Track your work in JIRA Core by using our built in report
ing, your dashboard, and custom filters based on your searches.
Issue types Task and sub-task. A sub-task must belong to a parent task.
Issue fields Summary, Issue type, Reporter, Attachment, Due Date, Original Estimate, Remaining
Estimate, Description, Assignee, Priority, Resolution and Labels
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 17
Feel like project management will suit your needs, but think you may need a little more? Have a look at some
of our examples for some tips and tricks on what you can do with the project management project.
Use case Application tracking - You advertise for a role that's become available, and you start
receiving applications in the mail, through your website, and via email.
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a task for each candidate applying for a role.
this? 2. Add any accompanying CV's, resumès or paperwork as an attachment to the task.
3. Depending on your hiring process, if the candidate is unsuccessful they may go
directly to Done, or if you need to perform further tasks, like back ground checks,
interviews, or wait for additional paperwork, the candidate may go to In progress.
4. Once you have a successful candidate, move them to Done and add a comment or
label to say they've been successful.
How would
this look?
Can I make Yes, you can! If you've integrated JIRA Core with your email system, you can make
this easier? sure that incoming emails regarding job applications are automatically created as tasks.
Any accompanying attachments on the email will also be added as attachments to the
task. Ever wondered why some job advertisements ask for your name, the position
you're applying for and job reference in the email subject line? It's because this is
exactly what they're doing, taking those emails and automatically converting them to
"something" they can track and process! Why not use JIRA Core to do it for you.
Other We know that processing a candidate for a role is never as easy as it sounds.
customizations Depending on the role, and any requirements you may need to do several interviews,
background checks, make sure you've got the correct paperwork signed and returned...
the list goes on! JIRA Core allows you to customise the workflow to suit this, and you
can assign the task to the relevant person at each stage.
Want to use the same project for all your job applications, but worried after a while it'll
get too large with too many tasks open? Well you can help sort your issues by
assigning them defined labels for each open role. This will help you search the tasks
easily and pick out the tasks that relate to the role you're hiring for. You could also add
components to the project, which are like a grouping for your tasks. You can use
components to automatically assign someone to each task that's placed within that
component.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 18
Maybe you're in marketing? Have a look at how you could maybe use JIRA Core to manage your work.
Use case Marketing campaign - you need assets, locations booked, websites created, approval to go
live... the list goes on!
What Business Project Management - This gives you a workflow of To do, In progress and Done, and
project accompanying issue types of Task and Sub-task.
should I start
with?
How can I do 1. Create a new task for each item of work that needs done. Give it a descriptive title to
this? make sure everyone knows at a glance what it's for.
2. Add sub-tasks for any additional work that may need done, making sure you break big
chunks of work into more manageable pieces.
3. When the sub-tasks are done, you can complete the parent task. And your work is done!
How would
this look?
Can I make Don't forget you can add comments to your tasks, and mention people in the comments by
this easier? using the "@" mention. This makes sure everyone is aware of the work and tasks that are
needed. When using tasks and sub-tasks to track your work, it's also useful to remember you
can view the Activity and Statistics page for your project by clicking on the project name in
your sidebar. These views give you a breakdown of the issues in your project so you always
know where you stand. If you need more detailed info, you can also create you own
dashboard with all the statistics you need, and add a link to the dashboard in your sidebar.
Other Marketing tasks can be very diverse and very specific in their requirements. You can
customizations customize your issues and make various fields 'required' to ensure they're always completed
correctly. You can set the fields in various ways (drop-down, multi-select, free text etc.) to
make sure whoever creates the tasks can only select from your pre-defined selections, or
can complete the information as they see fit. Notifications can also be customized so that the
right people are always updated when they need to be. Make sure the tasks and project are
set up they way you work.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 19
step you through adding a status, making sure you add transitions so that you can get to your new status,
and give you more information on what you can do to that status to make it even more powerful. For
instance, you may want to make sure that when you do move an issue to "Review", it's automatically
assigned to a specific person. This can be achieved by adding a post function that allows you to update a
specific field on an issue. Make the field the Assignee field, and select the specific person you want the issue
assigned to. Bingo! The issue will now be assigned to the person when it's transitioned to that status. Take a
look at Atlassian Answers, it's full of useful information.
What if I want a parallel workflow, where I can have more than one person work on an issue at a time?
JIRA Core has one Assignee field, and this allows you to assign an issue to one person at a time. This is
intentional, as it means one person is responsible for that piece of work. It stops the cases occurring
where either two people are working on the same thing, or neither work on it as they think the other person is
working on it! That being said, there's a few ways to achieve the concept above. You could split the issue into
sub-tasks, and assign each sub-task to a different person. Another slightly more complex option is to add
another field to the issue called a "user picker" field, which allows you to select other users. The Assignee of
the issue is still responsible for the work, but it does mean other people can be added to the issue and will
show as working on it. See the tip on assigning issues to a group below for more information!
So I can add other fields to an issue? How would I do that?
You can add additional fields to JIRA Core's default issues, in fact you can even add additional issue types if
you like. All this is covered in the JIRA application administration documentation, just search for Adding a
custom field. That'll walk you through which fields you can add to an issue, and how.
Issue fields sound pretty interesting, is there any way to restrict access to them?
Issue field security is something that a lot of organizations request, but it's not something we support in JIRA
JRA-1330 - Field level security permissions
Core. You can read more about that decision on this issue CLOSED .
You can set the security level on an issue however, visit the JIRA application administration and search for
Setting security on an issue for more information on that topic.
How can I copy an issue?
If you'd like to copy an issue, it's possible by using the Clone functionality. A cloned issue will create a link to
the issue it's cloned from, and vice versa. You can read up on more details about issues and cloning them he
re.
How can I review all my information in one place?
Dashboards! JIRA Core comes with a variety of gadgets that you can configure to show your information how
you need to see it. You can add these gadgets to your dashboard, and make that dashboard your
homepage in JIRA Core when you first log in. That way the first thing you'll see is the information that matters
to you, and you'll know what you need to do.
How do I find my work? And how do I find issues that I need to?
JIRA Core offers a powerful search function, and you can even save these searches as filters for use at a
later stage. You can even share these filters with your team, so you're all looking at the same information.
Keep on top of things together!
So I use search and I still struggle to find issues I want to check. Is there any easy way to tag issues?
Yes there is! JIRA Core comes with the ability to add a label to an issue, and labels can be used in
searches. In fact, the label is 'clickable' which means that when you click the label, you'll be taken to a search
that shows all issues with that label. You can then refine that search if needed.
A word of caution though, check with your project administrator as to your organization's policy on using
labels. There may be a policy in place regarding how this field should be used, as some organizations use it
as part of a process.
Can I assign an issue to a group, so that someone in that group will work on it?
JIRA Core is designed so that issues must be assigned to a single individual to prevent tasks from being
overlooked. A team lead or manager should assign issues out to individuals, or your users will pick from a list
of issues that they have the option to take on.
However, if you want to configure JIRA Core to allow issues to be assigned to multiple users there are a few
option for doing so:
Managing Issues via a Queue
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 20
You can configure your JIRA Core project to assign issues to an 'Unassigned' "queue" by default, which your
users can then pick issues from.
To do this, set up the following:
1. Configure your JIRA Core project to allow the 'default assignee' to be 'Unassigned'.
2. Ensure that 'Allow unassigned issues' is set to ON in your General Configuration settings (Administra
tion > Global Settings > General Configuration).
3. Set any issues that you want to be in the queue to be 'Unassigned'.
4. Create a dashboard page with a filter that lists all 'Unassigned' issues, share the dashboard page and
request that interested members of the group display the shared page on their dashboards.
You can add a custom field to store which users and groups should be associated with a given issue. This is
particularly useful for projects where a team owns all issues of a particular type.
To do this, set up the following:
1. Add a group picker custom field to your issues.
2. Configure an email notification in your project's notification scheme to be sent to the 'Group Custom
Field Value'.
An issue can now be "assigned" to the group by selecting the appropriate group in the group picker. An email
notification will be sent to the group.
Another option is to add a user picker custom field rather than a group picker, and assign multiple users to
an issue. However, you will then have both the JIRA Core default user field and custom user field for your
assignees.
You can create a JIRA Core user account to represent a group of people (e.g. 'developers') and assign
issues to this user.
To do this, set up the following:
1. Create a JIRA Core user to represent the group.
2. (Optional) Create an email mailing list for this group (not a JIRA Core function) and set the mailing list
email as the JIRA Core user's email address.
3. Create a dashboard page showing issues assigned to this user, share the dashboard page and
request that interested members of the group display the shared page on their dashboards.
An issue can now be assigned the new "user" representing the group and your users can track the issues on
their dashboards. If you have set up a mailing list, your users will also be notified by email.
If you have a task managed by different users then you are able to break the combined task into individual
subtasks with their own single assignees.
It sounds like issues could benefit from having some defined groups to make them easier to manage. Is this
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 21
possible?
Yes it is. JIRA Core comes with two methods of grouping issues, Versions and Components. You can read
more on these in the Administering a projectsection of the documentation. Essentially versions and
components allow you to group issues, and the main distinction is that with a component you can assign a
user as a default assignee when the component is added to the issue, and versions can have a start and end
date.
What's in a workflow?
First, let’s take a look at what defines a workflow. A workflow has four unique components: statuses, transitions,
assignees, and resolutions. As an example, libraries have well-known workflows surrounding materials they lend
out to the public. Each item could be stored in JIRA Core as an issue, and administered in the following simple
workflow:
Statuses: where
Statuses represent the position of the issue within a workflow. In the library example, a book can be in one of
three places: at the library, with a customer, or retired from inventory. Every status should be a unique state in
your workflow.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 22
Transitions: how
Transitions are the bridges between statuses; the way a particular issue moves from status to status. At the
library, books are loaned out by librarians, returned by customers, and evaluated by library staff to see if they’re
fit for circulation. Note that customers cannot evaluate if an item is fit for inventory – that must be decided by the
library staff. With JIRA Core, you're able to set workflow permissions that allow only the right people to transition
an issue.
Assignees: who
Workflows guide how people work together. In JIRA Core the assignee dictates the responsible party for any
given issue. In the library example, we would set the assignee to the borrower every time a book is loaned out,
so that the library knows which customer has that book. When the book is returned from inventory, we would
then remove the assignee when we transition the book back to inventory.
Resolutions: why
Resolutions explain why an issue transitions from an open status to a closed status. The act of retiring a book
removes it from inventory, therefore, we can put a resolution on that book. In this example, we might use
resolutions such as damaged, out of date or lost. The two biggest mistakes new JIRA Core administrators make
are:
Confusing resolution with status – Status describes where an item is in the workflow whereas
resolution explains why an item is no longer in flight. In order to effectively use these features to retire
a book from circulation, our librarian should create a status called retired, and options for resolution t
hat include things like lost, damaged, or out of date. Searching for everything that’s retired (or
resolved) – with the ability to search for why it’s retired via the resolution options gives much better
reporting metrics. That’s why JIRA Software uses resolution to know if the issue is considered inactive
by the organization. The best way to check to see if you’ve got it right is to use the created versus
resolved gadget. You can have a workflow between when an issue is tagged with a resolution and
officially closed. Many organizations verify resolved issues to ensure they're resolved for the right
reasons.
Setting resolution correctly – You must set a resolution when an issue moves from an open state to
a closed state. Likewise, resolution needs to be removed when an issue gets reopened. At the library,
if the librarians decide to put the book back into circulation, they would need to remove the resolution
from that book. For example, a book that is able to be checked out should not have a resolution of lost.
Building the workflow you need can be challenging. Remember, it's all about building what you and your team
need to work more efficiently and effectively. That may involve you and one other person, or it could involve
several departments and many people. Here's a few pointers to get you going.
Workflow is about scaling culture, and culture is about people. Whenever it comes time to build a process
around a set of people, identify all of the stakeholders in that workflow. For example, if you’re trying to build a
workflow between product management, software development, and support, ensure you have one
representative from each organization in the meeting. As the person designing the workflow, spend time talking
with each stakeholder about what’s important to them. Before the meeting starts, draw a draft workflow on the
whiteboard, then walk through each case in the meeting and gather stakeholder feedback. Workflows are touchy
as they govern how people work, so be patient, and your investment will pay off later.
Use a whiteboard in low fidelity so it’s easy to get feedback and make changes at this stage.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 23
Most of the time, stakeholders want to have statuses for each part of the workflow. Generally, that’s a good
thing, but remember: each status adds more transitions and complexity to the workflow. Workflow is designed to
make things simple and scalable. Whenever you're adding a new status to a workflow, ensure that the
stakeholder has no other option but to grow the workflow. Let’s look at two examples.
For many news papers, articles needs to be reviewed and this is an important part of the editorial
process. Jane, the editorial manager, wants to add a specific status called article review so that it’s
clear to the team what issues are still being written, and which issues are waiting review. Reviewing
articles is distinctly different from writing articles. It makes sense to add a new state as the review state
will indicate an article has been written, and a different person (assignee) is now responsible for
review.
Bill, the editor, wants to add a new status called rejected for all issues that don’t pass review by his
team. I’d advise against doing this, as the writing team can simply reopen any issue that fails review.
An alternative option is to move the issue into a resolved state with the resolution rejected.
As a JIRA Core administrator you owe it to yourself and your users to keep workflow simple.
JIRA Core has a number of options administrators can employ when transitioning issues between states.
Conditions – Conditions control who can perform a transition. For example, only someone in the
library can retire a book from inventory.
Validators – Validators ensure that a transition can happen given the state of the issue. For example,
if a book is to be retired because it’s allegedly damaged by a customer, we’d like to ensure the book
has been checked out at least once to verify that claim.
Post functions – Post functions execute actions on issues after both conditions and validators pass.
The most common post function is to clear the resolution when reopening an issue. In the library
example, we would use a post function to clear the reason a book was retired when it got put back into
service. JIRA Core keeps a detailed history of issues, so we could look up when the issue was retired
and why.
Assignees – Whenever a transition occurs, always ask who the new owner of the issue is. Ensure that
in every transition there's a default action to route the issue to the right place. Users can override the
default action as well.
Properties – JIRA Core recognizes some properties on transitions. The most common one is to limit
resolutions displayed to the user on a given transition. For example, we might want the resolution scrat
ched to show up for disk media when retiring, but not for books.
Check out the JIRA administrator documentation on workflows for all the information on how to build the
workflow you want. Once you’ve built your workflow in JIRA Core, you should take the time to ensure the
workflow is robust and doesn't have any dead ends, or unexpected behaviours. You'll want to share the workflow
with all of your stakeholders for a final round of feedback. You should also enable the option in JIRA Core to
easily show where the current issue is in the workflow. All users have to do is click view workflow.
There's a few things you should check, and a few tricks you can use you get the most out of your workflows:
If you intend to change the workflow you're using for your project, make sure that the workflow isn't
being used by any other projects! Any changes made to a shared workflow will impact all the
projects using it.
If you already have a workflow that works for you, and you want to use it in another project, you
can either create the new project and select "Create with shared configuration", or once you've
created the project you can change the default workflow to the existing workflow that you want.
Once you edit your workflow, remember to publish it! Publishing the workflow effectively makes it
active on your project.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 24
JIRA Core can be customized to suit your needs, and can also be extended and linked with other applications to
provide you with the perfect solution to track all your work in one place.You can install JIRA Core Server anytime
by downloading a trial version, selecting the server installation type that suits your needs, and choosing the
number of users that you want the installation for.
Once you have downloaded the installer, follow our Installation guide to get up and running.
Download
If you experience any trouble with your installation or you have any question, please contact Support .
Each application delivers a tailored experience for its users, and has an associated project type which in turn
offers application specific features. Below is a list of the project types, and their associated application specific
features.
Business projects
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 25
Software projects
All users that can log in to a JIRA instance will be able to see all the projects in that instance (pending
permissions), but they will only be able to see the application-specific features when they have application
access. For example, a Software project is able to display information from linked development tools, such
as Bitbucket and FishEye, as well as agile boards, but this information is only viewable by a JIRA Software user.
A JIRA Core user would be able to see the Software project, but would not be able to see the Software-specific
features, like agile boards or the information from linked development tools. Likewise, a JIRA Software user
would not be able to see any JIRA Service Desk application-specific features on a Service Desk project, only a
basic view of the project and its issues.
A list of the applications, their user roles, and their project's application specific features is listed below:
Issue Create
level
View
Comment
Transition
JIRA View
Gadgets
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 26
Issue Create
level
View
Comment
Transition
View
Development
Information
View
Release
information
Board Create
level
View
JIRA View
Software
gadgets
Issue Create
level
View
Comment
Transition
SLA Create
level
View
Queue Create
level
View
JIRA View
Service
Desk
gadgets
What is Confluence?
Confluence is a content creation and collaboration platform that connects teams with the content, knowledge,
and coworkers they need to get work done, faster. Confluence spaces are great for creating and organizing rich
content related to JIRA projects using Confluence pages – meeting notes, project plans, requirements
documents, release notes, roadmaps, and more.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 27
Here are some of the reasons we think you might like to add Confluence to your JIRA instance:
General JIRA Use Case Document and collaborate with your team on an issue in Confluence.
And here are just a few of the things Confluence allows you to do:
Collaborative commenting, especially through the use of @mentions
Share pages
Watch pages
Form a 'team' network and let them know what you are doing via a status update
Add images, picture galleries, videos, and more
Enable various content macros
Here are some of the best features of Confluence that JIRA users would benefit from.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 28
Surface everything your development team is working on in JIRA to the teams that live in Confluence with Team
Calendars.
Timeline Calendar: View plans 3 months ahead of time.
JQL Support: Track your versions, issues, and agile sprints.
Date Ranges: Visualize issues over time to understand upcoming workload.
Report on issues
Insert issues on any Confluence page using the JIRA Issues macro
Any JIRA search result can be embedded in a Confluence page using the JIRA Issues macro with your choice of
included fields and field ordering. With the JIRA Issues macro, you can:
Display a table of issues on your page, based on the results of a search using JIRA Query Language
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 29
Autoconvert makes producing reports of issues, backlogs, and tasks as easy as copy and paste. With JIRA and
Confluence connected, you can paste individual issues or JIRA query URLs into the editor and watch them
immediately transform into the JIRA Issues macro.
Automatic links
Whenever an issue is mentioned in a Confluence page using the JIRA Issues macro, JIRA will create an issue
link to that page for you, automatically. Specs to issues, knowledge base articles to support tickets, project
outlines to tasks – it all works.
Gadgets
You can embed a Confluence activity stream or a Confluence page in JIRA's dashboard. Likewise, JIRA gadgets
can be rendered on a Confluence page. See these topics for information on how to set up these gadgets:
Add a Confluence Gadget to a JIRA Dashboard
Add JIRA Gadgets to a Confluence Page
Using JIRA applications with HipChat
Integrating JIRA applications and HipChat gives you and your team the
following collaboration power:
Get notifications in your HipChat rooms when a customer
updates a service desk request, or a developer comments on
an issue.
Create a dedicated HipChat room from the issue you're
working on and want to discuss with your team.
Preview issues and service desk requests directly in HipChat
when someone on your team mentions them.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 30
On this page:
Connectin
g projects
to rooms
Invite
users
Discuss
issues in
rooms
Issue
preview
Remove
OAuth
Permission
s
You can link JIRA projects with one or more HipChat rooms so that when issues are updated or created,
messages are sent to the HipChat rooms that you specify.
1. You must be a logged in as an Administrator or a Project Administrator.
2. Choose
> Projects.
3. Select a project.
4. In the Project Administration menu, select HipChat Integration.
5. Choose a HipChat room and select Add.
6. Select the Issue Type, Priority, or select Advanced to enter a JIRA JQL Query.
7. Select the actions that will send a notification to your room (issue created, assignee changed, new
comments, and issue transitions).
8. Select to notify users (using HipChat notifications) when a message is sent to the room.
9. Changes are saved automatically, continue browsing your project to continue.
Notify Users in This Room uses HipChat notifications (playing a sound, popups, and bouncing dock icon) to
alert users of new messages sent from JIRA. This functionality is only available in the web and IOS clients.
Private rooms
Private rooms in HipChat are by invitation only. In order to in connect JIRA to a private room in HipChat you
will need to authoriize HipChat from the HipChat Integration setup screen.
Once you have authorized JIRA, all of the private rooms that you are a member of will be displayed in the
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 31
room selector drop-down menu. When your JIRA project and room are integrated, everyone in the private
room will be able to see the notifications that are sent to that room.
Invite users
If you have administrator permissions, you can invite users to join HipChat directly from the Integration
screen. Follow the instructions in Linking JIRA and your HipChat site above, to access the integration
screen. You must have at least one project integrated with a room to see the invite users link. Select the link
to send an email inviting users to HipChat. To invite users, you will need to confirm access to your HipChat
account to give JIRA permission to invite users.
You can remove this access by following the instructions in Removing OAuth Permissions.
You can focus your discussion by creating or selecting a HipChat room to discuss an issue. When JIRA is
integrated with HipChat and you are in the issue screen, you can select to "Create a room" or "Choose a
room" in the HipChat discussions panel. This will associate the current issue and the room and any
changes to the issue will send a notification to that room.
You can also select to have links open in your HipChat App (OSX only) when you select a link. In the issues
screen, select the cog icon in the HipChat discussion to enable opening links in the application.
Issue preview
With issue preview enabled, if you enter an issue key as part of a message, or paste a URL for the issue in
any room in HipChat, you can receive a preview of the issue. This way, the entire room can see and be on
the same page when discussing an issue, without ever having to leave the discussion.
For this feature to work, HipChat needs to be able to talk to JIRA, which means that your JIRA instance must
be addressable and accept inbound connections via HTTPS.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 32
If this feature is enabled for a project, a preview will be posted in HipChat for any issue key/URL for that
project. If a project contains sensitive information you don't want shared in HipChat, make sure to disable this
feature for this project.
If you are logged in as a JIRA Administrator, you can enable or disable issue preview for all projects. A
Project Admin can also override issue preview by individually enabling or disabling this setting for each
project.
As a JIRA Administrator
As a Project Administrator
> Projects.
3. Select a project.
4. In the Project Administration menu, select HipChat Integration.
5. Select Advanced Settings.
6. Select the checkbox to enable or disable Issue Preview for your current room.
7. Select Save to exit.
You can remove permissions that you have granted to allow JIRA to access HipChat. For instance, if you
have given JIRA permission to invite users on HipChat's behalf.
1. Select your avatar to access your profile.
2. Click Profile.
3. Select Tools.
4. Click HipChat OAuth Sessions.
5. Select Remove Access.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 33
Plan automatically
Set priorities, estimates, and target dates to instantly see when you can ship releases based on your
commitments
Automatically optimize your plan and get suggestions on ideal resource allocation to create a realistic
forecast
Account for dependencies, resources, parallel vs. sequential activities and the realistic number of
people that can work on a single item to create an optimized roadmap
Use themes to categorize your backlog items by strategic focus areas, value streams, or investment
categories to see relative resource allocation between themes
Avoid bottlenecks
Identify and avoid bottlenecks and potential holdups by accounting for dependencies across teams
and projects
Model skills and define who can do which type of work to avoid unrealistic resource loads
Automatically account for team member availability, including time off, training and inter-team
commitments
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 34
Keep up to date
Keep the long term plan in sync with reality by adjusting delivery dates, team member resources and
dependencies using up to date data
Changes are displayed in real-time across all projects, giving you a comprehensive view of your entire
roadmap
Having an up-to-date schedule gives your team a transparent understanding of what's next, lending
clarity to your decision-making
Confidently make commitments for scope and ship dates by using your more reliable forecasts
Adjust dependencies to quickly check the impact across all of your projects, for example, if a critical
feature is taking longer than expected
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 35
Model changes
Quickly visualize what different scenarios and decisions mean to your projects
Evaluate new change requests by seeing the impact on scope, dates, resources and cost
commitments
Model different scenarios without affecting the underlying data in your JIRA projects
You can find more information about managing your portfolio here: Portfolio for JIRA.
JIRA Core is a workflow management system which allows you to set up unique processes that suit the way
you work. At the heart of all systems are workflows, moving packets of work from A to B. JIRA Core allows
you to make your workflow as easy or as complex as you need, giving you the freedom to concentrate on the
work, not the process. JIRA Core can be used in a variety of ways. For example, you could use it to run a
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 36
t-shirt business, setting up workflows that can manage your internal processes such as your design process,
your sales process, your manufacturing process, and even controlling your stock. The beauty of JIRA Core is
that the only constraints on your workflow are your processes!
Now that you have a basic understanding of JIRA Core and its users, select a tutorial and let's get
started:
For the purpose of the tutorials, we'll assume you're going to use JIRA Audience
Core Cloud, as it's the quickest to set up. If you want to install a JIRA
Core Server instance, please refer to the installation guides on the first step Administrators
of the JIRA administrator guide. Time
JIRA Core administrators should complete this tutorial to understand the 45 minutes
basic concepts of managing a JIRA Core Cloud site. (including JIRA
Here's what you can count on learning: Core Cloud
provisioning)
1. How to set up a JIRA Core Cloud site
2. How to add users to your site
3. How to create a project and customize it
4. How to manage permissions
By the end of this tutorial, you'll have a fully functioning JIRA
Core Cloud site, several users with different access permissions, and you'll
have created your first project.
Ready to dive in and get your hands dirty? Get started and learn how to set up your site.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 37
Success! You now have a new JIRA Core Cloud site set up. Now, let's create a project for your team.
Next
Creating a project
1. Setting up your site
2. Creating a project
3. Adding new users
4. Managing permissions
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 38
A JIRA Core project is a container that holds issues. Issues can be viewed as the packets of work required
within a project. To create issues, you must have an available project to contain them. JIRA Core comes with
several default project types with preconfigured workflows and issue types, so you can quickly get your
project up and running. In this step of the tutorial, you will use the project management template to help your
team plan, organize, and collaborate on their work.
Note that creating and configuring a project is done by an administrator. A project administrator controls user
access to the project, and can only configure certain aspects of the look and feel of the project. You should
still be logged in to JIRA Core as an administrator from the previous step. If not, log into your administrator
account.
In this step, you will be customizing the your project avatar and project
details to help your team identify the project more easily. These
customizations are helpful if you have several projects in your JIRA
Core Cloud site. If you have navigated away from your project, simply go to
Projects > Dragon Design Tees.
1. In the bottom left corner, select
Congratulations! You've now created and customized your first project. Next, we'll add users to your
project and look at how you can set up and restrict access to projects.
Next
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 39
You will be adding three users: Jason, Kate and Emma. You can add more or choose your own usernames
if you like, but please note that we will be referring to these usernames later in the tutorials. You can always
disable or delete any users you set up.
If you've logged out of your new Cloud site, log in with the administrator account you created.
1. Navigate to the User Management screen by selecting
Note that usernames are not case sensitive. Emma can enter her username as Emma, emma, or
even EmMA to log into JIRA Core. Passwords, on the other hand, are case sensitive.
Well done! You've added three new users to your Cloud site. Next, you'll learn how to manage access
to your project with site and project permissions.
Next
Managing permissions
1. Setting up your site
2. Creating a project
3. Adding new users
4. Managing permissions
You won't want every user in your team to have the same level of access to JIRA Core. For example, you
may want to restrict who can administer JIRA Core, or prevent users from viewing a project. In this step, you
will learn about the different permissions in JIRA Core and set permissions for a new project.
A role is a project-specific set of groups and/or individual users. In our example of the design project in the
t-shirt business, all product managers need to be able to assign work (issues) across all projects, while
senior designers need to be able to assign work on specific design projects. In JIRA Core, you can define a
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 40
product manager role that includes all product managers. You can then define a set of permissions with the
'Assign issue' permission for this role, and apply this set of permissions to all projects. Individual senior
designers can be added to the product manager role on each project, as needed.
Global permissions cover a small set of functions that affect all projects in JIRA Core (for example,
permission to administer JIRA Core). They can only be assigned to groups:
Project permissions cover a set of more granular functions that affect a single project in JIRA Core. For
example, permission to create issues in a project. They can be assigned to groups, users and project-specific
roles:
Now let's put this into practice! You're going to go through the tasks involved to use project permissions to
hide a new, secret t-shirt design project from some of your users.
This project role will only contain users that you want to view a particular project. We will assign permissions
to this role in the next step.
1. Select
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 41
The 'Browse Projects' permission controls whether a user can browse a project, i.e. whether they can view
the project. Let's assign this permission to your new project role.
1. Select
For the last step, let's associate the permission scheme with your new project.
1. Select Project > Create Project and choose Task Management.
2. Name the project Top Secret Tee and Submit.
3. Navigate to Project administration by selecting
Well done! You created a project permissions scheme and applied it to a project.
You've now completed the Administrator Getting started tutorial. We suggest you complete the Project
Administrator tutorial as well, so you have a better understanding of how your team will be using JIRA Core.
So put on your project administrator hat and let's get started!
JIRA Core project administrators manage specific business projects that Audience
they have been assigned to in JIRA Core. Project administrators can
customize their projects, add and remove users, and perform certain Project
configuration tasks. Administrators,
Administrators
This tutorial will teach you how to manage your project. Here's what you can
count on learning: Time
Ready to exercise those product administrator muscles? Get started by customizing your project.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 42
Customizing your project will make it stand out, and make it easier for your
teams to recognize if they're working on multiple projects.
1. On the Project Administration > Summary page, select Edit project.
2. Click Select image to change your project avatar.
3. Select an image from those displayed, or upload an image specific to
your team.
4. Note that you can also change the project name and description in
this Edit Project dialogue.
5. Select Update when you have made all changes.
Your changes will appear to all users who can access the project.
Success! You've customized your project avatar. Now, let's add a user
to your project.
Next
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 43
In this step, you will add one of your users (Emma) to the Administrators role, so she can help manage your
project.
1. In your project, select Project administration > Users and roles.
2. Select Add users to role.
3. Search for Emma. You can add multiple users and groups, and delete those you have accidentally
added in this Add users dialogue.
4. Select the Administrators role and select Add.
Emma will now have administrator access to your project. You can use the same process to add users or
groups to the Administrators role. If you would like to give users restricted access to your project (so they can
only view issues they're assigned to, for example), you can ask your administrator to create a new project
role.
Accessing a project
1. Accessing a project
2. Creating and working with issues
3. Searching for issues and filtering
Business projects can be viewed as containers that hold issues. Each project has an associated workflow,
and this workflow is applied to all issues held in the project. Start working on your assigned tasks by
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 44
Accessing a project
When you are given access to a project and you log in for the first time, you'll see the project listed in the Pro
jects dropdown menu. Let's check it out.
1. Select Projects > View All Projects. A list of all projects you have access to will display.
2. Select Dragon Design Tees. You'll land on the project summary page, which displays recent activity
and lets you easily track the status of issues in this project.
3. If you're participating in multiple projects, you can easily see which one you are currently working on,
by selecting Projects and looking under Current Projects.
You can view and filter the issues in your project so that you see, for example, only issues that are assigned
to you.
1. In your project, select Issues from the project sidebar. From here, you'll be able to preview issues and
select preconfigured filters to change which issues are displayed.
Well done! You now know how to browse to a project, and view the project details. Next, you'll create
and work with some of your own issues.
Next
Editing an issue
You can easily edit your issue to add more information, attach new files or
screenshots, and more. Inline editing is the quickest way to edit an issue. To
access all issue fields, including blank fields that don't appear when inline
editing, you can use the Edit Issue dialogue.
1. In your project, select Issues from the project sidebar and open the
first issue you created.
2.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 45
You can better manage your work by assigning issues to other members of
your team.
1. Open one of the issues you have created (e.g. DT-2).
2. Choose Assign on the issue.
3. Type emma in the Assignee field and select her as the assignee
from the drop-down list that appears.
4. Type (don't copy and paste) the following text in the Comment field,
then choose Assign.
Hi @emma, I've assigned this issue to you to work
on this week.
You will notice a few things when you enter the comment:
When you start typing after the @ symbol, you will be
prompted to choose a user: emma, in this example. Emma will
be sent an email notification that links to the issue, when you
save. This feature is called mentioning a user.
On choosing Assign:
The issue will be assigned to Emma with a comment
added to it.
A link will be automatically created to the issue in the
issue comment.
Awesome! You've created some issues, edited one, and assigned another to a member of your team.
You're really getting the hang of working with issues. Now, you'll learn how to best search for the
issues you need to work on.
Next
2.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 46
In this example, we are going tackle a common scenario: searching for all
unresolved issues assigned to you. You might regularly run a search like
this to check your backlog of work.
1. From your JIRA Core Cloud site header, select Issues > Search for
Issues. You should see issues from your demo project and any other
projects you have access to.
2. Set Assignee = Current User in the search criteria.
Notice that the search results refresh when you select new
criteria.
3. Choose More > type Resolution then select it.
4. Set Resolution = Unresolved. The search results will show the
issues that are unresolved and assigned to you.
If you are thinking that it would be handy to be able to rerun this search, we
have got you covered! Hover over the
icon in the top left and choose My Open Issues. Keep this screen open for
the next step.
If you run a search with the same criteria frequently, you may want to save it
as a filter. This lets you run the search again with a single click, rather than
selecting the same criteria every time. For example, you may use a filter to
review your open tasks for the day.
In this step, you will search for all tasks assigned to Kate in the Dragon
Design Tees project, and then save this search as a filter.
1. Select Issues > Search for Issues to start a new search.
2. Set Project = Dragon Design Tees and Assignee = kate as the
criteria. You should see at least one issue.
3. Select Save As (above the search criteria), enter Kate Dragon
Design issues as the Filter Name and save it.
That's it! Hover over the
icon in the top left. You can see your new filter under the Favorite Filters s
ection. Just click it to run it. Let's now look at some of the ways that you can
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 47
Getting your team on the same page is easy with shared filters. You could
share a filter with your team that shows the unresolved stories for a
development iteration, or the critical issues in a support backlog.
Here are two ways that you can share search results:
Run the desired filter, then choose Share. Enter the users that you want to
share the filter with and they will be emailed a link to your filter (if you have
email notifications set up).
The dashboard is the screen that all JIRA Core users see when they first log
in. You can show a filter's results on a dashboard and share it with other
users.
1. Choose Dashboards > Manage Dashboards, then choose Create
new dashboard.
2. Name your dashboard Dragon Design Tees and choose the +Add b
utton next to Add Shares to share it with everyone.
3. Leave the other fields and choose Add.
4. Choose Dragon Design Tees in the Favorite Dashboards section
to configure it.
5. Choose add a new gadget to open the 'Gadget Directory'.
6. Enter filter results in the search box and choose Add It Now.
7. Enter Kate Dragon Design issues in the Saved filter field and
choose Save.
Other users can now add this dashboard by choosing it as a favorite.
That's it! You've now performed some searches and filters, and learned to to save and share them
with your team. You're ready to jump right in and experience the full power of JIRA Core!
You've now completed the Getting started as a user tutorial. For more information on using JIRA Core,
continue to the JIRA Core documentation home.
Administering a project
Working in JIRA Core is all about working with issues in projects. A JIRA Core project is a collection of
issues, and issues are the basic packets of work that need to be done. A project allows you to apply a
process to each issue (via an associated workflow) within your project. You could choose to create a project
to track leave requests, or a project to create and monitor a marketing campaign, JIRA Core allows you to
modify your project to suit your needs.
Project details A project must have a name, a project key and a project lead. These details
help identify the project and the issues within it.
Learn more: Editing a project's details
Project access Access to your project is controlled through project role membership. You
can assign individual users or groups to the project roles.
Learn more: Managing project role memberships
Versions A version is a way to group issues within a project. Versions have a start
and end date, and can be used to effectively group issues (and therefore
your work) into deliverables by date
Learn more: Organizing work with versions
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 48
who could be a subject matter expert, or a team lead for that area of the
project.
Learn more: Organizing work with components
Workflows Each project has at least one workflow that can be applied to it's issues. A
workflow controls how an issue progresses, from creating the issue to
closing the issue.
Learn more: Workflows
Issues Issues are the packets of work that need to be done, and each issue
contains information held in fields. You can customize your issues by
changing the fields, to make sure you always have the information required
to complete your work.
Learn more: Customizing the issues in a project
Editing a project
> Projects, or
Navigate to the desired project's summary and click the Project Administration button at the
bottom of the project navigation sidebar.
2. Select Edit project.
3. Make your edits.
4. Select Update.
Managing project role memberships
You can use project roles to easily associate users and groups with a particular project. For example, you
may want to send notifications to a specific set of users associated with your project, and by adding them all
to a project role, you can then use that project role to control who receives the notifications. You can also use
project roles to restrict how much access certain users or groups have. Unlike groups, which have the same
membership throughout your application, project roles have specific members for each project.
This page contains instructions for managing membership of existing project roles. For information on
creating and using project roles, see Managing project roles.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 49
Since group membership can only be edited by users with the JIRA Administrator global
permission, project administrators may therefore prefer to assign users, rather than groups, to their
project roles.
You need to have the project-specific Administer Projects project permission or the JIRA Administrator gl
obal permission to be able to:
Add — create a new version against which issues can be aligned.
Release — mark a version as released.
Archive — hide an old version from the Releases report, and in the user interface.
Delete — remove a version. You must choose an action for any issues with that version.
Merge — combine multiple versions into one.
Reschedule — re-arrange the order of versions.
Once a version has been created for a project, the 'Affects version' and 'Fix version' fields will become
available for your issues. If you cannot see these fields on your issue, your project may not have any version
yet, or the fields are hidden from view.
The easiest way to manage a project's versions is through the Versions page.
1. Choose
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 50
1. The Add Version form is located at the top of the 'Versions' page.
2. Enter the name for the version. The name can be:
simple numeric, e.g. "2.1", or
complicated numeric, e.g. "2.1.3", or
a word, such as the project's internal code-name, e.g. "Memphis".
3. Optional details such as the version description (text not HTML), start date and release date (i.e. the pl
anned release date for a version) can be also be specified. These can be changed later if required.
4. Click the Add button. You can drag the new version to a different position by hovering over the 'drag'
icon
Release a version
1. On the 'Versions' page, hover over the relevant version to display the cog icon, then select Release fr
om the drop-down menu.
2. If there are any issues set with this version as their 'Fix For' version, JIRA allows you to choose to
change the 'Fix For' version if you wish. Otherwise, the operation will complete without modifying
these issues.
To revert the release of a version, simply select Unrelease from the drop-down menu.
Archive a version
1. On the 'Versions' page, hover over the relevant version to display the cog icon, then select Archive fro
m the drop-down menu.
2. The version list indicates the version 'archived' status with a semi-transparent icon. No further changes
can be made to this version unless it is un-archived. Also it is not possible to remove any existing
archived versions from an issue's affected and fix version fields or add any new archived versions.
To revert the archive of a version, simply select Unarchive from the drop-down menu.
Delete a version
1. On the 'Versions' page, hover over the relevant version to display the cog icon, then select Delete fro
m the drop-down menu.
2. This will bring you to the 'Delete Version: <Version>' confirmation page. From here, you can specify
the actions to be taken for issues associated with the version to be deleted. You can either associate
these issues with another version, or simply remove references to the version to be deleted.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 51
Merging multiple versions allows you to move the issues from one or more versions to another version.
1. On the 'Versions' page, click the Merge link at the top right of the page.
2. The 'Merge Versions' popup will be displayed. On this page are two select lists — both listing all
un-archived versions.
In the 'Merging From Versions' select list, choose the version(s) whose issues you wish to move. Versi
ons selected on this list will be removed from the system. All issues associated with these versions will
be updated to reflect the new version selected in the 'Merge To Version' select list. It is only possible
to select one version to merge to.
3. Click the Merge button. If you are shown a confirmation page, click Merge again to complete the
operation.
Reschedule a version
icon for the relevant version, and drag it to its new position in the version order.
The easiest way to manage a project's components is through the Components page.
1. Choose
1. The Add Component form is located at the top of the 'Components' screen.
2. Enter the Name for the component. Optionally, enter a Description and select a Component Lead a
nd Default Assignee (see options below).
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 52
You can optionally set a default assignee for a component. This will override the project's default assignee for
issues in that component. If an issue has multiple components, and the default assignees of components
clash, the assignee will be set to the default assignee of the component that is first alphabetically.
Project The assignee will If the project leader is not permitted to be assigned to issues in the
Lead be set to the permission scheme, this option will be disabled and will say "Project
project leader. Lead is not allowed to be assigned issues".
Component The assignee will If the component leader is not permitted to be assigned to issues in the
Lead be set to the permission scheme, this option will be disabled and will say
component leader. "Component Lead is not allowed to be assigned issues". The
Component Lead option will also not be available if the component
does not have a lead assigned to the component. Instead, under this
option, it will say "Component does not have a lead".
Unassigned The assignee of This option will only be available if "Allow unassigned issues" is
the issue will not enabled in the general configuration.
be set on the
creation of this
issue.
1. On the 'Components' screen, hover over the relevant component to display the pencil icon.
2. Edit the component's Name, Description, Lead, and Default Assignee.
3. Click the Update button to save your changes.
Deleting a component
1. On the 'Components' screen, hover over the relevant component to display the Delete button.
2. You will be prompted to associate these issues with another component if you wish.
Workflows
All JIRA projects contain issues that your team can view, work on, and transition through stages of work — from
creation to completion. The path that your issues take is called a workflow. Each JIRA workflow is composed of
a set of statuses and transitions that your issue moves through during its lifecycle, and typically represents work
processes within your organization.
In addition, JIRA uses workflow schemes to define the relationship between issue types and workflows.
Workflow schemes are associated with a project, and make it possible to use a different workflow for different
combinations of project and issue types.
If you need to edit or create a more advanced workflow to match how your team or organization works, you can
log in as a JIRA Administrator with global permission to access and create your workflow.Each project in JIRA
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 53
requires a workflow. If you want to keep things simple you can use the default built-in workflows in JIRA that
consist of moving an issue through the basic statuses. Your workflow will depend on which Project types you are
using and what workflows have been created in your JIRA application.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 54
To customize your issues, you need to be a JIRA administrator. You can review more conceptual information on
customizing issues in the JIRA administrator's documentation.
Working in a project
A project in JIRA Core is a collection of issues. Your team could use a project to coordinate the development
of a product, track a project, manage a help desk, and more, depending on your requirements. A project can
also be configured and customized to suit the needs of you and your team.
This section of the documentation covers working in a project that's already been set up for you.
Working in a project, and JIRA Core in general means you can log in. And if
User profile
you can log in, you have a profile that you can edit to make sure it's
configured how you want it to be configured.
Learn more about how to manage your profile
Getting to grips with how your project looks and is set up will help you work
Viewing a project
more effectively and efficiently.
Learn more about how to view a project and its contents
Issues are the packets of work that need done in a project. Knowing what
Working with issues
you can do with them, and how to do it, is the basis of all work in JIRA Core.
Learn more about working with issues
You can't work on issues if you can't find them. Working out what the most
Searching for issues
effective way to search for issues is, and how to use the powerful advanced
search function, will help you always be able to locate your issues when you
need them.
Learn more about searching
Reporting helps you manage and track your work.
Reporting
Learn more about reporting in JIRA Core
Gadgets are nifty ways of displaying data about your project and your
Gadgets
issues. Setting them up and using the right ones makes sure you always
have your stats at hand.
Learn more about gadgets
You can set up dashboards, and share them with team members, so that
Dashboards
everyone is viewing the same information on your projects and issues. You
can add gadgets to dashboards, and create wallboards which allow you to
display your stats anywhere you can connect to.
Learn more about dashboards and wallboards
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 55
In the Details section on the Summary page, click the edit icon
at the top-right of the section to edit your display name, email address, and password. If
your JIRA administrator has configured the user directory with external password management, the Change
Password link will not be available.
Select
or your current avatar to change the image that appears next to your name in JIRA. If your administrator
has enabled Gravatar for user avatars, your Gravatar (i.e. the Gravatar associated with the email address in
your user profile) will automatically be set as your user avatar. If Gravatar has been enabled, you will not be
able to choose JIRA -specific user avatars and vice versa. using Gravatar.com. If Gravatar has been
disabled, you can choose your user avatar from the ones pre-packaged with JIRA or upload your own.
Your cropped image is resized to 48x48 pixels before it is saved as your new custom user
avatar.
A separate 16x16 pixel version of your custom user avatar will be generated for use
in comments.
Custom user avatars can only be selected by the user who uploaded them.
Your JIRA home page is the JIRA page you are presented with immediately after you log in.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 56
You can configure the following JIRA pages as your JIRA home page:
The Dashboard
The Issue Navigator
The Rapid Board (available if you're using JIRA Software)
1. Click on your profile icon at the top right of the screen.
2. Select the appropriate home page option within the My JIRA Home section:
Dashboard
Issue Navigator
Rapid Board (available if you're using JIRA Software)
Your page will be reloaded the JIRA home page you selected.
3. (Optional) To verify that your JIRA home page has been reset, log out and log back in to JIRA again.
You should be taken directly to the JIRA home page you selected in the previous step.
In the Preferences section on the Summary page, click the edit icon
at the top-right of the section to open the Updated User Preferences dialog box. You can then manage the
following:
Change the Email Type to change the format (plain text or HTML) in which JIRA sends its outgoing
email notifications.
In My Changes, Choose between making JIRA send you email notifications about issue updates
made by either both you and other people (Notify me) or other people only (i.e. Do not notify me).
The global defaults for most of the user preferences below can be set by your JIRA administrator; however,
you can override these default settings by changing the following:
The Page Size, or number of issues displayed on each Issue Navigator page
Your preferred language from the drop-down list. If you don't see your preferred language in the list,
see Translating JIRA for more information.
Your time zone specified in your profile doesn't match the time zone of the computer you are working
on, JIRA will ask if you want to update this selected time zone setting. All time fields in JIRA will now
be displayed in your preferred time zone.
Choose the default Sharing setting for when you create new filters and dashboards, which can be
either shared with all other users (Public) or restricted.
Choose to enable or disable JIRA's keyboard shortcuts feature.
Choose between allowing JIRA to make you an autowatcher of any issue that you create or comment
on.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 57
An OAuth access token is issued by JIRA to give gadgets access to restricted data on an external,
OAuth-compliant web application or website (also known as a "consumer"). Check out Allowing OAuth
access for recommendations on when to issue or revoke OAuth access tokens.
If you are accessing your JIRA applications in a public environment, you can clear you login tokens by
clicking the Clear all Tokens link in the Details section of your Profile.
The JIRA gadget on the 'consumer' is granted access to your JIRA data via an 'OAuth access token', which
acts as a type of 'key'. As long as the consumer is in possession of this access token, the JIRA gadget will be
able to access JIRA data that is both publicly available and privy to your JIRA user account. You can revoke
this access token at any time from your JIRA user account, otherwise, all access tokens expire after seven
days. Once the access token is revoked or has expired, the JIRA gadget will only have access to publicly
available data on your JIRA instance.
An OAuth access token will only appear in your user profile if the following conditions have been
met:
1. Your JIRA Administrator has established an application link using OAuth between your JIRA instance
and the consumer. JIRA Administrators should refer to Using AppLinks to link to other applications.
2. You have accessed a JIRA gadget on a consumer and have allowed this gadget access to your
JIRA data. See Issuing OAuth access tokens below for details on this process.
Screenshot: Viewing your OAuth Access Tokens
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 58
An OAuth access token is issued by JIRA to provide one of its gadgets on a consumer, access to your
JIRA data (that is, data which is restricted to your JIRA user account).
1. When you are using a JIRA gadget on a consumer (such as Bamboo) and this gadget requires access
to your JIRA data, you will first be prompted to log in to JIRA (if you have not already done so).
2. Once you have logged in to JIRA, you will be prompted with a ' Request for Access' message:
Screenshot: Request for Access Message
At this point, JIRA is preparing to issue the JIRA gadget (on the consumer) with an OAuth access
token.
3. To grant the gadget access to your JIRA data, click the 'Approve Access' button. The consumer
application will receive the OAuth access token from your JIRA instance. This access token is specific
to this gadget and as long as the token resides with the gadget, your gadget will have access to your
JIRA data.
You can revoke an OAuth access token to deny a JIRA gadget on a consumer access to JIRA data which is
restricted to your JIRA user account. You can only revoke OAuth access tokens that you have allowed JIRA
to issue previously.
1. Choose your user name at top right of the screen, then choose Profile.
2. Click the 'Tools' menu and select the 'View OAuth Access Tokens' menu item.
3. The 'OAuth Access Tokens' page will be displayed.
Screenshot: Viewing your OAuth Access Tokens
Your list of OAuth access tokens is presented in a tabular format, with each access token presented in
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 59
separate rows and each property of these tokens presented in a separate columns. Refer to the OAut
h access token table details section below for more information about this table.
4. Locate the JIRA gadget and its associated consumer application whose OAuth access token you wish
to revoke and click its 'Revoke OAuth Access Token' link in the 'Actions' column.
5. You may be prompted to confirm this action. If so, click the ' OK' button.
The gadget's access token is revoked and the JIRA gadget on the consumer will only have access to
publicly available JIRA data.
Column Description
name
Consumer The name of the JIRA gadget that was added on the consumer.
Consumer A description of this consumer application. This information would have been obtained from
Description the consumer's own OAuth settings when an OAuth relationship was established between
JIRA and that consumer.
If the consumer is another Atlassian application, this information is obtained from the Con
sumer Info tab's 'Description' field of the OAuth Administration settings. The application's
administrator can customize this Consumer Info detail.
Issued On The date on which the OAuth access token was issued to the consumer by JIRA. This would
have occurred immediately after you approved this gadget access to your JIRA data (privy to
your JIRA user account).
Expires On The date when the OAuth access token expires. This is seven days after the 'Issued On'
date. When this date is reached, the access token will be automatically removed from this
list.
Requesting add-ons
The Atlassian Marketplace website offers hundreds of add-ons that administrators can install to enhance and
extend your JIRA applications. If the add-on request feature is enabled for your instance, you can submit
requests for Marketplace add-ons directly to your administrator.
The 'Atlassian Marketplace for JIRA' page presents an integrated view of the Marketplace website from within
the JIRA user interface. The page offers the same features as the Marketplace website, such as add-on search
and category filtering, but tailors the browsing experience to JIRA application users.
This in-product view of the Marketplace gives day-to-day users of the Atlassian applications, not just
administrators, an easy way to discover the add-ons that can help them work. When you find an add-on of
interest, you can submit a request with just a few clicks.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 60
1. From anywhere in the application, open your profile menu and choose Atlassian Marketplace.
2. In the Atlassian Marketplace page, use the search box to find add-ons or use the category menus to
browse or filter by add-ons by type, popularity, price or other criteria. You can see what your fellow users
have requested by choosing the Most Requested filter.
3. When you find an add-on that interests you, click Request to generate a request for your administrator.
4. Optionally, type a personal message to your administrators in the text box. This message is visible to
administrators in the details view for the add-on
5. When ready, click Submit Request.
6. Click Close to dismiss the 'Success!' message dialog box.
At this point, a notification appears in the interface your administrators use to administer add-ons. Also your
request message will appear in the add-on details view, visible from the administrator's 'Find New Add-ons'
page. From there, your administrator can purchase the add-on, try it out or dismiss requests.
After submitting the request, you can update your message at any time. Click the Update Request button next
to the listing in the 'Atlassian Marketplace' page to modify the message to your administrator.
The administrator is not notified of the update. However, your updated message will appear, as you have
modified it in the details view for the add-on immediately.
Using keyboard shortcuts
Keyboard shortcuts are a great way for you to speed up editing, navigating, On this page:
and for performing actions without having to take your fingers off the View
keyboard. keyboard
shortcuts
Some keyboard shortcuts require additional permissions or applications, and
Enabling
depend on how your JIRA administrator(s) have configured permissions for
and
your user account and which applications are installed.
disabling
keyboard
shortcuts
Choose
Keyboard shortcuts are enabled by default. However, you can disable them on a per-user basis in
the Keyboard Shortcuts dialog box.
1. Ensure you are logged in and open the Keyboard Shortcuts dialog box (see above).
2.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 61
2. At the bottom of the Keyboard Shortcuts dialog box, click Disable Keyboard Shortcuts or Enable
Keyboard Shortcuts.
You can also disable or re-enable keyboard shortcuts by editing the Preferences section of your user
profile. See Managing your user profile for more information.
Modifier keys
Some keyboard shortcuts require modifier keys to be pressed simultaneously, along with a single 'action'
key. Modifier keys may differ, depending on your combination of operating system and web browser. The
following table identifies the modifier keys for some supported web browsers and operating systems:
Firefox Ctrl Alt + Shift Alt + Shift In Firefox, it is possible to customize 'Modifier key
shortcuts'. Please read Mozilla's documentation for
more information.
Viewing a project
When you select a project to view for the first time, you're taken to the project Activity page. If you've viewed the
project before, you'll be taken to the last screen you visited on it. The Activity page provides a summary of your
project activity, and further navigation which allows you to 'dig down' into further detail. The sidebar provides
navigation to all the issues in the project, and the reports available. If you're a project administrator, you can also
add unique shortcuts to information and other webpages to the sidebar, which are accessible to all users with
access to the project.
You can access the project Activity page by selecting the Project drop-down, and selecting your project from the
list. If your project is not listed, select View all projects to search for your project. Once you're viewing the
project, click the Summary link to view the Activity page.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 62
From the project summary screen, you can view the following by selecting the link in the project navigation
sidebar:
Project:
Summary (as shown above)— Shows recent activity in your project, the project lead, the most
active users within your project, and the project key.
Issues— Takes you to the issue navigator, which shows a list or detailed view of issues in your
project.
Reports – Shows reports on statistics for particular people, versions, issues or other fields within
issues.
Components* — Shows a summary of all components for a given project.
Versions* — Shows a snapshot of all versions within a project, and can be filtered by released and
unreleased.
* Versions and Components are only available if your project administrator has created versions or components
within the project.
Project Shortcuts:
Project shortcuts can be added to your project navigation page to any online resources your team
may want to access. These shortcut links are available to everyone who has access to the project.
Viewing a project's versions
JIRA's Versions page shows a summary of all versions in a project. These can be further filtered by released
versions and unreleased versions, and you can search by text contained within a version. Versions can only be
displayed if your project administrator has created versions for your project. When versions have been created,
you can assign the versions to your issues via the Affects Version/s and Fix Version/s fields
The Versions page is a visual representation of how your versions are progressing. The data represented is
taken from the Fix Version/s field, and shows the status of the issues assigned to that version. Selecting the
version link in the Version column will display further detail on that version, as well as giving you the option to
view release notes, and to release that version (providing you have the correct permission to do so).
To view a project's releases:
1. On the top navigation bar, click the white triangle next to Projects. The projects drop-down will display.
Tip: You can access your current project directly by simply clicking the Projects link instead of the
triangle.
2. Click the project you wish to browse. If the project is not displayed in the drop-down, click View All
Projects, which allows you to view a list of all accessible projects on your JIRA instance, and select your
project from there.
3. Click Versions in the project navigation sidebar. A list of versions for your project is displayed.
Viewing a project's components
JIRA's Components page shows a summary of all components (if any have been created) in a project. You can
search for components by text contained within the component's name or description.
To browse a project's components,
1. On the top navigation bar, click the white triangle next to Projects. The projects drop-down will display.
Tip: You can access your current project directly by simply clicking the Projects link instead of the
triangle.
2. Click the project you wish to browse. If the project is not displayed in the drop-down, click View All
Projects, which allows you to view a list of all accessible projects on your JIRA instance, and select your
project from there.
3. Click Components on the left of the page. A list of components for your project will display (see
screenshot below).
Click the name of a component to view all the issues related to the component.
Viewing a project's issues
The Activity page allows you to access the issues contained in that project via the project navigation sidebar.
The issues are displayed as a list, and have several filters you can select to view the issues relevant to you.
To view a project's Issues,
1. On the top navigation bar, click the white triangle next to Projects. The projects drop-down will display.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 63
1.
Tip: You can access your current project directly by simply clicking the Projects link instead of the
triangle.
2. Click the project you wish to browse. If the project is not displayed in the drop-down, click View All
Projects, which allows you to view a list of all accessible projects on your JIRA instance, and select your
project from there.
3. Click the Issues tab in the project navigation sidebar. An embedded issue navigator is shown for all the
issues in your project.
Tip: To view an expanded view of an issue, click the expand (
) icon on the issue or any issue link in the issue (description or comment).
Project shortcuts
You can add shortcuts to the project navigation sidebar to web pages and online information that you think your
team may find useful. When you add a link, it will be available to all users who can access the project. The
shortcuts can be accessed when the sidebar is collapsed by hovering over the shortcut icon, however to add,
edit or delete a shortcut the sidebar must be expanded.
To add, delete or edit a link, you need to have the JIRA Administrator permission or the Project Administrator
permission. When adding or editing a link you also need to have the full web address, and you can optionally
give it a label that will show in the project navigation sidebar. Labeling the shortcuts makes it easier to identify
where the link will take you.
Add a shortcut
1. On the top navigation bar, click the white triangle next to Projects. The projects drop-down will display.
Tip: You can access your current project directly by simply clicking the Projects link instead of the
triangle.
2. Click the project you wish to browse. If the project is not displayed in the drop-down, click View All
Projects, which allows you to view a list of all accessible projects on your JIRA instance, and select your
project from there.
3. Select Add link in the project navigation sidebar.
4. Enter the web address for your shortcut and an optional label, then select Add. Your shortcut will display
in the project navigation sidebar.
Note that you must enter a valid web address that JIRA recognizes. These must be prefixed with a valid
URI. The valid URI's are listed below.
Edit a shortcut
1. Access the project navigation sidebar as you did above, and locate the shortcut you'd like to edit.
2. Select the drop-down arrow to the right of the shortcut.
3. Select Edit.
4. Edit the link details, and select Save. Your shortcut has been edited.
Delete a shortcut
1. Access the project navigation sidebar as you did above, and locate the shortcut you'd like to delete.
2. Select the drop-down arrow to the right of the shortcut.
3. Select Delete. Confirm the deletion. Your shortcut has been deleted and removed from the project
navigation sidebar.
"http://", "https://", "mailto:", "skype:", "callto:", "facetime:", "git:", "irc:", "irc6:", "news:", "nntp:", "feed:", "cvs:", "svn
:", "mvn:", "ssh:", "itms:", "notes:", "smb:", "hipchat:"
Working with issues
Need help working with issues? JIRA Coreallows you to create issues
quickly, assign them to the right person, and get working on them in
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 64
seconds! On this page, you'll find a quick overview for everything that you On this page:
can do with an issue, as well as links to pages with more detail.This page
introduces you to the concept of an issue. You can then learn more about What is an
creating, editing, and collaborating issues in the Next steps section. issue?
Next steps
What is an issue?
Different organizations use JIRA applications to track different kinds of issues, which can represent anything
from a software bug, a project task, to a leave request form.
In JIRA Core, an issue is essentially a packet of work. It could be a small task like "Remember to order pizza
for charity night", or a large chunk of hard work like "Build bridging wall between house and garage"! It all
depends on your project, and how you and your team decide to break down your work into issues.
An issue is broken down into several key areas. Here's an example of an issue to build a wall, and we've
pointed out the key areas for you.
<screenshot when tied down>
Next steps
A JIRA administrator must enable specific user permissions so that you can add attachments and
screenshots into issues. The most common permissions are briefly described below. For more information,
your administrator should refer to Configuring file attachments.
JIRA administrator set permissions
You can attach files and screenshots if your JIRA administrator has file attachments enabled.
You need the Create Attachments permission in the appropriate projects.
The screenshot feature only works with Windows or Mac client. If you use another operating
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 65
system, you can attach a screenshot using the file attachment feature. For Linux users, please
see our article for enabling this feature.
If your JIRA admin has disabled thumbnails in JIRA's attachment settings, the image files will
appear as a list.
If your JIRA admin has disabled ZIP support in JIRA's attachment settings, the attachments feature
will not be available. You must download the zip file to your computer before accessing its
individual files.
To remove attachments from an issue, you need one of the following the project permissions in
that issue's project:
Delete Own Attachments — to delete files that you have added to the issue.
Delete All Attachments — to delete files that anyone has added to the issue.
Browser capabilities
If you're using Google Chrome, Mozilla Firefox, or Internet Explorer 11, attaching screenshots
relies on HTML5 compatibility. Safari is not supported.
Adding attachments
You can add file and image attachments to any issue. To add an attachment when you first create an issue,
copy a file from your computer and paste it directly in the Create Issue dialog. To add attachments to an
existing issue, open the issue and follow these steps:
1. Click More >Attach files.
2. Add a file(s).
3. Click Attach or Open.
You can also drag and drop files onto an issue to attach them.
Acceptable file formats, characters, and sizes
File formats: GIFs, JPGs, PNGs
A valid file name cannot contain any of these characters: '\', '/','\"', '%', ':', '$',
'?', '*'.
By default, the maximum size of any one file is 10MB, although this limit can be customized by
your JIRA admin.
The attachments section of the issue displays a list of options to sort, manage, and download attachments.
Select the down-arrow to the right of the attachments section to open the menu. You can reorder the
attachments according to a selected criteria. This criteria will be applied to all issues in your
project. To remove attachments from the issue, select Manage Attachments or hover over the attachment
and select
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 66
You can view the contents of a zip file (including '.zip' or '.jar' file name extensions) in the attachments
section. Click the down-arrow and select List. In list view, click the arrow icon in front of the zipped file's
name to view and download its individual files. If a file is located within a subdirectory of the zipped file, the
path to that file is indicated in the content of the zipped file. To download the entire zip file, click Download
Zip.
You can capture a screenshot to the system clipboard and paste it directly into an issue.
1. Capture a screenshot using your system keyboard shortcut.
2. Paste the image from your clipboard onto the issue using your system keyboard shortcut or right-click
menu. The Attach screenshot dialog will display.
3. Enter a filename.
4. Select Upload.
Creating an issue
1. Click Create at the top of the screen to open the Create Issue dialog box.
2. Select the relevant Project and Issue Type in the Create Issue dialog box.
3.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 67
3. Type a Summary for the issue and complete any appropriate fields — at least the required ones that
are marked by an asterisk.
If you want to access fields that are not shown in this dialog box, or you want to hide existing fields:
a. Click the Configure Fields button at the top right of the screen.
b. Click Custom and select the fields you want to show or hide by selecting or clearing the
relevant check boxes respectively, or click All to show all fields.
When you next create an issue, these selected fields will be displayed.
4. Optional: To create a series of similar issues – with the same Project and Issue Type – select the Cr
eate another checkbox at the bottom of the dialog. Depending on your configuration and the values
you may have specified when creating previous issues, some of the fields in the new Create Issue
dialog box may be pre-populated. Make sure you check they're all correct before creating the next
issue.
5. When you are satisfied with the content of your issue, click the Create button.
Cloning an issue
Cloning or copying an issue lets you quickly create a duplicate of an issue within the same project. The
cloned issue is a replica of the original issue, containing most of the same details stored in the original issue
— e.g. Summary, Affects Versions, Components, etc. However, some details aren't cloned — e.g. Work Log,
Comments, Issue history, and Links to Confluence pages. Statuses and resolutions aren't cloned as well; the
statuses return to the first step of the corresponding workflow, and the resolutions are cleared. The cloned
issue can also be linked to the original issue.
1. Open the issue you wish to clone.
2. Select More > Clone. The Clone Issue screen will appear.
You can edit the clone issue's Summary if you wish.
If the issue contains links to other issue(s), you can select whether or not to include the links in
the new cloned issue.
If the issue contains sub-tasks, you can select whether or not to create the sub-tasks in the new
cloned issue.
If the issue contains attachments, you can select whether or not to include the attachments in
the new cloned issue.
3. Click Create.
Creating a sub-task
A sub-task can be created for an issue to either split the issue into smaller chunks, or to allow various
aspects of an issue to be assigned to different people. An issue cannot be resolved until all its sub-tasks are
completed and resolved. If you find a sub-task is holding up the resolution of an issue, you can convert the
sub-task to an issue, to allow it to be worked on independently. If you find an issue is really just a sub-task of
a bigger issue, you can also convert an issue to a sub-task.
Note: You can only create sub-tasks if your administrator has enabled sub-tasks, and has added the
sub-task issue type to the project's issue type scheme.
1. Navigate to the issue you would like to be the parent issue of the sub-task you are about to create.
2. Select More > Create Sub-Task. You will see the Create sub-task screen.
3. Fill in the details as needed, and then click Create at the bottom of the page.
Tip: You can customize the Create sub-task screen to show fields you use most often. To do this, click Conf
igure Fields at the top right corner of the dialog, and use the All and Custom links to switch between the
default screen and your custom settings. Your changes are saved for future use.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 68
5.
required. Otherwise, you will see the message 'All fields will be updated automatically'. Click Next.
6. The Step 4. Confirmation screen is displayed. If you are satisfied with the new details for the issue,
click Finish.
7. The issue will be displayed. You will see that it is no longer a sub-task, that is, there is no longer a
parent issue number displayed at the top of the screen.
When creating (or editing) an issue, you can restrict access to that issue to members of your team who are
part of a chosen security level. To be able to set the security level for an issue, your administrator must add
you to the appropriate issue security level, and also grant you the 'Set Issue Security' permission for the
appropriate projects.
1. Create/edit the relevant issue.
2. In the Security Level drop-down field, select the desired security level for the issue. You will only see
the security levels you belong to.
3. Save the issue. It is now only accessible to members of the specified security level.
Users who are not members of this security level will not be able to access that issue, or see it in any
filters, queries, or statistics.
There are two steps to using the CSV importer, and an optional third step:
1. Preparing your CSV file
2.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 69
The JIRA Importers plugin assumes that your CSV file is based off a default Microsoft Excel-styled CSV file.
Fields are separated by commas, and any content that must be treated literally, such as commas and new
lines/'carriage returns' themselves are enclosed in quotes.
For Microsoft Excel and OpenOffice, it is not necessary to quote values in cells as these applications
handle this automatically.
Use double-quote marks (") in your CSV file to capture data that spans multiple lines. For example, upon
import, JIRA will treat the following as a valid CSV file with a single record:
Use double-quote marks (") around a section of text to treat any special characters in that section literally.
Once this data is imported, these special characters will be stored as part of JIRA's field data. Examples of
special characters include carriage returns/enter characters (as shown in the example above), commas, etc.
To treat a double quote mark literally, you can 'escape' them with another double quote mark character.
Hence, the CSV value:
"Clicking the ""Add"" button results in a page not found error"
once imported, will be stored in JIRA as:
Clicking the "Add" button results in a page not found error
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 70
Aggregating multiple values into single issue fields
You can import multiple values into an issue field that accepts multiple values (e.g. Fix (for) Version, Affect
s Version, Component, Labels). To do this, your CSV file must specify the same column name for each
value you wish to aggregate into the mapped issue field. The number of column names specified must match
the maximum number of values to be aggregated into the mapped field. For example:
In the above example, the Component field of the second issue and the Fix Version field of the third issue
will generate multiple values in appropriate issue fields upon import.
Be aware that only a limited number of issue fields support multiple values. The CSV importer will not
allow you to import aggregated data into issue fields that only support a single value.
Importing attachments
You can attach files to issues created from your CSV file. To do this, specify the URL of your attachment in
an 'Attachments' column within your CSV file.
URLs for attachments support the HTTP and HTTPS protocols and can be any location that your
JIRA instance must be able to access.
You can import issues from your CSV file into different projects through a CSV file import. To do this:
Your CSV file requires two additional columns whose headings should be named similarly to Project
Name and Project Key.
Ensure that every issue represented in your CSV file contains the appropriate name and key in these
columns for the projects to which they will be imported.
The project name and key data is the minimum project data required for importing issues from a
CSV file into specific projects.
In the example above, the first and second issues will be imported into the 'Sample' project (with project key
'SAMP') and the third issue will be imported into the 'Example' project (with project key 'EXAM') , assuming
you match the 'Project Name' and 'Project Key' fields in your CSV file to the Project name and Project key i
ssue fields, respectively during the CSV file import wizard.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 71
Summary,Worklog
Only time spent (one hour),3600
With a date and an author,2012-02-10 12:30:10;wseliga;120
With an additional comment,Testing took me 3 days;2012-02-10
12:30:10;wseliga;259200
Your CSV file can contain multiple entries for the one Multi Select Custom Field. For example:
This will populate the Multi Select Custom Field with multiple values.
You can import values to a cascading choice custom field using the following syntax:
Before you begin: If your JIRA installation has existing data, you should back it up.
1. Select Issues > Import Issues from CSV to open the Bulk Create Setup page. (If you do not have
the option Import issues from CSV, your JIRA Admin must update the JIRA Importers plugin to
version 6.2.3 or above.)
2. On the Setup page, select your CSV Source File.
Leave the Use an existing configuration file checkbox cleared if you do not have a configuration file,
or if you want to create a new configuration file. Configuration files specify a mapping between column
names in your CSV file's header row and fields in your installation.
If you select this option, you will be asked to specify an Existing Configuration File.
If you do not select this option, then at the end of the CSV file import wizard, JIRA will ask you if
you want create a configuration file that you can use for subsequent CSV imports.
3. Click the Next button to proceed to the Settings step of the CSV file import wizard. Complete the
required fields.
If your CSV file uses a different separator character other than a comma, specify that character
in the CSV Delimiter field. If the separator is a 'Tab', this can be entered using the format ' /t'.
4. Click the Next button to proceed to the Map fields step of the CSV file import wizard. Here, you can
map the column headers of your CSV file to the fields in your selected project. If you want to select
specific JIRA field values to map specific CSV values to, tick the checkbox for Map field value.
Note: You must map a CSV field to the issue's summary field. This ensures the issues created
have a summary.
5. Click the Next button to proceed to the Map values step of the CSV file import wizard. On this step of
the import wizard, you can select which specific CSV field values you want to map to which specific
issue field value. For example, your issue types you may have a CSV field value of "Feature Request",
which you may want to map to the issue type field value "New Feature".
Please note:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 72
Any fields whose Map field value checkboxes were selected in the previous step of the CSV
file import wizard will be presented on this page.
Leave a field cleared or clear any content within it if you wish to import the value 'as is'.
If you are importing a username-based CSV field (e.g. Reporter or Assignee) and you do not
select the Map field value checkbox for this field in the previous step of the CSV file import
wizard, then the importer will automatically map imported usernames from the CSV file to
(lowercase) JIRA usernames.
Regardless of whether or not you select the Map field value checkbox, JIRA will
automatically create usernames based on the data in your CSV file if they have not already
been defined in JIRA.
6. Click the Begin Import button when you are ready to begin importing your CSV data into JIRA. The
importer will display updates as the import progresses, then a success message when the import is
complete.
7. If you're confident your import is correctly set up, click the Begin Import button. Your import will begin
and once complete you will be informed of any errors. If you'd like to check your import first, click the V
alidate button and JIRA will validate your import and inform you of any expected errors or warnings.
You can then go back and correct these before running your full import.
Note:
If you experience problems with the import (or you are curious), click the download a detailed
log link to reveal detailed information about the CSV file import process.
If you need to import another CSV file with the same (or similar) settings to what you used
through this procedure, click the save the configuration link to download a CSV configuration
file, which you can use at the first step of the CSV file import wizard.
Congratulations, you have successfully imported your CSV data into JIRA! If you have any questions or
encounter any problems, please contact Atlassian support.
Below are some helpful tips when importing data from your CSV file into specific issue fields:
Project CSV data is imported on a per-project basis. You can either specify an existing project(s)
as the target, or the importer will automatically create a new project(s) for you at time of
import.
Component(s) You can import issues with multiple components by entering each component in a
separate column.
Affects You can import issues with multiple 'Affects Versions' by entering each version in a
Version(s) separate column.
Fix Version(s) You can import issues with multiple 'Fix Versions' by entering each version in a separate
column.
Comment You can import issues with multiple comments by entering each comment in a separate
Body column.
Due Date Please use the date format specified on the second step of the CSV import wizard.
Issue Type If not specified in your CSV file, imported issues will be given the default (i.e. first) Issue
Type, as specified in your JIRA instance. For more information, see Defining issue type
field values.
You can also create new values on-the-fly during the import process.
Labels You can import issues with multiple labels by entering each label in a separate column.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 73
Priority If not specified in your CSV file, imported issues will be given the default (i.e. first) Priority
as specified in your JIRA instance. For more information, see Defining priority field values.
You can also create new values on-the-fly during the import process.
Time Spent The value of this field needs to be specified as number of seconds.
Users You can choose to have the importer automatically create JIRA users for any values of
the Assignee or Reporter field.
Users will be created as active accounts in JIRA. Users will need to get their
passwords emailed to them the first time they log into JIRA.
Users with no real name will get the portion of their email address (login name) before
the "@" character as their Full Name in JIRA.
If you are using External User Management, the import process will not be able to
create users; instead, the importer will give you a list of any new users that need to be
created. You will need to create the users in your external user repository before
commencing the import.
If you have a user-limited license (e.g. personal license), and the number of required
users is larger than the limit, then the import will be stopped. A page will be displayed
showing a list of users that can't be created.
If Assignee and Reporter are not mapped, then no usernames are created.
Other fields If you wish to import any other fields, you can choose to map them to specific JIRA
custom field(s). If your custom fields don't exist yet in JIRA, the importer can automatically
create them for you. If your custom field is a date field, please use the date format
specified on the second step of the CSV import wizard.
Complete your work more efficiently with these tips and tricks for editing and On this page:
collaborating on issues. Attaching
files and
In addition to learning about the basics of editing and commenting on an
screenshot
issue, you can refer to this page for help with:
s
Using the wiki toolbar to make your comments and descriptions pop Collaborati
Sharing issues with your team and mentioning other people ng on
Keeping track of issues with labels and issue watchers issues
Editing
issue
details
Commenti
ng on
issues
Formatting
text with
wiki
markup
Tracking
issues with
labels
Watching
and voting
for issues
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 74
If your administrator has enabled file attachments, you and your customers can attach files and screenshots
to issues you're working on. See Attaching files and screenshots to issues for more information.
Collaborating on issues
button to share an issue with other JIRA users. If your administrator has enabled anonymous access, you
can also share issues by entering the email address of a non-JIRA user.
If you want to invite members of your team to help you work on an issue, you can mention them by typing @
and their username in the issue description or comment. Note that the users you mention will be notified
once you save the issue description or comment.
To edit an existing issue, select Edit to open the Edit Issue dialog box and modify the issue details. If you
want to change the fields you need to edit, select Configure Fields > Custom and choose the fields you
want to show or hide. Select Update to save your changes.
Commenting on issues
What How
Delete a On the comment you wish to delete, select the trashcan icon located on the comment. Confirm
comment that you want to remove this comment from the issue by selecting Delete when prompted.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 75
Edit a Select
comment
located on the comment, and edit the text or restrictions (Viewable by...) as needed. When
you save your revised comment, you'll see 'edited' displayed to indicate that the comment has
been edited:
You can hover over 'edited' to see who edited the comment and when.
Link to a Select the Permlink icon on the comment, which will be highlighted in pale blue. Copy the link
comment from the Permlink icon and paste it into your email or chat message. The link will look
something like this: http://jira.atlassian.com/browse/TST-123?focusedCommentId=94796#actio
n_94796.
Restrict Apply viewing restrictions to a comment by selecting the open padlock icon
a
comment
(or
JIRA application Text Formatting Notation allows you to use rich-text features, such as:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 76
Labeling helps you categorize and search for an issue. When viewing an issue, select More > Labels to add
or remove labels, which will appear in the Details section:
You can click a label (e.g. doc in the above screenshot) to jump to the Issue Navigator and see a list of all
issues that have this label. You can also add the Labels Gadget to your dashboard to quickly find issues with
labels relevant to you and your team.
If your administrator has set up the needed notification scheme, you can select Start watching this issue to
be automatically notified of issue updates. You can also click the number of watchers on the issue to add
other JIRA users as watchers.
If your administrator has enabled the voting on issues, you can select Vote for this issue to encourage the
responsible team to resolve or complete the issue.
Linking issues
Issue linking allows you to create an association between two existing
issues on either the same or different JIRA servers. For example:
An issue may relate to another.
An issue may duplicate another.
An issue may block another.
Issue linking also allows you to:
Create a new linked issue from an existing issue in a service desk or
business project.
Create an association between an issue and a Confluence page.
Link an issue to any other web page.
Your JIRA administrator can customize the types of links that you can
create.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 77
On this page:
Creating a
link to
another
issue on
the same
JIRA site
Creating a
link to an
issue on
another
JIRA site
Create a
new linked
issue from
an existing
issue in a
service
desk or
business
project
Creating a
link to a
Confluenc
e page
Creating a
link to any
web page
URL
Deleting a
link
Searching
for linked i
ssues
Note: Resolved issues (i.e. issues with a Resolution set) are displayed in strike-through font, e.g. DEMO-1.
To create links on issues, you need to have the Link Issues permission in the project(s) to which the
issues belong.
1. Open the issue you wish to link to another issue in the same JIRA site.
2. Select More > Link to display the Link dialog box.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
2.
3. Ensure that the JIRA Issue item is selected at the left of the dialog box and then choose the type of
link to be created from the This issue drop-down list.
If your JIRA system administrator has configured fully reciprocal application links between your
JIRA site and another one, a Server drop-down list may appear above the This issue list. If this is the
case, ensure your JIRA site appears or has been selected from the Server list.
4. In the Issues field, specify the issue(s) to be linked to your currently viewed/selected issue. There are
two ways to do this:
Type the full issue key (e.g. ABC-123) — or to link to multiple issues, press the 'Enter' key
between each typed issue key.
If you have previously browsed an issue, you can quickly find the issue by typing the first
few letters of the issue key (or part of the Summary), which will appear in an ' autocomplete'
drop-down list for selection:
OR:
Click the search for an issue link to use the Find JIRA issues popup, which allows you to
perform either a simple text search or an advanced search for issues.
5. Optional: Add a Comment to describe why you are linking these issues.
6. Click the Link button at the bottom of the dialog.
To create this type of link, your JIRA system administrator should have configured fully reciprocal applicati
on links between your JIRA site and the other JIRA site containing the issue(s) you want to link to.
This feature is not available in Atlassian Cloud.
1. Open the issue you wish to link to another issue.
2. Select More > Link to display the Link dialog box.
3. Ensure that the JIRA Issue item is selected at the left of the dialog box.
Note:
This option will not be available if your JIRA system administrator has not configured
an application link between your JIRA site and the remote JIRA site.
If, after selecting this option, you are prompted for authorisation, you may be required to log in
to the remote JIRA site, which will allow your JIRA site to access the remote JIRA site on behalf
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 79
Troubleshooting
Problem: If you selected the Create reciprocal link checkbox, but after clicking the Link button, you
discover that a reciprocal link from the remote issue back to your issue has not been created, then your JIRA
system administrator has most likely created only a one-way link from your JIRA site to the remote JIRA site.
Solution: Ask your JIRA system administrator to configure fully reciprocal application links between your
JIRA site and the remote JIRA site.
Problem: If you attempted to create a reciprocal link but received the following message:
'A reciprocal link from issue 'XYZ-123' back to this issue was not created as the remote JIRA server
returned the following error: No Link Issue Permission for issue 'XYZ-123'. ' (where 'XYZ-123' is the
issue key on the remote JIRA site),
then a reciprocal link on the remote JIRA site will not have been created, because the user account through
which you authenticated on the remote JIRA site (at step 3 above) does not have the Link Issues project
permission.
Solution:
Ask the JIRA project administrator(s) on the remote JIRA site to grant your user account the Link
Issues project permission for the relevant project(s) to which you need to create issue links.
Alternatively, if the application link between your JIRA site and the remote JIRA site use OAuth
authentication and you suspect you may have authenticated on the remote site with another user
account that does not have the Link Issues project permission, repeat the procedure above but during
the authorisation step (at step 3), authenticate on the remote site with a user account which has this
permission.
If you are not prompted for authentication during authorisation, try clearing your browser's cookies
first and repeat the procedure again.
Create a new linked issue from an existing issue in a service desk or business project
To create a linked issue, you need to have Create issue and Linked Issues permissions in the
destination project(s).
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 80
4. Select the destination Project in which the new linked issue is to be created.
5. Select the correct Issue Type for the new linked issue.
6. In the Linked issues field, specify issue(s) to be linked to your new linked issue.
7. Edit the linked issue Summary.
8. Edit the Description and describe why you are linking these issues.
9. Select the Copy attachments checkbox to include any attachments from the original issue.
10. Select the Copy links checkbox to include any URLs from the original issue.
11. Click the Create button at the bottom of the dialog.
Your linked issue has now been created.
To create this type of link, your JIRA system administrator needs to have configured an application link be
tween your JIRA site and the Confluence site containing the pages you want to link to.
1. Open the issue you wish to link to another issue.
2. Select More > Link to display the Link dialog box.
3. Click the Confluence Page option at the left of the dialog box.
This option is not available if your JIRA system administrator has not configured an application
link between your JIRA site and Confluence site.
4. If more than one application link has been configured between your JIRA site and other Confluence
sites, then choose the appropriate Confluence site from the Server drop-down list.
5. Specify the Confluence page to be linked to your currently viewed issue. There are two ways to do
this:
In the Page URL field, enter the URL of a page on the Confluence site you want to link to. For
example:
http://<confluence-server>/display/ds/Welcome+to+the+Confluence+Demon
stration+Space
Click the search for a page link. The Link dialog box is replaced by the Find a Confluence
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 81
Troubleshooting
Problem: If Confluence page links you create show Failed to load on the issue or if you attempted to
search for a Confluence page but received the following message:
'Content on the Confluence site could not be accessed because the Confluence server's 'Remote API'
feature is disabled. The Confluence system administrator must enable this 'Remote API' feature for
JIRA to successfully access this content.'
then JIRA was unable to communicate with the Confluence server to either:
retrieve information about the link or
conduct a Confluence page search in the Find a Confluence page dialog box.
Solution:
Ask the Confluence system administrator to enable the Remote API (XML-RPC & SOAP) feature, since this
Confluence feature is disabled by default. See Enabling the Remote API in the Confluence documentation for
details.
Deleting a link
1. Go to an issue that contains links, and locate the Issue Links section (see screenshot above).
2. Hover your mouse over the link you wish to delete, and click the Delete (trashcan) icon that appears.
You can search for issues that are linked to a particular issue. See Advanced searching for more information.
Be aware that this functionality does not extend to issues on a remote JIRA server.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 82
On this page:
Before you
begin
Transition
multiple
issues
Delete
multiple
issues
Move
multiple
issues
Edit
multiple
issues
Watch /
stop
watching
multiple
issues
Required permissions - To perform a bulk operation, you'll need the appropriate project-specific
permission and the global Bulk Change permission. For example, you would need to have both the Move
Issue and Bulk Change permissions to perform the Bulk Move operation.
Disabling Mail Notification for Bulk Operations - You can disable mail notifications for a particular bulk
operation by deselecting the Send Notification checkbox in the bulk operation wizard. For this option to be
available, you must be an administrator or project administrator of all the projects associated with your
selected issues.
Using the bulk change wizard - The bulk change wizard will progress you through your bulk change. To
step back at any step of the operation, select the relevant step in the menu on the left-hand side. Selecting C
ancel will cancel the entire process.
This bulk operation allows you to transition multiple issues through a workflow at the same time. You can
only perform one transition bulk operation at a time. You will also need to provide any values required to
complete the transition. For example, to close multiple issues, you will need to provide a value for the
Resolution field, such as Done, Fixed, or Won't Fix.
How to transition multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
4. Select Transition Issues, and select Next.
5. Select the available workflow action. The actions available are dependent on the issues (and their
associated workflows) that you have selected. Select Next.
6. Select a value for any required fields for this transition, and if available, decide whether you'd like
to send email notifications. Select Next.
7. Review your bulk operation, and select Confirm when you are happy with the operation.
This bulk operation allows you to delete multiple issues at the same time.
How to delete multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
4. Select Delete Issues, and select Next.
5.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 83
5. If available, decide whether you'd like to send email notifications. Select Next.
6. Review your bulk operation, and select Confirm when you are happy with the operation.
This bulk operation allows you to move multiple issues at the same time. The issues you're moving need to
be mapped to both a project and an issue type, and in doing this, you may need to also map the status and
fields of the issues. Subtasks need to be mapped, too.
How to move multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
More information...
The bulk move operation can be performed on both standard issues and sub-task issues.
Standard issues can be moved to another project and issue type, whereas a sub-task can only
have its issue type changed. (Note that it is possible to convert a sub-task to an issue, and vice
versa.)
It is not possible to select both a sub-task and its parent to bulk move. This is so as to adhere
to the parent/sub-task relationship (i.e. the sub-task is always located in the same project as the
parent issue). Any sub-tasks of selected parent issues that were also selected will be
automatically discarded from the move.
For example, you have issue B being a sub-task of issue A and you try to bulk move both A and
B simultaneously. You will see a warning message (see below) and will be prompted to select a
target project and issue type for issue A. If you select a new project for A, you will be prompted
to move the sub-task to a new issue type based on issue A's new project. If you don't change
the project for issue A, the sub-task will not be required to be moved.
4. Select Move Issues, and select Next.
The bulk move operation may require additional information dependent on which issues you have
selected to move. This information is requested as follows:
a. Select Projects and/or Issue Types
More information...
The first step of the Bulk Move wizard is to choose which projects and issue types you
will move your issues to. The target project and issue type will determine whether extra
steps will be required to migrate statuses and fields.
Selected issues are grouped by their current project and issue type. You can either
select a new project and issue type for each one or choose to move all standard issues
to a single project and issue type.
Note: This does not apply to sub-tasks since they cannot be moved to a standard
issue type.
b. Select Projects and/or Issue Types for Sub-Tasks
More information...
If you are moving issues with sub-tasks to another project, you will also need to move
the sub-tasks to the new project. You can also elect to change the issue types of the
sub-tasks being moved if you need to.
c. Select status migration mappings for invalid statuses
More information...
As multiple workflows can be active simultaneously, some statuses associated with the
collection of selected issues may not be valid in the target workflow. In this case, you
should map invalid statuses to valid statuses in your new workflow.
d. Select values for required fields and fields with invalid values
More information...
In order to adhere to the field configuration scheme associated with the target project
and issue type, it may be necessary to update/populate required fields (e.g. fields that
are required in the target project, but may not have been in the original project).
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 84
For each field that needs to be populated, you will be prompted to supply a value. This
value will be applied to all issues that are being Bulk Moved together.
For the following fields, you can select from a list of possible values provided for you:
Component
Affects Version
Fix Version
Custom fields of type 'Version-Picker'
Note that versions which have been archived in the target project cannot be selected as
the target when performing a bulk move. If you need to move issues into an archived
version, you will need to first unarchive the version in the target project.
It is possible to retain original field values that are valid in the target destination by
checking the Retain checkbox associated with the field. For example, some issues may
already include a valid custom field value — these values can be retained, while issues
that require an update will adopt the value specified on the Field Update screen.
Checked: the original value is retained where possible¹. The field will not be
updated with the specified new value.
Unchecked: all fields will be updated with the specified new value.
Note that the 'Retain' checkbox is not available for the following fields, since an explicit
mapping is required:
Component
Affects Version
Fix Version
Custom fields of type 'Version-Picker'
2. Confirm changes to be made and complete the operation
More information...
When all move parameters — e.g. target project, status mappings and field updates — have
been specified for all issues, you will be presented with a confirmation screen displaying all
changes that will be made to the issues being moved. The following details are displayed as
applicable:
Issue Targets: the target project and issue type
Workflow: the target workflow and invalid status mappings
Updated Fields: new values for fields that require updating
Removed Fields: values to be removed in fields that are not valid in the target
The issues will only be moved once the Confirm button is clicked from the confirmation page. If
the operation is exited anytime before this step, no changes will be made to the issues.
Note that steps C and D above will occur once for each different target project and issue type
combination.
This bulk operation allows you to edit multiple issues at the same time. The bulk edit operations available
depend on the issues selected and the nature of the field/s you want to change.
How to edit multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
4. Select Edit Issues, and select Next.
5. Select the bulk edit operation from the list of available operations (expand more information for a
full list of available and unavailable operations, and their conditions).
More information...
Available Conditions
Operations
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 85
Change Selected issues belong to one project, and that project has version/s
Affects This field is not hidden in any field configurations the selected issues
Version/s belong to
Current user has 'edit issue' permission for all the selected issues
Change This field is not hidden in any field configurations the selected issues
Assign To belong to
Current user has 'assign issue' permission for all the selected issues
Change This field is not hidden in any field configurations the selected issues
Comment belong to
Current user has 'comment issue' permission for all the selected issues
Change Selected issues belong to one project, and that project has component/s
Component/s This field is not hidden in any field configurations the selected issues
belong to
Current user has 'edit issue' permission for all the selected issues
Change Due This field is not hidden in any field configurations the selected issues
Date belong to
Current user has 'edit issue' permission for all the selected issues
Current user has 'schedule issue' permission for all the selected issues
Change Fix Selected issues belong to one project, and that project has version/s
For Version/s This field is not hidden in any field configurations the selected issues
belong to
Current user has 'edit issue' permission for all the selected issues
Change Current user has 'edit issue' permission for all the selected issues
Issue Type
Change This field is not hidden in any field configurations the selected issues
Priority belong to
Current user has 'edit issue' permission for all the selected issues
Change This field is not hidden in any field configurations the selected issues
Reporter belong to
Current user has 'edit issue' permission for all the selected issues
Current user has 'modify reporter' permission for all the selected issues
Change This field is not hidden in any field configurations the selected issues
Security belong to
Level All the selected projects are assigned the same issue level security
scheme
Current user has 'edit issue' permission for all the selected issues
Current user has 'set issue security' permission for all the selected issues
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 86
Unavailable Operations
The fields listed in this section have no operations for bulk editing. This is because there is an
alternative method or it is not logical to perform bulk edit on them.
The following system fields are unavailable for bulk editing:
Attachments
Summary
Description
Environment
Project — Please use 'Bulk Move' to move issues between projects
Resolution — Please use 'Bulk Workflow Transitions' to modify the resolution of issues
Time Tracking fields — Original Estimate, Remaining Estimate, Time Spent
The following custom field types are unavailable for bulk editing:
Import Id
Read Only Text
6. Select a value for any required fields for this operation, and if available, decide whether you'd like
to send email notifications. Select Next.
7. Review your bulk operation, and select Confirm when you are happy with the operation.
These bulk operations allows you to start watching or stop watching multiple issues at the same time.
How to watch multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
4. Select Watch Issues, and select Next.
5. Review your bulk operation, and select Confirm when you are happy with the operation.
How to stop watching multiple issues
1. Perform a search with the required filters to produce a list of issues.
2. Select Tools > Bulk Change.
3. Select the issues you'd like to perform the bulk operation on, and select Next.
4. Select Watch Issues, and select Next.
5. Review your bulk operation, and select Confirm when you are happy with the operation.
Scheduling an issue
You can schedule issue due dates in JIRA Core to track and review, and inform teams about issues dates. The
powerful scheduling feature allows you to perform fixed and relative date searches based on specific due dates
as well as arbitrary search periods. You can also perform advanced searches using JIRA Query Language.
Scheduling an issue
To schedule an issue, populate its Due date field. This can be done either when creating an issue, or at a later
stage by editing the issue.
To enable Issue Scheduling, at least one group or project role must be given the Schedule Issues
permission by your JIRA administrator. Only users with the Schedule Issues permission can populate
the Due date field.
You can use either basic search or advanced search to search for issues by their Due Date.
You can search for issues using the search form in Issue Navigator (see Searching for issues). There are two
ways to search for issues based on the Due date field. The first way is using fixed date values, the second is
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 87
There are two text fields in the search form that allow searching based on the Due date field.
To search for all issues that are due after a certain date, enter the date in the Due After text field. For
example, to find all issues that are due after 1st June 2010, enter 1-6-2010 in the Due After field. You can
also use the Calendar popup to select a date by clicking the calendar icon to the right of the field.
To search for issues that are due before a certain date, enter the date in the Due Before text field. For
example, to find all issues that are due before 1st July 2010, enter 1-7-2010 in the Due Before field.
To search for issues that are due between two dates, populate both the Due After and the Due Before fields.
It is possible to perform a search that is relative to the time when it is run. For example, it is possible to do a
search for issues that are due seven days from now. To do this, enter 7d in the Due Date To text field of the
Issue Navigator. If the search is saved and run the next day, the issues that are due in seven days from the time
that the search is run will be retrieved. Thus, this search will find all issues that are due within a week every time
it is run.
The values that are entered in the Due Date From and Due Date To fields have to conform to a special syntax
(described below). However, it is also possible to use the Due Date popup by clicking the icon to the right of the
Due Date To text field to specify the search period.
Due Date Popup
Use the Due Date popup to do the following:
To search for issues that are overdue at the time of the search, select the first radio button, and click OK.
To search for issues that are overdue by more than a certain number of days, populate the text field in the
second row, and click OK.
To search for issues that are due in the next certain amount of days, and are not overdue at the time of
the search, populate the text field in the third row with the number of days, and choose and not from the
select box in the third row. Select the third radio button, and click OK.
To search for issues that are due in the next certain amount of days, and are overdue at the time of the
search, populate the text field in the third row with the number of days, and choose and from the select
box in the third row. Select the third radio button, and click OK.
The fourth row of the popup is used for arbitrary period searches. Use the to text field to specify the upper
bound of the search, and the from text field to specify the lower bound of the search. A blank text field
means no bound. Populating the text fields in the fourth row actually has the same effect as populating
the Due Date From and Due Date To text boxes. The syntax is described below.
Relative Period Search Syntax
The Due Date From and Due Date To fields use a special syntax to denote time period bounds. The syntax uses
numbers and abbreviations that follow the numbers to represent what the numbers actually mean. The
abbreviations are "w" for weeks, "d" for days, "h" for hours, and "m" for minutes. For example, to specify 10 days
in the future, use "10d" or "1w and 3d". To specify a period bound in the past, prefix the value with the "-" sign.
For example, to specify 2 days, 4 hours, and 3 minutes ago, use "-2d 4h 3m".
You can also use JIRA Query Language (JQL) to search for issues by due date — see Advanced searching, and
particularly the documentation on the Due field.
Moving an issue
Sometimes, an issue may belong to a different project, and you may want to move this issue to another project.
You can easily do this by using the Move Issue wizard.
You must have the Move Issues permission for the project that has the issue that you want to move.
You must have the Create Issues permission for the project that you wish to move your issue to.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 88
If you do not have either of this permissions, please contact your JIRA administrator to have these added to your
user profile.
If you wish to move multiple issues between projects at the same time, please refer to the
documentation on bulk moving issues.
Moving an issue
The Move Issue wizard allows you to specify another project in your JIRA instance to move your selected issue
to. As there may be significant differences in the configuration of your original project and target project, the Mov
e Issue wizard allows you to change certain attributes of the issue. These include:
Issue Type — If your issue is a custom issue type that does not exist in your target project, you must
select a new issue type. You can also choose to arbitrarily change the issue type.
Issue Status — You may have set up custom issue statuses as part of a workflow. If you have assigned
a custom status to your issue, and it does not exist in your target project, you must select a new issue
status for your issue. You cannot arbitrarily change the issue status, i.e. the option to change the issue
status will only appear if you are required to change it.
Custom Fields — If you have defined required custom fields for your issue that do not exist in your
target project, you must set values for them. You will only be prompted to enter the values for required
custom fields in the target project that are missing values. If you wish to change the existing values for
other fields on your issue, you can do this after the move is complete.
To move an issue:
1. View the issue that you wish to move.
2. Select More > Move.
3. The first page of the Move Issue wizard is displayed. Complete the steps required.
4. The confirmation page will display with all of your changes. If you wish to revise any of your changes, you
can click the appropriate step in the left-hand menu to return to that page of the wizard. Once you are
happy with your changes, click Move to move the issue to the target project.
5. Your issue will be moved to the target project and displayed on screen. You can now edit the issue to
make further changes, if you wish.
If your issue has sub-tasks, the 'Move Issue' wizard will also move the sub-tasks to the target project.
If you are moving an epic, the 'Move Issue' wizard will not move the issues in the epic. The epic and the
issues in the epic will still be linked to each other, but the issues in the epic will remain in the original
project. You will need to move them separately.
Troubleshooting
Restricted comments appear to be removed after moving the issue. See this article: Restricted comments
disappear after moving an issue to a new project.
Logging work on issues
JIRA Core provides the flexibility to set your estimation and tracking
statistics differently depending on your team's needs. Time Tracking
features projects schedule planning and time expectations management tha
nks to its reports, which show original and current time estimates for all the
issues, and whether they are ahead or behind the original schedule. Teams
often need to be able to estimate how long a product will take to deliver in
order to have conviction that the work will be completed. You will be able to
easily track the tracking time info by just watching the issue time tracking
color bars.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 89
On this page:
Before you
begin
Setting a
time
estimate
for an
issue
Logging
work on an
issue
Editing a
work log
entry
Deleting a
work log
entry
Customize
d JIRA
installation
s
Note that anyone with the Browse Project permission can view time tracking information on an
issue.
Teams can set a time estimate for an issue in order to calculate how long it will take to solve the issue.
1. Open the issue and select Edit.
2. Scroll down the Edit issue window to fill in the following time tracking fields:
Field Description
Original Amount of time you believe is required to solve the issue. If you want to change
Estimate original estimate values once they have logged work time, ask your JIRA
administrator to disable legacy mode on time tracking.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 90
Remaining Amount of time you believe is required to solve the issue in its current state.
Estimate
If the JIRA time tracking feature is in legacy mode, you will only see the original estimate field if work
has not been logged. Once work time has been logged, you will only see the remaining estimate field.
Tips:
You can specify additional time units after a time value 'X', such as Xw, Xd, Xh, or Xm,
to represent weeks (w), days (d), hours (h), and minutes (m), respectively. If you type a
number without specifying a time unit (e.g. if you type '2' instead of '2h'), the default
time unit that your JIRA administrator specified will apply.
Default conversion rates are 1w = 5d and 1d = 8h.
3. Select Update.
When work is first logged against the issue, the Time Spent is subtracted from the Original Estimate, and
the resulting value is automatically presented in the Remaining Estimate. When subsequent work is logged,
any Time Spent is subtracted from the Remaining Estimate.
Additionally, once work has been logged on an issue, various reports based on the time tracking information
become available.
Once you have started to work on a specific issue, you can log your work by following these steps:
1. Select the issue you want to log time on.
2. Go to More > Log Work.
3. Fill in the following Log Work fields, and select Log:
Time The amount of time spent on the issue. This is the aggregate amount of time that has
spent been logged against this issue.
Date Date and time when you started this unit of work.
started
Remaining Amount of time anticipated to resolve the issue after completing this unit of work. You
estimated can adjust this value using the following options:
Adjust Automatically - Adjust the remaining estimate value by subtracting the
amount of work logged in the Time Spent field from the remaining estimate current
value.
Leave Estimate unset - This option is displayed only if no time estimate has been
specified on the issue. You can use this option when you want to keep track of
work, but you don't necessarily have a time estimate for an issue.
Use Existing Estimate of - Select this option if you do not want to change the
issue remaining estimate value.
Set to - You can adjust the remaining estimate value to the amount of time you
specify in this field.
Reduce by - Select this option to manually adjust the remaining estimate value by
subtracting the amount of time you specify in this field.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 91
You can also log work while resolving or closing an issue by closing it and editing the log work fields.
Select the padlock icon to set the work logged to be viewable only by members of a particular project role or
group.
You can can edit your own work log entries if you have been granted the Edit Own Work Logs permission. Yo
u can also edit other people's work log entries if you have been granted the Edit All Work Logs permission.
You can delete your own work log entries if you have been granted the Delete Own Work Logs permission
You can also delete other people's work log entries if you have been granted the Delete All Work Logs permi
ssion.
1. Go to the desired issue, and open the Work Log tab.
2. Hover over the work log entry to display the actions for the entry on the right side.
3. Select the entry you want to delete, and click the trash can icon. You will be prompted to choose how
the Remaining Estimate is affected by deleting the work log:
Auto adjust Choose this option to automatically add the time spent value to the
current remaining estimate value.
Leave existing estimate Select this option if you do not want to change the issue remaining
estimate value.
Set estimated time Choose this option to manually set the issue's remaining estimate value
remaining to the specified amount.
Increase estimated time Select this option to increase the estimated remaining.
remaining
4. Click Delete.
JIRA applications can be customized by your JIRA administrator by adding the Log Work and Time Tracking
fields to the customized screens. This way, you can log work and specify time estimates on the same JIRA
screen when performing any JIRA operation, such as editing, creating an issue, or transitioning an issue to
another status.
If you want to work and/or specify time estimates on the same JIRA screen:
1. Navigate to the issue and view its details.
2. Perform the customized JIRA operation that allows you to log work and specify time estimates on the
same JIRA screen. For example, assuming that your JIRA administrator has added the Time
Tracking fields to the Resolve Issue Screen, and assuming this screen also retains the default Log
Work fields, select Workflow > Resolve Issue at the top of the issue.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 92
If your JIRA administrator has configured the Log Work fields as optional, then you can
choose whether or not to log work by checking the Log Work checkbox.
If your JIRA administrator has made logging work mandatory, you will not see the Log Work
checkbox, and will instead need to log work when transitioning an issue.
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.
Quick The quick search is the fastest way to define search criteria. However, it is less precise than other search m
search complex queries (e.g. project = JIRA AND status = Open AND priority = High). It is most use
your search criteria is not complex, for example, you know the project key and some key words for an issue.
To use the quick search: Enter your search criteria in the search box in the header 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
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 93
Basic The basic search is more precise than the quick search, but easier to use than the advanced search. It prov
search user-friendly interface that lets you define complex queries, without needing to know how to use JQL (advan
searching).
To use the basic search: Navigate to Issues (in header) > Search for issues, then enter your search crite
Tip: If the advanced search is shown instead of the basic search, click Basic next to the
icon.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 94
Advanced The advanced search is the most powerful of the three search methods. You can specify criteria that cannot
search in the other searches (e.g. ORDER BY clause). However, you need to know how to construct structured quer
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
Tip: If the basic search is shown instead of the advanced search, click Advanced next to the
icon.
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.
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:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 95
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.
Next steps
Basic searching
The basic search provides a user-friendly interface that lets you define On this page:
complex queries, without needing to know how to use JQL (advanced Basic
searching). searching
Running a
If you don't have complex search criteria, you may want to use quick
saved
search instead.
search
If you are comfortable with the JIRA Query Language (JQL), you may
Troublesho
want to use advanced search instead. This search is more powerful
oting
than than the basic search.
Next steps
Screenshot: Basic search
Basic searching
icon).
Why can't I switch between basic and advanced search?
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 96
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.
2. Enter the criteria for the search. You can search against specific fields and/or search for specific text.
If you are searching against a field and can't find the field you want, or the field is displaying
greyed out text, see the Troubleshooting section below.
If you are searching for text, you can use special characters and modifiers in your search text,
such as wildcards and logical operators. See Search syntax for text fields.
3. The search results will automatically update in the issue navigator, unless your administrator has
disabled automatic updates of search results. If so, you will need to click the Update button on the
field drop-down after every change.
Saved searches (also known as filters) are shown in the left panel, when
using basic 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 search criteria for
the basic search will be set, and the search results will be displayed.
Note, clicking the Recently Viewed filter will switch you to the advanced
search, as the basic search cannot represent the ORDER BY clause in this
filter.
Troubleshooting
Why can't I find the field I want to choose?
Some fields are only valid for a particular project/issue type context. For these fields, you must select the
applicable project/issue type. Otherwise, the field is not available for selection.
Why are the field criteria displaying in grey text?
Some fields are only valid for a particular project/issue type context. If you choose a field in your search,
then remove all projects/issue types that reference the field, then the field is invalid. The invalid field does
not apply to your search and displays in grey text.
Why is there a red exclamation mark in my field?
Some field values are only valid for a particular project/issue type context. For example, you may have
configured a project to use a status In QA Review in its workflow. If you select this project and status in
your search, then change the search to filter for a project that doesn't use In QA Review, the status will be
invalid and ignored in the search.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 97
Next steps
Quick searching
Sometimes, you just want to be able to get to the particular issue that you On this page:
are interested in. Other times, you can't remember what the issue was, but Quick
you remember that it was an open issue, assigned to you. Quick search can searching
help you in these scenarios. Understan
ding quick
Quick searching
searching
Searching
The Quick Search box is located at the top right of your screen. To use it, issues
just starting typing what you are looking for. from your
browser's
search box
Next steps
Read the following topics to learn how to get the most out of quick searching:
Jumping to an issue | Smart querying | Free-text searching
Jumping to an issue
If you type in the key of an issue, you will jump straight to that issue. For example, if you type in 'ABC-107'
(or 'abc-107'), and press the Enter button, you will be redirected to the issue 'ABC-107'.
In many cases, you do not even need to type in the full key, but just the numerical part. If you are currently
working on the 'ABC' project, and you type in '123', you will be redirected to 'ABC-123'.
Smart querying
Quick search also enables you to perform 'smart' searches with minimal typing. For example, to find all the
open bugs in the 'TEST' project, you could simply type 'test open bugs' and quick search would locate them
all for you.
Your search results will be displayed in the Issue Navigator, where you can view them in a variety of useful
formats (Excel, XML, etc).
The search terms that quick search recognizes are:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 98
r: Find issues reported by you, another user or with no r:me — finds issues
reporter, using the prefix r: followed by a specific reported by you.
reporter term, such as me, a username or none. r:samuel — finds issues
reported by the user whose
Note that there can be no spaces between "r:" and the username is "samuel".
specific reporter term. r:none — finds issues with
no reporter.
created:-1d
updated:-4h — finds
issues created in the last
day, updated in the last 4
hours.
<issue Find issues with a particular Issue Type. Note that you bug
type> can also use plurals. task
bugs
tasks
c: Find issues with a particular Component(s). You can c:security — finds issues
search across multiple components. with a component whose
name contains the word
Note that there can be no spaces between "c:" and the "security".
component name.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 99
v: Find issues with a particular Affects Version(s). To find v:3.0 — finds issues that
all issues belonging to a 'major' version, use the wildcar match the following versions
d symbol '*'. (for example):
* Wildcard symbol '*'. Can be used with v: and ff:. v:3.2* — finds any issue
whose version number is (for
example):
3.2
3.2-beta
3.2.1
3.2.x
Free-text searching
You can search for any word within the issue(s) you are looking for, provided the word is in one of the
following fields:
Summary
Description
Comments
You can combine free-text and keywords together, e.g. "my closed test tasks". You can also you
wildcards, e.g. ''win*8".
For more information on free-text searching, see Search syntax for text fields.
If you are using Firefox or Internet Explorer 8 (or later), you can add your JIRA instance as a search
engine/provider via the drop-down menu next to the browser's search box. Once you add your JIRA instance
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 100
as a search engine/provider in your browser, you can use it at any time to conduct a Quick Search for issues
in that JIRA instance.
OpenSearch
JIRA supports this browser search feature as part of the autodiscovery part of the OpenSearch stand
ard, by supplying an OpenSearch description document. This is an XML file that describes the web
interface provided by JIRA's search function. Any client applications that support OpenSearch will be
able to add JIRA to their list of search engines.
Next steps
Advanced searching
The advanced search allows you to build structured queries using the JIRA On this page:
Query Language (JQL) to search for issues. You can specify criteria that Advanced
cannot be defined in the quick or basic searches (e.g. ORDER BY clause). searching
Understan
If you don't have complex search criteria, you may want to use quick ding
search instead. advanced
If you are not comfortable with the JIRA Query Language (JQL), you searching
may want to use basic search instead. Reference
Note, JQL is not a database query language, even though it uses SQL-like Running a
syntax. saved
search
Screenshot: Advanced search Next steps
Advanced searching
icon).
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
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 101
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.
2. 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.
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
to run your query. Your search results will display in the issue navigator.
Read the following topics to learn how to get the most out of advanced searching:
Constructing JQL queries | Setting the precedence of operators | Restricted words and characters | Perf
orming text searches
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".
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.
You can use parentheses in complex JQL statements to enforce the precedence of operators.
For example, if you want to find all resolved issues in the 'SysAdmin' project, as well as all issues (any status,
any project) currently assigned to the system administrator (bobsmith), you can use parentheses to enforce
the precedence of the boolean operators in your query, i.e.
Note that if you do not use parentheses, the statement will be evaluated left-to-right.
You can also use parentheses to group clauses, so that you can apply the NOT operator to the group.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 102
Reserved characters
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.
Show me...
"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.
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
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 103
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 104
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 105
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.
Next steps
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 106
Basic searching
Search syntax for text fields
JQL: The most flexible way to search JIRA (on the Atlassian blog)
Saving your search as a filter
Working with search results— find out how to use the issue navigator, export your search results, bulk
modify issues, and share your search results.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 107
^ top of page
Assignee
Search for issues that are assigned to a particular user. You can search by the user's full name, ID, or email
address.
Syntax assignee
Auto-complete Yes
Supported = , !=
operators IS, IS NOT, IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED
Note that the comparison operators (e.g. ">") use the version order that has been set up
by your project administrator, not a numeric or alphabetic order.
Supported When used with the IN and NOT IN operators, this field supports:
functions
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field supports:
currentUser()
Note that full-stops and "@" symbols are reserved characters and need to be surrounded by
quote-marks.
^ top of page
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 108
Attachments
Syntax attachments
Auto-complete Yes
Unsupported =, != , ~ , !~ , > , >= , < , <= IN, NOT IN, WAS, WAS IN, WAS
operators NOT, WAS NOT IN, CHANGED
Supported None
functions
^ top of page
Category
Syntax category
Auto-complete Yes
Supported operators =, !=
IS, IS NOT, IN, NOT IN
Unsupported ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN,
operators CHANGED
Examples Find issues that belong to projects in the "Alphabet Projects" Category:
category = "Alphabet Projects"
^ top of page
Comment
Search for issues that have a comment that contains particular text. JIRA text-search syntax can be used.
Syntax comment
Auto-complete No
Supported ~ , !~
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 109
Supported None
functions
Examples Find issues where a comment contains text that matches "My PC is quite old"
(i.e. a "fuzzy" match:
comment ~ "My PC is quite old"
Find issues where a comment contains the exact phrase "My PC is quite old":
comment ~ "\"My PC is quite old\""
^ top of page
Component
Search for issues that belong to a particular component(s) of a project. You can search by component name
or component ID (i.e. the number that JIRA automatically allocates to a component).
Note, it is safer to search by component ID than by component name. Different projects may have
components with the same name, so searching by component name may return issues from multiple
projects. It is also possible for your JIRA administrator to change the name of a component, which could
break any saved filters that rely on that name. Component IDs, however, are unique and cannot be changed.
Syntax component
Auto-complete Yes
Supported operators = , !=
IS , IS NOT , IN , NOT IN
Supported functions When used with the IN and NOT IN operators, component supports:
componentsLeadByUser()
^ top of page
Created
Search for issues that were created on, before, or after a particular date (or date range). Note that if a
time-component is not specified, midnight will be assumed. Please note that the search results will be relative
to your configured time zone (which is by default the JIRA server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 110
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) to specify a date relative to the current time.
The default is "m" (minutes). Be sure to use quote-marks ("); if you omit the quote-marks, the number you
supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax created
Alias createdDate
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN
functions EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
^ top of page
Creator
Search for issues that were created by a particular user. You can search by the user's full name, ID, or email
address.
Syntax creator
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 111
Auto-complete Yes
Supported = , !=
operators IS , IS NOT , IN , NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN
Supported When used with the IN and NOT IN operators, this field supports:
functions
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field supports:
currentUser()
^ top of page
Custom field
Only applicable if your JIRA administrator has created one or more custom fields.
Search for issues where a particular custom field has a particular value. You can search by custom
field name or custom field ID (i.e. the number that JIRA automatically allocates to an custom field).
Note, it is safer to search by custom field ID than by custom field name. It is possible for a custom field to
have the same name as a built-in JIRA system field; in which case, JIRA will search for the system field (not
your custom field). It is also possible for your JIRA administrator to change the name of a custom field, which
could break any saved filters that rely on that name. Custom field IDs, however, are unique and cannot be
changed.
Syntax CustomFieldName
Alias cf[CustomFieldID]
Auto-complete Yes, for custom fields of type picker, group picker, select, checkbox and radio
button fields
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 112
Unsupported ~ , !~
operators: WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED
number and date
fields
Supported = , !=
operators: IS , IS NOT , IN , NOT IN
picker, select,
checkbox
and radio button
fields
Supported ~ , !~
operators: IS , IS NOT
text fields
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER
functions: THAN EQUALS,
date/time fields LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
Supported Version picker fields: When used with the IN and NOT IN operators, this field
functions: supports:
version picker
fields releasedVersions()
latestReleasedVersion()
unreleasedVersions()
earliestUnreleasedVersion()
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 113
Examples Find issues where the value of the "Location" custom field is "New York":
location = "New York"
Find issues where the value of the custom field with ID 10003 is "New York":
cf[10003] = "New York"
Find issues where the value of the "Location" custom field is "London" or
"Milan" or "Paris":
cf[10003] in ("London", "Milan", "Paris")
Find issues where the "Location" custom field has no value:
location != empty
^ top of page
Auto-complete Yes
Supported = , !=
operators
IN , NOT IN
Note that the Lucene value for Customer Request Type, is portal-key/requ
est-type-key. While the portal key cannot be changed after a service desk
portal is created, the project key can be changed. The Request Type key cannot
be changed once the Request Type is created.
Supported None
functions
Examples Find issues where Customer Request Type is Request a new account in projects
that the user has access to:
"Customer Request Type" = "Request a new account"
Find issues where the Customer Request Type is Request a new account in Simpl
eDesk project, where the right operand is a selected Lucene value from the
auto-complete suggestion list.
"Customer Request Type" = "sd/system-access"
Find issues where Customer Request Type is either Request a new account or Get
IT Help.
"Customer Request Type" IN ("Request a new account", "Get IT
Help")
^ top of page
Description
Search for issues where the description contains particular text. JIRA text-search syntax can be used.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 114
Syntax description
Auto-complete No
Supported ~ , !~
operators IS , IS NOT
Supported None
functions
Examples Find issues where the description contains text that matches "Please see
screenshot" (i.e. a "fuzzy" match):
description ~ "Please see screenshot"
Find issues where the description contains the exact phrase "Please see
screenshot":
description ~ "\"Please see screenshot\""
^ top of page
Due
Search for issues that were due on, before, or after a particular date (or date range). Note that the due date
relates to the date only (not to the time).
Use one of the following formats:
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks) or "d" (days) to specify a date relative to the current date. Be sure to use quote-marks (
").
Syntax due
Alias dueDate
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 115
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER
functions THAN EQUALS,
LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
^ top of page
Environment
Search for issues where the environment contains particular text. JIRA text-search syntax can be used.
Syntax environment
Auto-complete No
Supported ~ , !~
operators IS , IS NOT
Supported None
functions
Examples Find issues where the environment contains text that matches "Third floor" (i.e.
a "fuzzy" match):
environment ~ "Third floor"
Find issues where the environment contains the exact phrase "Third floor":
environment ~ "\"Third floor\""
^ top of page
Epic link
Search for issues that belong to a particular epic. The search is based on either the epic's name, issue key,
or issue ID (i.e. the number that JIRA automatically allocates to an issue).
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 116
Auto-complete No
Supported operators = , !=
IS , IS NOT, IN , NOT IN
Supported functions When used with the IN or NOT IN operators, epic link supports:
issueHistory()
linkedIssues()
votedIssues()
watchedIssues()
Examples Find issues that belong to epic "Jupiter", where "Jupiter has the issue key
ANERDS-31:
"epic link" = ANERDS-31
or
"epic link" = Jupiter
^ top of page
Filter
You can use a saved filter to narrow your search. You can search by filter name or filter ID (i.e. the number
that JIRA automatically allocates to a saved filter).
Note:
It is safer to search by filter ID than by filter name. It is possible for a filter name to be changed, which
could break a saved filter that invokes another filter by name. Filter IDs, however, are unique and
cannot be changed.
An unnamed link statement in your typed query will override an ORDER BY statement in the saved
filter.
You cannot run or save a filter that would cause an infinite loop (i.e. you cannot reference a saved
filter if it eventually references your current filter).
Syntax filter
Auto-complete Yes
Supported = , !=
operators IN , NOT IN
Supported None
functions
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 117
Examples Search the results of the filter "My Saved Filter" (which has an ID of 12000) for
issues assigned to the user jsmith:
filter = "My Saved Filter" and assignee = jsmith
or
filter = 12000 and assignee = jsmith
^ top of page
Fix version
Search for issues that are assigned to a particular fix version. You can search by version name or version ID
(i.e. the number that JIRA automatically allocates to a version).
Note, it is safer to search by version ID than by version name. Different projects may have versions with the
same name, so searching by version name may return issues from multiple projects. It is also possible for
your JIRA administrator to change the name of a version, which could break any saved filters that rely on that
name. Version IDs, however, are unique and cannot be changed.
Syntax fixVersion
Auto-complete Yes
Note that the comparison operators (e.g. ">") use the version order that has
been set up by your project administrator, not a numeric or alphabetic order.
Unsupported ~ , !~
operators
Supported When used with the IN and NOT IN operators, this field supports:
functions
releasedVersions()
latestReleasedVersion()
unreleasedVersions()
earliestUnreleasedVersion()
^ top of page
Issue key
Search for issues with a particular issue key or issue ID (i.e. the number that JIRA automatically allocates to
an issue).
Syntax issueKey
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 118
Auto-complete No
Unsupported operators ~ , !~
WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Supported functions When used with the IN or NOT IN operators, issueKey supports:
issueHistory()
linkedIssues()
votedIssues()
watchedIssues()
^ top of page
Labels
Search for issues tagged with a label or list of labels. You can also search for issues without any labels to
easily identify which issues need to be tagged so they show up in the relevant sprints, queues or reports.
Syntax labels
Auto-complete Yes
Supported None
functions
Last viewed
Search for issues that were last viewed on, before, or after a particular date (or date range). Note that if a
time-component is not specified, midnight will be assumed. Please note that the search results will be relative
to your configured time zone (which is by default the JIRA server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) to specify a date relative to the current time.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 119
The default is "m" (minutes). Be sure to use quote-marks ("); if you omit the quote-marks, the number you
supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax lastViewed
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN
functions EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
Examples Find all issues last viewed before 12th December 2010:
lastViewed < "2010/12/12"
Find all issues last viewed on or before 12th December 2010:
lastViewed <= "2010/12/13"
Find all issues last viewed on 12th December 2010 before 2:00pm:
lastViewed > "2010/12/12" and created < "2010/12/12 14:00"
Find issues last viewed less than one day ago:
lastViewed > "-1d"
Find issues last viewed in January 2011:
lastViewed > "2011/01/01" and created < "2011/02/01"
Find issues last viewed on 15 January 2011:
lastViewed > "2011/01/15" and created < "2011/01/16"
^ top of page
Level
Only available if issue level security has been enabled by your JIRA administrator.
Search for issues with a particular security level. You can search by issue level security name or issue level
security ID (i.e. the number that JIRA automatically allocates to an issue level security).
Note, it is safer to search by security level ID than by security level name. It is possible for your JIRA
administrator to change the name of a security level, which could break any saved filter that rely on that
name. Security level IDs, however, are unique and cannot be changed.
Syntax level
Auto-complete Yes
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 120
Supported operators = , !=
IS , IS NOT, IN , NOT IN
Examples Search for issues with a security level of "Really High" or "level1":
level in ("Really High", level1)
Search for issues with a security level ID of 123:
level = 123
^ top of page
Original estimate
Syntax originalEstimate
Alias timeOriginalEstimate
Auto-complete No
Unsupported operators ~ , !~
WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
^ top of page
Parent
Syntax parent
Auto-complete No
Supported operators = , !=
IN , NOT IN
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 121
^ top of page
Priority
Search for issues with a particular priority. You can search by priority name or priority ID (i.e. the number that
JIRA automatically allocates to a priority).
Note, it is safer to search by priority ID than by priority name. It is possible for your JIRA administrator to
change the name of a priority, which could break any saved filter that rely on that name. Priority IDs,
however, are unique and cannot be changed.
Syntax priority
Auto-complete Yes
Unsupported ~ , !~
operators
Supported None
functions
^ top of page
Project
Search for issues that belong to a particular project. You can search by project name, by project key or by
project ID (i.e. the number that JIRA automatically allocates to a project). In the rare case where there is a
project whose project key is the same as another project's name, then the project key takes preference and
hides results from the second project.
Syntax project
Auto-complete Yes
Supported operators = , !=
IS , IS NOT, IN , NOT IN
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 122
Supported functions When used with the IN and NOT IN operators, project supports:
projectsLeadByUser()
projectsWhereUserHasPermission()
projectsWhereUserHasRole()
Examples Find issues that belong to the Project that has the name "ABC Project":
project = "ABC Project"
Find issues that belong to the project that has the key "ABC":
project = "ABC"
Find issues that belong to the project that has the ID "1234":
project = 1234
^ top of page
Remaining estimate
Syntax remainingEstimate
Alias timeEstimate
Auto-complete No
Unsupported operators ~ , !~
WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
^ top of page
Reporter
Search for issues that were reported by a particular user. This may be the same as the creator, but can be
distinct. You can search by the user's full name, ID, or email address.
Syntax reporter
Auto-complete Yes
Supported = , !=
operators IS , IS NOT, IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN ,
CHANGED
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 123
Supported When used with the IN and NOT IN operators, this field supports:
functions
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field supports:
currentUser()
^ top of page
Resolution
Search for issues that have a particular resolution. You can search by resolution name or resolution ID (i.e.
the number that JIRA automatically allocates to a resolution).
Note, it is safer to search by resolution ID than by resolution name. It is possible for your JIRA administrator
to change the name of a resolution, which could break any saved filter that rely on that name. Resolution IDs,
however, are unique and cannot be changed.
Syntax resolution
Auto-complete Yes
Unsupported ~ , !~
operators
Supported None
functions
^ top of page
Resolved
Search for issues that were resolved on, before, or after a particular date (or date range). Note that if a
time-component is not specified, midnight will be assumed. Please note that the search results will be relative
to your configured time zone (which is by default the JIRA server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 124
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) to specify a date relative to the current time.
The default is "m" (minutes). Be sure to use quote-marks ("); if you omit the quote-marks, the number you
supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax resolved
Alias resolutionDate
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN
functions EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
Examples Find all issues that were resolved before 31st December 2010:
resolved <= "2010/12/31"
Find all issues that were resolved before 2.00pm on 31st December 2010:
resolved < "2010/12/31 14:00"
Find all issues that were resolved on or before 31st December 2010:
resolved <= "2011/01/01"
Find issues that were resolved in January 2011:
resolved > "2011/01/01" and resolved < "2011/02/01"
Find issues that were resolved on 15 January 2011:
resolved > "2011/01/15" and resolved < "2011/01/16"
Find issues that were resolved in the last hour:
resolved > -1h
^ top of page
Sprint
Search for issues that are assigned to a particular sprint. This works for active sprints and future sprints. The
search is based on either the sprint name or the sprint ID (i.e. the number that JIRA automatically allocates to
a sprint).
If you have multiple sprints with similar (or identical) names, you can simply search by using the sprint name
— or even just part of it. The possible matches will be shown in the autocomplete drop-down, with the sprint
dates shown to help you distinguish between them. (The sprint ID will also be shown, in brackets).
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 125
Syntax sprint
Auto-complete Yes
Supported operators = , !=
IS , IS NOT, IN , NOT IN
^ top of page
Status
Search for issues that have a particular status. You can search by status name or status ID (i.e. the number
that JIRA automatically allocates to a status).
Note:
It is safer to search by status ID than status name. It is possible for your JIRA administrator to change
the name of a status, which could break any saved filter that rely on that name. Status IDs, however,
are unique and cannot be changed.
The WAS, WAS NOT, WAS IN and WAS NOT IN operators can only be used with the name, not the
ID.
Syntax status
Auto-complete Yes
Supported = , !=
operators IS , IS NOT, IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN
, CHANGED
Supported None
functions
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 126
^ top of page
Summary
Search for issues where the summary contains particular text. JIRA text-search syntax can be used.
Syntax summary
Auto-complete No
Supported ~ , !~
operators IS , IS NOT
Supported None
functions
Examples Find issues where the summary contains text that matches "Error saving file"
(i.e. a "fuzzy" match):
summary ~ "Error saving file"
Find issues where the summary contains the exact phrase "Error saving file":
summary ~ "\"Error saving file\""
^ top of page
Text
This is a "master-field" that allows you to search all text fields, i.e.:
Summary
Description
Environment
Comments
custom fields that use the "free text searcher"; this includes custom fields of the following built-in
custom field types:
Free text field (unlimited text)
Text field (< 255 characters)
Read-only text field
Notes:
The text master-field can only be used with the CONTAINS operator ("~" and "!~").
JIRA text-search syntax can be used with these fields.
Syntax text
Auto-complete No
Supported ~
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 127
Supported None
functions
Examples Find issues where a text field matches the word "Fred":
text ~ "Fred"
or
text ~ Fred
Find all issues where a text field contains the exact phrase "full screen":
text ~ "\"full screen\""
^ top of page
Time spent
Syntax timeSpent
Auto-complete No
Unsupported operators ~ , !~
WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Examples Find issues where the time spent is more than 5 days:
timeSpent > 5d
^ top of page
Type
Search for issues that have a particular issue type. You can search by issue type name or issue type ID (i.e.
the number that JIRA automatically allocates to an issue type).
Note, it is safer to search by type ID than type name. It is possible for your JIRA administrator to change the
name of a type, which could break any saved filter that rely on that name. Type IDs, however, are unique and
cannot be changed.
Syntax type
Alias issueType
Auto-complete Yes
Supported operators = , !=
IS , IS NOT , IN , NOT IN
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 128
^ top of page
Updated
Search for issues that were last updated on, before, or after a particular date (or date range). Note that if a
time-component is not specified, midnight will be assumed. Please note that the search results will be relative
to your configured time zone (which is by default the JIRA server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) to specify a date relative to the current time.
The default is "m" (minutes). Be sure to use quote-marks ("); if you omit the quote-marks, the number you
supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax updated
Alias updatedDate
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Supported When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER
functions THAN EQUALS,
LESS THAN or LESS THAN EQUALS operators, this field supports:
currentLogin()
lastLogin()
now()
startOfDay()
startOfWeek()
startOfMonth()
startOfYear()
endOfDay()
endOfWeek()
endOfMonth()
endOfYear()
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 129
Examples Find issues that were last updated before 12th December 2010:
updated < "2010/12/12"
Find issues that were last updated on or before 12th December 2010:
updated < "2010/12/13"
Find all issues that were last updated before 2.00pm on 31st December 2010:
updated < "2010/12/31 14:00"
Find issues that were last updated more than two weeks ago:
updated < "-2w"
Find issues that were last updated on 15 January 2011:
updated > "2011/01/15" and updated < "2011/01/16"
Find issues that were last updated in January 2011:
updated > "20011/01/01" and updated < "2011/02/01"
^ top of page
Voter
Search for issues for which a particular user has voted. You can search by the user's full name, ID, or email
address. Note that you can only find issues for which you have the "View Voters and Watchers" permission,
unless you are searching for your own votes. See also votedIssues.
Syntax voter
Auto-complete Yes
Supported operators = , !=
IS , IS NOT , IN , NOT IN
Supported functions When used with the IN and NOT IN operators, this field supports:
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field supports:
currentUser()
^ top of page
Votes
Syntax votes
Auto-complete No
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 130
Unsupported operators ~ , !~
IS , IS NOT , WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
^ top of page
Watcher
Search for issues that a particular user is watching. You can search by the user's full name, ID, or email
address. Note that you can only find issues for which you have the "View Voters and Watchers" permission,
unless you are searching for issues where you are the watcher. See also watchedIssues.
Syntax watcher
Auto-complete Yes
Supported = , !=
operators IS , IS NOT , IN , NOT IN
Supported functions When used with the IN and NOT IN operators, this field supports:
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field supports:
currentUser()
^ top of page
Watchers
Syntax watchers
Auto-complete No
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 131
Unsupported ~ , !~
operators IS , IS NOT , WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Supported functions When used with the IN and NOT IN operators, this field supports:
membersOf()
When used with the EQUALS and NOT EQUALS operators, this field
supports:
currentUser()
Examples Find all issues that are being watched by more than 3 people:
watchers > 3
^ top of page
Work ratio
Syntax workRatio
Auto-complete No
Unsupported ~ , !~
operators WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED
Examples Find issues on which more than 75% of the original estimate has been
spent:
workRatio > 75
^ top of page
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 132
Find all issues in a particular project that are not assigned to jsmith:
Find all issues for a specific release which consists of different version numbers across several
projects:
Find all issues where neither the Reporter nor the Assignee is Jack, Jill or John:
^ top of page
OR
Find all issues that are overdue or where no due date is set:
^ top of page
NOT
Used to negate individual clauses or a complex JQL query (a query made up of more than one clause) using
parentheses, allowing you to refine your search.
(Note: also see NOT EQUALS ("!="), DOES NOT CONTAIN ("!~"), NOT IN and IS NOT.)
Examples
Find all issues that are assigned to any user except jsmith:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 133
Find all issues that were not created by either jsmith or jbrown:
^ top of page
EMPTY
Used to search for issues where a given field does not have a value. See also NULL.
Note that EMPTY can only be used with fields that support the IS and IS NOT operators. To see a field's
supported operators, check the individual field reference.
Examples
Find all issues without a DueDate:
duedate = empty
or
duedate is empty
^ top of page
NULL
Used to search for issues where a given field does not have a value. See also EMPTY.
Note that NULL can only be used with fields that support the IS and IS NOT operators. To see a field's
supported operators, check the individual field reference.
Examples
Find all issues without a DueDate:
duedate = null
or
duedate is null
^ top of page
ORDER BY
Used to specify the fields by whose values the search results will be sorted.
By default, the field's own sorting order will be used. You can override this by specifying ascending order ("as
c") or descending order ("desc").
Examples
Find all issues without a DueDate, sorted by CreationDate:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 134
Find all issues without a DueDate, sorted by CreationDate, then by Priority (highest to lowest):
Find all issues without a DueDate, sorted by CreationDate, then by Priority (lowest to highest):
Ordering by Components or Versions will list the returned issues first by Project, and only then by
the field's natural order (see JRA-31113).
^ top of page
^top of page
NOT EQUALS: !=
The "!=" operator is used to search for issues where the value of the specified field does not match the
specified value. (Note: cannot be used with text fields; see the DOES NOT MATCH ("!~") operator instead.)
Note that typing field != value is the same as typing NOT field = value, and that field !=
EMPTY is the same as field IS_NOT EMPTY.
The "!=" operator will not match a field that has no value (i.e. a field that is empty). For example, component
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 135
!= fred will only match issues that have a component and the component is not "fred". To find issues that
have a component other than "fred" or have no component, you would need to type: component != fred
or component is empty.
Examples
Find all issues that are assigned to any user except jsmith:
or:
assignee != jsmith
Find all issues that were reported by me but are not assigned to me:
Find all issues where the Reporter or Assignee is anyone except John Smith:
or
assignee != null
^top of page
The ">" operator is used to search for issues where the value of the specified field is greater than the
specified value.
Note that the ">" operator can only be used with fields that support ordering (e.g. date fields and version
fields), and cannot be used with text fields. To see a field's supported operators, check the individual field
reference.
Examples
Find all issues with more than 4 votes:
votes > 4
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 136
^top of page
The ">=" operator is used to search for issues where the value of the specified field is greater than or equal
to the specified value.
Note that the ">=" operator can only be used with fields that support ordering (e.g. date fields and version
fields), and cannot be used with text fields. To see a field's supported operators, check the individual field
reference.
Examples
Find all issues with 4 or more votes:
votes >= 4
^top of page
The "<" operator is used to search for issues where the value of the specified field is less than the specified
value.
Note that the "<" operator can only be used with fields which support ordering (e.g. date fields and version
fields), and cannot be used with text fields. To see a field's supported operators, check the individual field
reference.
Examples
Find all issues with less than 4 votes:
votes < 4
^top of page
The "<=" operator is used to search for issues where the value of the specified field is less than or equal to
than the specified value.
Note that the "<=" operator can only be used with fields which support ordering (e.g. date fields and version
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 137
fields), and cannot be used with text fields. To see a field's supported operators, check the individual field
reference.
Examples
Find all issues with 4 or fewer votes:
votes <= 4
Find all issues that have not been updated in the past month (30 days):
^top of page
IN
The "IN" operator is used to search for issues where the value of the specified field is one of multiple
specified values. The values are specified as a comma-delimited list, surrounded by parentheses.
Using "IN" is equivalent to using multiple EQUALS (=) statements, but is shorter and more convenient. That
is, typing reporter IN (tom, jane, harry) is the same as typing reporter = "tom" OR report
er = "jane" OR reporter = "harry".
Examples
Find all issues that were created by either jsmith or jbrown or jjones:
reporter in (jsmith,jbrown,jjones)
Find all issues where the Reporter or Assignee is either Jack or Jill:
^top of page
NOT IN
The "NOT IN" operator is used to search for issues where the value of the specified field is not one of
multiple specified values.
Using "NOT IN" is equivalent to using multiple NOT_EQUALS (!=) statements, but is shorter and more
convenient. That is, typing reporter NOT IN (tom, jane, harry) is the same as typing reporter
!= "tom" AND reporter != "jane" AND reporter != "harry".
The "NOT IN" operator will not match a field that has no value (i.e. a field that is empty). For example, assi
gnee not in (jack,jill) will only match issues that have an assignee and the assignee is not "jack"
or "jill". To find issues that are assigned to someone other than "jack" or "jill" or are unassigned, you would
need to type: assignee not in (jack,jill) or assignee is empty.
Examples
Find all issues where the Assignee is someone other than Jack, Jill, or John:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 138
Find all issues where the Assignee is not Jack, Jill, or John:
Find all issues where the FixVersion is not 'A', 'B', 'C', or 'D':
Find all issues where the FixVersion is not 'A', 'B', 'C', or 'D', or has not been specified:
^top of page
CONTAINS: ~
The "~" operator is used to search for issues where the value of the specified field matches the specified
value (either an exact match or a "fuzzy" match — see examples below). For use with text fields only, i.e.:
Summary
Description
Environment
Comments
custom fields that use the "Free Text Searcher"; this includes custom fields of the following
built-in Custom Field Types
Free Text Field (unlimited text)
Text Field (< 255 characters)
Read-only Text Field
The JQL field "text" as in text ~ "some words" searches an issue's Summary, Description, Environment,
Comments. It also searches all text custom fields. If you have many text custom fields you can improve
performance of your queries by searching on specific fields, e.g.
Summary ~ "some words" OR Description ~ "some words"
Note: when using the "~" operator, the value on the right-hand side of the operator can be specified using JIR
A text-search syntax.
Examples
Find all issues where the Summary contains the word "win" (or simple derivatives of that word, such
as "wins"):
summary ~ win
Find all issues where the Summary contains a wild-card match for the word "win":
summary ~ "win*"
Find all issues where the Summary contains the word "issue" and the word "collector":
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 139
Find all issues where the Summary contains the exact phrase "full screen" (see Search syntax for text
fields for details on how to escape quote-marks and other special characters):
^top of page
The "!~" operator is used to search for issues where the value of the specified field is not a "fuzzy" match for
the specified value. For use with text fields only, i.e.:
Summary
Description
Environment
Comments
custom fields that use the "Free Text Searcher"; this includes custom fields of the following
built-in Custom Field Types
Free Text Field (unlimited text)
Text Field (< 255 characters)
Read-only Text Field
The JQL field "text" as in text ~ "some words" searches an issue's Summary, Description, Environment,
Comments. It also searches all text custom fields. If you have many text custom fields you can improve
performance of your queries by searching on specific fields, e.g.
Summary ~ "some words" OR Description ~ "some words"
Note: when using the "!~" operator, the value on the right-hand side of the operator can be specified using JI
RA text-search syntax.
Examples
Find all issues where the Summary does not contain the word "run" (or derivatives of that word, such
as "running" or "ran"):
summary !~ run
^top of page
IS
The "IS" operator can only be used with EMPTY or NULL. That is, it is used to search for issues where the
specified field has no value.
Note that not all fields are compatible with this operator; see the individual field reference for details.
Examples
Find all issues that have no Fix Version:
fixVersion is empty
or
fixVersion is null
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 140
^top of page
IS NOT
The "IS NOT" operator can only be used with EMPTY or NULL. That is, it is used to search for issues where
the specified field has a value.
Note that not all fields are compatible with this operator; see the individual field reference for details.
Examples
Find all issues that have one or more votes:
or
^top of page
WAS
The "WAS" operator is used to find issues that currently have or previously had the specified value for the
specified field.
This operator has the following optional predicates:
AFTER "date"
BEFORE "date"
BY "username"
DURING ("date1","date2")
ON "date"
This operator will match the value name (e.g. "Resolved"), which was configured in your system at the time
that the field was changed. This operator will also match the value ID associated with that value name too —
that is, it will match "4" as well as "Resolved".
(Note: This operator can be used with the Assignee, Fix Version, Priority, Reporter, Resolution,
and Status fields only.)
Examples
Find issues that currently have or previously had a status of 'In Progress':
Find issues that were resolved by Joe Smith before 2nd February:
^top of page
WAS IN
The "WAS IN" operator is used to find issues that currently have or previously had any of multiple specified
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 141
values for the specified field. The values are specified as a comma-delimited list, surrounded by parentheses.
Using "WAS IN" is equivalent to using multiple WAS statements, but is shorter and more convenient. That is,
typing status WAS IN ('Resolved', 'Closed') is the same as typing status WAS "Resolved" O
R status WAS "Closed".
^top of page
WAS NOT IN
The "WAS NOT IN" operator is used to search for issues where the value of the specified field has never
been one of multiple specified values.
Using "WAS NOT IN" is equivalent to using multiple WAS_NOT statements, but is shorter and more
convenient. That is, typing status WAS NOT IN ("Resolved","In Progress") is the same as typing
status WAS NOT "Resolved" AND status WAS NOT "In Progress".
Find issues that did not have a status of 'Resolved' or 'In Progress' before 2nd February:
^top of page
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 142
WAS NOT
The "WAS NOT" operator is used to find issues that have never had the specified value for the specified field.
Find issues that did not have a status of 'In Progress' before 2nd February:
^top of page
CHANGED
The "CHANGED" operator is used to find issues that have a value that had changed for the specified field.
(Note: This operator can be used with the Assignee, Fix Version, Priority, Reporter, Resolution,
and Status fields only.)
Examples
Find issues whose assignee had changed:
assignee CHANGED
Find issues whose status had changed from 'In Progress' back to 'Open':
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 143
Find issues whose priority was changed by user 'freddo' after the start and before the end of the
current week.
^top of page
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 144
^ top of page
closedSprints()
Search for issues that are assigned to a completed Sprint. Note, it is possible for an issue to belong to both a
completed Sprint(s) and an incomplete Sprint(s). See also openSprints().
Syntax closedSprints()
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 145
^ top of page
componentsLeadByUser()
Find issues in components that are led by a specific user. You can optionally specify a user, or if the user is
omitted, the current user (i.e. you) will be used. Note that if you are not logged in to JIRA, a user must be
specified.
Syntax componentsLeadByUser()
componentsLeadByUser(username)
Supported Component
fields
Supported IN , NOT IN
operators
^ top of page
currentLogin()
Perform searches based on the time at which the current user's session began. See also lastLogin.
Syntax currentLogin()
Supported fields Created, Due, Resolved, Updated, custom fields of type Date/Time
Examples Find issues that have been created during my current session:
created > currentLogin()
^ top of page
currentUser()
Perform searches based on the currently logged-in user. Note, this function can only be used by logged-in
users. So if you are creating a saved filter that you expect to be used by anonymous users, do not use this
function.
Syntax currentUser()
Supported = , !=
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 146
^ top of page
earliestUnreleasedVersion()
Perform searches based on the earliest unreleased version (i.e. next version that is due to be released) of a
specified project. See also unreleasedVersions. Note, the "earliest" is determined by the ordering assigned to
the versions, not by actual Version Due Dates.
Syntax earliestUnreleasedVersion(project)
Supported IN , NOT IN
operators
Examples Find issues whose FixVersion is the earliest unreleased version of the ABC project:
fixVersion = earliestUnreleasedVersion(ABC)
Find issues that relate to the earlist unreleased version of the ABC project:
affectedVersion = earliestUnreleasedVersion(ABC) or fixVersion
= earliestUnreleasedVersion(ABC)
^ top of page
endOfDay()
Perform searches based on the end of the current day. See also endOfWeek, endOfMonth, and endOfYear;
and startOfDay, startOfWeek, startOfMonth, and startOfYear.
Syntax endOfDay()
endOfDay("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. endOfDay("+1") is the same as endOfDay("+1d"). If the
plus/minus (+/-) sign is omitted, plus is assumed.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 147
^ top of page
endOfMonth()
Perform searches based on the end of the current month. See also endOfDay, endOfWeek, and endOfYear;
and startOfDay, startOfWeek, startOfMonth, and startOfYear.
Syntax endOfMonth()
endOfMonth("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. endOfMonth("+1") is the same as endOfMonth("+1M"). If
the plus/minus (+/-) sign is omitted, plus is assumed.
^ top of page
endOfWeek()
Perform searches based on the end of the current week. See also endOfDay, endOfMonth, and endOfYear;
and startOfDay, startOfWeek, startOfMonth, and startOfYear.
For the endOfWeek() function, the result depends upon your locale. For example, in Europe, the first day of
the week is generally considered to be Monday, while in the USA, it is considered to be Sunday.
Syntax endOfWeek()
endOfWeek("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. endOfWeek("+1") is the same as endOfWeek("+1w"). If the
plus/minus (+/-) sign is omitted, plus is assumed.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 148
^ top of page
endOfYear()
Perform searches based on the end of the current year. See also startOfDay, startOfWeek, and startOfMonth
; and endOfDay, endOfWeek, endOfMonth, and endOfYear.
Syntax endOfYear()
endOfYear("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. endOfYear("+1") is the same as endOfYear("+1y"). If the
plus/minus (+/-) sign is omitted, plus is assumed.
^ top of page
issueHistory()
Find issues that you have recently viewed, i.e. issues that are in the 'Recent Issues' section of the 'Issues'
drop-down menu.
Note:
issueHistory() returns up to 50 issues, whereas the 'Recent Issues' drop-down returns only 5.
if you are not logged in to JIRA, only issues from your current browser session will be included.
Syntax issueHistory()
Supported Issue
fields
Supported IN , NOT IN
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 149
Examples Find issues which I have recently viewed, that are assigned to me:
issue in issueHistory() AND assignee = currentUser()
^ top of page
issuesWithRemoteLinksByGlobalId()
Perform searches based on issues that are associated with remote links that have any of the specified global
ids.
Note:
This function accepts 1 to 100 globalIds. Specifying 0 or more than 100 globalIds will result in errors.
Syntax issuesWithRemoteLinksByGlobalId()
Supported Issue
fields
Supported IN , NOT IN
operators
Examples Find issues that are linked to remote links that have globalId "abc":
issue in issuesWithRemoteLinksByGlobalId(abc)
Find issues that are linked to remote links that have either globalId "abc" or "def":
issue in issuesWithRemoteLinksByGlobalId(abc, def)
^ top of page
lastLogin()
Perform searches based on the time at which the current user's previous session began. See also currentLo
gin.
Syntax lastLogin()
Supported fields Created. Due, Resolved, Updated, custom fields of type Date/Time
Examples Find issues that have been created during my last session:
created > lastLogin()
^ top of page
latestReleasedVersion()
Perform searches based on the latest released version (i.e. the most recent version that has been released)
of a specified project. See also releasedVersions(). Note, the "latest" is determined by the ordering assigned
to the versions, not by actual Version Due Dates.
Syntax latestReleasedVersion(project)
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 150
Supported IN , NOT IN
operators
Examples Find issues whose FixVersion is the latest released version of the ABC project:
fixVersion = latestReleasedVersion(ABC)
Find issues that relate to the latest released version of the ABC project:
affectedVersion = latestReleasedVersion(ABC) or fixVersion =
latestReleasedVersion(ABC)
^ top of page
linkedIssues()
Perform searches based on issues that are linked to a specified issue. You can optionally restrict the search
to links of a particular type. Note that LinkType is case-sensitive.
Syntax linkedIssues(issueKey)
linkedIssues(issueKey,linkType)
Supported Issue
fields
Supported IN , NOT IN
operators
^ top of page
membersOf()
Syntax membersOf(Group)
Supported IN , NOT IN
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 151
Examples Find issues where the Assignee is a member of the group "jira-administrators":
assignee in membersOf("jira-administrators")
Search through multiple groups and a specific user:
reporter in membersOf("jira-administators") or reporter in
membersOf("jira-core-users") or reporter=jsmith
Search for a particular group, but exclude a particular member or members:
assignee in membersOf(QA) and assignee not in ("John
Smith","Jill Jones")
Exclude members of a particular group:
assignee not in membersOf(QA)
^ top of page
now()
Syntax now()
Supported fields Created. Due, Resolved, Updated, custom fields of type Date/Time
^ top of page
openSprints()
Search for issues that are assigned to a Sprint that has not yet been completed. Note, it is possible for an
issue to belong to both a completed Sprint(s) and an incomplete Sprint(s). See also closedSprints().
Syntax openSprints()
Examples Find all issues that are assigned to a sprint that has not yet been
completed:
sprint in openSprints()
^ top of page
projectsLeadByUser()
Find issues in projects that are led by a specific user. You can optionally specify a user, or if the user is
omitted, the current user will be used. Note that if you are not logged in to JIRA, a user must be specified.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 152
Syntax projectsLeadByUser()
projectsLeadByUser(username)
^ top of page
projectsWhereUserHasPermission()
Find issues in projects where you have a specific permission. Note, this function operates at the project level.
This means that if a permission (e.g. "Edit Issues") is granted to the reporter of issues in a project, then you
may see some issues returned where you are not the reporter, and therefore don't have the permission
specified. Also note, this function is only available if you are logged in to JIRA.
Syntax projectsWhereUserHasPermission(permission)
For the permission parameter, you can specify any of the permissions described
on .
Supported IN , NOT IN
operators
Examples Find open issues in projects where you have the "Resolve Issues" permission:
project in projectsWhereUserHasPermission("Resolve Issues")
AND status = Open
^ top of page
projectsWhereUserHasRole()
Find issues in projects where you have a specific role. Note, this function is only available if you are logged in
to JIRA.
Syntax projectsWhereUserHasRole(rolename)
Supported IN , NOT IN
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 153
Examples Find open issues in projects where you have the "Developers" role:
project in projectsWhereUserHasRole("Developers") AND
status = Open
^ top of page
releasedVersions()
Perform searches based on the released versions (i.e. versions that your JIRA administrator has released) of
a specified project. You can also search on the released versions of all projects, by omitting the project para
meter. See also latestReleasedVersion().
Syntax releasedVersions()
releasedVersions(project)
Supported IN , NOT IN
operators
Examples Find issues whose FixVersion is a released version of the ABC project:
fixVersion in releasedVersions(ABC)
Find issues that relate to released versions of the ABC project:
(affectedVersion in releasedVersions(ABC)) or (fixVersion in
releasedVersions(ABC))
^ top of page
standardIssueTypes()
Perform searches based on "standard" Issue Types, that is, search for issues that are not sub-tasks. See
also subtaskIssueTypes().
Syntax standardIssueTypes()
Supported Type
fields
Supported IN , NOT IN
operators
Examples Find issues that are not subtasks (i.e. issues whose Issue Type is a standard issue
type, not a subtask issue type):
issuetype in standardIssueTypes()
^ top of page
startOfDay()
Perform searches based on the start of the current day. See also startOfWeek, startOfMonth, and startOfYea
r; and endOfDay, endOfWeek, endOfMonth, and endOfYear.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 154
Syntax startOfDay()
startOfDay("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. startOfDay("+1") is the same as startOfDay("+1d"). If the
plus/minus (+/-) sign is omitted, plus is assumed.
^ top of page
startOfMonth()
Perform searches based on the start of the current month. See also startOfDay, startOfWeek, and startOfYea
r; and endOfDay, endOfWeek, endOfMonth, and endOfYear.
Syntax startOfMonth()
startOfMonth("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. startOfMonth("+1") is the same as startOfMonth("+1M"). If
the plus/minus (+/-) sign is omitted, plus is assumed.
Examples Find new issues created since the start of this month:
created > startOfMonth()
Find new issues created since the start of last month:
created > startOfMonth("-1")
Find new issues created since the 15th of this month:
created > startOfMonth("+14d")
^ top of page
startOfWeek()
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 155
Perform searches based on the start of the current week. See also startOfDay, startOfMonth, and startOfYea
r; and endOfDay, endOfWeek, endOfMonth, and endOfYear. For the startOfWeek() function, the result
depends upon your locale. For example, in Europe, the first day of the week is generally considered to be
Monday, while in the USA, it is considered to be Sunday.
Syntax startOfWeek()
startOfWeek("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. startOfWeek("+1") is the same as startOfWeek("+1w"). If
the plus/minus (+/-) sign is omitted, plus is assumed.
^ top of page
startOfYear()
Perform searches based on the start of the current year. See also startOfDay, startOfWeek and startOfMonth
; and endOfDay, endOfWeek, endOfMonth and endOfYear.
Syntax startOfYear()
startOfYear("inc")
where inc is an optional increment of (+/-)nn(y|M|w|d|h|m). If the time unit qualifier is omitted, it
defaults to the natural period of the function, e.g. endOfYear("+1") is the same as endOfYear("+1y"). If the
plus/minus (+/-) sign is omitted, plus is assumed.
^ top of page
subtaskIssueTypes()
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 156
Perform searches based on issues that are sub-tasks. See also standardIssueTypes().
Syntax subtaskIssueTypes()
Supported Type
fields
Supported IN , NOT IN
operators
Examples Find issues that are subtasks (i.e. issues whose Issue Type is a subtask issue
type):
issuetype in subtaskIssueTypes()
^ top of page
unreleasedVersions()
Perform searches based on the unreleased versions (i.e. versions that your JIRA administrator has not yet
released) of a specified project. You can also search on the unreleased versions of all projects, by omitting
the project parameter. See also earliestUnreleasedVersion().
Syntax unreleasedVersions()
unreleasedVersions(project)
Supported IN , NOT IN
operators
Examples Find issues whose FixVersion is an unreleased version of the ABC project:
fixVersion in unreleasedVersions(ABC)
Find issues that relate to unreleased versions of the ABC project:
affectedVersion in unreleasedVersions(ABC)
^ top of page
votedIssues()
Perform searches based on issues for which you have voted. Also, see the Voter field. Note, this function can
only be used by logged-in users.
Syntax votedIssues()
Supported Issue
fields
Supported IN , NOT IN
operators
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 157
^ top of page
watchedIssues()
Perform searches based on issues that you are watching. Also, see the Watcher field. Note that this function
can only be used by logged-in users.
Syntax watchedIssues()
Supported Issue
fields
Supported IN , NOT IN
operators
^ top of page
Query terms
A query is broken up into terms and operators. There are two types of terms: Single Terms and Phrases.
A Single Term is a single word, such as "test" or "hello".
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.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 158
Term modifiers
JIRA supports modifying query terms to provide a wide range of searching options.
Wildcard searches: ? and * | Fuzzy searches: ~ | Proximity searches
To perform a multiple character wildcard search, use the " *" symbol.
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, Wi
n95, 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 Windo
ws95, 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~
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
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 159
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:
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.
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:
or
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:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 160
Required term: +
The "+" or required operator requires that the term after the "+" symbol exists somewhere in a 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:
Note: The NOT operator cannot be used with just one term. For example, the following search will return no
results:
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:
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 for bugs and either atlassian or jira, use the query:
This eliminates any confusion and makes sure that bugs must exist, and either term atlassian or jira m
ay exist.
Do not use the grouping character '(' at the start of a search query, as this will result in an error. For
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 161
JIRA supports the ability to search issues for special characters by escaping them in your query syntax. The
current list of such characters is:
+ - & | ! ( ) { } [ ] ^ ~ * ? \ :
To escape these characters, type a backslash character '\' before the special character (or if using advanced
searching, type two backslashes '\\' before the special character).
For example, to search for (1+1) in either a basic or quick search, use the query:
\(1\+1\)
and to search for [example] in the summary of an advanced search (in JIRA Query Language or JQL), use
the query:
summary ~ "\\[example\\]"
Please note: If you are using advanced searching, see Reserved characters for more information about how
these characters and others are escaped in JIRA Query Language.
Reserved words
To keep the search index size and search performance optimal in JIRA, the following English reserved 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", "s", "such", "t", "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 words will and not are 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 the Indexing Language to Other (under Administration >
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:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 162
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 the Indexing Language to Other (under Administration > System
> General Configuration).
Word stemming applies to all JIRA 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
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.
Next steps
Screenshot: Issue filter results in detail view (click to view full size image)
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 163
Running a filter
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 164
The Manage Filters page allows you to view and configure filters that you have created, as well as work with
filters that other users have shared with you. See the following topics for more information:
Searching for a filter
Updating a filter
Deleting a filter
Cloning a filter
Adding a filter as a favorite
Sharing a filter
Defining a filter-specific column order
Subscribing to a filter
You can find and run any filters that you have created or that have been shared by other users.
1. Click the Search tab on the 'Manage Filters' page.
2. Enter your search criteria and click Search to run the search.
3. Your search results are displayed on the same page. Click the name of any issue filter to run it.
Tip: If the filter has been added as a favorite by many users, you may also be able locate it on the Popular ta
b of the Manage Filters page.
Updating a filter
You can update the name, description, sharing, favorite of any filters that you have created. If you want to
edit a filter that was shared with you, either clone (aka copy) the shared filter, or ask your JIRA administrator
to change the filter's ownership.
Update the filter's details:
1. Click the My tab on the 'Manage Filters' page.
2. Locate the filter you wish to update, click the cog icon > Edit.
3. The Edit Current Filter page displays, where you can update the filter details as required.
4. Click Save to save your changes.
Update the filter's search criteria:
1. Click the My tab on the 'Manage Filters' page.
2. Locate the filter you want to update and run it.
3. Update the search criteria as desired, and rerun the query to ensure the update is valid. You will see
the word Edited displayed next to your filter name.
4. Click Save to overwrite the current filter with the updated search criteria. If you want discard your
changes instead, click the arrow next to the save button, and select Discard changes.
Deleting a filter
Cloning a filter
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 165
You can clone any filter – which is just a way of making a copy that you own – that was either created by you
or shared with you.
1. Locate the filter you wish to clone and run it.
2. Update the search criteria as desired. Click the arrow next to the Save button, and select Save > Save
as to create a new filter from the existing filter.
Filters that you've created or that have been shared by others can be added to your favorite filters. Favorite
filters are listed in the menu under Issues > Filters, and in the left panel of the issue navigator.
1. Locate the filter you wish to add as a favorite.
2. Click the star icon next to the filter name to add it to your favorites.
Sharing a filter
Filters that you have created can be shared with other users via user groups, projects, and project roles.
They can also be shared globally. Any filter that is shared is visible to users who have the 'JIRA
Administrators' global permission. See Managing other users' shared filters below.
1. Click the My tab on the 'Manage Filters' page.
2. Locate the filter you wish to share, click the cog icon > Edit.
3. Update the Add Shares field by selecting the group, project, or project role that you want to share the
filter with, and clicking Add. Note that you can only share filters with groups/roles of which you are a
member.
Why can't I see the filter's sharing configuration?
You need the Create Shared Object global permission to configure sharing for a filter. Contact your
JIRA administrator to obtain this permission.
4. Click Save to save your changes.
Tip: You can also share your filter by running it, then clicking Details > Edit Permissions.
You can add a defined column order to a saved filter, which displays the filter results according to the saved
column order. Otherwise, the results are displayed according to your personal column order (if you have set
this) or the system default.
Tip: To display your configured column order in a filter subscription, select 'HTML' for the 'Outgoing email
format' in your User Profile. If you receive text emails from JIRA, you won't be able to see your configured
column order.
To add a column layout to a saved filter:
1. Click the My tab on the 'Manage Filters' page.
2. Locate the filter you wish to update; click the filter's name to display the results. Be sure you are
viewing the filter in the List view so that you see the columns.
3. Configure the column order as desired by clicking on the column name and dragging it to the new
position. Your changes are saved and will be displayed the next time you view this filter.
To remove a filter's saved column layout:
1. Click the My tab on the 'Manage Filters' page.
2. Locate the filter you wish to update; click the filter's name to display the results. Be sure you are
viewing the filter in the List view so that you see the columns.
3. Click the Columns option on the top right of the displayed columns, and select Restore Defaults in
the displayed window.
When the results of a saved filter are exported to Excel, the column order and choice of columns are those
that were saved with the filter. Even if a user has configured a personal column order for the results on the
screen, the saved configuration is used for the Excel export. To export using your own configuration, save
a copy of the filter along with your configuration, and then export the results to Excel.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 166
Subscribing to a filter
A shared filter is a filter whose creator has shared that filter with other users. Refer to Sharing a filter above
for details. When a shared filter is created by a user, that user:
Initially 'owns' the shared filter.
Being the owner, can edit and modify the shared filter.
If you have the JIRA Administrators global permission, you can manage shared filters that were created by
other users. For instructions, see Managing shared filters.
Next steps
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 167
On this page:
Changing
your view
of the
search
results
Working
with
individual
issues
Sharing
your
search
results
Displaying
your
search
results in
Confluenc
e
Displaying
your
search
results as
a chart
Exporting
your
search
results
Subscribin
g to your
search
results
Bulk
modifying
issues in
your
search
results
Next steps
The following screenshot provides an overview of the key features of the issue navigator.
Screenshot: Issue navigator (Detail view)
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 168
Change Click the column name. If you click the same column name more than once, the sort order
the sort will switch between ascending and descending. Note:
order
You cannot sort by the 'Images' column nor the sub-task aggregate columns (i.e. all
columns beginning with '').
If you sort the search results for an advanced 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. To switch
— between different column configurations, click Columns and select one of the following tabs:
show/hide
and move 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: Click Columns, 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 been hidden and that you
have permissions to see.
It is possible to add any of the existing custom fields to 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.
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 that you have a constant set of search results that you can work from when
triaging issues.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 169
Action an To action an issue (e.g. edit it, transition it, log work on it, etc):
issue
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 details panel.
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.
Click Share in the issue navigator to email a link to a search result or shared filter.
Recipients will receive an email with a link to the search result and the content of the Note field (if
specified). The subject of the email will state that you (using your username) 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.
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.
Click Export > Charts. Choose the desired chart from the dialog that is displayed, then click Save to
Dashboard.
The chart will be added to your dashboard. For more information on what each chart shows, see Reporting.
Excel Click Export > Excel (All fields) or Export > Excel (Current fields).
Excel (All fields): this will create a spreadsheet column for every issue field (excluding
comments).
Note: This will only show the custom fields that are available for all of the issues in the search
results. For example, a field that is only available for one project when your search results has
issues from multiple projects.
Excel (Current fields): this will create a spreadsheet column 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 the tempMax parameter in the URL.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 170
title
<title>[TEST-4] This is a test</title>
link
<link>https://extranet.atlassian.com:443/jira/browse/TEST-
description
<description>This is a detailed description of the issue.<
environment
<environment>Sydney network<environment>
key
<key id="22574">TEST-4</key>
summary
<summary>This is a test<summary>
parent
<parent id="22620">TEST-5</parent>
priority
<priority id="4"
iconUrl="https://extranet.atlassian.com:443/jira/images/ic
status
<status id="5"
iconUrl="https://extranet.atlassian.com:443/jira/images/ic
resolution
<resolution id="1">Fixed</resolution>
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 171
labels
<labels>
<label>focus</label>
<labels>
assignee
<assignee username="jsmith">John Smith</assignee>
reporter
<assignee username="jsmith">John Smith</assignee>
security
<security id="10021">Private</security>
created
<created>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/created>
updated
<updated>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/updated>
votes
<votes>1</votes>
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 172
timeoriginalestimate
<timeoriginalestimate seconds="600">10 minutes</timeorigin
timeestimate
<timeestimate seconds="300">5 minutes</timeestimate>
timespent
<timespent seconds="300">5 minutes</timespent>
aggregatetimeoriginalestimate
<aggregatetimeoriginalestimate seconds="36000">10 hours</a
aggregatetimeestimate
<aggregatetimeremainingestimate seconds="18000">5 hours</a
aggregatetimespent
<aggregatetimespent seconds="18000">5 hours</aggregatetime
timetracking
<timeoriginalestimate seconds="600">10 minutes</timeorigin
<timeestimate seconds="300">5 minutes</timeestimate>
<timespent seconds="300">5 minutes</timespent>
<aggregatetimeoriginalestimate seconds="36000">10 hours</a
<aggregatetimeremainingestimate seconds="18000">5 hours</a
<aggregatetimespent seconds="18000">5 hours</aggregatetime
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 173
issuelinks
<issuelinks>
<issuelinktype id="10020">
<name>Duplicate</name>
<inwardlinks description="is duplicated by">
<issuelink>
<issuekey id="22477">INTSYS-1009</issuekey
</issuelink>
</inwardlinks>
</issuelinktype>
</issuelinks>
customfield_xxxxx
<customfields>
<customfield id="customfield_10112"
key="com.atlassian.jira.plugin.system.customfieldtypes:sel
<customfieldname>Department</customfieldname>
<customfieldvalues>
<customfieldvalue>Adminstration</customfieldva
</customfieldvalues>
</customfield>
</customfields>
allcustom
<customfields>
<customfield id="customfield_10112"
key="com.atlassian.jira.plugin.system.customfieldtypes:sel
<customfieldname>Department</customfieldname>
<customfieldvalues>
<customfieldvalue>Adminstration</customfieldva
</customfieldvalues>
</customfield>
<customfield id="customfield_10111"
key="com.atlassian.jira.plugin.system.customfieldtypes:sel
<customfieldname>Expenditure Type</customfieldname
<customfieldvalues>
<customfieldvalue>Operating</customfieldvalue>
</customfieldvalues>
</customfield>
</customfields>
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.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 174
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.
If you want to specify a group as a recipient:
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).
RSS 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 the tempMa
x parameter in the URL.
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 add os_authType=basic to the feed URL
(e.g. http://mycompany.com/anypage?os_authType=basic) to show a login dialog
when viewing the feed.
Bulk operations let you action multiple issues at once. These actions include transitioning issues, deleting
issues, moving issues, and watching/unwatching issues.
Click Tools > Bulk Change: all <N> issue(s) and follow the 'Bulk Operation' wizard.
For more information, see Editing multiple issues at the same time.
Next steps
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 at 8:15 am on the second Friday of every month.
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):
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 175
This literally translates to 0 second, 15 minute, 8 hour, any day of the month, January, 2014.
In plain English, this represents 8:15am on every 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 section at 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.
L 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. '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'.
W 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 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
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 176
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 15 8 ? * 6#2 8:15 am on the second Friday of every month during the years 2007, 2008, and 2009.
2007-2009
Reporting
JIRA Core provides a range of reports that show statistics for particular people, projects, versions, or
information about issues.
The documentation in this section will help you configure and use the reports in JIRA Core.
Generating a report
To generate a report:
1. Navigate to the desired project and click Reports.
2. Select a report from the list. See the 'Reports' section below for information about each report.
Reports
Chart Purpose
Average Shows the average age of unresolved issues for a project or filter. This helps you see
Age whether your backlog is being kept up to date.
Report
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 177
Created vs Maps created issues versus resolved issues over a period of time. This helps you
Resolved understand whether your overall backlog is growing or shrinking.
Issues Notes...
Report Viewing the chart — Areas in red show periods where more issues were created
than resolved. Areas in green show periods where more were resolved than created.
Pie Chart Shows a pie chart of issues for a project or filter grouped by a specified field. This helps you
Report see the breakdown of a set of issues, at a glance.
For example, you could create a chart to show issues grouped by Assignee for a particular
version in a project (using a filter).
Recently Shows the number of issues created over a period of time for a project or filter, and how
Created many were resolved. This helps you understand if your team is keeping up with incoming
Issues work.
Report Notes...
Viewing the chart — The green portion of the bar shows the created issues that are
resolved. The red portion shows created but unresolved issues as yet.
Resolution Shows the length of time taken to resolve a set of issues for a project or filter. This helps you
Time identify trends and incidents that you can investigate further.
Report
Single Shows issues grouped by a particular field for a filter. This helps you group search results by
Level a field, and see the overall status of each group.
Group By
Report For example, you could view the issues in a version of a project, grouped by Assignee.
Time Since For a date field and project or filter, maps the issues against the date that the field was set.
Issues This can help you track how many issues were created, updated, etc over a period of time.
Report
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 178
Time Shows time tracking information on issues for a particular version of a project.
Tracking Notes...
Report * The table in the report shows the issues within the version:
There are four time tracking fields as follows:
Original Estimate - The original estimate of the total amount of time it would take
to complete this issue.
Estimated Time Remaining - The current estimate of the remaining amount of
time it would take to complete this issue.
Time Spent - The amount of time spent on the issue. This is the aggregate
amount of time that has been logged against this issue.
Accuracy- The accuracy of the original estimate compared to the current
estimate for the issue. It is the difference between the sum of the Time Spent an
d Estimated Time Remaining fields, and the Original Estimate field.
If sub-tasks are enabled, the *''*column at the right of the field shows the aggregate
time tracking information for each 'parent' issue (i.e. the sum of the issue's own
values, plus those of its sub-tasks).
The last line of the table shows the aggregate time tracking information for the whole
version.
The report also includes two bar-graphs (above the table), which represent the
aggregate time tracking information for the version:
The first bar-graph ('Progress') shows the percentage of completed issues (green)
and incomplete issues (orange) in this version:
The second bar-graph ('Accuracy' -blue) shows the accuracy of the original
estimates.
The length of the Accuracy bar compared to the Progress bar indicates whether the
issues in this version are ahead of or behind schedule. There are three cases:
1. The issues are on schedule with the original estimate.
The Accuracy bar is completely blue and is the same length as the Progress bar
above it.
2. The issues are behind the original estimate (i.e. will take longer than originally
estimated).
The Progress graph is longer than the Accuracy graph. The blue region represents
the original estimated time, and the light-grey region is the amount of time by which
issues are behind.
3. The issues are ahead of the original estimate (i.e. will take less time than originally
estimated).
The Accuracy graph is longer than the Progress graph. The blue bar represents the
original estimated time, and the light-grey region represents the amount of time by
which the original estimates were overestimated.
User Shows how much work a user has been allocated, and how long it should take.
Workload
Report * For a specified user, you'll be able to see the number of unresolved issues assigned to the
specified user, and the remaining workload, on a per-project basis.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 179
Version Shows how much outstanding work there is (per user and per issue) before a given version
Workload is complete.
Report *
For the specified version, you'll be able to see a list of unresolved issues assigned to each
user, each user's workload, and a summary of the total remaining workload for the version.
Workload Shows the relative workload for assignees of all issues for a project or filter.
Pie Chart
Report *
If you have connected JIRA to Confluence, you can create the following reports in Confluence.
Chart Purpose
Change Displays a list of issues from JIRA. This list can be static or dynamic, automatically updating as
Log the status of your issues change in JIRA.
Status The Status Report displays the progress of a JIRA project and fix version in pie charts by status,
Report priority, component, and issue type. The Status Report uses the JIRA Chart macro, and is
dynamic.
Other reports
Additional reports (e.g. Gantt Chart Report, Timesheet Report, JIRA SQL Plugin) are available for
download from the Atlassian Marketplace.
JIRA administrators can also create new reports with the plugin API — see our Tutorial - Creating a
JIRA report. If you don't want to build a plugin yourself, Atlassian Experts are available for custom
projects.
Issue filters can be exported to Microsoft Excel, where they can be further manipulated into charts and
reports. See Working with search results.
Configuring dashboards
Your dashboard is the main display you see when you log in to your project.
You can create multiple dashboards for different projects, or multiple
dashboards for one big project. Each project has a default dashboard, or
you can create a personal dashboard and add gadgets to keep track of
assignments and issues you're working on. Dashboards are designed to
display gadgets that help your organize your projects, assignments, and
achievements in different charts.
You can see all dashboards by selecting the Dashboards drop-down from
your JIRA application header.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 180
On this page:
About the
default
dashboard
Creating a
dashboard
Managing
dashboard
s and
permission
s
Sharing
and editing
your
dashboard
Adding
favorite
dashboard
s
Note on
dashboard
permission
s
Setting up
a
Wallboard
The gadgets on the default dashboard can be reordered and switched between the left and right columns.
Additional gadgets can also be added, while some gadgets can be configured. The layout of the dashboard
(e.g. number of columns) can also be configured.
All changes made to the default dashboard will also change the dashboards of all users currently using the
default dashboard. However, gadgets that users do not have permissions to see will not be displayed to
them. For example, the 'Administration' gadget, although it may exist in the default dashboard configuration,
will not be visible to non-admin users.
Creating a dashboard
You can easily create and customize your own dashboard to display the information you need. Note that only
administrators can customize the default dashboard for your project.
1. At the top right of the Dashboard, click the Tools menu.
2. Select either Create Dashboard to create a blank dashboard, or Copy Dashboard to create a copy
of the dashboard you are currently viewing.
3. Name and describe your dashboard.
4. Fill out the rest of the fields as applicable.
5. Click Add.
By default, sharing is set to private if you have not specified a personal preference. You can adjust this
setting in the sharing preferences in your user profile, and change dashboard permissions at any time in
the Manage Dashboards page.
To choose a different layout for your dashboard page (e.g. three columns instead of two):
1. At the top right of the Dashboard, click the 'Edit Layout' link. A selection of layouts will be displayed:
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
1.
Documentation for JIRA Core 7.1 181
Managing gadgets
To get the most out of your dashboard, including adding, rearranging, removing, and configuring gadgets,
see Adding and customizing gadgets.
You can edit, delete, copy, mark favorites, and share your dashboards from the Manage Dashboards page.
1. Select Dashboards > Manage Dashboards.
2. Choose the dashboard.
You can edit the details for your dashboard, and restrict or share with other users according to the
permissions that are set. In addition, you can see all the dashboards you've created, any public dashboards,
and any shared dashboards.
1. Click
If you find a dashboard you like, click the star icon next to its name to add it to your favorite dashboards list.
You can also add the default dashboard to your favorites list so it's easily available to you.
JIRA administrators, as set in global permissions, can manage their users' shared dashboards in the Shared
dashboards menu. Administrators can also change the ownership of a dashboard if the creator is unable to
maintain the dashboard or its gadgets. See Managing shared dashboards for more information.
Setting up a Wallboard
Turn any JIRA application dashboard into a wallboard by plugging your computer into a TV monitor. The
Wallboard is a dashboard gadget that acts as an information radiator to provide instant visual insight into
project progress and team accomplishments. With your favorite dashboard selected, click Tools > View as
Wallboard. The dashboard will appear against a black background, and will rotate gadgets if the user
enables the slideshow option.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 182
The Wallboard below shows the same Created vs. Resolved Issues gadgets and data above.
You can add gadgets to your own personal dashboard(s). To add a gadget to the default dashboard for your
JIRA application, you must be a JIRA admin.
Some applications allow dashboards that are shared by groups of people. If you have permission to update a
shared dashboard, the other people sharing the dashboard will see your changes, too.
1. Go to the dashboard by selecting the Dashboard link in the header.
2. On the dashboard, Click Add Gadget.
3. Use the gadget wizard to choose the gadgets you want to add. You can see a list of these gadgets in Gad
gets for JIRA applications.
For more information about managing dashboards, see Configuring dashboards.
There are a few ways you can customize the view of gadgets in a dashboard:
To Do this
Custom gadgets
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 183
You need administrator privileges to add a gadget to the list of available gadgets. If you have permission to add
gadgets to and remove gadgets from the directory itself, you will see the ' Add Gadget to Directory' and 'Remov
e' buttons on the 'Add Gadget' screen. This functionality is only available for the Server version of applications; if
you would like to add an Atlassian gadget to a directory in your Cloud site, please contact Atlassian Support.
Gadgets for JIRA applications
Gadgets let you customize the information that appears on dashboards in JIRA applications (or on your
wallboards, if you use dashboards for that purpose). This page lists all of the gadgets available for JIRA
applications and which ones they're available for.
Activity See the activity in your instance: it's like a Facebook feed for your in
Stream stance!
Sprint See the burndown for a given sprint in a handy line chart.
Burndown
Gadget
Version Track the projected release date for a version. This helps you
Report monitor whether the version will release on time, so you can take
action if work is falling behind.
Agile Know how you're tracking with an agile board displayed on your
Wallboard wallboard (or dashboard).
Gadget
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 184
Average Want to know the average age of unresolved issues? This gadget
Age Chart tells you just that.
Notes...
The report is based on your choice of project or issue filter,
and your chosen units of time (i.e. hours, days, weeks,
months, quarters or years).
For the purposes of this gadget, an issue is defined as
unresolved if it has no value in the system resolution field.
The age of an issue is the difference between the current
date and the created date of the issue.
Average Displays the average number of times issues have been in a status.
Number of
Times in
Status
Average Displays the average number of days issues have spent in status.
Time in
Status
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 185
Bamboo Seeing a list of all plans on a particular Bamboo server and each
Plans plan's current status.
Notes...
Your JIRA administrator must have configured the Bamboo
plugin on your JIRA server, if you want to add the Bamboo
Charts gadget to your dashboard. If you have added multiple
Bamboo servers in JIRA there will be one Bamboo Charts
gadget available per server, e.g. 'Bamboo Charts Gadget
from http://172.20.5.83:8085', 'Bamboo Charts Gadget from
http://172.19.6.93:8085', etc.
When you add this gadget to your JIRA dashboard, you may
see a message similar to this:
The website (container) you have placed this
gadget on is unauthorized. Please contact your
system administrator to have it approved.
To fix this problem, you will need to configure your Bamboo
site to allow JIRA to draw information from it via gadgets on
the JIRA dashboard. To do this, your JIRA administrator first
needs to define your JIRA site as an OAuth consumer in
Bamboo. You will then be required to perform a once-off
authentication before your gadget will display correctly.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 186
Created vs. Checking your progress by seeing the number of issues created vs
Resolved number of issues resolved over a given period of time.
Chart Notes...
The chart is based on your choice of project or issue filter,
and the chart can either be cumulative or not.
An issue is marked as resolved in a period if it has a
resolution date in that period.
The resolution date is the last date that the Resolution field
was set to any non-empty value.
Days Countdown! See how many working days you have before the
Remaining current sprint ends.
in Sprint
Gadget
Favorite See a list of all the issue filters that have currently been added by
Filters you as a favorite filter.
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 187
FishEye Get two charts about your repo in one: lines of code and commit
Recent activity.
Changesets Notes...
Your JIRA administrator must have configured the FishEye
plugin on your JIRA server, if you want to add the Crucible
Charts gadget to your dashboard (not applicable to JIRA
Cloud).
Issue See the issues returned from a specified project or saved filter
Statistics (grouped by a specified field).
Issues In Time to work! See all issues that are currently in progress and
Progress assigned to you.
JIRA Issues Generating a calendar-based view of due dates for issues and
Calendar versions
Notes...
The JIRA Calendar plugin is required for this gadget to be
available.
JIRA Road See which versions are due for release in a given period, as well as
Map a summary of the progress made towards completing the issues in
the versions.
Labels Use this gadget to see a list of all the labels used in a given project.
Gadget
Pie Chart See the issues returned from a specified project or issue filter,
grouped by a specified field.
Recently See the rate at which issues are being created, as well as how
Created many of those created issues are resolved - all in a bar chart.
Chart
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.
Documentation for JIRA Core 7.1 188
Time Since See a bar chart showing the number of issues for which your
Chart chosen field (e.g. 'Created', 'Updated', 'Due', 'Resolved', or a
custom field) was set on a given date.
Notes...
'Resolved' here is the system Resolution Date field, which is
the last date that the system Resolution field was set to any
non-empty value.
The report is based on your choice of project or issue filter,
and your chosen units of time (ie. hours, days, weeks,
months, quarters or years).
Two See data based on a specified issue filter (For example, you could
Dimensional create a filter to retrieve all open issues in a particular project. You
Filter can then configure the gadget to display the statistical data on this
Statistics collection of issues, in a table with configurable axes.
Workload Displays the matching issues for a project or filter as a pie chart.
Pie Chart
Created in 2016 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.