This documentation relates to an earlier version of Application Links.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

Once you have installed Application Links, you will need to configure the linked applications using the administration screens of each relevant application (JIRA, Confluence, etc).

Please install Application Links first

Icon

Before following the instructions below, please make sure that you have installed the Application Links plugin as described in the Installation Guide.

On this page:

Link to Subversion Not Required

(info) There is no need to link AppLinks to a Subversion repository unless you have a specific requirement to do so.

The integration with Subversion provides a way for plugins to know what SVN repository a project is associated with. For example, Atlassian uses AppLinks primarily in JIRA Studio, where this feature allows JIRA Studio to create, update and delete repositories. However, there are currently no publicly-available plugins that make use of this functionality.

This means that, unless you are writing a new plugin to use the Subversion linking, you will not find it useful to add Subversion to your AppLinks suite. It will not provide any extra rendering of links in JIRA or Confluence. To render links of the form source:<Filename>, you will need FishEye.

Below is a summary of the steps you need to take, to configure Application Links across your applications. These steps will get your Application Links up and running. For more detail and more complex setups, you will find links to further guides at the bottom of the page.

Step 1: Set the Base URL in Each Application

Make sure that the base URL is set correctly in each application which you intend to link. This is required for synchronisation to work correctly.

  1. Set the base URL in Confluence:
    1. Choose the cog icon  at top right of the screen, then choose Confluence Admin.

    2. Choose General Configuration in the left-hand panel.
    3. Choose Edit.
    4. Enter the new URL in the Server Base URL text box.
    5. Choose Save.
    If you run into problems, please refer to the Confluence Administration Guide.

  2. Set the base URL in FishEye and Crucible:
    1. In FishEye, click 'Server Settings' on the 'Admin' menu.
    2. Set the 'Site URL' to the base URL for your FishEye and Crucible instance.
      If you run into problems, please refer to the FishEye Administration Guide.

  3. Set the base URL in JIRA:
    1. In JIRA, go to the 'Administration' menu.
    2. Select 'General Configuration' under 'Global Settings'.
    3. Click 'Edit Configuration'.
    4. Set the 'Base URL' to the base URL for your JIRA instance.
    5. Click 'Update' to save your changes.
      If you run into problems, please refer to the JIRA Administration Guide.

Step 2. Enable the Wiki Renderer in JIRA

You will need to do this if you are intending to use Application Links with JIRA. If JIRA's Wiki Renderer is not enabled, JIRA link rendering will not work.

In JIRA, go to JIRA field configuration and enable the Wiki Renderer for the 'Description' field and other relevant fields, as described below.

  1. In JIRA, go to the 'Administration' menu.
  2. Select 'Field Configurations' under 'Issue Fields'.
  3. Select 'Configure' next to 'Default Field Configuration'.
    (If you have added your own field configuration schemes, you should enable Wiki Renderer for those too, where relevant.)
  4. Find the 'Description' field in the list of fields, and click 'Renderers' next to it. The 'Edit Field Renderer' screen will appear, as shown in the screenshot below:


  5. Select 'Wiki Style Renderer' and click 'Update'.
  6. Confirm your selection as prompted.
  7. Now perform the same steps to enable the Wiki Renderer for the 'Comment' and 'Environment' fields, and any custom fields as required.

If you run into problems, refer to the JIRA documentation for detailed instructions.

Step 3. Add an Application to your Application Links Suite

Now you will add each of your applications into the Application Links suite. The suite is the set of applications that you want to take part in the cross-application linking.

You can add applications via either Confluence or JIRA.

  • In our example below, we have used the JIRA Administration screens to add Confluence to the Application Links suite.
  • If you are using Confluence but not JIRA, you can perform similar steps using the Confluence Administration console. See Adding your Applications via Confluence Administration.
  1. Make sure that the application you want to add is running. For example, if you want to add Application Links between Confluence and JIRA, then both Confluence and JIRA must be up.
  2. Log in to JIRA as a system administrator.
  3. Go to the 'Administration' screen.
  4. Click the 'Application Links' link. The 'External Application Links' screen will appear, as shown below:


  5. Click 'Add Instance'.
  6. The 'Edit Instance Details' screen will appear, as shown below:


  7. Enter the following information:

    Field

    Description

    Examples

    Application

    Select the application you are adding.

     

    Instance name

    Enter the name of the application instance. We recommend that you use a unique instance name, to ensure that synchronisation will work.
    (info) When using the JIRA screens to synchronise, there is currently a limitation that the instance you are synchronising from be called jira. See APL-2.

    confluence
    confluence extranet
    fisheye
    my-svn

    URL

    Enter the address of the application instance. Please make sure that the URL agrees with the base URL configured in your application. For Subversion, the URL is {{

    file:///

    }} plus the path to the SVN repository. (See the note about Subversion below.)

    Login, Password

    Enter the username and password of a user with system administration rights on the application instance. They are not required for Subversion.

     

    FishEye Admin Password

    Enter the password of the FishEye administrator. This field is only required when you are adding the FishEye application.

     

  8. Click the 'Save' button.
  9. The application instance has now been added into Application Links. The new application instance will now show on the 'External Application Links' screen:

