The Recovery Procedure for a Standalone YSoft SafeQ Management Server - Server Installer

This page describes the recovery of a single management node (which might be part of a Spooler Controller group) and that was installed using the Server installer package – First server deployment scenario.

Please enable license reactivation before transferring the license to a new server (e.g., when the original hardware fails or when an OS is reinstalled).

This guide assumes that you have a backup of databases and a backup of configuration (and binary) files available.

Jobs stored on the non-functional server will be lost and users will need to submit them again.

Recovery

  1. Prepare a server (or a virtual machine) with the samehostname/IP as the original Management Server had used.

  2. If you are using an external database (on another server), check its state.

    1. If the external database is damaged, perform a Recovering Databases but skip the Finalization part for now.

  3. Check the backup of the configuration files and note the following:

    1. Which optional features were installed:

      1. Mobile Print Server - an MPS folder is available in backup files.

      2. YSoft SafeQ Payment System - a YPS folder is available in backup files.

    2. Management Server GUID. It is noted in the safeq.properties file as the value of the communicator.cml.guid option. For example:

      backup\Management\conf\safeq.properties
      # COMMUNICATOR
      communicator.cml.guid = MGMT1
    3. SPOC GUID. It is noted in the guid.conf file as the value of the LocalGUID option. For example:

      backup\SPOC\conf\modules\guid.conf
      localGUID = ectp5o8ep0op3hzi
  4. Reinstall Management Server using the same version build of the installation package.

    1. Enable optional features if they were used before (see step 3.a.).

    2. Provide the wizard with the same Management Server GUID that was used before (see step 3.b.).

    3. If you have YSoft SafeQ 6 MU11 or later build, also provide the wizard with the same SPOC GUID that was used before (see step 3.c.).

    4. Finish the installation.

      See First server installation for a detailed procedure.

  5. Stop almost all YSoft SafeQ services except the YSoft SafeQ Bundled PostgresSQL service (available if embedded a PostgresSQL DB is used) after installation finishes.

    You can use the following PowerShell script to perform the task:

    Get-Service *YSoft* | Where-Object { $_.Name -ne 'YSoftPGSQL' } | Stop-Service
  6. If you are using an embedded PostgreSQL database, perform a Recovering Databases but skip the Finalization part for now (as new empty databases were created during the installation).

  7. If you have YSoft SafeQ 6 MU10 or older build, edit <install_dir>\SPOC\conf\modules\guid.conf, and rewrite the localGUID to the value that was used before (see step 3.c.).

  8. Delete the SPOC cache by deleting the whole folder <install_dir>\SPOC\SpoolCache.

  9. Start the YSoft SafeQ services with the Automatic startup type again.

    Do not start YSoft SafeQ Spooler Controller Group Service. It will be started by the YSoft SafeQ Spooler Controller service when the proper configuration is ready.

    You can use the following PowerShell script to perform the task:

    Get-Service *YSoft* | Where-Object { $_.Name -ne 'YSoftSQ-SPOCGS' } | Start-Service
  10. Re-activate the YSoft SafeQ 6 license using your preferred method (online/offline). See Management Interface - License Activation for detailed instructions.

  11. Restore customized configuration:

    1. If you had services running under a specific domain account, set it up again.

    2. If you used customized scripts on the server (e.g., for batch files launched by Rule-Based Engine or customized batch files used by Workflow Processing System), restore those scripts from the backup.

    3. If you used customized configuration (such as your own certificates for the web services), seek the relevant documentation and set the configuration up again.

  12. Check that Spooler Controller is correctly connected on the management web.

Finalization

Clear the Cache on Other Spooler Controllers and Start All Services Again

Cache on Spooler Controllers needs to be deleted after Database restore to avoid possible inconsistencies.

Delete Spooler Controller cache directory on all servers

Delete YSoft SafeQ Spooler Controller cache by deleting whole folder <SAFEQSPOC_DIR>\SpoolCache (e.g. c:\SafeQ6\SPOC\SpoolCache)

Start Management service again

Open the Services window (e.g. Start > Run > services.msc) and start the following services:

  1. Start YSoft SafeQ Management Service

Verify the Spooler Controller cache recovery settings

Go to tab System > Configuration on YSoft SafeQ management interface and set orsCacheRecovery property to enabled.

In case of YSoft SafeQ Spooler Controller cache data corruption, cache can be manually deleted and all job-related metadata will be recovered from YSoft SafeQ Management Server.

If you omit this step, all jobs stored on the YSoft SafeQ Spooler Controller might be lost after the end of procedure.

Start the remaining services on all servers

Do not start YSoft SafeQ Spooler Controller Group Service manually. If YSoft SafeQ Spooler Controller is part of Spooler Controller group then this service will start automatically when its configuration is ready.

  1. Start remaining YSoft services with Automatic startup type in no particular order

You can use the following PowerShell script to perform the task:

Get-Service *YSoft* | Where-Object {$_.Name -ne 'YSoftSQ-SPOCGS'} | Start-Service

Verify the correct Spooler Controller functionality

Once the YSoft SafeQ Spooler Controller cache is deleted and YSoft SafeQ Spooler Controller services are running, verify the correct YSoft SafeQ Spooler Controller functionality according to the article YSoft SafeQ Spooler Controller Health Check.

Reconfigure the etcd Cluster in Terminal Server if Failover for Embedded Terminals Is Being Used

  1. If failover for embedded terminals is being used and parameter enableEtcd is enabled, then the etcd cluster in Terminal Server must also be reconfigured.

    1. Follow Reconfiguring or Recovering an etcd Cluster in Terminal Server.