Updating Using the Server Installer

This page describes how to update the YSoft SafeQ installation using the server installer. This procedure is valid for First Server, Additional Management Server, and Site Server deployments.

General Information

• The installer detects the previous installation and informs the user that an update instead of a clean installation will be performed.

• The update does not allow the changing of any system configurations, it updates the environment as-is.

The update procedure can be summarized as several steps:

1. The installer stops all running services.

2. The new version is deployed.

3. A configuration that may contain user data is restored.

4. Services are started again.

Order of Update

1. Update Management Server or one of the Management Server cluster nodes first.

2. Update the remaining Management Server cluster nodes one by one (i.e., start the update of the second node after the update of the first node has finished).

3. Update Site Servers after the update of Management Server(s) is finished.
   

Preparation

Download the installation package

Download the server installer archive from the YSoft Partner Portal.

1. Use ysq-server-install.zip or YSoft-SafeQ-6-MUXX-Server-installer.zip for deployments without an OCR engine.

2. Use ysq-server-ocr-install.zip or YSoft-SafeQ-6-MUXX-Server-installer-with-Advanced-workflows.zip for deployments with an OCR engine.

Extract the archive

1. Extract the archive with the installer to your disk.

2. The installer consists of one main executable file (SafeQ6.exe) and several component installers located in the bin subfolder.

3. Run the main executable file.

Updating Using the Installer Wizard

Run the executable file.

Choose the language

• The installer uses the selected language to communicate with the user with the exception of text coming directly from the OS, which is dependent on the OS language. Typically the YES, NO, and OK buttons.

• The number of languages depend on the localization scope for each installer.

• The default language is English.

Welcome page

• The user is notified that a wizard-like setup will guide them through the installation process.
  

License agreement

• The License Agreement shows the standard Y Soft EULA.

• The user has to Agree with EULA content in order to continue.

Destination folder

• The YSoft SafeQ 6 installation in the following directory will be updated.

• The folder's path must consist of ASCII characters only.

• At least 3.5 GB of available space is required.

Preinstallation check

• The preinstallation check performs a series test to verify if the server environment is suitable for the installation.

• The installer checks that the license in the database has valid software support and disallows the update if the validity criteria are not met. License validation result is saved in ${INSTALL_DIRECTORY}/license-validator.log. If access to the database fails, copy the encrypted license from the activation portal or the "data" field of database table tenant_1.license to ${MGMT_directory}/conf/license.xml and run the installation again.

• The installer process has Administrator rights.

• The Server OS is intended for servers (not Windows 7,8,10, etc.).

• .Net Framework is available in a suitable version.
  

Update summary

• The user is shown a summary where both the old and new version numbers are displayed.

• Only assembly files will be changed, the user data and configuration remain unchanged.

Backup page

• The whole installation folder is backed up to the specified location, based on the ‘Backup data’ checkbox

• The folder's path must consist of ASCII characters only and cannot be empty.

Installation progress

• The update continues in a similar manner as a clean installation.

• The update's progress is shown in the form of a progress bar.

• The user can monitor update activities.

• An explanatory error message is shown if the update fails.

Backup and installation finished (optional)

• After an update with a backup the installer provides three options for the administrator. These are:

  • restore the previous installation from the backup (even for successful installation),

  • delete the backup and finish the update,

  • keep the backup and finish the update (default).

• The restore option gives the administrator the opportunity to check the installation and verify the update in a real use-case scenario, while keeping the installer open for a possible backup.

Restore/Remove backup progress (optional)

• Based on selection from the previous screen the restore or backup removal progress is shown on this page.

• After the restore finishes, the administrator has a choice for either keeping or deleting the backup on a next screen.

• After the backup deletion finishes, the installer moves to the Installation finished page.

Installation finished

• The user is informed that a new version of YSoft SafeQ was successfully installed and it is possible to safely exit the installer.
  

Updating Using the Silent Installer

An unattended update does not support altering any aspects of the already deployed and running environment. Customer data and the configuration remain as unchanged as possible.

Run the unattended update by executing the installer binary file from any command-line-like tool: 

SafeQ6.exe /S

On silent runs where an existing installation is detected, the installer can create a pre-install backup of the product tree under the configured install root before deploying the new version. If deployment fails, the installer restores from that backup by default (unless restore is explicitly disabled). The following switches control this behavior:

/SkipBackup

• Meaning: Disables the pre-install file backup for this run (nothing is copied to a backup folder before deployment).

• Interaction with other parameters: If /SkipBackup is present, /CFG:backupLocation= is ignored (the installer does not parse backupLocation when skip-backup is active). Because no backup is created, post-failure restore is not performed.

SafeQ6.exe /S /SkipBackup

/SkipRestore

• Meaning: Disables automatic restore-from-backup after a failed silent deployment.

• Default behavior if omitted: Automatic restore is attempted on failure when a backup exists.

• Interaction with other parameters: If /SkipBackup is also present, restore is not performed regardless of /SkipRestore (no pre-install backup exists to restore from).

SafeQ6.exe /S /SkipRestore

/CFG:backupLocation=<path>

• Meaning: Folder where the pre-install backup should be written for a silent upgrade (previous version present).

• If omitted: The installer uses the default pattern <OEM install root>Backup\<previous product version>(i.e. C:\SafeQ6Backup\<version>).

• Constraints: The path must be non-empty, the installer must be able to create the directory (if needed), and the location must be writable. If validation fails, the installer aborts.

SafeQ6.exe /S /CFG:backupLocation="C:\MyBackups\SQ6SilentBackup"