› Upgrade tenants › Using the Zero downtime upgrade process

Using the Zero downtime upgrade process

In a zero-downtime upgrade process, the tenants are upgraded using the OPMTDBUpgrader utility and not via the Tenant Management System without the need to install the newer version of TotalAgility on extra servers. The TotalAgility Designer is disabled for all tenants to prevent usage of new TotalAgility features during the upgrade of TotalAgility servers to the next version, as there may still be TotalAgility servers running using the earlier version.

If any issues occur during the zero-downtime upgrade, you can only roll back to the pre-upgrade backup, that is, the backup of the tenant databases done before the upgrade starts, as the tenant's system will still be running during the upgrade.

To upgrade TotalAgility On-Premise Multi-Tenancy using zero-downtime, perform the following steps:

  1. From your TotalAgility installation files, navigate to \\TotalAgility\Utilities\OPMTDBUpgrader and run Kofax.TotalAgility.Install.OPMTDBUpgrader on any Application server as an administrator.
    The upgrader connects to the default DataCenter databases using the connection details from the Application server configuration files. If you run this utility from any server other than the Application Server, you must manually enter the database details.

    The Kofax TotalAgility Multitenancy Tenant upgrader window opens.

  2. Click Next to continue with the setup.

    The Databases window opens.

  3. Specify the MasterTenants database connection string along with the DataCenter database connection string to upgrade. These connection strings are used to pre-upgrade the Master/datacenter tables.
  4. Click Next and then click Yes to confirm.

    The Upgrade Tenants window displays the list of tenants.

  5. On the Select deployment to upgrade list, select the deployment type.

    The list of tenants that belong to the selected deployment type appears in the table. The following tenant information is displayed: Tenant name, database server, status, upgrade status, and result.

  6. Select a single tenant, multiple tenants, or all tenants to upgrade and click Pre Upgrade.

    A confirmation message appears.

  7. Click Yes.

    All the selected tenants are upgraded to the latest version. Each of the selected tenants is deactivated during the data upgrade. Once the upgrade process starts, TotalAgility Designer access for all the tenants is deactivated until the completion of the upgrade process.

  8. Click Refresh.

    The Status column for the tenant displays the status of the selected tenant as Upgrading. The status of remaining tenants under the selected deployment is displayed as Active.

  9. Select the tenant and click View Results.

    The Tenant Upgrade Result window displays the upgrade result.

  10. Click Close to return to the Upgrade Tenants window.

    The Upgrade Status column for the tenant displays the status as Post Upgrade Pending.

    TotalAgility 8.0.0 only supports zero-downtime upgrade from TotalAgility 7.11.0. If a tenant being upgraded is using a version other than 7.11.0, an error appears.

  11. Once all the tenants are pre-upgraded, the databases are now backward compatible. You can close the utility.
  12. From your TotalAgility installation files, navigate to \\TotalAgility\\OnPremiseMultiTenancyInstall, run Setup.exe and start upgrading all the on-premise multi-tenant TotalAgility deployment servers to the latest version via the TotalAgility installer. See Kofax TotalAgility On-Premise Multi Tenancy Installation Guide for more information.
  13. Similarly, upgrade the Tenant Management System deployment server to the latest version via the Tenant Management System installer.
    1. From your TotalAgility installation files, navigate to \\TotalAgility\\TenantManagementInstall.
    2. Run Setup.exe.
      Once the Tenant Management System and datacenter databases are upgraded to the latest version, the databases are now backward compatible. See the Kofax TotalAgility Tenant Management System Help for more information.
  14. Make sure the tenants are working. To test, you can activate TotalAgility Designer access to a single tenant via the Tenant Management System tenant update screen and perform all tests.
  15. Open the OPMTDBUpgrader utility, in the Upgrade Tenants window, click Post Upgrade to run the post upgrade database scripts for all the selected tenant databases to clean up the old data.

    Running the post-upgrade database scripts also executes the postscripts for master and datacenter tables and activates TotalAgility Designer access for all these tenants. During this process, each tenant is deactivated during the data upgrade.

    All the tenants are now upgraded to the latest version and are no longer backward compatible with the previous TotalAgility version.