Installing YSoft SafeQ using bundle installer

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

  • Bundle installer allows you to install YSoft SafeQ CML, YSoft Payment System and YSoft Mobile Print Server at once without need of further steps to interconnect the installed components. Therefore, some of advanced installation options are not available in the bundle installer. The installer is dedicated for installations of single CML node environments with all components installed on one server.

  • The bundle installer does not support upgrade from YSoft SafeQ 4.

Standard installation

1

Obtain and run installation file  ysf-sq5-bundle-installer.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: This file contains everything necessary for installing a fully functional YSoft SafeQ server, YSoft Payment System and YSoft Mobile Print Server.

2

Select a language that will be used for the installation process. This language will also be used as the default language for all installed components.

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

images/download/attachments/34254540/aio_install_lang.png

3

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

images/download/attachments/34254540/aio_install_first.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/34254540/aio_install_license.png

5

Please choose destination folder where YSoft SafeQ and other components will be installed. You can choose any destination other than a UNC path or a root folder of a disk drive.

images/download/attachments/34254540/aio_install_path.png

6

Now you can select which components will be installed together with YSoft SafeQ which installation is mandatory. The options are:

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: To get all components fully working, you have to obtain license which will contain support for these components. Otherwise, you will not be able to use these components.

images/download/attachments/34254540/aio_install_components.png

7

After selecting the components to install, the installer runs a system readiness 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

  • Administrator rights for user account under which installer is running

  • 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 components that were selected to be installed

images/download/attachments/34254540/aio_install_preinstall.png

8

Choose the database that will be used by YSoft SafeQ and also YSoft Payment System, if the latter was selected to be installed.

    • If selecting Embedded database server type continue to step 9a. Based on database vendor selection PostgreSQL 9.2 or Microsoft SQL Server 2012 Express Edition database engine will be installed.
      images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Installation of embedded Microsoft SQL Server 2012 Express Edition database engine is possible only if Windows Installer version 4.5 or higher is present 
       

    • If selecting External database server type continue to step 9b. Based on the database vendor selection, a connection can be set up to an existing PostgreSQL 9.2.x or Microsoft SQL Server database engine. Chosen engine have to have enough capacity to hold the YSoft SafeQ and YSoft Payment System database.

images/download/attachments/34254540/Untitled.png

9a

If you have selected  Embedded database server type in step 8, now you have to 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/34254540/aio_install_dbpass.png

In case you selected embedded Microsoft SQL Server, 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  =;"<>:@%&`\'\\ and whitespace characters.

9b

If you have selected  External database server type in step 8, now you can set up connection to an existing PostgreSQL 9.2.x or Microsoft SQL Server 2008, 2012 or 2014 database engine by specifying following values (image below describes connection to Microsoft SQL Server):

  • Server hostname or IP address where one of the supported database engines are installed and running

  • Port number or Instance name on which the database engine is running

  • Database username and password. This user have to be the database administrator. Domain users are not supported by bundle installer.

To verify connection to external database, use Test connection button.

images/download/attachments/34254540/aio_install_connection.png

10

If you have also selected the YSoft Mobile Print Server to be installed, set up connection to an external email server by specifying following values:

  • Server hostname or IP address where email server is installed and running

  • Email account and password, where jobs to print will be sent

  • Email protocol and port which will be used for connection of the YSoft SafeQ to the YSoft Mobile Print Server

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: When using a server hostname instead of an IP address (e.g. "mail.domain.com"), do not use domain name again in Email account username field (use "user", not "user@domain.com").

images/download/attachments/34254540/aio_install_mps.png

Example 1

  • Server hostname = mail.domain.com

  • Email account username = user 

Example 2 

  • Server IP address = 10.0.0.1

  • Email account username = user@domain.com

11

Installation options page presents you with the following settings:

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

  • You can also select Network interface which will be used for communication for all installed components.

  • At last you can create exceptions in Windows Firewall for all ports which are used for incoming and outgoing communication by all installed components
    images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Firewall exceptions will be created only in default Windows Firewall. No changes are applied to third party firewalls.

images/download/attachments/34254540/aio_install_guid.png

12

Summary page informs you about the selected:

  • components to be installed and their version

  • database engine which will be used

  • destination folder where all components will be installed

If all parameters meet your requirements, you can start installation by clicking Install button.

images/download/attachments/34254540/aio_install_summary.png

13

The installer starts to install all selected components and the database engine (in case of embedded database type was selected) to the selected destination folder on the server.

In case you wish to see detailed installation progress, press Show details button (or user Alt+D shortcut).

images/download/attachments/34254540/aio_install_progress.png

14

The last page of the wizard informs you about results of the installation process. Click Finish when you are ready to close the installation wizard.

Installation is complete. Now you can start using all the installed components of YSoft SafeQ.

images/download/attachments/34254540/aio_install_last.png

15

Once the SafeQ license is activated, all SafeQ services needs to be restarted.

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.

  • aio-install.log - contains information about steps performed during installation readiness check

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

  • payment-install.log - contains information about YSoft Payment System installation process

  • mps-install.log - contains information about YSoft Mobile Print Server installation process 

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