Integrating JIRA with FishEye

Initial Configuration

You should check that JIRA is configured to accept remote API calls; in JIRA, go to Administration > System > General Configuration and turn on Accept remote API calls (under 'Options'). A restart is not required. See JIRA options for more detail.

 If you set up your Application Links prior to enabling either Remote API, please re-create both the JIRA and FishEye Application Links.

Note, we do not recommend the use of project links with FishEye 2.9 and later, if you have JIRA 5.0 or later as well as the latest version of the JIRA FishEye Plugin. This is because application links now provide all of the functionality previously available with project links. However, project links are retained in FishEye and Crucible for the following reasons:

• Setting up project links provides a way to restrict the scope of JIRA searches, which can provide performance benefits.
• Legacy configurations can continue to use project links without any need for changes.
• Third-party plugins may continue to rely on project links for their functionality.

Step 1. Create an Application Link Between a JIRA and a FishEye/Crucible Server

To begin integrating JIRA with either FishEye or Crucible, you must create an application link between your JIRA server and FishEye or Crucible server.

You require JIRA System Administration permissions in order to perform this procedure.

To create an application link between a JIRA and a FishEye/Crucible server:

1. Log in to JIRA as a user with the JIRA Administrators permissions.
2. Choose > Add-ons. Select Application Links in the Add-ons panel to open the configuration screen.
3. Click Add Application Link.
4. The first screen of the 'Add Application Link' wizard will appear. Copy the base URL for your FishEye site (e.g. http://fisheye.example.com:8060 and paste it into the Server URL field.
5. Click Next.
6. The 'Link to FishEye' screen will appear. Enter the following information:
   
   • Create a link back to this server – This option is selected by default. Leave it selected, if you want create a reciprocal link back from your FishEye server to your JIRA server.
   • Username – Enter the username of the administrator on your FishEye site.
   • Password – Enter the password of the administrator on your FishEye site.
   • Reciprocal Link URL – Leave this field at its default value, pointing to your JIRA site.
7. Click Next.
8. The 'Set Users and Trust' screen will appear. Enter the following information:
   
   • The servers have the same set of users – This option is selected by default. Let it remain selected.
   • These servers fully trust each other – This option is selected by default. Let it remain selected.
9. Click Create. The application link will be created and displayed on the 'Configure Application Links' page.

Step 2. Configure the FishEye Plugin in JIRA

The FishEye plugin for JIRA is bundled as part of the JIRA package, so there is no need to install it. Now you will configure the plugin for your installation and configure JIRA to trust FishEye.

1. Navigate to the JIRA Administration console.
2. Choose > Add-ons. Select FishEye Configuration to open the JIRA FishEye configuration screen.
3. Click Edit Primary Configuration.
4. Enter the following information:
   
   • Enable Crucible Integration – Select 'True' if you want to enable Crucible integration (e.g. view reviews related to an issue).
   • Update the other fields as desired.

5. Click Update.

   Next Steps

    The next topics will ask you to choose an authentication method to be used between JIRA and Fisheye. Please, refer to the Configuring Authentication for an Application Link for details about how to choose the appropriate method for your environment.

   If you choose Trusted Applications because both JIRA and Fisheye have access to the same source of users (ie. JIRA Server, Crowd or LDAP), please make sure that Fisheye will be able to Auto-Add a user when an authentication is successful or that the users will already exist in both applications databases before the integration is tested (ie. by running a sync between the application and the user repository).

6. Click Application Links Configuration at the bottom of the screen.
7. Click Trusted Applications in the Outgoing Authentication column for your FishEye/Crucible link.
8. Click Modify and enter the following information:
   

   • IP Patterns: Enter the IP addresses for your FishEye/Crucible instance, one per line: 

     127.0.0.1
     172.20.5.95

9. Click Apply.
10. Click Incoming Authentication in the left menu.
11. Click Modify and enter the following information:
    

    • IP Patterns: Enter the IP addresses for your JIRA instance, one per line:

      127.0.0.1
      172.20.5.95

    • URL Patterns: Enter the following paths, one per line:

      /secure/CreateSubTaskIssueDetails.jspa
      /browse/
      /rest
      /plugins/servlet/applinks/whoami
      /plugins/servlet/streams
      /rpc/soap
      /sr/jira.issueviews:searchrequest
      /secure/RunPortlet
      

12. Click Apply > Close.

Step 3. Add Permissions to Users

Before linking FishEye Repositories to JIRA Projects, you will need to add the correct permissions to the users that will be able to see the FishEye information in the JIRA Project pages and tickets:

1. Go to your JIRA URL in your browser, e.g. http://jira.mycompany.com:8080.

2. Choose > Projects. (In this case, select the project that you want to associate with a FishEye repository/Crucible project.)
3. Locate the Permissions option and click  Default Permission Scheme or the specific scheme you are using for the project. The page for configuring permission from your JIRA project will appear.
4. On the right-upper corner, choose Actions > Edit Permissions.
5. Locate the 'View Development Tools' permission and then click Add and add to the list the Users and/or groups that will be able to see the Fisheye and Crucible data in JIRA.

Step 4. (Optional) Subscribe JIRA to FishEye Gadgets

In this optional step, you will make your FishEye gadgets available for use in JIRA. This will allow JIRA users will be able to add any FishEye gadget to their dashboards.

1. Click Dashboards > Add Gadget in JIRA's top navigation bar.
2. The 'Gadget Directory' popup window will appear. Click Gadget Subscriptions.
3. The 'Gadget Subscriptions' popup window will appear. Click Add Subscription.
4. The 'Add Subscriptions' popup window will appear. Copy the base URL for your FishEye site (e.g. http://fisheye.example.com:8060 and paste it into the text box on the screen.
5. Click Add Subscription.
6. Click Finished. The FishEye gadgets are now available in your JIRA gadget directory.

Notes

• Integrating FishEye with JIRA — You can also configure FishEye to integrate with JIRA, which enables you to view JIRA data from within FishEye. Please see Jira Integration in Fisheye in the FishEye documentation for instructions.
• JIRA requires FishEye to manually refresh repository cache when repository changes are made — When a repository is removed, or when there has been any change in FishEye repositories, JIRA does not update the FishEye repository list cache automatically. You must manually refresh the repository list cache. This is done in JIRA: 'Administration' > 'FishEye Configuration' > 'Refresh Cache' link (next to 'Repository List Cache').
• Associating a JIRA Project with a Repository Path — Once an application link has been established between JIRA and a FishEye site, you can associate a Repository Path on that FishEye site with a JIRA project, via the 'Select Path' link of the 'Repository Path' option in the 'Settings' section of JIRA's Project Configuration area. Specifying a Repository Path changes the behavior of the 'Source' tab on a JIRA issue:
  • If no Repository Path is specified, the 'Source' tab on a JIRA issue will only show the commits/changes which include that JIRA issue number in the commit log.
  • If a Repository Path is specified, the 'Source' tab on a JIRA issue will show all commits/changes made in this repository path.

Related Topics

• View an Issue's FishEye Changesets
• Browse a Project's FishEye Changesets
• Add the FishEye Charts Gadget to your JIRA Dashboard
• Add the FishEye Recent Changesets Gadget to your JIRA Dashboard