Versions Compared

Old Version 5

changes.mady.by.user Li Xuan Liew (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Jeff Gleeson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Before You Start

Info

  • Please note that it is strongly recommended to use the Manual Installation process if you are using version 4.3.x of JIRA.

  • For JIRA 4.4+, you can use the UPM (Universal Plugin Manager) to simplify the JIRA installation process.

  • The highest version of the Connector for JIRA 4.3 to 4.4.5 which is supported is v5.0.5.

  • For instructions on installing on JIRA 5.x and above, consult the Installation and licensing page in the Administrator guide.

Installing and configuring the Connector Suite has been designed to be fairly simple, however it is a complex plugin and some level of experience will be helpful.

At the very least, you will need to be able to install plugins and restart your instance. If you do not have access to the instance to restart it yourself, you will at least need to be able to get someone else to restart it for you.

Access to the machine your instance is on is helpful, but not required. In particular, some of the plugins are quite large, and transferring them directly in to the filesystem is much quicker than using the Universal Plugin Manager (UPM).

Required Files

Note
title

OBR files

Typical plugins have an extension of ".jar". The UPM allows the upload of plugins with the extension of ".obr", which are collections of ".jar" files. This simplifies the installation process for the end user, minimizing the number of items that needs to be installed to a single package.

The following plugins can be downloaded from Atlassian Market placeMarketplace. These plugins can be installed through the UPM, so you only need to download them if you plan to do a manual install.

Connector Suite

This file is required when using the Connector Suite with JIRA.

  • jira-connector-plugin-<VERSION>.obr (e.g. jira-connector-plugin-1.0.0.obr)

Remote System Specific

For each system that you want to connect to, a different jar needs to be installed (note that if you want to connect to more than 1 system, you may install any combination of these).

  • For Get Satisfaction - getsat-connector-plugin-<VERSION>.obr

  • For Salesforce.com - salesforce-connector-plugin-<VERSION>.obr

  • For Saucelabs- saucelabs-connector-plugin-<VERSION>.obr

  • For uTest - utest-connector-plugin-<VERSION>.obr

  • For Zendesk - zendesk-connector-plugin-<VERSION>.obr

Installation Instructions

UPM (Preferred)

Using the UPM to install the plugins is preferred for its simplicity. The screenshots in the following steps use an example of installing the Salesforce connector, but it will apply to the specific remote system that you are using.

  1. Go to Administration and enter your password if prompted.

  2. Go to the Plugins link in the System section in the left menu towards the bottom.

  3. Click on the Install tab.

  4. Click on the "Upload Plugin" link as shown below:

    Image Modified

  5. Browse for the remote system "obr" file and click Upload.

    Image Modified

  6. Check the plugin is successfully installed.

    Image Modified

  7. Go back to the JIRA Install tab and repeat for the Connector Suite ".obr" file. You will be prompted to restart the application after this is installed.

    Image Modified

  8. Restart the JIRA instance when prompted.

  9. Check the plugins were successfully installed. The image below shows the successful installation of 5 plugins in JIRA 4.3.3, which already has the Applinks plugin bundled and therefore not installed.

    Image Modified

  10. You should also see a new menu section on the left menu.

    Image Modified

  11. The Connector Suite is now installed!

Manual Installation for JIRA

If the UPM fails to install the plugins, you can also try to install them manually. First you will need to extract the files.

Extract the files

  1. Use an archive utility like 7zip or WinZip to open the archive. The example below is from 7zip and displays the root directory.

    Image Modified

  2. Extract from the Connector Suite ".obr" file:

    1. The two "activeobjects-xxx.jar" files in the "dependencies" directory

    2. The "applinks-plugin-<VERSION>.jar" file in the "dependencies" directory

    3. The "core-connector-plugin-<VERSION>.jar" file in the "dependencies" directory

    4. The "jira-connector-plugin-<VERSION>.jar" file in the "dependencies" directory

  3. Extract from the remote system ".obr" file only the ".jar" file at the root of the archive e.g. salesforce-connector-plugin-5.0.0.jar

You should have 6 ".jar" files.

title
Tip

JIRA 4.3

Please note that a separate .zip installation has been provided for JIRA 4.3.x, this is to simplify the installation process, you will only need to extract the .zip file provided which contains all of the necessary files to install the plugin on JIRA 4.3.x.
The pre-packaged version for JIRA 4.3 can be found on the Download page.

Check for existing files

The installation will not work if one of the above files already exists as a bundled plugin in your version of JIRA, in particular the Active Objects and Applinks plugins. To check the existence of these plugins:

  1. Navigate to your JIRA installation directory

  2. Go to atlassian-jira/WEB-INF/classes

  3. Open up the "atlassian-bundled-plugins.zip" archive in an archive utility

  4. Check that neither the two Active Objects plugins or the Applinks plugin is in this archive

Install the files

  1. Shut down JIRA.

  2. Go to your JIRA home directory on the server.

  3. Navigate to <JIRA_HOME>/plugins/installed-plugins.

  4. Copy over all the files you extracted except for those that you noted already exist as bundled plugins.

  5. Start JIRA up again.

Check the installation

  1. Go to Administration and enter your password if prompted.

  2. Go to the Plugins link in the System section in the left menu towards the bottom.

  3. Make sure you are on the "Manage Existing" tab.

  4. The plugins you just installed should be displayed in the "User-installed Plugins" section. You may need to Enable them if they were previously unenabled.

  5. Check the new section called "Cloud Connectors" appears in the left menu.

  6. The Connector Suite is now installed!