This page last changed on Apr 10, 2008 by smaddox.

The Atlassian IDE Plugin allows you to monitor, add and update JIRA issues right there in your integrated development environment.

On this page:

Error formatting macro: toc: java.lang.NullPointerException

Contents of the JIRA Tab in the Plugin Window

The JIRA tab of the plugin window shows a list of issues on the selected JIRA server. To build this list, you will use a filter defined either locally in the plugin window, or as a filter saved on the JIRA server. There are more guidelines on filters below.

Screenshot: JIRA context menu in the JIRA tab of the plugin window



You can perform the following functions for each line in the list:

  • Double-click a line to open the selected issue in a new browser window.
  • Right-click a line to show a popup context menu (pictured above) with actions that can be performed for the selected issue:
    • View — Open the selected issue in a new browser window.
    • Edit — Open the selected issue for editing in a new browser window.
    • Add Comment — Add a comment to the issue. (See below.)
    • Log Work — Record the time worked against the issue.
    • Create Changelist — Add a changelist relating to the issue. (See below.)


The tool bar above the list of issues provides more functionality:

  • — Open the plugin configuration panel.

  • — Get help on the usage of the JIRA tab (i.e. open this page in your browser).

  • — Select your JIRA server from the list of configured servers.

  • — Add a JIRA issue. (See below.)

  • — Quick search for issue (launches a web browser).

  • - Tick this box if you want to use a filter from the JIRA server. If not ticked, you will define a local filter in the plugin window. (See below.)

  • — Select a filter defined on the JIRA server. (See below.)

  • — Define a local filter. (See below.)

  • — Refresh the contents of the list by re-running the currently defined filters.

  • , — Page through search results.

Filtering the List of Issues

  1. First, select your JIRA server from the dropdown list in the tool bar. This list will show all JIRA servers defined in the plugin configuration panel.
  2. Now you will see all relevant JIRA issues on that server.
    The plugin will 'remember' your selection of the JIRA server and filter next time you start IDEA.
  3. Decide how to filter the issues on the server — there are two ways to do this:
    • Use the filters defined on the JIRA server. These filters cannot be modified by the plugin. You can run the filter and display results in the JIRA tool window of the plugin.
    • Or define your filter locally in the plugin window and send the filter values to the JIRA server.

Using Filters Defined on the JIRA Server

  1. Put a tick in the 'Use server filters' checkbox in the plugin window.
  2. Select the saved filter from the dropdown list. This list will show all saved filters which you have permission to view on the JIRA server.
  3. Click the 'Refresh' icon .

For more information on JIRA filters, please refer to the JIRA documentation.

Using Filters Defined in the Plugin

Screenshot: Defining a filter in the JIRA tab of the plugin window


  1. Click the icon to open the filter definition panel of the JIRA tab, as pictured above.
    The filter definition panel provides a number of criteria which you can use to filter the issues. You can collapse and expand sections of the panel by clicking the arrow icons on the left of the panel.
  2. Select one or more criteria.
    For each criterion, you can select multiple values by Control-clicking (Windows/Linux) or Command-clicking (OS X) on them.
  3. Click the 'Apply' icon to apply and save your filter.

The filter definition view contains the following icons:

  • — Applies the defined filter and saves it, so that it is used on next IDEA restart.

  • — Cancels the definition of the filter and opens the issue list view.

  • — Resets the filter to default values.

Creating a New JIRA Issue

Screenshot: Creating a New JIRA issue

To add a new JIRA issue:

  1. Select your JIRA server from the dropdown list on the tool bar.
  2. Click the plus icon on the tool bar.
  3. A dialogue box opens, as shown below. The information requested is the same as required when you add an issue using the JIRA UI:
    • Project — The JIRA project on the JIRA server.
    • Type — The issue type, as defined within the JIRA project.
    • Priority — The priority of the issue.
    • Summary — The title of your JIRA issue.
    • Description — A detailed description of the problem you wish to record or the feature you wish to request.
  4. Click the 'Create' button to add the issue to the selected JIRA server.

For more information on JIRA, please refer to the JIRA documentation.

Commenting on a JIRA Issue

Screenshot: Commenting a JIRA issue


To add a comment to an existing JIRA issue:

  1. Select your JIRA server from the dropdown list in the tool bar.
  2. Use the filter and search functions to find your issue.
  3. Right-click the issue in the list and select 'Add Comment'.
  4. A dialogue box appears, as pictured below. Add your comment text.
  5. Click the 'Comment' button to append the comment to the issue on the JIRA server.

Creating a Changelist from a JIRA Issue

A changelist, or change set, is a collection of code changes committed at the same time. You may want to create a changelist in IDEA, based on the issue key and description from JIRA. This eases working on several issues simultaneously — you can drag and drop files you have modified from one changelists to another, and commit the whole changelist in one operation. The commit dialogue's comment box will be pre-populated with the name of the changelist.

Screenshot: Creating a changelist from a JIRA issue key



To create a changelist from an existing JIRA issue:

  1. Select your JIRA server from the dropdown list in the tool bar.
  2. Use the filter and search functions to find your issue.
  3. Right-click the issue in the list and select 'Create Changelist'.
  4. A dialogue box appears, as pictured below.
  5. Click the 'Create' button.

Screenshot: Changelists defined from the JIRA issue keys


RELATED TOPICS

Configuring the Plugin
IDE Plugin User Guide


Add JIRA Comment.jpg (image/jpeg)
JIRA menu.jpg (image/jpeg)
changesets.jpg (image/jpeg)
changelist name.jpg (image/jpeg)
SelectJIRAServer.png (image/png)
jira tab.jpg (image/jpeg)
use server filters.png (image/png)
select filter.png (image/png)
jira tab with menu.jpg (image/jpeg)
server.jpg (image/jpeg)
filters panel 3.png (image/png)
Create JIRA Issue - 3.png (image/png)
Document generated by Confluence on Apr 13, 2008 17:32