Software requirements
Supported operating systems
Operating System | CML | ORS | Mobile Print Server | AP Connector | CRS | Payment System |
Microsoft Windows Server 2008 R2 SP1 64bit all editions | ||||||
Microsoft Windows Server 2012 64bit all editions | ||||||
Microsoft Windows Server 2012 R2 64bit (Standard/Datacenter edition) | ||||||
Microsoft Windows Server 2016 64bit all editions | ||||||
Microsoft Windows Server 2019 64bit all editions | ||||||
Microsoft Windows Small Business Server 2011 Standard | ||||||
Microsoft Windows 7 SP1 32bit/64bit* | ||||||
Microsoft Windows 8 32bit/64bit |
* Workstation operating system has limited number of incoming connections
Notes
Installation of CML with embedded MS SQL database is not supported on server core editions.
YSoft SafeQ CML supports Microsoft Server Cluster (MSCS).
Using embedded terminals on YSoft SafeQ CML (embedded terminals connected to CML) always requires Microsoft .NET 4.8 or higher.
Note: If you do not install Terminal Server component, Microsoft .NET 4.8 or higher is not required; embedded features will not be available.
Using embedded terminals on YSoft SafeQ ORS (embedded terminals connected to ORS) always requires Microsoft .NET 4.8 or higher.
See Installing YSoft SafeQ CRS for additional requirements of the YSoft SafeQ CRS.
YSoft SafeQ 5 Server does not support Linux.
Microsoft Windows Server 2019 is fully supported since YSoft SafeQ 5 MU81.
Supported databases
Component | Supported data engine |
YSoft SafeQ 5.0 ORS | No database required (internal persistent cache). |
YSoft SafeQ 5.0 CML Server | PostgreSQL 9.2 embedded or standalone Microsoft SQL Server 2008/2012 Express edition (up to 10 devices per server)* Microsoft SQL Server 2008/2008 R2/2012 (including all Service Pack versions)/2014/2016/2019 Standard or Enterprise Edition, 32-bit or 64-bit *Not recommended for use with CML server cluster. |
YSoft SafeQ 5.0 CRS | |
YSoft Payment System | PostgreSQL 9.2 embedded or standalone Microsoft SQL Server 2008/2012 Express edition Microsoft SQL Server 2008/2008 R2/2012/2014/2016/2019 Standard or Enterprise Edition, 32-bit or 64-bit |
Microsoft SQL Server 2012/2014/2016/2019 offers AlwaysOn Availability Group or AlwaysOn Failover Cluster. This functionality is not supported by SafeQ.
“MS SQL in active-passive cluster with AlwaysON Availability Group stores a hostname of currently active DB server node in SYS.SERVERS table. SafeQ DB validator expects that SYS.SERVERS table contains the same DB server hostname as dbURL setting in cmldb.conf.
As dbURL needs to contain a virtual hostname of the DB cluster, there is a conflict and DB validator refuses to start CML. DB validator behaves this way because it tries to verify that DB server hosting SQDB5 and DB server hosting SQDB5_DW (may be different) are linked and thus SafeQ is able to execute stored procedures remotely.“
An (insufficient) workaround exists: Manually rewrite SafeQ config file to contain the hostname of currently active SQL cluster node. Requires manual change with every DB cluster failover which is usually not acceptable.
As we still require a simple recovery model and such mode is not compatible with AlwaysOn feature
Required database settings
Simple recovery model is set
http://msdn.microsoft.com/en-us/library/ms189275.aspx : The following features cannot be used in simple recovery mode: AlwaysOn or Database mirroring
Database instances and connection
YSoft SafeQ CML requires a stable connection to the database server for its proper functionality.
YSoft SafeQ CML server requires two databases:
one is used for real-time access, configuration and active job data
second is used as data archive, primarily for reporting and data audit
YSoft SafeQ application level cluster requires two databases for each CML server. All databases can be on the same database server (highly available SQL server is mandatory in this case)
Connection to the SQL server is realized on the Java level using secured JDBC connection (integral part of the application)
YSoft SafeQ will not work if the connection to the database server and its databases is not available, even in the case of short, intermittent outages.
Database sizing
Example based on real customer data (10 million pages per month):
CML Database: 16 GB per SafeQ server
CRS Database SQL: 100 GB aggregated DB (after 3 years)
CRS Database OLAP: 100 GB aggregated DB (after 3 years)
Database settings and configuration
YSoft SafeQ provides automated database maintenance tools. Scheduled database maintenance is strongly recommended. The following configuration is required for different database types.
Common settings:
Login credentials for YSoft SafeQ access, with ownership rights to its database
Collation case-insensitive
Reliable low-latency network connection (if the DB server is on another server)
Microsoft SQL Server configuration:
Correct collation: Case-Insensitive and Accent-Sensitive (language_CI_AS) where applicable
The user that YSoft SafeQ uses to connect to the databases must have the default language set to English (but not British English) in the SQL Server
Enabled TCP/IP connection or named pipes
Enable Simple recovery model
Connecting to SQL server that requires encrypted connection is supported, however requires several manual steps (see comments).
To install YSoft SafeQ 5.0 the following database role is required: db_owner.
To update/upgrade YSoft SafeQ 5.0 the following database role is required: db_owner.
To run YSoft SafeQ 5.0 the following database roles are required: db_datareader, db_datawriter, db_ddladmin.
For the installation to an MS SQL server, there must be two accounts created. One can be named in any way, name of second account is "sync" and this name is mandatory.
The two accounts must either both be domain accounts or both SQL accounts (mixing both types is not supported).
In case of installation to a named instance of the external MS SQL server, the service "SQL Server Browser" must be configured and running on the SQL Server.
In case that you are going to use the external MS SQL server with named instance, you will need following to be allowed between SafeQ server and MS SQL server:
a) UDP, both directions, local port on MS SQL server is 1434. This communication is used to query the SQL server (its SQL Browser service). The SQL Browser service will respond and inform the requester about the port it shall connect to via TCP.
b) TCP communication, direction from SafeQ to SQL, port "random". The port number is dynamically assigned by the SQL Browser service (http://technet.microsoft.com/en-us/library/cc646023.aspx).
PostgreSQL configuration:
UTF-8 collation
9.2 version only
Non-local-admin account for running PostgreSQL system service (Windows OS)
To install, update or run YSoft SafeQ 5.0 CML Server database user postgres and sync must have superadmin role.