Created by Anonymous, last updated by SteveW on Nov 29, 2012 2 minute read
JIRA 101
Thank you for choosing JIRA to track your projects and issues. To help you get up and running quickly, we've compiled some easy instructions for configuring and using JIRA 5.0.
入門ガイド
1. Installing JIRA
First things first. If you haven't already got JIRA up and running, carry out the following steps:
Download the appropriate JIRA Windows Installer (.exe) file (which matches the 'bit' version of your Windows operating system) from the JIRA download page.
Run the '.exe' file, choose an installation directory, a home directory and a port ('8080' will do). We recommend that you choose to 'Run JIRA as a service'.
To access JIRA, go to your web browser and type this address: http://localhost:8080. Windows 'Start' menu shortcuts will also be added which you can also use to start and stop JIRA.
Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.
Before using JIRA as a production system, ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only). Please see the documentation for details.
Download the appropriate Linux Installer (.bin) file (which matches the 'bit' version of your Linux operating system) from the JIRA download page.
Open a console as the 'root' user (e.g. open a shell and enter the command 'su root').
Execute the '.bin' file, choose an installation directory, a home directory and a port ('8080' will do). (If you execute the '.bin' file with 'root' user privileges, JIRA will be installed as a service and will run under a dedicated 'jira' user account.)
To access JIRA, go to your web browser and type this address: http://localhost:8080.
Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.
Before using JIRA as a production system, ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only). Please see the documentation for details.
JIRA running on Mac OS X is supported for evaluation purposes only.
Download the JIRA Standalone (tar.gz) file from the JIRA download page and extract it.
Edit the jira-application.properties file in the JIRA Installation Directory, add a 'jira.home' property and set it to your desired location for the JIRA home directory. Please use forward-slashes ("/"), not back-slashes ("\").
Run bin/start-jira.sh to start JIRA.
To access JIRA, go to your web browser and type this address: http://localhost:8080.
Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.
Choose Administration at the top right of your screen.
Select Users > Users from the top menu, then click Add User.
Enter the Username, Password, Full Name and Email Address; and (optionally) tick the box to send the user an email containing their account details. Then click the Add button. For more details, please see the documentation.
If the user is going to need to work on issues, select the jira-developers group and click the Join button. (If the user is only going to log issues, and not work on them, then they do not need to belong to the jira-developers group.) For more about groups, please see the documentation. Adding your users to the jira-developers group will automatically add them to the Default Members for the Developers project role. For more about project roles, please see the documentation.
You may want to suggest to your users that they take a look at 'Mastering the Basics' (below). You may also want to point them to the documentation on:
Your users will need to access JIRA at http://<JIRA machine name>:8080 (not http://localhost:8080).
3. Creating a project
Choose Administration at the top right of your screen.
Select Projects > Projects from the top menu, then click Add Project.
In the Name field, type a descriptive name for your project (typically two or three words, e.g. Purchase Orders).
In the Key field, type a meaningful prefix for issues in your project (typically three or four characters, e.g. ORD). Be aware that you cannot subsequently change this in JIRA.
In the Project Lead field, select the user to whom issues should be assigned by default.
If you chose to set up email when you installed JIRA (see above), change the Notification Scheme field from None to Default Notification Scheme. This will allow JIRA to automatically send emails to appropriate people when particular events occur (e.g. 'Issue Created', 'Issue Resolved'). For more about email, please see the documentation.
Leave the rest of the fields with their default values for now. Click the Add button.
Mastering the basics
4. Creating an issue
Click the 'Create Issue' link in the top navigation-bar.
Select the relevant Project and Issue Type, then click the 'Next' button.
Type a short description of the issue in the 'Summary' field, then click the 'Create' button.
Go to the issue and select Log Work from the More Actions button's dropdown menu.
In the Time Spent field, enter the amount of time to be logged. Use 'w', 'd', 'h' and 'm' to specify weeks, days, hours or minutes (e.g. to enter two hours of work, type '2h').
作業の説明フィールドで、完了した作業に関して説明またはコメントを入力します。
Click the Log button.
For more details about the other options on this screen, please see the documentation.
6. Resolving an issue
Go to the issue, and select 'Resolve Issue' from the 'Available Workflow Actions' menu in the left column.
In the 'Resolution' field, select the 'Resolution' that best describes the outcome (e.g. 'Fixed').
(Optional) In the 'Comment' field, type a description or comment about the issue's resolution.
Click the 'Resolve' button.
For more information about how an issue moves from one Status to another, please see the documentation.
7. Searching for issues
Use the Quick Search box in the top of your screen to quickly search JIRA. You can type an issue key (e.g. TEST-1234) to jump directly to an issue, or use syntax like my open issues to immediately return all issues which are assigned to you and haven't yet been resolved.
Choose Issues > Search for Issues on the top navigation bar to display JIRA's searching and filtering panel.
Select the Project, Issue Type, or any other issue attributes of interest. You can also perform comprehensive text searches when using the basic search.
Click Issues > Search for Issues on the top navigation bar, then click Switch to Advanced to display the JQL (JIRA Query Language) panel.
Type your query (e.g. 'project=TEST') and press Enter/Return on your keyboard.
View your search results (see 'Searching' above) in the Issue Navigator.
Click the 'Views' menu and select the 'Charts' option.
Choose your preferred type of chart, and enter any required configuration details. For more details, please see the documentation.
Click 'Projects' in the top navigation bar.
Select the project you are interested in.
Click 'Reports' at the right of the screen and select the report of interest.
Enter any required configuration details, then click 'Next' to display your report (e.g. Workload Pie Chart Report).
View your search results (see 'Searching' above) in the Issue Navigator.
Click the 'Views' menu and select 'Word', 'Excel', or your preferred format. For more details, please see the documentation.
Customising JIRA
(Note that you need to be an Administrator to do the tasks in this section.)
You may want to create a sample project named 'Purchase Orders', in which to perform the tasks described in this section. For instructions, please see 'Creating a Project' (above).
9. Adding a new issue type
The Issue Type is one of the first things a user must choose when they create an issue. Depending on how your organisation is using JIRA, you might want to add a new Issue Type. For example, if you are using JIRA to track purchase orders, the default Issue Types ('Bug', 'Improvement', 'New Feature', 'Task') might not be relevant. So you might want to add a new Issue Type called 'Order'.
To add a new Issue Type called 'Order', and associate it with a project called 'Purchase Orders':
Choose Administration at the top right of your screen.
Select 'Issues' > 'Issue Types'.
In the 'Add New Issue Type' form, in the 'Name' field, type 'Order. In the 'Description' field, type 'A purchase order'. Then click the 'Add' button'. (For more about adding Issue Types, and icons, please see the documentation.)
Click the 'Issue Types Scheme' tab at the top of the 'Manage Issue Types' screen.
In the 'Add New Issue Type Scheme' form, in the 'Name' field, type 'Purchase Order Issue Type Scheme'. Then click the 'Add' button'. (For more about Issue Type Schemes, please see the documentation.)
In the 'Available Issue Types' list, click the Issue Type called 'Order' and drag it into the 'Issue Types for Current Scheme' list. Then click the 'Save' button.
Click 'Projects' in the left navigation column. Then in the 'Name' column, click 'Purchase Orders'. The project details will be displayed.
Click the 'Select' link next to the 'Issue Type Scheme' field, select 'Purchase Order Issue Type Scheme' and click the 'Associate' button.
To test what you have done, create an issue in the 'Purchase Orders' project. The only available Issue Type should be 'Order'.
10. Adding a new screen
Depending on how your organisation is using JIRA, you might want to add a purpose-built screen that will be displayed for particular types of issues, or for particular projects or workflows. For example, if you are using JIRA to track purchase orders, some of the normal issue fields (e.g. 'Affects Version', 'Fix Version', 'Environment') might not be relevant. So you might want to create a simplified screen that omits these fields.
To add a new Screen called 'Purchase Order Screen', and associate it with a project called 'Purchase Orders':
Choose Administration at the top right of your screen.
Select 'Issues' > 'Screens'.
Click the 'Copy' link next to 'Default Screen'.
In the 'Name' field, type 'Purchase Order Screen'. Then click the 'Copy' button'. (For more about Screens, please see the documentation.)
Click the 'Configure' link next to 'Purchase Order Screen'.
Tick the 'Remove' box for the following fields: 'Affects Version', 'Fix Version', 'Environment'. Then click the 'Remove' button.
Click 'Screen Schemes' in the left navigation column (under 'Issue Fields').
In the 'Name' field, type 'Purchase Order Screen Scheme'. In the 'Default Screen' field, select 'Purchase Order Screen'. Then click the 'Add' button'. (For more about Screen Schemes, please see the documentation.)
Click 'Issue Type Screen Schemes' in the left navigation column (under 'Issue Fields').
In the 'Name' field, type 'Purchase Order Issue Type Screen Scheme'. In the 'Screen Scheme' field, select 'Purchase Order Screen Scheme'. Then click the 'Add' button'. (For more about Issue Type Screen Schemes, please see the documentation.)
Click 'Projects' in the left navigation column. Then in the 'Name' column, click 'Purchase Orders'. The project details will be displayed.
Click the 'Select' link next to the 'Issue Type Screen Scheme' field, select 'Purchase Order Issue Type Screen Scheme' and click the 'Associate' button.
To test what you have done, view an issue in the 'Purchase Orders' project. You shouldn't see the 'Affects Version', 'Fix Version' or 'Environment' fields.
11. Adding a new custom field
Depending on how your organisation is using JIRA, you might need to add a 'custom' field that will be displayed for particular types of issues, or for particular projects. For example, if you are using JIRA to track purchase orders, you might create a custom field called 'Supplier'.
To create a new custom field called 'Supplier' and put it on the 'Purchase Order Screen':
Choose Administration at the top right of your screen.
Select 'Issues' > 'Fields' > 'Custom Fields'.
Click 'Add Custom Field'.
On the 'Create Custom Field - Step 1' screen, in the 'Field Type' field, choose 'Select List'. Then click the 'Next' button.
On the 'Create Custom Field - Step 2' screen:
in the 'Name' field, type 'Supplier'.
in the 'Description' field, type 'Choose the supplier for this Purchase Order'.
under 'Choose applicable issue types' select 'Order'. Then click the 'Finish' button.
On the 'Associate field Order to screens' screen, tick the check-box for 'Purchase Order Screen'. Then click the 'Update' button.
On the 'View Custom Fields' screen, click the 'Configure' link next to 'Supplier'. Then click 'Edit Options'.
Add three options: 'ABC Pty Ltd', 'ACME Pty Ltd', 'XYZ Pty Ltd'. Choose 'ACME Pty Ltd' as the default. Then click the 'Done' button.
To test what you have done, create an issue in the 'Purchase Orders' project. You should see a field called 'Supplier' that has a drop-down box containing your three options.
12. Adding a new issue status and workflow
Depending on how your organisation is using JIRA, you might need to add a new 'Status' , i.e. a new step in the issue 'workflow'. For example, if you are using JIRA to track purchase orders, you might add a new Status called 'Purchase Approved' .
To add a new Status called 'Purchase Approved', and create a new workflow that has an extra step between 'Open' and 'In Progress':
Choose Administration at the top right of your screen.
Click 'Statuses' in the left navigation column (under 'Issue Settings').
In the 'Name' field, type 'Purchase Approved'. Then click the 'Add' button'. (For more about adding Statuses, and icons, please see the documentation.)
Click 'Workflows' in the left navigation column.
Click the 'Copy' link next to 'jira (Read-only System Workflow)'.
In the 'Workflow Name' field, type 'Purchase Order Workflow'. Then click the 'Copy' button'. (For more about Workflow, please see the documentation.)
Click the 'Steps' link next to 'Purchase Order Workflow'.
In the 'Add New Step' form:
in the 'Name' field, type 'Purchase Approved'.
in the 'Linked Status' field, select 'Purchase Approved'.
click the 'Add' button.
Click the 'Add Transition' link next to 'Open':
in the 'Name' field, type 'Approve Purchase'.
in the 'Destination Step' field, select 'Purchase Approved'.
click the 'Add' button.
Click the 'Add Transition' link next to 'Purchase Approved':
in the 'Name' field, type 'Start Progress'.
in the 'Destination Step' field, select 'In Progress'.
click the 'Add' button.
Click the 'Delete Transitions' link next to 'Open'. Select 'Start Progress' and click the 'Delete' button.
Click 'Workflow Schemes' in the left navigation column (under 'Schemes'). Then click 'Add Workflow Scheme'.
In the 'Name' field, type 'Purchase Order Workflow Scheme'. In the 'Default Screen' field, select 'Purchase Order Screen'. Then click the 'Add' button'. (For more about Workflow Schemes, please see the documentation.)
Click the 'Workflows' link next to 'Purchase Order Workflow Scheme', click 'Assign Workflow' and select 'Purchase Order Workflow'. Then click the 'Add' button.
Click 'Projects' in the left navigation column. Then in the 'Name' column, click 'Purchase Orders'. The project details will be displayed.
Click the 'Select' link next to the 'Workflow Scheme' field, select 'Purchase Order Workflow Scheme' and click the 'Associate' button.
To test what you have done, create an issue in the 'Purchase Orders' project. After you save the issue, the left column should contain a link called 'Approve Purchase', but not a link called 'Start Progress'.
13. Using permission schemes, groups and project roles
A Permission scheme allows you to grant people 'permission' to work on issues in a project. The new project that you created previously is using JIRA's Default Permission Scheme. If you end up creating lots of projects, you might need to grant different people permission to work on different projects. For example, if your organisation requires all software development issues to be tested by a Quality Assurance person before being closed, you could create a permission scheme called 'Software Development Permission Scheme' in which you assign the 'Close Issue' permission to the appropriate people. You would then associate your new permission scheme with all your software development projects. There are a number of ways to do this, depending on your requirements:
Project roles enable you to associate different people with particular functions, for particular projects.
Groups enable you to associate the same people with a particular function, for all projects that use this permission scheme.
To add a new permission scheme called 'Software Development Permission Scheme', and a project role called 'Quality Assurance':
Create a project role called 'Quality Assurance':
Choose Administration at the top right of your screen.
Select 'Users' > 'Roles' from the top menu.
In the 'Name' field, type 'Quality Assurance'. Then click the 'Add Project Role' button.
Create a permission scheme called 'Software Development Permission Scheme', in which you assign the 'Close Issue' permission to the 'Quality Assurance' project role:
Select 'Issues' > 'Permission Schemes' from the top menu.
Click the 'Copy' link next to 'Default Permission Scheme'. A new permission scheme called 'Copy of Default Permission Scheme' will be created.
Click the 'Edit' link next to 'Copy of Default Permission Scheme'. On the 'Edit' screen,
change the 'Name' to 'Software Development Permission Scheme'
change the 'Description' to 'Permission scheme for software development projects'. Then click the 'Update' button.
Click the 'Permissions' link next to 'Copy of Default Permission Scheme'. On the 'Edit Permissions' screen,
for the 'Close Issues' permission, click the 'Delete' link next to 'Project Role (Developers)'.
for the 'Close Issues' permission, click the 'Add' link. Click 'Project Role' and choose 'Quality Assurance'. Then click the 'Add' button.
Associate the 'Software Development Permission Scheme' with all your software development projects. Do the following for each relevant project:
Click 'Projects' and select the project of interest. The project details will be displayed.
Click the name of the project's current Permission Scheme, then select 'Software Development Workflow Scheme' and click the 'Associate' button.
For each software development project, add the appropriate people to the 'Quality Assurance' project role:
Click 'Projects' and select the project of interest. The project details will be displayed.
Click 'View Project Roles' to display the 'People' screen
Select the 'Edit' link next to 'Quality Assurance' and add the appropriate people.
Or, to add a new permission scheme called 'Software Development Permission Scheme', and a group called 'quality-assurance':
Create a group called 'quality-assurance', and add the appropriate people to it.
Choose Administration at the top right of your screen.
Select 'Users' > 'Groups' from the top menu.
In the 'Name' field at the bottom of the page, type 'quality-assurance'. Then click the 'Add Group' button.
Create a permission scheme called 'Software Development Permission Scheme', in which you assign the 'Close Issue' permission to the 'quality-assurance' group.
Select 'Issues' > 'Permission Schemes' from the top menu.
Click the 'Copy' link next to 'Default Permission Scheme'. A new permission scheme called 'Copy of Default Permission Scheme' will be created.
Click the 'Edit' link next to 'Copy of Default Permission Scheme'. On the 'Edit' screen,
change the 'Name' to 'Software Development Permission Scheme'
change the 'Description' to 'Permission scheme for software development projects'. Then click the 'Update' button.
Click the 'Permissions' link next to 'Copy of Default Permission Scheme'. On the 'Edit Permissions' screen,
for the 'Close Issues' permission, click the 'Delete' link next to 'Project Role (Developers)'.
for the 'Close Issues' permission, click the 'Add' link. Click 'Group' and choose 'quality-assurance'. Then click the 'Add' button.
Associate the 'Software Development Permission Scheme' with all your software development projects. Do the following for each relevant project:
Click 'Projects' and select the project of interest. The project details will be displayed.
Click the name of the project's current Permission Scheme, then select 'Software Development Workflow Scheme' and click the 'Associate' button.
14. Installing add-ons
You can install add-ons to add new functionality to JIRA (e.g. additional gadgets or reports), or to change the behaviour of existing features.
Choose Administration at the top right of your screen.
Choose Plugins > Find New Add-ons. The 'Atlassian Marketplace for JIRA' page is displayed. This in-product view of the Atlassian Marketplace website lets you browse add-ons specifically for JIRA.
Find add-ons by searching the Marketplace, choosing categories, or browsing the featured add-ons list.
Click the Install button to install free add-ons, or either the Buy Now or Free Trial buttons to install paid add-ons. A confirmation message and the plugin details will appear after the plugin is installed successfully. Note: You may need to restart JIRA for your change to take effect. The plugin manager will inform you if this is the case. Note: Not all add-ons can be automatically installed. Some require manual installation. These add-ons have a Download button instead of an Install button. In these cases, you should read and follow the add-on installation instructions.
(Note that you need to be an Administrator to do the tasks in this section.)
15. Import existing data from another issue tracker into JIRA
If you have existing projects and issues in another issue tracker such as Bugzilla, FogBugz, Mantis, Pivotal Tracker, Trac and more, have a look at our page on Migrating from Other Issue Trackers. This section of our documentation contains detailed instructions on how to import data from your other issue tracker into JIRA.
Ideally, before allowing your users to use your JIRA installation as a 'production system', ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only).