Crucible 2.10 : JIRA Integration in Crucible 2.0 Beta

Crucible 2.0 Beta is a public development release leading up to Crucible 2.0. For all production use and testing of Crucible, please use the latest official release.

Do not use in production.
Beta releases should not be used in production environments.

Please also take note of the following information:

  • Beta releases are not safe — Beta releases are snapshots of the ongoing Crucible development process. As such:
    • While we try to keep these releases stable, they have not undergone the same degree of testing as a full release.
    • Features in development releases may be incomplete, or may change or be removed before the next full release.

This page contains instructions for setting up JIRA integration in Crucible.

(info) JIRA is Atlassian's issue tracking product, which can be used to manage projects and associated work.

(warning) Before you begin: Ensure that you configure your JIRA instance to enable sub-tasks, enable unassigned issues and allow Remote API access. The instructions on this page have been tested with JIRA 3.13.4.

On this page:

JIRA issues can be viewed in the main Dashboard view in Crucible. This requires you to enter details on the required JIRA server(s) via the Crucible administration screens.

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 listed on this page.

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 Internet address of the JIRA server.

Yes

Subtask Type ID

Number

This is required to enable creating issues from a Crucible comment.

No

Subtask Resolution Action ID

Number

This is required to enable creating issues from a Crucible comment. See below for instructions on obtaining this number.

No

Subtask Resolution ID

Number

This is required to enable creating issues from a Crucible comment. See below for instructions on obtaining this number.

No

Allow Unassigned

True/False Button

Allow unassigned sub-tasks.

No

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 on the Dashboard.

No

Authenticate as Trusted Application

Check Box

Allows the system to interface with JIRA and let users log on with their own accounts (and use their own accounts on the JIRA server. See complete FishEye documentation and complete JIRA documentation.

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'.

Obtaining the Subtask Type ID

(info) This value is required (along with the Subtask Resolution ID and Subtask Resolution Action ID) to enable creating issues from a Crucible comment. This is the subtask type that will be created when you create a JIRA subtask in Crucible.

To obtain this value, carry out the following steps.

1. Enable sub-tasks on your JIRA instance from the 'JIRA Administration' > '*Sub-Tasks' page. See the JIRA documentation for details on this step.
2. Return to the FishEye Administration screen and then click 'JIRA Servers' under the 'Global Settings' sub-menu on the left navigation bar. Click 'Edit' next to the JIRA server you have configured.
3. Your JIRA server's basic details should appear. Click 'Test' once again. The field for Subtask Type ID will change to a drop-down menu, showing the available subtask types. Choose the correct one.
4. Save your Crucible configuration settings.

Screenshot: Obtaining the Subtask Type ID

Obtaining the Subtask Resolution ID and Subtask Resolution Action ID

(info) These values are required (along with the Subtask Type ID) to enable creating issues from a Crucible comment.

To obtain these values, carry out the following steps.

1. Open your JIRA instance and go to 'Administration' > 'Workflows'. The 'Workflows' screen opens. By default, the 'JIRA' workflow is shown on screen in a table.
2. Click the 'Steps' link in the far right table cell. The 'View Workflow Steps — JIRA' page opens.
3. The 'Subtask Resolution Action ID' is in the 'Open' row, under the 'Transitions' column. Look at the link in that cell named 'Resolve Issue'. The ID number is shown in brackets next to that heading 'Resolve Issue' (shown in the screenshot below as 5).
4. Save your Crucible configuration settings.
5. The 'Subtask Resolution ID' is the 'Resolved ID' on this page. The ID number is shown in brackets next to the heading 'Resolved' (shown in the screenshot below as '4'). Note it down and enter it into the Crucible configuration screen.
6. Save your Crucible configuration settings.

Screenshot: Obtaining the Subtask Resolution ID & Subtask Resolution Action ID

Editing Default JIRA Server Mappings

(info) This setting enables the Crucible feature that shows JIRA information in a dynamic window when you hover the mouse over a JIRA issue key in Crucible. It will also turn every issue key into a hyperlink to that issue in Crucible.

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 you have configured for use in 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'.

(warning) 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.