Upgrading from YSoft SafeQ 5 to YSoft SafeQ 6

Summary

The purpose of the upgrade process is to migrate data (configuration, records, and reporting records) from YSoft SafeQ 5 to newly installed YSoft SafeQ 6 during the installation process or manually.

Migrated areas

  • Configuration

  • Users

  • Devices

  • Device templates

  • Queues

  • Spooler Controllers configuration

  • Price lists

  • Billing codes

  • Rule-based Engine rules

  • Scan workflows

  • Reporting records

  • Statistics

Areas out of the scope

  • Physical job data

  • Spooler Controller servers (have to be installed separately for each server)

  • Migration of YSoft SafeQ Terminal Professional v 3.5

See A Detailed Description of the Upgrade Steps and The YSoft SafeQ 5 to YSoft SafeQ 6 Upgrade Tool for more information about migrated data and exceptions.

General Prerequisites

  • The existing installation of YSoft SafeQ 5 is updated to the latest available version (the last available build).

  • Ensure the new YSoft SafeQ 6 license is available and the new product can be properly licensed.

  • There is a backup of the current YSoft SafeQ 5 installation, mainly these parts:

    • Database

    • Configuration, see article CML configuration backup page from YSoft SafeQ 5 documentation.

  • Expected downtime is dependent on the size and type of the database, mainly the number of jobs, users, devices, and terminal access records. For example, an upgrade with 1,000,000 jobs, 20,000 users, 200 devices, and 30,000 terminal access records may take approximately three hours on the MS SQL server. On the PostgresSQL server, the same upgrade can take about four hours.

  • In the case of a SQL Server dedicated database used with YSoft SafeQ 5, the database must exist on the same database machine as the future YSoft SafeQ 6 database.

  • Migration is possible only between identical database engines (PostgreSQL→ PostgreSQL, MS SQL→MS SQL).

Please resolve all mentioned prerequisites above to be sure the upgrade process is as smooth as possible.

According to the environment, there are slightly different possibilities for how to upgrade:

Upgrading a YSoft SafeQ 5 Single Server Installation (Without ORS Servers)

For automatic upgrading with the Server Installer, follow the Upgrade of YSoft SafeQ 5 single server installation without ORS servers article.

Upgrading a YSoft SafeQ 5 Cluster Server Installation with a Non-trivial Environment Setup

The architecture of YSoft SafeQ 5 and YSoft SafeQ 6 is completely different and may require a change of the architecture of the current solution, so please consider whether it is necessary to contact customer support, e.g., if there are more application servers in the cluster or a database cluster with failover.

For semi-automatic upgrading with a server installer, follow the Upgrading a YSoft SafeQ 5 Cluster Server Installation with a Non-trivial Environment Setup article.

Manual Upgrading of YSoft SafeQ 5 – Migration of the Database

The main purpose of the manual upgrade process is to migrate data from the previous version of YSoft SafeQ 5 to the newer blank YSoft SafeQ 6 version if the automatic upgrade run from the installer fails or it is necessary to upgrade to the new server. It is divided into particular steps that are run in order, and each next step depends on the previous one, see The YSoft SafeQ 5 to YSoft SafeQ 6 Upgrade Tool for more information about the steps.

See the The Manual Upgrading of YSoft Safe 5 - Migrating the Database article to run a manual upgrade.