JIRA Integration in FishEye

This page contains instructions for setting up JIRA integration.

JIRA is Atlassian's issue tracking product, which can be used to manage projects and associated work. JIRA issues can be viewed in the main Dashboard view. This requires you to enter details on the required JIRA server(s) via the administration screens.

Before you begin: Ensure that you configure your JIRA instance to enable sub-tasks and allow Remote API access; it is also recommended that you enable unassigned issues.

The instructions on this page have been tested with JIRA 4.0.0.

On this page:

Opening the Administration Screen for JIRA Integration

To set up JIRA integration, open the Administration screen and then click 'JIRA Servers' under the 'Global Settings' sub-menu on the left navigation bar. The 'View JIRA Servers' administration page opens.

Screenshot: The View JIRA Servers Page

On the View JIRA Servers page, you can carry out a number of operations as described below.

Adding a New JIRA Server

To add a new JIRA server from the View JIRA Servers page, click 'Add JIRA Server'.

The 'Add JIRA Server' page opens.

Screenshot: The Add JIRA Server Page

A number of fields and options must be filled out or selected on this page. See the table below for information on each field.

Option	Type	Description	Required
Name	Text Field	A descriptive name for the JIRA server.	Yes
URL	Text Field	The base URL of the JIRA server, e.g. http://jira.atlassian.com	Yes
Username	Text Field	The username of an account on the JIRA instance. (All activity that takes place will be attributed to this user, unless using the Trusted Application setting).	Yes
Password	Text Field	The password for the account on the JIRA instance.	Yes
Include in Activity Streams	Check Box	Allows JIRA information to appear in the Activity Streams.	No
Authenticate as Trusted Application	Check Box	Allows the system to interface with JIRA, letting users log on with their own accounts (and use their own accounts on the JIRA server). If you enable subtasks using a trusted JIRA instance, you will also need to add FishEye as a trusted application to your JIRA instance, and then add the root path (denoted by '/' ) to the URL Paths to Allow field on the trusted applications screen in the administration interface of your JIRA instance. For more information, see the FishEye documentation and JIRA documentation about trusted applications. Also see the Known Issues.	No
Subtask Type ID	Number	This is required to enable creating issues from a Crucible comment (not required for standalone FishEye). See the instructions on obtaining this number.	No
Subtask Resolution Action ID	Number	This is required to enable creating issues from a Crucible comment (not required for standalone FishEye). See the instructions on obtaining this number (not required for standalone FishEye).	No
Subtask Resolution ID	Number	This is required to enable creating issues from a Crucible comment (not required for standalone FishEye). See the instructions on obtaining this number (not required for standalone FishEye).	No
Allow Unassigned	True/False Button	Allow unassigned sub-tasks. This setting must match your 'Allow Unassigned Issues ' setting in JIRA. .	No

Once you've filled out the necessary fields, click 'Test' to ensure that your details are correct. If you have a positive message return from the test, click 'Save'.

Editing Default JIRA Server Mappings

This setting has two effects; it enables the feature that shows JIRA information in a dynamic window when you hover the mouse over a JIRA issue key; it will also turn every issue key into a hyperlink to that issue.

To enable this feature, click 'Edit Default JIRA Server Mappings' from the View JIRA Servers page. The 'Map JIRA Project Default' page opens.

Screenshot: The Default JIRA Server Mappings Page

On this page, select the FishEye Repositories or Crucible Projects that you wish to associate with all the JIRA servers that you have configured for use in FishEye/Crucible. You can click 'add all' to quickly include them all in this category. You can remove individual items by clicking the small 'X' marks.

Once you've finished, click 'Save'.

You should disable any existing Crucible linkers you have set up for JIRA, as they will override this feature and prevent the dynamic dialog box from appearing when you mouse over an issue.

Operations on Existing Servers

Once you have configured an existing JIRA server, there are three main operations you can carry out on it: 'Edit', 'Mappings' and 'Delete'. These options appear on the far right of the screen.

Screenshot: Operations in the JIRA Servers Page

Edit settings for an existing JIRA server

When you click 'Edit', you can adjust any of the general settings you configured when you first added the server.

Edit mappings for an existing JIRA server

When you click 'Mappings', a page is loaded that is almost identical to the 'Default Mapping' screen, but allows you to choose mappings only for that specific JIRA server.

Delete an existing JIRA server

Clicking 'Delete' will remove the server from the list.

Known Issues

If you elect to use Trusted Applications for authentication with your JIRA server, activity streams will be generated using the currently logged in user. However JIRA project mapping and issue key linking (including the associated "hovering" content) will be retrieved using the user specified on the JIRA Server configuration page in the FishEye administration section.

We are working towards supporting Trusted Applications for issue key linking and project mapping. If this issue is important to you, please vote for CRUC-1910.

All Versions

FishEye 2.2 Documentation

Child pages