Chapter 3: Upgrading InControl

Home Prev	InControl 3.19.01 Administration Guide	Next

When new releases of InControl are made available, these can be downloaded by logging in as a customer to http://www.clavister.com and selecting the relevant download. InControl updates are packaged as a set of four Windows executable .exe files which run an installation wizard. There is one installation executable file each for the client, server and ILA components plus a fourth file called clavister-incontrol-n-nn-nn-bundle-setup.exe which allows all components to be upgraded together (where n-nn-nn is the InControl version number).

	Important: Upgrade all InControl components together
	Although InControl releases include separate installation executables for the upgrade of the client, server and ILA, they should be viewed as a single upgrade. One component should not be upgraded without the others since dependencies may exist. For this reason, it is recommended to run the bundle-setup.exe file.

Uninstallation of existing versions is not required and the order of installation is not important. However, upgrading from version 1.10 has special requirements which are described later in this section.

Before installing, both the client and server management interfaces should be closed. The server installation will automatically stop the relevant services and then restart them.

The InControl server database is not normally affected by upgrading. Even a complete uninstall of the server will leave the database intact and remaining files must be deleted from the installation directory manually to completely remove the database.

Creating a Database Backup

The installation wizard for the InControl server will ask if the current InControl database is to be backed up. By default, this option is enabled and it is recommended not to disable it. The backup file has a timestamped filename of the form dbyyyy-mm-ddThhmmss-i.ics and is stored in the same directory as the original database folder. This folder has the default location:

		%appdata%\Clavister\InControl\Server\

Where %appdata% is the root path Windows variable and this is usually set to be the folder for the current user's application data.

A backup file created by the installer can be restored by using the Database > Load menu option in the InControl Server Settings management interface. This will automatically stop and restart the InControl services.

The server settings interface and saving or restoring the InControl database is discussed further in Chapter 4, Server Management.

Upgrading from InControl 1.10

If upgrading from InControl version 1.10 then some special manual operations are required. The three InControl components of client, server and Log Query Server (LQS) must be uninstalled before installing a later InControl version.

	Important: Back up the old LQS files
Uninstallation of 1.10 will preserve most of the old server database (including the audit logs) as well as the LQS log database files. These can then be manually transferred into the new InControl version's file structure as described below. However, the LQS configuration file lqs.xml is deleted during LQS uninstallation and a copy will be needed if the new ILA configuration is to replicate the old LQS configuration. This file is found in the Clavister\InControl\LQS folder.

Important: Back up the old LQS files

Uninstallation of 1.10 will preserve most of the old server database (including the audit logs) as well as the LQS log database files. These can then be manually transferred into the new InControl version's file structure as described below.

However, the LQS configuration file lqs.xml is deleted during LQS uninstallation and a copy will be needed if the new ILA configuration is to replicate the old LQS configuration. This file is found in the Clavister\InControl\LQS folder.

For the filepaths used in the description below, the Windows variable %programfiles% is assumed to be the root path for the old InControl version installation. The variable %appdata% is assumed to be the root path for the new installation and this usually defaults to be the current user's application data folder. Both roots may have been changed when LQS was installed.

A. Moving server files

The InControl server installer provides the option to specify the location of the new InControl server database. The location chosen can be the same as the old installation directory.

If it is the same, the installer will not overwrite the old database and it will therefore become the database for the new version.

B. Moving LQS log files

Take all the subfolders (each has a firewall identifier), but not the lqs.xml file, from the LQS database folder:
```
		%programfiles%\Clavister\InControl\LQS
```
And copy these subfolders with their contents to the ILA database folder:
```
		%appdata%\Clavister\InControl\LoggingAgent\LogDatabase
```
The old LQS log folders and files will merge with any existing ILA log files. Files with the same name will be overwritten.

Some typical examples of the names of the copied subfolders is shown in the file explorer screenshot below.

It is important NOT to copy the lqs.xml file from the old LQS installation unless the old LQS configuration is to become the configuration for the new ILA installation. This file is deleted when LQS is uninstalled so a copy should be made before beginning the uninstall process.

When it is transferred into the new ILA directory structure, the file lqs.xml will be automatically converted to become the current ILA configuration file ila.xml but only when the ILA Windows service (called ILA.exe in the process list) is restarted. To do this, go into the Windows control panel and restart the service.

	Note
	The file lqs.xml is deleted during the conversion process ila.xml. Retain a copy of lqs.xml in case the conversion process does not complete successfully.