CML - Rollback steps for returning to the previous version

This article describes how to roll back to the previous version of YSoft SafeQ in case that an upgraded version prevents you to use some of critical YSoft SafeQ functions. Due to the complexity of the procedure you shall perform these steps only when it is requested by Y Soft.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg You can revert only to the version you was using before the upgrade in order to keep the database and version compatibility.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Any new data (users/printers/statistical data) that were obtained after the upgrade will be lost when reverting to the older version.

Prerequisites

Kindly prepare all the required data before starting with reverting to the previous version:

  1. YSoft SafeQ installation package of the version you are going to revert to.

  2. SQDB5 database backup of the first CML node that was created before the upgrade to the newer version

  3. SQDB5_SQDW database of the first CML node that was created before the upgrade to the newer version

  4. Configuration files backup of the first CML node that was created before the upgrade to the newer version

  5. TEMP (<SAFEQ_DIR>\server\temp) and SPOOL (<SAFEQ_DIR>\server\spool) folder backup from all nodes you are going to revert

    • required only in case that you wish to restore the print jobs that were stored on the server

  6. Folder containing scripts for scanning (in case that scan to script is used)

Step 1 - remove YSoft SafeQ CML

Kindly use "Add or Remove Programs" (or "Programs and Features") to uninstall CML on all servers you are going to revert.

Also drop SQDB5 and SQDB5_SQDW databases in case you are using the external database server,

Step 2 - restore YSoft SafeQ CML on the first node


1

Perform following step on the node which you are recovering:


1a. Perform the installation

Install YSoft SafeQ according to Basic server installation instructions using the older installation package.

Installation requirements:

  • Install only one CML server node

  • Use the same database type as for other nodes that are installed already

  • Untick the "Start SafeQ services after the installation is finished" option


1b. Restore databases

Restore databases according to CML - Database restore instructions with following exception:

  • Do not start YSoft SafeQ services at the end of the restore procedure but continue on the next step of this guide

1c. Using pgAdmin III or MS SQL management studio run following query:

delete from smartq_validator


1d. Replace the configuration files

Overwrite existing configuration files with original configuration backup:

  • <SAFEQ_DIR>\conf

  • <SAFEQ_DIR>\tomcat\conf

  • <SAFEQ_DIR>\terminalserver\terminalserver.exe.config

  • Delete or rename <SAFEQ_DIR>\conf\update.conf file (it would block the start of YSoft SafeQ CML service)

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg WARNING: This step requires the password for database/sync users in the database is the same as it was before the reverting. Skip this step and configure server manually if you do not have exactly the same configuration as before the server reverting! However keep in mind:

  • localGUID in startup.conf must be configured the same way as before the reverting

  • the same guid as in startup.conf has to be also put to <SAFEQ_DIR>\terminalserver\terminalserver.exe.config - parameter "networkAddress"


1e. Restore spooled jobs

Restore your backup of temp and spool directory

  • Copy spool directory from original YSoft SafeQ server to <SAFEQ_DIR>\server\spool

  • Copy temp directory from original YSoft SafeQ server to <SAFEQ_DIR>\server\temp

  • Copy folder containing scripts for scanning (if scan to script is used) to the same location as it was on the original server

2

Open Services (e.g. Start => Run => services.msc) and start all YSoft SafeQ services in any order:

  • YSoft SafeQ CML

  • YSoft SafeQ CML DBS

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ LDAP Replicator Service

  • YSoft SafeQ Web Interface

3

Reactivate the license. For more information see article Reactivating license.

Step 3 - restore YSoft SafeQ CML on the rest of the servers in the cluster

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg Skip this step in case you have just 1CML in your environment (not a clustered solution).

Kindly install the rest of the nodes using the older installation package according to the instructions from article CML - Recovery procedure for slave node. If you wish to restore also the spool jobs, it is just necessary to select "Do not start YSoft SafeQ services" during the installation => once the installation has finished restore the spool directory the sane way like on the first installed node => then start all YSoft SafeQ CML services.

Step 4 - reinstall ORS servers

As the ORS servers has to be always running in the same version as the CML servers, it is necessary to uninstall the ORS servers and install it again from the old installation package.


1

Verify the orsCacheRecovery attribute is enabled in the CML settings.

Open YSoft SafeQ Web Interface => System => System settings => In the Expert View set orsCacheRecovery to enabledimages/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If you omit this step, all jobs stored on the ORS will be lost at the end of procedure.

2

Backup ORS configuration files by backing up the directory <SafeQORS>\conf\

Backup ORS spooler files by backing up the content of directory <SafeQORS>\server\spool\

Backup folder containing scripts for scanning (if scan to script is used)

3

Uninstall the ORS as described in article Uninstalling YSoft SafeQ ORS.

4

Copy old ORS installation package to the server and prepare the safeq-ors.ini according to the instructions from Installing YSoft SafeQ ORS article with following exceptions:.

a. Parameteres for safeq-ors.ini can be taken from the backup of the original configuration files that was created in previous steps (<SafeQORS>\conf\modules\ors.conf).

b. Set localGUID according to the value from backup of the original configuration (<SafeQORS>\conf\modules\guid.conf).

c. Set spoolDir according to your needs.

5

Upload all print jobs from the backup of spool directory (created in previous steps) to the new location defined in safeq-ors.ini (parameter spoolDir).

Copy folder containing scripts for scanning (if scan to script is used) to the same location as it was on the original server.

6

Run the installation of ORS server using installORSv2-exe.cmd.

7

Once the installation of ORS server is finished, verify the correct ORS functionality according to the article YSoft SafeQ ORS Health Check. Also check that you are able to release the jobs that were delivered to the ORS before the ORS has been moved.

Step 5 - reinstall embedded terminals

In case that you are using the embedded terminals which are sharing the communication keys with the YSoft SafeQ server (Sharp devices), make sure that you reinstall the embedded terminals.

Step 6 - verify the functionality

Test authentication/print/copy/scan via CML and ORS. All functions must be working. Also accounting must return the correct result.