Installing YSoft SafeQ CML

This page describes how to use the interactive installer to perform a basic YSoft SafeQ server installation. 

 

All nodes of the CML cluster have to be in the same timezone

Standard installation

 

1

Obtain and run installation file ysf-sq5-install.exe from YSoft Partner Portal. Once you have the file and the server is ready for installation, you can begin YSoft SafeQ installation.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: In order to install YSoft SafeQ, this file is required. It contains everything necessary for installing a fully functional YSoft SafeQ server.

2

Select a language that will be used for the installation process. This language will also be used as the default language for the YSoft SafeQ system.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: You can change the language for YSoft SafeQ at any time after installation is done.

images/download/attachments/21955405/inst_2.png

3

Close all other applications to avoid issues with updating the relevant system files.

images/download/attachments/21955405/inst_3.png

4

If you agree to all the license terms and conditions, click I Agree to continue. If you do not agree, click Cancel to quit the installation.

images/download/attachments/21955405/inst_4.png

5

After you accept the license agreement, the installer runs a preinstallation check. This procedure checks several conditions and determines if the server meets all requirements for YSoft SafeQ installation.

If any of these conditions are not met, they will be displayed in either the Show warnings or Show problems area, depending on their severity. If there are warnings, installation can continue. If there are problems, installation cannot continue. If any warnings or problems are indicated, review the warnings and resolve the problems, then continue.

The conditions the installer checks are:

    • Correct version of Windows

    • User installing YSoft SafeQ has administrator rights

    • Version of .NET (must be .NET 4.5.1 or higher)

    • Version of Windows Installer (must be 4.5 to install MS SQL)

    • All required ports are open and free

    • Enough available disk space

    • Enough available system memory

    • Presence of a previous version of YSoft SafeQ

images/download/attachments/21955405/inst_5.png

6

The installer now displays YSoft SafeQ installation settings.

To use the default installation settings:

    • Accept the default YSoft SafeQ server installation folder, database engine, and IP address.

    • Check Use server hostname and provide host name of your server. CML web will be reachable under this host name.
      This configuration serves as protection against DNS rebind attack.

To use values other than the default ones:

images/download/attachments/21955405/2016-11-23_13_57_00-10.0.13.137_-_Remote_Desktop_Connection.png

7

If you chose the default installation, the installer displays the account name and password for the database. The password is automatically copied to the clipboard. Save this password to a safe place so that you can either use it when you need it or change it if you want.

Click OK.

images/download/attachments/21955405/inst_7.png

8

The installer begins to copy all the files required by YSoft SafeQ and the database system you chose to the selected destination folder on the server. In case you wish to see detailed installation progress, press Show details button (or D key).

images/download/attachments/21955405/inst_8.png

9

The last page of the wizard informs you about the results of the installation process and gives you the option to display the YSoft SafeQ Web Interface. Click Finish when you are ready to close the installation wizard.

images/download/attachments/21955405/inst_9.png

10

Installation is now complete. You might also want to check firewall and antivirus settings.

Troubleshooting the installation process

If an error occurred during the installation process, please check the following log files that were created during the process. All the installation log files are located in the YSoft SafeQ installation folder.

  • pginstall.log - contains information about PostgreSQL installation (if you selected PostgreSQL as the database to install).

  • sqinstall.log - contains information about the entire YSoft SafeQ installation process.

Additional logs can be obtained from AppData\local\Temp\1\ of currently logged user.

Customized installation or adding / replacing node

6a

If you wish to use values other than the default settings, check I want to customize my YSoft SafeQ installation.

images/download/attachments/21955405/instx_6a.png

6b

You can select witch node you want to install.

 If you want to install master node select Install a new YSoft SafeQ server (or the first node of a YSoft SafeQ cluster) and continue by click "Next"

 If you want to add node to existing cluster, select Add or replace a node in an existing YSoft SafeQ cluster, enter Cluster master node IP address and after clicking Retrieve node list select Add new node option.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: When you add new node to cluster in environment with ORS servers, configuration of ORS servers must be adjusted to communicate with new CML server too.

 images/download/attachments/21955405/instx_6b.png

6c

You now have the option to select your own installation location. You can install YSoft SafeQ anywhere other than a UNC path or the root folder of the drive.

images/download/attachments/21955405/instx_6c.png

6d

