Recovery procedure for standalone YSoft SafeQ Management Service - standalone installer

This page describes the recovery of a single Management Server (which is not part of any cluster) and which was installed using ysq-management-server-install.exe package.

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

This guide assumes that you have Backup of Databases and Backing Up Configuration and Binary Files available.

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 Recovering Databases but skip the Finalization part for now.

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

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

      backup\Management\conf\safeq.properties
      # COMMUNICATOR
      communicator.cml.guid = MGMT1
  4. Reinstall the Management Server using the same build installation package.

    1. Tick the I want to customize my YSoft SafeQ Management Server option.

    2. Choose the Install a new YSoft SafeQ Management Server... option.

    3. Use the same database type as was used before.

    4. Provide wizard with the same Management Server GUID which was used before (see step 3.a.)

    5. Finish the installation.

      See Install the YSoft SafeQ Management Server for detailed procedure.

  5. Stop almost all YSoft services after installation is finished.

    1. Leave only the YSoft Bundled PostgresSQL service running (available if embedded PostgresSQL DB is used).

    2. Stop all other YSoft SafeQ services.

      1. 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 Recovering Databases but skip the Finalization part for now (as new empty databases were created during installation).

  7. Start YSoft services again.

    1. You can use the following PowerShell script to perform the task

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

  9. Restore customized configuration:

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

Finalization

Clear cache on 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.