Subversion Links Not Currently Used outside JIRA Studio

Application Links was originally developed for JIRA Studio, which uses the Subversion linking to associate the repository with the Atlassian applications. Outside JIRA Studio, there are currently no plugins that use SVN application links.

This means that, unless you are writing a new plugin to use the Subversion linking, you will not find it useful to add Subversion to your Application Links suite. It will not provide any extra rendering of links in JIRA or Confluence. To render links of the form source:<Filename>, you will need FishEye.

Step 4. Add more Applications or Application Instances

Follow the steps above, to add any of the other supported applications into your Application Links suite.

If you have two or more instances of a particular application, you can add them individually. For example, if you have two Confluence sites, you can add them both.

If you need more information about adding multiple applications, refer to More about Adding Applications.



Step 5. Synchronise your Applications

You can add an application to your Application Links suite via the JIRA or the Confluence administration screens. The added application will then appear in the list on the administration screen where you added it.

Now you need to synchronise with the other applications in the Application Links suite. This will let the other applications know that a new application has been added to the suite. For example, if you added a Confluence application via the JIRA administration screens, you should synchronise so that the Confluence application knows it is linked to JIRA.

  1. Log in to JIRA as a system administrator.
  2. Go to the 'Administration' screen.
  3. Click the 'Application Links' link. The 'External Application Links' screen will appear, as shown below:


  4. Click 'Synchronize' next to the relevant application instance.

If you need more information about synchronisation, refer to Synchronising Application Instances.

You can add your project links via either Confluence or JIRA.

  • In our example below, we have used the JIRA project administration screens to add project links to a Confluence space.
  • If you are using Confluence but not JIRA, you can perform similar steps using the Confluence space administration screens. See Adding and Synchronising Project Links via Confluence.

Project links allow you to associate a particular Confluence space with a particular JIRA project, or a particular Crucible project with a JIRA project, etc.

If you have more than one instance of the same application (for example, you may have two Confluence sites), you can link a project to the primary application instance or any other instance. (If you are not sure what a primary instance is, please refer to Specifying a Primary Application Instance.)

  1. In JIRA, log in as a project administrator.
  2. Go to the 'Administer Project' page for the relevant project. See the example in the screenshot below:


  3. Click the 'Select' link next to the 'Confluence Space', 'Subversion Repository', 'FishEye Repository' or 'Crucible Review' item. The 'Associate' screen appears. Below we show two examples of this screen, one for Confluence and one for FishEye:
    • The 'Associate' screen for Confluence:


      1. Select an application instance from the 'Instance' dropdown menu, or select '-- Default Instance --'.
      2. In the next field you will enter a space or project key as prompted, depending upon the type of application selected above. This will associate the current JIRA project with a particular space or project in the other application. For example, in the screenshot above we are linking the Confluence 'DOCS' space to our JIRA project.
      3. Click 'Associate'.
    • The 'Associate' screen for FishEye:


      1. Select a FishEye instance from the 'Instance' dropdown menu, or select '-- Default Instance --'.
      2. In the next field you will enter a 'FishEye repository key'. This value must match the 'Name' as defined in your 'Repository List' in FishEye. For example, in the screenshot above we have linked the FishEye 'ProductRepository' and 'LibrariesRepository' to our JIRA project.
        (info) You can link more than one repository from the same FishEye instance, as shown on the screenshot above.
        (warning) AppLinks does not validate the repository name entered here. It is up to you to ensure that the repository key entered in AppLinks is the same as the repository name entered in FishEye.
      3. Click 'Associate'.

  4. The new project link appears on the 'Administer Project' page, as shown in the screenshot below:

You can synchronise your project links via either Confluence or JIRA. We have used JIRA in our example below. You can perform similar steps using the Confluence space administration screens. See Adding and Synchronising Project Links via Confluence.

You can add a project link to your Application Links suite via the JIRA or the Confluence administration screens. The project link will then appear in the list on the administration screen where you added it.

Now you need to synchronise with the other applications in the Application Links suite. This will let the other applications know that the project link has been added. For example, if you added a project link from a JIRA project to a Confluence space via the JIRA administration screens, you should synchronise so that the Confluence space knows it is linked to the JIRA project.

  1. Once you have created a project link in JIRA, the link appears on the 'Administer Project' page, as shown in the screenshot below:


  2. Click the 'Synchronize' link to create a matching link on the remote instance.

(info) Due to a current limitation, the instance that you are synchronising from must be called 'jira' if you are synchronising from JIRA, or 'confluence' if you are synchronising from confluence. See APL-2.

RELATED TOPICS

Application Links Installation Guide
Application Links Documentation Home
Atlassian Product Integration

  • No labels