Choose the database that will be used by YSoft SafeQ:

  • the default Embedded PostgreSQL 9.2.x

  • Bundled Microsoft SQL Server 2012 Express Edition (if Windows Installer version 4.5 or higher is present)

  • Use an existing external database server which you can choose if you already have MS SQL 2008 or 2012 or PostgreSQL 9.2.x database with enough capacity to hold the YSoft SafeQ database.

  • Same database type must be installed on all CML nodes. In the case that 1st node is installed on PostgreSQL DB, installation of second node (and all others) is allowed only for PostgreSQL (MS SQL installation is disabled). 
    images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: For database synchronization the user named sync must exist. Users sync rights settings: sysadmin or Read/write rights for SQDB5 and SQDB5_SQDW. See how to create sync user on external MS SQL server.

images/download/attachments/21955405/instx_6d.png

6d1

In case of Embedded PostgreSQL or Bundled Microsoft SQL Server you must specify password for database user and sync user. Passwords must be entered twice to avoid problem with potential typo.

You can use Generate password buttons to generate passwords for database user and sync user. On button click, password is generated and copied into the clipboard.

images/download/attachments/21955405/instx_6d1.png

 

In case you selected embedded Microsoft SQL Server 2012 Express edition, password must meet minimum password strength as described here:

Strong passwords cannot use prohibited conditions or terms, including:

  • A blank or NULL condition

  • "Password"

  • "Admin"

  • "Administrator"

  • "sa"

  • "sysadmin"

A strong password cannot be the following terms associated with the installation computer:

  • The name of the user currently logged onto the machine.

  • The computer name.

Password must not contain  =;"<>:@%&`\'\\

 

 

6d2

In case of External database you must specify information about connection.

images/download/attachments/21955405/instx_6d2.png

6d3

Enter names for YSoft SafeQ databases.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Database names should not contain special characters or white spaces.

images/download/attachments/21955405/instx_6d3.png

6e1

If you are installing additional node you have to enter master node IP address, retrieve node list information and click "add new node".

images/download/attachments/21955405/instx_6e1.png

6e2

Enter YSoft SafeQ admin credentials from master node to perform database dump during installation process.

This step is skipped in case of using external database.

images/download/attachments/21955405/instx_6e2.png

6f

The last page of the wizard presents you with the following settings:

    • Local GUID for currently installing CML server (node).

    • TCP port that the YSoft SafeQ Web Interface will use.

    • HTTPS TCP port for YSoft SafeQ Web Interface.

    • Install the Terminal Server: To install Terminal Server, check the checkbox. To not install it, leave the checkbox empty.

    • Start YSoft SafeQ services after the installation is finished: To start services after installation, check the checkbox. To not start services, leave the checkbox empty.

    • Enable support for embedded IIS web server: To install IIS web server, check the checkbox. To not install IIS web server, leave the checkbox empty.
      IIS web server is required to use embedded hostable web core (HWC) web server inside Terminal Server. HWC web server is suitable for environments with a lot of devices on one node (e.g. up to 400) or for customers that experience problems with the legacy web server mainly for stability reasons (unexpected crashes). It provides best performance and stability, that is not achievable with any other embedded web server solution. This option is also required for the YSoft SafeQ Embedded Terminal for Ricoh.
      images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Checkbox for web role installation appear, only on systems which supports IIS 7 or higher (Windows Server 2008, 2008 R2 and 2012)

images/download/attachments/21955405/instx_6f.png

6g

During the installation process, the pop-up window is displayed, asking user to backup the database from master node and restoring it on a slave node (the one you are installing at the moment). DO NOT make a database backup, until the pup-up window is displayed or else the installation will fail. The database backup file will not contain all records, necessary for proper function of SafeQ 5 cluster.

7

When installation is finished, please restart YSoft SafeQ CML and YSoft SafeQ CML DBS services on all previously installed nodes.

 

Using the file update.conf

When installation is complete, a <SAFEQ_DIR> \conf\update.conf is created with preconfigured database configuration options. The file update.conf is deleted after the options it contains are updated. You can create this file anytime you want to change multiple configuration options stored in a database. Restart the YSoft SafeQ CML service to process the file. When you use update.conf, keep in mind the following rules:

  • The file cannot contain configuration options that are stored in the files startup.conf, cmldb.conf, cmldb-sqdw.conf, and cmldb-cluster.conf (otherwise the service will not start).

  • You can create the file whenever you need it; you can also use it for preconfiguring your installation, but changes are applied only after the YSoft SafeQ CML service is restarted.

  • The file cannot contain a new configuration. If you want to add a new configuration option: in the YSoft SafeQ Web Interface, use System Settings > Add new item.

  • The file updates only values. To change any other setting, such as a required restart or applying an update on a subsystem, you must use the YSoft SafeQ Web Interface.

  • Listed configuration options are referenced by their internal name. The format in the file is internal name = value. You can find internal names on the System Settings page.

  • If update.conf is used in clustered environment, all other CML nodes have to run and be available to CML node where update.conf is applied.