This page last changed on Feb 17, 2009 by smaddox.

The Atlassian IntelliJ Connector allows you to monitor, add and update JIRA issues from within IntelliJ IDEA.

Prerequisites

Please make sure that you have installed the Atlassian IntelliJ Connector, as described in the Installation Guide, and defined at least one JIRA server, as described in the Configuration Guide.

Summary of What You Can Do

Below are the highlights of the functionality supplied by the IntelliJ Connector for managing JIRA issues within IDEA, with links to the relevant section on this page. Please read the rest of the page for a full reference guide.

Sections on this page:

Accessing the JIRA Issues Tab in IDEA

To open the connector's JIRA Issues tab in IDEA:

  1. Click the Atlassian Connector control button at the bottom of the IDEA screen:



  2. The connector window will open. Select the JIRA Issues tab at the top of the connector window:

Using the JIRA Issues Tab

The JIRA issues tab shows a list of issues on the selected JIRA server(s). The issues are on the right, the servers and filters are on the left. You can add and remove JIRA servers, as described in the Configuration Guide.

To build the list of issues, you will use a filter. Currently-defined filters are shown on the left of the JIRA issues tab, under the relevant server name. Available filters are:

  • A custom filter defined locally in the connector window.
  • One or more filters defined on the JIRA server.


Screenshot: JIRA tab in the connector window

In the sections below, we tell you what you can do with the following parts of the JIRA issues tab:

  • The tool bar above the list of servers
  • The tool bar above the list of issues
  • The popup context menu for each issue in the list

Using the Toolbar above the Servers

The tool bar above the list of servers provides the following functionality:

Open the connector configuration panel, to set up your servers and other options. (See Configuring your JIRA Options in IDEA.)
Retrieve information from all the configured JIRA servers and re-run the currently defined filters.
Open all the filter lists, so that you can see the server name and filter names for all servers and filters.
Close all the filter lists for all servers, so that you can see only the server names.

Using the Toolbar above the Issues

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

Divide the list of JIRA issues into groups. You can choose:
  • None — Display a flat list of issues, in no particular order.
  • Project — Display the issues per project, as defined on the JIRA server.
  • Type — Display the issues per issue type, as defined on the JIRA server. For example, this would group all feature requests under one heading, all bug reports under another heading, etc.
  • Status — Display the issues per issue status, as defined on the JIRA server. For example, this would group all closed issues under one heading, all open issues under another heading, etc.
  • Priority — Display the issues per priority. For example, this would group all blocker issues under one heading, all major issues under another heading, etc.
  • Last Updated — Group the issues depending on the date of last modification. The connector groups the issues into logical time periods: today, yesterday, 2 days ago, last week, etc.
Collapse sub-issues under their parents. This option is useful if you have defined sub-tasks in JIRA.
Open all the issue groups, so that you can see the list of issues under every heading.
Close all the issue lists for all groups, so that you can see only the group headings.
Open the selected issue in an IDEA output tool window. See below.
Open the selected issue in your browser, using the JIRA user interface.
Add an issue to the active JIRA server, i.e. the server for which you have currently selected a filter in the left-hand panel.
Quick search for an issue. Enter:
  • An issue key — Opens the issue in an IDEA output tool window.
  • Some text — Launches a JIRA search in your web browser.
Refresh the contents of the currently-displayed issues list by re-running the selected filter.
Get help on the usage of the JIRA tab (i.e. open this documentation page in your browser).
The search box gives you quick access to an issue. Just type the issue key into the search box at top right of the Issues tab. The connector will display matching issues as you type.

Using the Context Menu for an Issue

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

  • Hover over a line to see a preview of the issue information.
  • Double-click a line to open the selected issue in an IDEA output tool window. See below.
  • Right-click a line to show a popup context menu (pictured in the screenshot above) with actions that can be performed for the selected issue:
    • Open Issue — Open the selected issue in an IDEA output tool window. See below.
    • View in Browser — Open the selected issue in a new browser window, using the JIRA user interface.
    • Edit in Browser — Open the selected issue for editing in a new browser window.
    • Add Comment — Add a comment to the issue.
    • Log Work — Record the time worked against the issue.
    • Create ChangeList — Add a changelist relating to the issue. A changelist is a set of changes in one or more source code files, making up a logical set of changes.
    • Assign to Me — When you select this option, the issue is immediately assigned to your username on the JIRA server. The connector will send JIRA the username which you used to authenticate to the JIRA server (as described in Configuring the IntelliJ Connector).
    • Assign to User — When you select this option, the connector prompts you for a username. Enter the JIRA username of the person to whom you wish to assign this issue. Note that the username is only validated when the request reaches the JIRA server. If the username is unrecognised, you will receive a remote validation exception message at the bottom of the connector panel. Please try again.
    • Assign to Me and Start Working — Select this option to assign the issue to yourself immediately, and to set the issue status to 'In Progress'.
    • Copy to Clipboard — This option offers a quick way to copy specific information about the issue to your clipboard, so that you can then paste it into another application. Hover your cursor over this option and then choose to copy one of the following:
      • The issue key
      • The issue URL on your JIRA server
      • The issue summary
      • The issue key and summary
    • Perform Available Workflow Actions — Hover over this option to see a list of available actions. Simple actions will be completed when you click the menu option. If the action needs more information, it will open in a browser window.

If your update does not appear in the issue preview, click the refresh icon .

Viewing and Updating Issues

From the JIRA issues tab, described above, you can open a JIRA issue in an IDEA output tool window. For example, you can do one of the following:

  • Select the issue and then click the 'Open Issue' icon , or
  • Right-click the issue and then select 'Open Issue' from the popup context menu.

The issue will open in an IDEA output tool window. The window will have two or more tabs, displaying information related to the issue.

Viewing Issue Details

Screenshot: JIRA issue window, showing the issue details



The tool bar provides the following functionality:

Open the selected issue in your browser, using the JIRA user interface.
Open the selected issue for editing in a new browser window.
Record the time worked against the issue.
Add a changelist relating to the issue. A changelist is a set of changes in one or more source code files, making up a logical set of changes.
Refresh the contents of the currently-displayed issue by fetching the latest data from the JIRA server.
Close the issue window in IDEA.

Viewing and Adding Comments

Screenshot: JIRA issue window, showing the issue comments



To add a new comment, click the 'Add Comment' icon

Viewing Stack Traces

If the JIRA issue contains a stack trace in the issue description or in a comment, you will be able to click the relevant link(s) in the stack trace to open the corresponding source file in IDEA.

Screenshot: JIRA issue window, showing a hyperlinked stack trace in a description

RELATED TOPICS

Document generated by Confluence on Mar 23, 2009 12:06