ORS - Recovery procedure

This section describes how to recover the failed ORS server.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If the ORS server is not operational for a longer period of time, you can use the procedure from ORS - Printing without ORS server - ORS server Failure to sustain the printing functionality.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg All CML servers must be running and functional when performing procedure.


This article consists of:

Requirements

Kindly prepare all the required data before starting ORS server recovery:

  1. ORS installation package

  2. ORS configuration files

  3. SPOOL folder backup from the ORS (optional)

    • images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If the spool backup is not available, jobs stored on failed ORS will be lost and users will have to send them for print again.

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

Step 1- restore hardware after server failure (optional)

Restore hardware required for YSoft SafeQ server.

Step 2 - restore software after server failure

1

Install one of the supported Operating Systems for YSoft SafeQ ORS server

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg   Make sure that server has the same IP address and hostname settings as before the failure. In case IP address or hostname changes, it is necessary to change it also via YSoft SafeQ web interface before the start of ORS installation. The ORS IP address can be changed in parameter "Spooler IP address" in the same window as "Spooler GUID" described below.

Step 3 - install and configure the new server


1

Verify the ORS cache recovery settings.

Go to System settings and set orsCacheRecovery property to enabled
images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/information.svg  In case of ORS cache data corruption, cache can be manually deleted and all job-related metadata will be recovered from CML. If this option is enabled, job consolidation will not be run during ORS startup.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE:  If you omit this step, all jobs stored on the ORS will lost after the end of procedure.

2

Obtain localGUID of failed ORS server.

ORS localGUID of recovered ORS must be exactly the same as the GUID on the failed ORS server. There are two ways to obtain the GUID of failed ORS:

a. localGUID can be taken from ORS configuration file <SafeQORS>\conf\module\guid.conf from parameter localGUID

b. localGUID can be taken from YSoft SafeQ CML Web Interface => Devices => Printers => Edit ORS that you are recovering and see value at Spooler GUID

images/download/attachments/21955740/07.png

 

3

Copy ORS installation package to the new 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.

 

 

 

4

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg  
        This step is optional. If not performed users would need to reprint their jobs (all missing jobs are marked as deleted)

 

Copy the spooler folder from the failed ORS server to the new location.

  • The spooler folder on failed server is stored in directory specified in <ORS_HOME>\conf\module\ors.conf as spoolDir

  • The new spooler folder location is specified in safeq-ors.ini in the installation package by parameter spoolDir. If left empty, <targetDir>/server/spool is used instead

5

Run installation of ORS server using installORSv2-exe.cmd and wait for installation to finish.

 

 

Step 4 - verification of the functionality

This section describes what additional steps must be performed for a proper functionality of the YSoft SafeQ once the ORS was moved to a new location.

1

Verify the correct ORS functionality according to the article YSoft SafeQ ORS Health Check.

 

2

Verify that you are able to release the jobs that were delivered to the ORS before the ORS has been restored. Perform this step only if you restored the spool directory.