Installing YSoft SafeQ ORS

 

To install YSoft SafeQ ORS (Offline Remote Spooler), use the installORSv2-exe.cmd installation script. By default the installer installs YSoft SafeQ ORS in the C:\SafeQORS directory. The installer generates the global identifier (GUID) for the ORS server and places it in the configuration file guid.conf. If this file already exists in the target location, the existing GUID is preserved and will be used.

 

 images/download/attachments/14976741/warning.png Do not install YSoft SafeQ ORS on the same server where YSoft SafeQ CML is running.

Configuring settings in the Safeq-ors.ini file

Before beginning the installation, edit the file safeq-ors.ini (included in the installation package). Below is a description of most important configuration attributes.


1

For a new YSoft SafeQ ORS installation with an already assigned GUID, enter the GUID in the parameter localGUID:images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Use this parameter only if you want to install YSoft SafeQ ORS on a server with a specific GUID, typically for a server crash recovery, in which case it is necessary to keep the original GUID that was on the ORS server before the accident. The detailed instructions for the recovery of the ORS can be found in ORS - Recovery procedure.

 

localGUID= <NEW_ORS_GUID>

2

Set the GUIDs, IP addresses, and ports for communication with YSoft SafeQ CML servers.

  • CML server GUIDs were created during YSoft SafeQ CML installation. They can be found on respective web interface of each CML server in System info widget.

    images/download/attachments/21955384/cml_guid.png
  • Another option to locate GUID of the CML server is in the value of the property localGUID which can be found in <SafeQ_DIR>\conf\startup.conf configuration file of respective CML server.

  • Do not change the port for communicating — keep it as 6010.

  • Add the IP address or DNS name of the YSoft SafeQ CML server.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg It is always necessary to fill in details for all CML servers in your CML cluster.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg If you do not have all four CML servers in your environment, delete redundant rows (e.g. serverGUID4, serverPORT4, serverIP4) or comment them by putting ";" mark in front of them.

serverGUID1= <FIRST_NODE_GUID>
serverPORT1= 6010
serverIP1= <FIRST_SERVER_IP>
serverGUID2= <SECOND_NODE_GUID>
serverPORT2= 6010
serverIP2= <SECOND_SERVER_IP>
Example
serverGUID1=BB6FBF1-8388-47C9-8679-47D846E4AA2
serverPORT1=6010
serverIP1=10.0.10.50
serverGUID2=1EC0A9D8-5488-4B05-B7B1-52B8C829437B
serverPORT2=6010
serverIP2=10.0.10.51
;serverGUID3=
;serverPORT3=
;serverIP3=
;serverGUID4=
;serverPORT4=
;serverIP4=

3

Define directory for the installation of YSoft SafeQ ORS by setting the following parameters:

targetDir = <PATH>
Example
targetDir=C:\SafeQORS

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Use backslash as directory divider.

 

4

You can also set the location of these directories:

  • spoolDir = The folder where print jobs are stored.

  • parserTemp = The folder where every print job is temporarily stored during the receive process.

  • cacheDir = Cache folder on the ORS.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If you do not enter these directories, the default values will be used: <targetDir>/server/spool, <targetDir>/server/temp, <targetDir>/server/cache.

 

5

Another parameters in the SafeQ-ors.ini file are for configuring the SMTP server. The SMTP server is used for sending scanned documents to users and for sending notifications to users. In the configuration file, enter the IP address or DNS name of the SMTP server, IP address or DNS name of the backup SMTP server, sender's e-mail, and login to SMTP server (if required).

smtpServer= <SMTP_SERVER_IP_ADDRESS>
smtpServerBackup= <BACKUP_SMTP_SERVER_IP_ADDRESS>
emailSender= <EMAIL_SENDER>
smtpUser= <SMTP_USER>
smtpPassword= <SMTP_PASSWORD>

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If you do not enter these settings, values will be obtained from CML server setting.

Example
smtpServer= 10.0.0.1
smtpServerBackup= 10.0.1.1
emailSender= sender@safeq.com
smtpUser= smtp_user
smtpPassword= secret_password

