The installation of Outlook Integration for Jira has two parts:

The order of the installation parts is not relevant.

There is a special version of the Outlook add-in available for mass deployment (e.g., terminal servers). The installation of this version is described at the end of this document.

The configuration of the Outlook Integration for Jira app is described in the Configuration section of the user documentation.

Install the Jira App

To install the Jira app of Outlook Integration for Jira using the Universal Plugin Manager (UPM), do the following:

  1. Log into the Jira server as administrator.
  2. From the Administration menu, select Add-ons.
  3. By default, you should see Atlassian Marketplace for Jira dialog in the right frame. If not, select Find new add-ons in the left frame.
  4. Search the Marketplace for "Outlook Integration". Outlook Integration for Jira from catworkx should appear in the list of results.
  5. To install the app, select Free trial or Buy now and follow the order process.
  6. To verify that the app is installed, select Manage add-ons in the left frame.
  7. By default the user-installed apps are listed in the right frame. The Outlook Integration for Jira should be listed.
  8. Make sure that all modules have been enabled (e.g. 5 of 5 modules enabled)

Install the Outlook Add-in

To install the Outlook add-in of Outlook Integration for Jira, do the following:

  1. Extract the Outlook.Integration.for.JIRA_v.{version}.zip archive.
    An directory labeled Outlook.Integration.for.JIRA_v.{version} should be created. It contains the following files:
    • Outlook.Integration.for.JIRA.msi
    • README_FIRST.txt
    • setup.exe
  2. Execute the file setup.exe.

    The file setup.exe checks for necessary dependencies (such as .NET framework) and install them if needed. It is recommend to use setup.exe to install the Outlook add-in.

    The file Outlook.Integration.for.JIRA.msi does not check for any dependencies. It is intended for software distribution only. catworkx does not offer support for software distribution.

    A Setup Wizard dialog appears.

  3. Follow the instructions of the installer.
    The plugin will be registered for the current user in the registry (HKEY_CURRENT_USER) to be loaded by Outlook on the next start.

Mass deploy the Outlook Add-in using your own software deployment strategy

In case you want to install Outlook Integration for Jira

  • on terminal servers,
  • on computers with multiple users or
  • according to your own software deployment strategy,

 You might want to install the add-in only once and handle the load behavior of the add-in for each user on your own. To do so, do the following:

  1. Uninstall all previous versions of the add-in if you are upgrading.

    (Uninstalling first is the safe path. Usually just installing/upgrading works as well, older files will be overwritten. Just in case of any errors, always uninstall and then reinstall the plugin.)

  2. Download and extract Outlook.Integration.for.JIRA_Mass.Deploy_v.{version}.zip
  3. Run setup.exe (not the MSI file) as administrator to install the plugin on the terminal server.
    The setup will install and register the add-in for all users of the server. By default the add-in installs to %ProgramFiles(x86)%. On this stage the add-in will only be registered on the server (HKEY_LOCAL_MACHINE), but not loaded into a user's Outlook.
  4. There are two options to load the add-in for users:
    1. Use the outlook_jira_current_user.reg file from the setup directory to install the add-in to your end-users. To add the contents of the file to the registry of the add-in's users (HKEY_CURRENT_USER), you can
      1. use the Group Policy Registry Preference or
      2. use a logon script
    2.  Use outlook_jira_local_maschine_office32bit_win32bit_and_office64bit_win64bit.reg or outlook_jira_local_maschine_office32bit_win64bit.reg. To add the contents of the file to the registry of the add-in's machine (HKEY_LOCAL_MACHINE).
      The add-in needs to be registered only once and will be loaded for all users.  
      Please make sure to use the proper *.reg-file due to different bitnesses (32bit/64bit) of Outlook and Windows.

In case you want to deploy the .msi file, make sure the .NET framework has been deployed as well, because the .msi installer does not download any depended packages.