Introduction
This manual is intended to guide the user through the five stages required to upgrade an existing installation of Mitrefinch TMS Version 7. It is intended for an IT professional who is familiar with the Mitrefinch software system.
Note: if you are upgrading from any version prior to Version 7 do not proceed. If you are upgrading from Version 6 please refer to the Mitrefinch TMS V6 to V7 Upgrade Instructions. To upgrade from any earlier version please contact Mitrefinch Support on 0330 726 0090 or email support@mitrefinch.co.uk for advice.
The five stages are:
- Backing up your system
- Downloading and unpacking the setup files for your installation
- Upgrading TMS for Windows (WinTMS) Version 7
- Upgrading TMS for Silverlight via the Mitrefinch Silverlight Upgrade tool
- Upgrading your data via SYSGEN.exe
Before you start, please make sure that:
- You have the TMS MASTER account password
- You have a network log in account with privileges to stop/restart your web server (IIS)
- You are currently running WinTMS Version 7. To verify this, log in to WinTMS and select Help > About. The About window will display your installed version number
- You have an existing installation of TMS for Silverlight Version 7. To verify this, log in to TMS for Silverlight and select Help > About. The License details panel in the About window will display your current version number
- You know the location of and have full access to the directories which contain the existing Version 7 files for WinTMS and TMS for Silverlight. These will usually be in C:\WinTms and C:\inetpub\wwwroot\TMS respectively although the names of the TMS directories may differ
- Ensure that ALL users are logged out of both WinTMS and TMS for Silverlight and that all Mitrefinch TMS applications and services (e.g. the Poller and Processor) are stopped
If you experience any problems in running either of them then please contact Mitrefinch Support by emailing support@mitrefinch.co.uk or raise a ticket via our support portal website by clicking here. Alternatively, please call 0330 726 0090.
Please note: Before starting, Mitrefinch strongly recommend that you read through this entire document to familiarise yourself with the upgrade procedure.
In this document, we refer to our network location as ‘C:\’. However, this path may be different for your installation.
System backup
Before attempting to upgrade your system, it is very important that you have a recent backup. This will allow you to roll back any changes you make during the upgrade procedure should anything go wrong. You should backup the WinTMS programs and database and your existing TMS for Silverlight directory.
Backing up the WinTMS database
To do this you will need to use either the database back up utility provided with your database system, a third-party back up tool or, if you are using the SQL Express database system, a back up script supplied by the Mitrefinch Implementer when your system was set up.
Note: the database backup procedure is not covered in this manual and is not supported by Mitrefinch. It needs to be performed by your own IT department.
Backing up the WinTMS programs
To do this you will need to make a copy of your existing WinTMS directory. The default location for your TMS directories is:
C:\WinTms
Browse to this directory which contains all the files necessary for WinTMS Right-click the directory and select copy. Then paste the directory in a safe location. This will allow you to roll back any changes you make during the upgrade procedure.
Backing up TMS for Silverlight
To do this you will need to make a copy of your existing TMS for Silverlight directory. The default location for your web directories is: C:\inetpub\wwwroot
Browse to this directory and locate the folder which contains all the files necessary for TMS for Silverlight. Right-click the directory and select copy. Then paste the directory in a safe location. This will allow you to roll back any changes you make during the upgrade procedure.
Download setup files
On the TMS Server, download the TMS v7 zipped CD image files for WinTMS and TMS for Silverlight from the Mitrefinch Support website. Your login details can be obtained from Mitrefinch Support on 0330 726 0090 or email support@mitrefinch.co.uk.
Next, unzip the downloaded files and extract the contents to a temporary location you can work from.
Alternatively request a TMS v7 upgrade CD from Mitrefinch Support.
All stages are identical from this point onwards whether you have extracted the contents of the downloaded CD image file or are using a CD.
Upgrading WinTMS Version 7
Once you have made a backup of your existing WinTMS system and have downloaded and extracted the TMS v7 CD image file for WinTMS (or have obtained a TMS v7 upgrade CD from Mitrefinch Support) you are ready to start the upgrade of your system.
TMS Setup
Locate the setup.exe file and double-click it to launch the InstallShield Wizard for TMS:
Click Next > to continue.
When prompted, click Yes to accept to the licence agreement:
Select packages to upgrade
The TMS Setup window opens:
Select the packages you use and click Next > to continue.
Note: you will need to have the appropriate licenses to run the packages. If you are unsure of the packages used, select all the boxes.
Choose the WinTMS directory
The installation routine will automatically detect the directory where WinTMS is currently installed on your machine. This is C:\WinTMSV7 in the example below:
Should you need to change this, use the Browse button to locate the correct directory. Click Next > to continue:
Select the folder for icons
Select a folder from the programs menu on your PC where the new TMS icons will be stored:
Click Next > to continue.
A progress window will be displayed as the installation proceeds:
The installation should run through to completion and automatically install the necessary programs and related files. If you are prompted to overwrite any files, agree for existing files to be overwritten. Click Finish when the following window is displayed:
If you are installing on a more recent operating system such as Windows 7, you may see the following:
Assume that the program has installed correctly and click 'This program installed correctly'.
Note: you may be prompted to reboot the server. You do not need to do this immediately if it is not convenient.
Upgrading TMS for Silverlight Version 7
Once you have made a backup of your existing TMS for Silverlight directory and have downloaded and extracted the TMS v7 zipped CD image files for TMS for Silverlight, you are ready to use the Mitrefinch Upgrade tool.
The Mitrefinch Upgrade tool is designed to upgrade an existing installation of TMS for Silverlight. Navigate to the location of your extracted CD image files and double-click the UpgradeWizard.exe file to run it:
Choose installer
The Upgrade wizard will prompt you to choose the MSI installer to launch the Mitrefinch Upgrade Tool. Browse to the location of your extracted files and double-click the SILVERLIGHT.msi:
Click Next to continue. A window will open displaying the progress while the files are extracted.
Prerequisite check
The next screen performs a prerequisite check on the server.
In the example screen above, the C++ Redistributables are already installed. If they are already installed on your server, click Next to continue and please go to Section 5.1.3.
If not, please read the following section which will guide you through the installation from the CD image.
Installing the C++ Redistributables
If the C++ Redistributables are not installed on your server, click the Install button which is displayed on the Prerequisites screen:
The Microsoft C++ Setup screen will open:
Select the check-box to accept the licence terms then click Install to start the process. Progress bars will be displayed as the installation proceeds:
The following screen will be displayed when the installation is completed:
Click Finish to close the Setup. Next click Refresh on the Mitrefinch Upgrade tool to update the Prerequisites screen, then click Next to continue.
Choose the web directory
Browse to the web directory where your existing TMS for Silverlight files have been installed. This will usually be in:
C:\inetpub\wwwroot\
As shown in the example below:
Click Next to continue.
Review
A window opens asking you to review the following information:
- The Installed Version
- The Upgrade Version
- The location of the Install File
- The location of the Web Directory
- The location of the Application Host Backup — the Upgrader tool backs up the applicationHost.config and machine_backup.config files
This window will also inform you that you need to run SYSGEN after performing the upgrade. This is described in Section 6 1 Upgrading data. If you need to change any of the previous steps click Back. If you are ready to begin the upgrade process click Start. A progress window will be displayed:
Summary
The final step is to review the upgrade summary. This will tell you if the upgrade has been successful and will inform you of the version of TMS for Silverlight you are now running. There are three possible outcomes from an upgrade:
- Upgrade Successful — this indicates that the upgrade of TMS for Silverlight has been completed successfully. Please ensure that you have also upgraded WinTMS to the same version before loading TMS for Silverlight. See Section 4 Upgrading WinTMS Version 7 for more details.
- Upgrade Successful with warnings — this indicates that the upgrade was completed successfully but some warnings were generated during the process. The summary will inform you of the warnings and direct you towards a solution.
The example above states: The Web Mitrefinch standard Web.Config file has changed — clicking 'more info' opens a window informing you that the WebConfig file has been changed and offering you the chance to view the changes using WinMerge:
WinMerge allows you to correct the changes to your WebConfig file manually. The Upgrader tool always makes a backup of the WebConfig file in case any errors are introduced.
Note: unless you are familiar with the contents of the WebConfig file, please click No at this point.
A WebConfig report is also produced by the Upgrade tool and, if you are having any difficulties, please send this to Mitrefinch Support, support@mitrefinch.co.uk, so that it can be investigated
3. Failed — the upgrade process was stopped and your TMS for Silverlight files have not been changed. If you see the following window you will need to run the IISRESET command then restart the Mitrefinch Upgrade tool:
Click Close to close the Mitrefinch Upgrade Tool.
See Restarting the web server for more details.
Should you require any assistance or if the upgrade fails then contact Mitrefinch Support on 0330 726 0090 or email support@mitrefinch.co.uk.
Upgrading data
The final stage in upgrading your existing installation of Mitrefinch TMS Version 7 is to update your data and database tables to the new version. To do this you need to run the SYSGEN program. Note: if you do not run SYSGEN after upgrading your system both WinTMS and TMS for Silverlight may fail.
Running SYSGEN
SYSGEN is the Mitrefinch System Generation application which is used to upgrade, backup and repair your TMS database. Navigate to the folder where WinTMS has been installed, for example C:\WinTMS. Double-click on SYSGEN.exe and follow the prompts. Before the login window opens, the following warning may be displayed:
If you have followed this guide then you will have already made a back-up of your data and so it is safe to proceed. Click Yes to continue. If not, please click No and refer to Section 2.2 Backing up WinTMS for more details.
The warning window will close and the SYSGEN login window will open:
You will need to enter the MASTER account login details. The SYSGEN application will open displaying your current server settings and Version information. In this example, the WinTMS package has been upgraded to version 7.10 but the database is currently at Version 7.8 Note: this may be different for your installation:
Click Upgrade or select Upgrade from the File menu to start the program. Click Yes in the Confirm window to proceed:
SYSGEN will then upgrade the database tables. A progress log is displayed:
At the end of the process, an Information window is displayed:
Click OK to dismiss the window. Then click Close on the SYSGEN log window:
The Version information in the System generator (SYSGEN) window should now indicate that the database has been upgraded. A new window will open telling you that the application will shutdown:
Clicking OK closes all windows and exits SYSGEN.
To verify that the new version has installed correctly, you should be able to launch WinTMS with no warnings about version differences. Select Help > About. The About window will display your installed version number. If the version number has changed to the latest version 7 then the software upgrade is complete, if not changed then contact mitrefinch support..
Reinitialising the system
Restarting the web server
Before attempting to use your upgraded version of TMS for Silverlight, you will need to restart your web server in order for the changes to take effect.
Note: you will need to have Administrator rights for the web server to be able to do this.
Open a command prompt on the web server and type the command IISRESET. This will force the IIS (Internet Information Services) server to reload the files from your updated TMS for Silverlight folder.
This process should only take a second or two. To verify that the upgrade has been successful browse to your TMS for Silverlight installation in a web browser and log in. Then select Help > About. The License details panel in the About window will display your current version number which should be Version 7.
Note: it may take a little longer than usual when you log in for the first time following an upgrade.
Restarting TMS services
After completing the upgrade of your systems, you will need to restart all Mitrefinch TMS applications and services such as the Poller and Processor on your polling PC or server.
If you experience any problems in running either of them then please contact Mitrefinch Support by emailing support@mitrefinch.co.uk or raise a ticket via our support portal website by clicking here. Alternatively, please call 0330 726 0090.
At the end of the upgrade procedure, you should be using the latest Version 7 upgrade of both WinTMS and TMS for Silverlight.