This documentation relates to Application Links 3.5.x
If you are using an earlier version, please view the previous versions of the AppLinks documentation and select the relevant version.
Skip to end of metadata
Go to start of metadata

This page describes an example of how to set up a common application links scenario — creating a two-way link between two applications that trust each other and share the same set of users. For example, you may wish to link your internal JIRA server to a private FishEye server. Setting up an application link allows you to take advantage of integration features like viewing FishEye changesets in JIRA. The instructions below also detail how to link two entities of your two linked applications, e.g. a JIRA project to a FishEye repository.

Applications Links is bundled with FishEye 2.4, Confluence 3.5, JIRA 4.3, and all later versions of those applications. In addition, Bamboo 3.1 is compatible with AppLinks. You can configure JIRA-to-Bamboo links via the JIRA administration screens. If one of the applications you are connecting to does not have Applinks, you can still set up an application link to it. See Adding an Application Link.

On this page:

Before You Begin

 

In this example, we will create a two-way Trusted Applications link between a 'local' FishEye server with Application Links ((http://fisheye.example.com/ in this example) and a 'remote' JIRA server without Application Links (http://jira.example.com/ in this example). We'll add the link from the FishEye server.

In FishEye, do the following: Log in as a system administrator and go to the administration page. Click 'Application Links' in the administration menu. The 'Configure Application Links' page will appear, showing the application links that have been set up. Click 'Add Application Link' to open the add application link wizard.

1. Specifying the Remote Application

First, we need to specify which application we are linking to. Enter the URL for the JIRA server in the 'Link to another server' dialogue, as shown in the screenshot below, and click 'Next'.

Screenshot: Entering the server URL

Gliffy

Enter an 'Application Name' and choose the 'Application Type' to be 'JIRA'. Click the 'Create' button. The application link will be created and displayed on the 'Configure Application Links' page.

Our JIRA server does not have Application Links, so we cannot automatically create a link back to our FishEye server nor set up authentication. We'll manually set these up in the next step.

Screenshot: Creating the application link

Gliffy

We are going to use Trusted Applications authentication for all incoming and outgoing requests via the application link, as both servers share the same userbase. Trusted Applications authentication is recommended when both applications fully trust each other and share the same set of users (read more about configuring Trusted Applications authentication). Other authentication configurations are described in Configuring Authentication for an Application Link.

On the 'Configure Application Links' page, click the 'Configure' link next to the application link just created. The configuration dialogue for the application link will be displayed.

First, we need to configure our JIRA server to trust our FishEye server. Navigate to the 'Outgoing Authentication' tab on the configuration dialogue and click the 'Configure' button on the 'Trusted Applications' sub-tab. Click the 'Apply' button to apply Trusted Applications authentication.

We also need to configure our FishEye server to trust our JIRA server. Navigate to the 'Incoming Authentication' tab on the configuration dialogue and click the 'Configure' button on the 'Trusted Applications' sub-tab. Click the 'Apply' button to apply Trusted Applications authentication.

Screenshot: Setting up Trusted Applications authentication (click to view larger image)

Gliffy

4. Additional JIRA Configuration

Our JIRA server does not have Application Links, so we need to perform additional Trusted Applications configuration in JIRA before our application link will work.

Follow the instructions on adding a trusted app in the JIRA documentation: Configuring Trusted Applications. You will need to enter the following information:

  • 'Base URL' — Enter the URL of your FishEye server, 'http://fisheye.example.com/'
  • 'Application Name' — Enter the name for your FishEye server, 'Example FishEye'.
  • 'Timeout' — '10000'
  • 'IP Addresses' — Leave this blank, unless you are using a proxy server (if so, see the Trusted Applications documentation for further instructions).
  • 'URL Patterns' — Enter the following URLs: /sr/jira.issueviews:searchrequest, /secure/RunPortlet, /rest, /rpc/soap

(tick) You may also want to enable issues activity in your activity stream. To do this, navigate to your Application Links and click the 'JIRA settings' link next to your application link. Tick the 'Include in 'Activity Streams' checkbox and click 'Save'.

Congratulations, you've just created an application link!

Configuring Project Links across Applications

 

Let's assume that you are managing a project or team. You would like to connect your project's Confluence space with your JIRA project, and link up your team's source repository too.

When you have connected your applications via Application Links, you can also connect the areas of those applications that contain information relating to your project or team. Using project links (also called entity links) you can associate one or more projects, spaces and repositories across the linked applications.

To connect all the information relating to the project or team that you are managing, you can link one or more of the following:

In the following example, we'll create an two-way project link between a JIRA project (project key is 'MYPROJECT') and a FishEye repository (repository key is 'MYREPO'), for the application link we previously created.

First, navigate to the FishEye administration console and find the repository that you want to link from. Click the icon and select 'Application Links' from the dropdown menu. The project links screen will be displayed.

Screenshot: Project links for a FishEye repository

Click 'Add Link' and click the remote application where the target project is located. In this case, it will be the 'Example JIRA' application that we linked to previously. The add project link dialogue will be displayed.

Screenshot: Adding a project link

Enter the key ('MYPROJECT') and an alias, i.e. display name, for the project ('My Project'). Click 'Create' to create the project link.

Congratulations, you've just added a project link!

What Next?

 

You've now successfully linked your JIRA server to a FishEye server. Try out some of the integration features enabled by your new application link, including:

Labels
  • None
  1. Feb 07, 2011

    If one of the applications you are connecting to does not have Applinks, you can still set up an application link to it.

    Does this mean I can use the new application link support to older JIRA releases (like 4.0.1)? We have application links working now on earlier version and want to know if it will continue to work with the new support if we upgrade to FishEye to 2.4 but do not upgrade JIRA.

    1. Feb 07, 2011

      Hi Bob,

      Could you clarify whether the links you're referring to are FishEye's in-built 'JIRA Server' integration - or something else, e.g. an earlier version of the Application Links plugin for which you have written custom integration?

      In the former case, upgrading to FishEye 2.4 should not effect your JIRA integration experience. Links should be automatically converted on upgrade and continue to work, without needing to upgrade JIRA.

      In the latter, you can still use the new Application Links plugin (3.x) to connect to older JIRA instances, however there is no automatic upgrade path for existing links created using the Application Links plugin 2.x or earlier links and the API has changed significantly. I wasn't aware that there were developers out there coding against the old AppLinks plugin. If this is the case and you'd like a hand developing your own upgrade process, let me know and I'll try to provide some assistance.

      cheers,
      Tim

      1. Feb 07, 2011

        No, just talking about our installation working. We did no customization. We depend on the links working though and they have worked good enough for us even though I know the older stuff was suspect. Just want to make sure an upgrade wouldn't break what we have because it will be longer before we could get JIRA upgraded.

        1. Feb 07, 2011

          Sweet, in that case your links to JIRA will be automatically upgraded.

          (although always make a backup of your existing data & configuration when upgrading)

  2. Apr 25, 2011

    Anonymous

    Can we create a two-way link between two applications with the same type (in our case two Jira server).

    For example, we want to link our internal JIRA server to other Jira server.

    1. Apr 26, 2011

      Yes, AppLinks supports two-way links between two applications of the same type.

      1. Apr 26, 2011

        Anonymous

        Thanks Tim for your fast response.

        My question is because we are trying to implement a kind of Jira clustering.

        You can see about Jira scalable in the folowing post: http://www.quora.com/Atlassian/Does-Atlassian-plan-to-make-JIRA-scalable

        Do you think this is possible?

        Thanks in advance

        1. Apr 26, 2011

          Hi again,

          I must admit I haven't really thought enough about clustering JIRA to be able advise how good an idea it is or how difficult it would be to achieve. It's probably best to follow up with Jonathon Nolen of that thread.

          However, if you're intending to build clustering, Application Links would be an appropriate mechanism for registering nodes and communicating between servers.

          Have a look at the AppLinks API documentation, particularly the ApplicationLinkService and ApplicationLink classes, to see what's available.

          cheers,
          Tim

  3. May 27, 2011

    Hi,

    we have an internal and an external JIRA installation. Will it be possible to link two issues between these two JIRA installations by the use of Application Links?

    Or will we have to develop additional functionalities (plugin..) to achieve this on top of Application Links?

    Cheers,

    Michael

    1. May 27, 2011

      Hi Michael,

      AppLinks allows you to create a link between the two applications and projects within those applications, but doesn't extend the existing "link issue" functionality in JIRA to work across instances. So yes, currently, an additional Application Links "client" plugin would be required to facility linking issues.

      I know Dan Hardiker from Adaptavist (one of Atlassian's premier partners) has done some work on a cross-instance issue linking plugin - you could check out the work so far at https://studio.plugins.atlassian.com/browse/JIL

      cheers,
      Tim

  4. Dec 12, 2011

    I've got application links set up between Jira Projects and Confluence spaces, however I am not able to get links created via the shortcut syntax (ie:  [home]).

    Is there something I'm missing?  Shouldn't it just work in any comment, summary, or any field in the issue?

  5. Apr 10, 2012

    I'm looking for a way when I link a Jira project to a Confluence page to automatically grant access those Jira project users to the confluence space linked. Any suggestions?

    Thanks in advance

    Best regards