Upgrade Equitrac

This section describes how to upgrade to Equitrac version 6.2 from a previous version

Upgrading Equitrac 6.0 to 6.2

A direct upgrade from Equitrac 6.0 to 6.2 is supported. However, there are some procedures that need to be performed when upgrading.

  • Update the existing Equitrac service and client enrollments. After upgrading, go to the Authentication & Security page in the Configuration Assistant and enter the Security Admin credentials and press Login. This will automatically enroll all Equitrac clients and services.
  • Save any custom Equitrac certificates. Before upgrading, export the custom certificate with its private key, and then import it through the Configuration Assistant after installation. Use the Microsoft Management Console (mmc) certificates Snap-in. The Snap-in should connect to the current user certificate store for the user that the Equitrac services are running under.

Upgrading Equitrac 5.x to 6.2

A direct upgrade to Equitrac 6.2 from an earlier 5.x version is not supported, and the current 5.x version must first be uninstalled before installing 6.2.

Before uninstalling the current 5.x version and performing an upgrade, consider the following:

  • Equitrac 6.2 cannot use existing 5.x version licenses. See Licensing ControlSuite for details.
  • Save and backup your databases. Saved databases will be updated when installing Equitrac 6.2 if they have been saved prior to uninstalling the 5.x version.
  • You must be running at least Equitrac version 5.6 or 5.7 in order to retain stored data and to upgrade the existing Equitrac components. If licensed, 5.x DREs and DCEs can be used with 6.2 for up to 6 months.
  • 32-bit server components are not supported in Equitrac 6.2. If you currently have any 32-bit server components installed on a 64-bit system, you must remove them and then reinstall the 64-bit components.
  • Ensure that Upgrade mode is enabled when upgrading from Equitrac 5.x. This option allows Equitrac authentication (EQAuth) clients to communicate with updated servers after an upgrade.
  • There is no uninstall process through the Install Assistant, therefore you must first uninstall Equitrac 5.x through Control Panel > Programs and Features.

Before performing the upgrade, it is recommended that the same service account used for Equitrac 5.x versions be used when upgrading to version 6.2. If a different service account is used, unexpected results may occur related to permissions, such as certificates not being created or deleted.

Upgrading the Oracle database

Support for Oracle will be removed in the next ControlSuite release. If upgrading from an earlier version of Equitrac using an Oracle database, you may continue to use Oracle with this release, but it will not be supported for future upgrades. Kofax recommends switching to Microsoft SQL Server.

A new ControlSuite installation does not have Oracle as a selectable database option, however, if you are upgrading Equitrac with an existing Oracle database, Kofax has provided a process to allow this for ControlSuite 1.2.

After running the Install Assistant and before running the Configuration Assistant, edit the ConfigurationAssistant.exe.config file (located in C:\Program Files\Kofax\Configuration Assistant) and set the value of "Eq.CAS.EnableOracleDb" to "true".

<appSettings>
  <add key="Eq.CAS.EnableOracleDb" value="false" />
</appSettings>

When you run the Configuration Assistant after editing this file, Oracle will be available as a supported database.

Performing an upgrade

A direct upgrade from an earlier 5.x version of Equitrac to version 6.2 is not supported, and the installation stops if an older version is already installed.

The ControlSuite Install Assistant detects any existing installed Equitrac versions 5.6 and 5.7, and if you attempt to run the installer without first uninstalling the current version of Equitrac from the server, an error message pops up asking you to uninstall before continuing. The Install Assistant will not allow you to continue before the uninstallation is done. Uninstall is not performed through the Install Assistant, and must be uninstalled through Control Panel > Programs and Features.

The Install Assistant does not detect any Equitrac versions lower than 5.6, and the installer will fail without notification.

Whether upgrading all components on a single server, or performing a large upgrade across multiple servers, you must upgrade CAS first, then upgrade the remaining components.

Backing up your CAS database prior to performing an upgrade is recommended. Before upgrading, ensure that all machines within the current Equitrac deployment meet the operating requirements. See Equitrac Requirements .

If you installed remote server components (server components hosted on a different machine other than the master CAS), perform these steps to upgrade each machine within the Equitrac deployment.

During the upgrade, all CAS information is maintained—not overwritten.

Upgrade the components in the following order:

  1. SFS - on all nodes (upgrades from Equitrac v6 and later)
  2. License server (upgrades from Equitrac v6 and later)
  3. Master CAS
  4. Subsidiary CAS (if applicable)
  5. DRE/DME (typically, DME is installed on the DRE server)
  6. DCE
  7. SPE
  8. Client workstations