Integrating JIRA with FishEye

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.
• For JIRA to successfully integrate with FishEye, you must set up the FishEye web server to receive remote API calls. A FishEye administrator can do this by visiting the FishEye web server's 'Server Settings' page (which can be accessed from FishEye's 'Administration' area) and setting the 'Remote API' setting to 'On'. See Configuring the Fisheye web server for more information.

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

1. In JIRA, click 'Administration' in the top navigation bar to open the JIRA Administration console.
2. Select 'Plugins > Application Links' from the top menu.
3. The 'Configure Application Links' screen will appear. 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. '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. '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. In JIRA, click 'Administration' in the top navigation bar.
3. Select 'Plugins > FishEye Configuration' from the top menu.
4. The 'JIRA FishEye Plugin' screen will appear. Click 'Edit Primary Configuration'.
5. 以下の情報を入力します：
   • 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.

6. Click 'Update'.

   次のステップ

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

7. Click 'Application Links Configuration' at the bottom of the screen.
8. Click 'Trusted Applications' in the 'Outgoing Authentication' column for your FishEye/Crucible link.
9. Click 'Modify' and enter the following information:
   • 'IP Patterns': Enter the IP addresses for your FishEye/Crucible instance (one per line), e.g. 127.0.0.1, 172.20.5.95.
10. Click 'Apply'.
11. Click 'Incoming Authentication' in the left menu.
12. Click 'Modify' and enter the following information:
    • 'IP Patterns': Enter the IP addresses for your JIRA instance (one per line), e.g. 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
      

13. Click 'Apply' and then '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 Projec pages and tickets:

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

2. Click 'Administration' in the top navigation bar to open the JIRA Administration console.
3. Click 'Projects' in the top menu and select the JIRA project that you want to associate with a FishEye repository/Crucible project. The JIRA project's configuration page will appear.
4. 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.
5. On the right-upper corner open the "Actions" menu and click on "Edit Permissions".
6. Locate the "View Version Control" 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. Link FishEye Repositories to JIRA Projects

In this step you link your FishEye repository to your JIRA project via a project link. Associating JIRA projects with FishEye repositories or Crucible projects is recommended as it greatly improves JIRA's responsiveness when your users view the 'Source' or 'Review' tabs on JIRA issues. Otherwise, JIRA must scan for all FishEye repositories/Crucible projects which are accessible to a user, whenever that user views these tabs on a JIRA issue.

This process is mandatory if your FishEye/Crucible server has no publicly accessible repositories/projects and JIRA's application link to this FishEye/Crucible server uses OAuth outgoing authentication.

始める前に

• You can only perform this procedure once an application link has been established between your JIRA and FishEye/Crucible servers (above).

To create a link between a JIRA project and a FishEye/Crucible repository:

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

2. Click 'Administration' in the top navigation bar to open the JIRA Administration console.
3. Click 'Projects' in the top menu and select the JIRA project that you want to associate with a FishEye repository/Crucible project. The JIRA project's configuration page will appear.
4. Locate the 'Application Links' option and click 'Configure Project Links'. The page for configuring links from your JIRA project to the entities of applications (already linked on your JIRA server) will appear.
5. Create a project link between your JIRA project and the appropriate FishEye repository/Crucible project. (See the procedure on Adding Project Links between Applications from step 4 for details.)

Step 5. (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' in JIRA's top navigation bar.
2. 「ガジェットの追加」をクリックします。
3. The 'Gadget Directory' popup window will appear. Click 'Gadget Subscriptions'.
4. The 'Gadget Subscriptions' popup window will appear. Click 'Add Subscription'.
5. 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.
6. Click 'Add Subscription'.
7. Click 'Finished'. The FishEye gadgets are now available in your JIRA gadget directory.

注意

• 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 behaviour 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.

関連トピック

• 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