How to upgrade TFS4JIRA to the latest version

Owned by spg bot
Last updated: Dec 14, 2023 by Jeff Gleeson
2 min read

Follow the steps below to upgrade to the latest version of TFS4JIRA Self-Hosted.

  1. Stop the TFS4JIRA Synchronizer application pool in IIS using IIS Manager (cmd: inetmgr)

  2. Before continuing, ensure your environment complies with TFS4JIRA's latest version requirements and prerequisites. A detailed documentation page concerning the latest released version can be found in this section: Installation.

    Confirm you have Microsoft® SQL Server® Compact 4.0 SP1 installed before you proceed. This is required even if the full SQL Server version is installed. Refer to TFS4JIRA Self-Hosted 9.0 or higher requirements and prerequisites for more information.

  3. To reduce the risk of configuration data loss, back up 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)

    3. database file name: config.sdf

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

  4. Back up the web.config file, as the upgrade overwrites the current configuration.

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

  5. 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

  6. Download and install the latest version of TFS4JIRA. Detailed instruction: Installing TFS4JIRA Synchronizer

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

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

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

  8. 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

  9. 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 log in, all profiles should be present and set 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, 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)