Documentation for Crucible 3.0.x. Documentation for other versions is available too.

Skip to end of metadata
Go to start of metadata

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

When Crucible was first installed, JIRA integration may have been configured using the setup wizard, which configures the JIRA connection automatically using the most common options. See Configuring JIRA integration in the Setup Wizard.

However, JIRA integration with Crucible can be configured at any time after installation, as described on this page.

Initial configuration in JIRA

Configure the following setting in JIRA:

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

JIRA integration in Crucible

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

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

1. Configuring an application link with JIRA

This section describes how to create 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 click Application Links (under 'Global Settings').
  2. Now:
    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 Next.
    4. Enter the following information:
      • Create a link back to this server – Check 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 Next.
    6. Enter the information required to configure authentication for your application link:
      • The servers have the same set of users – Check this box, because the users are the same in both applications.
      • These servers fully trust each otherCheck this 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 Create.

2. Connecting to JIRA for user management

This option is available only with JIRA 4.3 and later.

To manage your Crucible users using JIRA, 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 Administration 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:

Go to your Crucible administration screen.

  1. Click Authentication (under 'Security Settings').
  2. Click Setup JIRA/Crowd authentication. Note, if LDAP authentication has already been set up, you will need to remove that before connecting to JIRA for user management.
  3. Make the following settings:

    Authenticate againstSelect a JIRA instance
    Application name and passwordEnter the values that you defined for your application in the settings on JIRA.
    JIRA URL

    The web address of your JIRA server. Examples:

    http://www.example.com:8080/jira/
    http://jira.example.com
    
    Auto-addSelect Create a FishEye user on successful login so that your JIRA users will be automatically added as a FishEye user when they first log in.
    Periodically synchronise users with JIRASelect Yes to ensure that JIRA will synchronize all changes in the user information on a regular basis. Change the value for Synchronise Period if required.
    When Synchronisation HappensSelect an option depending on whether you want to allow changes to user attributes from within FishEye.
    Single Sign OnSelect Disabled. SSO is not available when using JIRA for user management and if enabled will make the integration fail.
  4. Click Next and select at least one user group to be synchronised from JIRA. If necessary, you could create a new group in JIRA, such as 'fisheye-users', and select this group here.
  5. Click Save.

Inline issue creation

Inline issue creation allows a user to create a JIRA issue from a review comment. The user must have the 'Comment' permission in Crucible to see the Create Issue link in the comment. See Creating JIRA issues from the review.

This requires that Crucible is integrated with JIRA 5.0, or later, and is disabled if Crucible is integrated with an earlier version of JIRA.

When creating the issue, the Create Issue dialog only displays required fields for the selected issue type.

  • A JIRA administrator can configure other fields to be required (and so displayed) from within JIRA. See Specifying Field Behaviour
  • Not all field types are supported. In particular, unbundled custom field types are not supported. See Supported fields for inline issue creation.
  • If any required field for the selected issue type is not supported, Crucible displays an error, with a link to create the issue directly in JIRA. This link will pre-populate the project, issue type, summary and description fields, but will not create a link from the comment to the issue. 

In the new issue in JIRA, you see a link back to the comment in Crucible. However:

  • Issue links may be disabled in JIRA.
  • The JIRA login that Crucible uses needs permission to create links.
  • The FishEye plugin (available from the Atlassian Marketplace) must be installed in JIRA for permission checking on the display of issue links in JIRA.

You can disable the Inline Issue Creation plugin in Crucible to restore the earlier behaviour.

  • No labels

3 Comments

  1. Anonymous

    In Jira, we currently don't allow unassigned issues to make sure all the tickets are assigned.

    If we keep this configuration and don't allow unassigned issues, which part of the integration will NOT work? Can I still create review from Jira, and create JIRA issue from review?

    If we don't setup user management with Jira, does it affect the integration? Can I still create review from Jira, and create JIRA issue from review?

    Thank you.

  2. What was the answer to this good question?

  3. Anonymous

    could someone please answer the above question??? i am struck on the same point...