6

ORS Web Server serves several functions: interface for desktop client, scanning using webdav, Mobile Print Server services. It is possible to change port for HTTP and HTTPS communication (These two ports are mandatory). YSoft ORS Web server service won't start if either one of these ports is blocked.

webServerPort= 80
webServerPortHTTPS= 443 

 

 

7

Optionally, the base URL of YSoft SafeQ Web interface can be entered. If set, it is used to access YSoft SafeQ web interface from YSoft SafeQ Client.

Trailing slash is not allowed here. Valid examples: http://hostname.example.com, http://10.10.20.20:8080, https://secure.example.com.

safeqWebBaseUrl = https://secure.example.com

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg It is recommended to leave this value empty (default) for most installations.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg It may be used to configure custom host name for YSoft SafeQ Client to match the SSL certificate of YSoft SafeQ ORS server (see Configuring SSL/TLS for Web interface).

 

8

In case you prefer to use Hostname instead of IP address for the local machine address, modify configuration of parameter useHostname. If set to 1, variable "smartQ-server-ip" in file "ors.conf" is set to local host name instead of local IP address

useHostname= 0

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg The DNS name resolution and the reverse lookup for the ORS server must be functional.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg If the ORS server is part of a domain, FQDN will be used instead of the host name. The DNS suffix must be configured properly in your network.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg The FQDN hostname address is used only for purposes of ORS. Internal communication between SafeQ subsystems (for example ORS<->CML) is always based on IP addresses (even when useHostname=1).

 

9

Terminal server is required for communication between YSoft SafeQ and embedded terminals. If you are not using embedded terminals at all, you can disable installation of Terminal server by configuration parameter installTerminalServer. Default value is to have Terminal server installed.

installTerminalServer= 1

 

10

Terminal server leverages Hostable web core of the IIS. By modifying pf parameter enableHwcSupport you can set whether all necessary system components shall be set automatically or you want to do so manually according to Configuring Terminal Server web server.

enableHwcSupport= 1

images/download/attachments/21955370/warning.png Installation of web role for embedded IIS web server may take several minutes depending on system usage and configuration.
 

 images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/forbidden.svg Warning

If port 80 is selected in the installer for ORS web interface, then IIS site called "Default Web Site" is deleted from IIS after installation as the site overrides system settings and uses port 80 instead of SafeQ web interface. If IIS was already installed before and you select this option, please make sure that no important site named "Default Web Site" is configured in external IIS otherwise it will be deleted.

YSoft SafeQ ORS installation

Before you begin, make sure you have modified the safeq-ors.ini file for your local conditions in the currently installed environment, even when performing an update.

 

Start the installation by running installORSv2-exe.cmd 

 

To install YSoft SafeQ ORS with specific configuration for HW terminal updates, copy your modified safeq.fwupdate.conf into the directory containing the YSoft SafeQ ORS installation files and run the setup file with an additional parameter:

installORSv2-exe.cmd safeq.fwupdate.conf.

YSoft SafeQ ORS service check

When you complete the configuration and installation procedures, check to be sure the YSoft SafeQ ORS server service is running. On the YSoft SafeQ ORS server, open Services (for example: Start > Run > services.msc) and check the following services:

  • YSoft SafeQ ORS

  • YSoft SafeQ ORS Web Service

  • YSoft SafeQ Terminal Server (only if installed)

 

For more intensive check, proceed with YSoft SafeQ ORS Health Check.

Troubleshooting the ORS installation

In case that ORS installation is failing, search the following places for more information about the failure:

  1. Install-ORS.log

    • log is created in the directory with ORS installation packages

  2. application event log

    • see the log on a computer where ORS installation has failed. Some MSI Installer related messages may be logged here

  3. cml.log

    • log is stored in folder <SafeQ_dir>\logs that can be located on the CML server, which was specified in safeq-ors.ini ServerIP field

  4. ors.log

    • log is stored in folder <SafeQ_dir>\logs that can be located on the ORS server. Check this log if installation was successful but ORS server is can not start