KB : How should you upgrade TFS4JIRA Synchronizer properly.

Owned by Avinash Bhagawati
Nov 21, 2023

Backup Your Data

Before upgrading TFS4JIRA Synchronizer, it will be the best to backup all the data you have in the Synchronizer. To do this, you may follow the steps below

  1. Backup the database file (config.sdf) at the Synchronizer installation directory
    By default, it should be at

    C:\inetpub\wwwroot\tfs-jira-synchronizer\App_Data\config.sdf
  2. Check the current TFS4JIRA Synchronizer version and remember it in case recovery is needed
    - How to do a recovery for TFS4JIRA Synchronizer

Afterward, depending on your TFS4JIRA Synchronizer's current version, there might be some small differences

If your current version is 5.2 or newer:

  1. Download the latest Synchronizer installer at Spartez Website
  2. Go to IIS Manager → Application Pools → Stop the TFS4JIRA app pool
  3. Execute the installer
    1. If the installation parameters were not changed before, you may just click the installer and execute it
    2. If you have used any custom installation parameters, you will need to execute the installer via command line with the same custom installation parameters you used before.
      - How to check if you have customized the installation parameters
  4. Let the installer completes the installation (finish and close)
  5. Clear the Synchronizer's caches
    - How to clear caches in TFS4JIRA Synchronizer
  6. Start & Recycle TFS4JIRA app pool in IIS Manager
  7. Access the Synchronizer to see if everything is alright after logging in.
  8. If you are using Jira Server or Jira Data Center, please upgrade your TFS4JIRA add-on also at your Jira accordingly to the TFS4JIRA Synchronizer's version you have just installed

If your current version is older than 5.2:

  1. Download TFS4JIRA Synchronizer version 6.0.0 at here
  2. Go to IIS Manager → Application Pools → Stop the TFS4JIRA app pool
  3. Execute the installer
    1. If the installation parameters were not changed before, you may just click the installer and execute it
    2. If you have used any custom installation parameters, you will need to execute the installer via command line with the same custom installation parameters you used before.
      - How to check if you have customized the installation parameters
  4. Let the installer completes the installation (finish and close)
  5. Clear the Synchronizer's caches
    - How to clear caches in TFS4JIRA Synchronizer
  6. Start & Recycle TFS4JIRA app pool in IIS Manager
  7. Access the Synchronizer to see if everything is alright after logging in.
  8. If everything is alright, please follow the upgrade steps for "If your current version is 5.2 or newer"