The Recovery Procedure for a Node of a YSoft SafeQ Management Server Cluster - Server Installer

This page describes the recovery of a single node of a Management Server cluster that was installed using the Server installer package – a First Server or Additional Management Server deployment scenario.

If the affected node is the one on which the YSoft SafeQ license was activated, enable license reactivation before transferring the license to a new server (e.g., when the original hardware fails or when an OS is reinstalled).

We expect that an external database is being used – i.e., there is no local database on any cluster node.

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

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

You can use the installer to reinstall the affected node.

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

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

    1. Which optional features were installed:

      1. Mobile Print Server – The MPS folder is available in backup files

      2. YSoft SafeQ Payment System – The 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 = MGMT3
    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 = j23892stpkfmvri9
  3. Reinstall Management Server using the same build installation package.

    1. Select the Other servers and Additional Management server options.

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

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

    4. 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 2.c.).

    5. Finish the installation.

  4. If you have YSoft SafeQ 6 MU10 or older build.

    1. Stop all YSoft SafeQ services after the installation is finished.
      You can use the following PowerShell script to perform the task:

      Get-Service *YSoft* | Stop-Service
    2. Edit <install_dir>\SPOC\conf\modules\guid.conf and rewrite the localGUID to the value that was used before (see step 2. c.).

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

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

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

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

        Get-Service *YSoft* | Start-Service
  5. Add the GUIDs, ports, and IP addresses of other Management Server cluster nodes into the configuration of YSoft SafeQ Spooler Controller on the reinstalled Management Server.

    1. Open the <install_dir>\SPOC\conf\modules\spoc.conf file on the other Management Server cluster node and copy the content of the Connections to CML server nodes: GUID, IP and PORT section (this node contains the correct configuration where all Management Server cluster nodes are listed).

    2. Paste these values into the Connections to CML server nodes: GUID, IP and PORT section of the <install_dir>\SPOC\conf\modules\spoc.conf file on the reinstalled Management Server and save the changes.

    3. Restart the YSoft SafeQ Spooler Controller service on the reinstalled Management Server to apply the changes.

    4. For more information see YSoft SafeQ Management Server cluster deployment section Reconfiguration of YSoft SafeQ Site Servers to connect to all YSoft SafeQ Management Servers.

  6. If the reinstalled node was the one on which the YSoft SafeQ 6 license was activated, re-activate the YSoft SafeQ 6 license using your preferred method (online/offline). See Management Interface - License Activation for detailed instructions.

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

  8. Restore the 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 backup.

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

If the YSoft SafeQ Spooler Controller that is installed on this server is connected to a Spooler Controller Group, continue with the following steps:

If the failover for Embedded Terminals is being used and the 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.

Check the number of Site Servers forming the Spooler Controller group using JConsole

Please do no change anything in the MBeans tab. Just check the values in the Attributes leaf.

  1. Run <SAFEQ_DIRECTORY>\SPOC\utilities\sqjconsole.bat

  2. Connect to a Site Serverthat is a member of the target Spooler Controller group on port 9999.

    images/download/attachments/160481858/New_Connection.PNG
  3. Confirm the Insecure connection.

    images/download/attachments/160481858/Insecure.PNG
  4. Switch to MBeans tab.

  5. Expand distCache > CacheManager > DefaultCacheManager > CacheManager and select Attributes.

  6. Check the value of clusterSize – it must correspond to the number of Site Servers in the desired Spooler Controller group.

    images/download/attachments/160481858/clusterSize_highlighted.PNG