TFS4JIRA Self-Hosted | Upgrade procedure

Owned by Damian Kilkowski (Inactive) (Deactivated)
Last updated: Sept 09, 2022
2 min read

Below steps should be followed to assure an unproblematic upgrade to the latest version of TFS4JIRA Self-Hosted.

  1. Before continuing with the below steps, please make sure your environment complies with TFS4JIRA latest version requirements and prerequisites. A detailed documentation page concerning the latest released version can be found in this section: https://appfire.atlassian.net/wiki/display/TFS4JIRA/Installation

  2. In order to be 100% safe from configuration data loss, please backup the database file with the current configuration.

    1. the configuration file is by default present in this folder: C:\inetpub\wwwroot\tfs-jira-synchronizer\App_Data (please look in other/custom location if you performed custom TFS4JIRA installation)

    2. database file name: config.sdf

    3. please copy this file to a safe location, for example, your desktop

  3. Back up web.config file as the upgrade will overwrite current configuration.

    1. by default web.config is present in following folder C:\inetpub\wwwroot\tfs-jira-synchronizer

  4. Uninstall currently installed TFS4JIRA using standard Windows procedure - 'Uninstall a program' in the ‘Programs’ section of the Control Panel.

    2. TFS4JIRA uninstaller will not remove previous logs and configuration database

  5. Please download and install the latest version of TFS4JIRA. Detailed instruction: https://appfire.atlassian.net/wiki/display/TFS4JIRA/Installing+TFS4JIRA+Synchronizer

  6. Once installed, implement previous configuration in the new web.config

    1. please do not overwrite the file (old on new)

    2. please copy additional configuration lines from the old web.config into the newly created web.config.

  7. IMPORTANT: Clear CACHE in your browser.

    1. How to clear cache in Google Chrome

    2. How to clear cache in EDGE

    3. How to clear cache in Safari

  8. Please run the TFS4JIRA configuration page.

    1. the first run always takes longer to load the page

    2. since uninstallation did not erase the configuration file (database), when you login, all profiles should be present and setup in your TFS4JIRA

    3. If for any reason proper expected configuration is not visible, because due to some reason configuration database has been replaced with a blank version, please simply use the backup created in point 2 and copy it to your current config.sdf location (by default C:\inetpub\wwwroot\tfs-jira-synchronizer\App_Data)