Crucible 2.7 : JIRA Integration in Crucible

JIRA is Atlassian's issue tracking and project management application. This page tells you how to integrate JIRA with Crucible.

Initial Configuration in JIRA

Configure the following setting in JIRA:

Consider also the following settings, to make full of the integration between Crucible and JIRA:

Quick Setup via the Crucible Setup Wizard

When you are installing the application, the setup wizard gives you the opportunity to configure the JIRA connection automatically. This is a quick way of setting up your JIRA integration with the most common options. See Configuring JIRA Integration in the Setup Wizard.

If you did not set up the JIRA integration during the Crucible setup, you can configure the integration via the Crucible administration screens as described below.

JIRA Integration via the Crucible Administration Screens

You can further configure the JIRA connections via the Crucible administration screens. There are two parts to the integration process:

  • A peer-to-peer link between JIRA and the application for sharing information and facilitating integration features. This link is set up via Application Links.
  • A client-server link between the application and JIRA for delegating user and group management to your JIRA server.

1. Configuring the Application Links with JIRA

Below are step by step instructions to creating a two-way trusted applications link between Crucible and JIRA. We assume that your Crucible and JIRA servers are using the same set of users. If not, please refer to Adding an Application Link for information about the various options available.

To add a two-way trusted applications link between Crucible and JIRA:

  1. Go to your Crucible administration screen and add the application link:
    1. Click 'Add Application Link'. Step 1 of the link wizard will appear.
    2. Enter the server URL of the application that you want to link to (the 'remote application').
    3. Click the 'Next' button.
    4. Enter the following information:
      • 'Create a link back to this server' – Tick this check box to add a two-way link between the two applications.
      • 'Username' and 'Password' – Enter the credentials for a username that has administrator access to the remote application.
        Note: These credentials are only used to authenticate you to the remote application, so that Application Links can make the changes required for the new link. The credentials are not saved.
      • 'Reciprocal Link URL' – The URL you give here will override the base URL specified in your remote application's administration console, for the purposes of the application links connection. Application Links will use this URL to access the remote application.
    5. Click the 'Next' button.
    6. Enter the information required to configure authentication for your application link:
      • 'The servers have the same set of users' – Tick this check box, because the users are the same in both applications.
      • 'These servers fully trust each other' – Tick this check box, because you trust the code in both applications and are sure both applications will maintain the security of their private keys.
        For more information about configuring authentication, see Configuring Authentication for an Application Link.
    7. Click the 'Create' button to create the application link.
  2. If you want to show issues in your Crucible activity streams:
    • Go to the list of application links and click 'JIRA settings' next to the JIRA application link.
    • Tick the 'Include in Activity Streams' check box.
    • Click 'Save'.
  3. Connect your projects across the applications:

2. Connecting to JIRA for User Management

This option is available only with JIRA 4.3 and later.

If you want to manage your Crucible users via JIRA, you need to configure a connection in JIRA and then set up the user directory in Crucible. Both steps are described below.

2.1. To configure a new connection for user management in JIRA:

  1. Log in to JIRA as a user with the 'JIRA System Administrators' global permission.
  2. Click the 'Administration' link on the JIRA top navigation bar.
    1. Go to the JIRA administration screen for configuring the applications that have been set up to use JIRA for user management:
      • In JIRA 4.3: Click 'Other Applications' in the 'Users, Groups & Roles' section of the JIRA administration screen.
      • In JIRA 4.4: Select 'Administration' > 'Users' > 'JIRA User Server'.
    2. Add an application.
    3. Enter the application name and password that your application will use when accessing JIRA.
    4. Enter the IP address or addresses of your application. Valid values are:
      • A full IP address, e.g. 192.168.10.12.
      • A wildcard IP range, using CIDR notation, e.g. 192.168.10.1/16. For more information, see the introduction to CIDR notation on Wikipedia and RFC 4632.
      • Save the new application.

2.2. To set up the JIRA user directory in Crucible:

  1. Go to your Crucible administration screen.
    1. Click 'Authentication' on the FishEye/Crucible 'Admin Menu'.
    2. Click 'Edit' in the section titled 'JIRA or Crowd Authentication'.
    3. Enter the following information:
      • Application name and Application password – Enter the values that you defined for your application in the settings on JIRA.
      • JIRA/Crowd URL – The web address of your JIRA server. Examples:
        http://www.example.com:8080/jira/
        http://jira.example.com
        
      • Auto-add – Select 'Create a FishEye/Crucible user on successful login' (default) to ensure that your JIRA users will be automatically enrolled into FishEye/Crucible when they first log in via JIRA.
      • Synchronize users with JIRA/Crowd – Select 'Yes' (default) to ensure that JIRA will synchronize all changes in the user information on a regular basis. The synchronization interval is set to 60 minutes (1 hour) by default.
      • Single sign on (SSO) – This option is not available when using JIRA for user management.
      • Groups of users to synchronize – Select at least one group to synchronize. The default is 'jira-users'.
    4. Click 'Apply changes'.

Obtaining Subtask Values for Crucible Configuration

The subtask ID is required (along with the subtask resolution ID and the subtask resolution action ID) to enable the creation of issues from a Crucible comment. This is the subtask type that will be created when you create a JIRA subtask in Crucible.

To set this up in Crucible:

  1. Enable subtasks on your JIRA site. See the JIRA documentation.
  2. Return to the Crucible administration screen and click 'Application Links' under the 'Global Settings' menu in the left-hand navigation bar.
  3. Click 'JIRA settings' next to the application link for the required JIRA server. The 'Update JIRA Server' screen will appear.
  4. Click 'Test'. The field for 'Subtask Type ID' will change to a dropdown menu, showing the available subtask types. Choose the correct one. The field for 'Subtask Resolution' will also turn into a dropdown menu. Select the required item from this menu as well.
  5. Click 'Save'.
  6. Open your JIRA site and go to 'Administration' > 'Workflows'. The 'Workflows' screen appears. By default, the 'JIRA' workflow is shown on screen in a table.
  7. Click the 'Steps' link in the far right table cell. The 'View Workflow Steps – JIRA' page appears.
  8. 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).
  9. Enter the number into the field in Crucible.
  10. Save your Crucible configuration settings.

Screenshot above: Choosing subtask values

 

Screenshot above: Obtaining the subtask resolution action ID

(star) Congratulations! Your Crucible JIRA integration is complete. (star)

Related Topics

User Management Limitations and Recommendations
Configuring Application Links