.png)
Upgrade to Central Server 10.2
This section will describe the upgrade procedure for the Central Server.
There are two different software packages which are referenced as the Central Server:
Print Server with the Central Server mode enabled (Central Server < 8.2).
Central Server (Central Server => 8.2).
First of all, identify the mode you are using. These two products have different methods for upgrade.
Central Server < 8.2 version: The Print Server with enabled Central Server (or formerly Master Server) in Settings > Server Type uses the standard Print Server installation package and the embedded Firebird database engine.
Central Server => 8.2: The Central Server is a standalone software with a separate installer and can only be used in the Central Server mode, not as a Print Server. It offers either Firebird database or Microsoft SQL Server database engines.
Print Server in the Central Server Mode
Since version 8.2, it is not possible to use the Print Server in the Central Server mode. The upgrade will not be permitted by the installer software if you are trying to upgrade this type of Central Server.
Install the Central Server 8.2 first and proceed with the migration process to convert the current installation of the Print Server to the Central Server.
Please, consult the Central Server version 8.2 guide for more information about the migration from the Print Server to the Central Server.
Central Server
This section will describe the upgrade procedure of the Central Server.
See other sections of this document if you want to upgrade to a different installation or contact your support representative to get more information.
The minimum supported version of Site servers is 8.2.
Older site servers must be upgraded first to version 8.2 or higher to be compatible with the 10.2 Central Server.
Upgrade Requirements
Before upgrading, verify that your server meets the hardware and software requirements and that the support license is valid.
Software Requirements
Operating system
Windows Server 2016 64-bit or higher (recommended).
Windows 8.1 64-bit or higher. Be aware of the connection limit of up to 20 clients.
MS SQL Server 2016 or higher (2017 or higher is recommended), if the MS SQL database is used.
Installation on a Desktop (non-Server) operating system like Windows 10 as well as a Domain Controller is not recommended.
To make sure that the system runs smoothly, you need to set an exception for both program and data folders in your antivirus settings.
.Net Runtime
Before the actual installation begins, the installation wizard will verify if required 3rd party components are installed on the server. If not, it will automatically download and install them. An Internet connection is required for this step.
Allow internet access to address http://redirect.myq.cz/* (* being a wild card) to allow download of these components.
You can also download and install all three required components manually:
.NET 8.0 Runtime which can be downloaded here.
Console apps
Desktop apps
Server apps
For Windows Server 2022 Core edition, it is necessary to install the Server Core App Compatibility Feature on Demand.
It can be installed from PowerShell as a Windows Update using this command: Add-WindowsCapability -Online -Name ServerCore.AppCompatibility~~~~0.0.1.0and then restarting the server.
Hardware Requirements
MyQ Central Server with integrated Firebird database
CPU: 6 cores
Memory: 8 GB RAM (10 000 users) – 12 GB RAM (50 000 users) - 16 GB RAM (100 000 users)
MyQ Central Server mode with external MS SQL database
CPU: 4 cores
Memory: 4 GB RAM (10 000 users) – 6 GB RAM (100 000 users)
Server with MS SQL database
CPU: 6 cores
Memory: 12 GB RAM (10 000 users) – 24 GB RAM (50 000 users) - 36 GB RAM (100 000 users)
Disk: 10 GB plus additional storage for replicated data, logs, and backups. The recommended size is at least 50 GB.
We strongly recommend using an SSD hard drive for the installation of both the program and data parts of the application.
Support License Requirements
The required support license validity is 1 April 2023.
It is necessary to have a valid support license before proceeding with the upgrade. Without a valid support license, the upgrade process will not be permitted, or some parts of the system will not work after the upgrade.
You can check the validity of your support licenses in Settings > License.
If the support license is not valid at least till the required date, do not start the upgrade. Activate the new support license first to prolong the support validity and do the upgrade afterward.
Minimum Version Requirements
The minimum version to upgrade from is 8.2.
If you are running an older version, please upgrade first to the latest available 8.2 release. Then proceed to upgrade to version 10.2.
Free Space Requirements
During the upgrade process, both databases (containing data and logs) are upgraded and modified to be compatible with the new structure of the application. During this process, the HDD storage requirements grow significantly as the database contents are copied to temporary files while the database engine works on the required changes.
Space required during the upgrade process can be up to four times the size of the actual databases.
Verify that both the system hard drive (which is storing the temporary files) and the drive used for the data part of the application have at least four times the storage space available than the total size of both data and log databases.
The size of the databases can be found in the Data folder of MyQ. By default, this is C:\ProgramData\MyQ Central Server, or it can be found in the Easy Config application in Settings > Data folder.
Files are named MYQ.fdb and MYQLOG.fdb.
In this example, we can see that the total size of both databases is about 330 MB, so for the upgrade process, the C: drive must have at least 1,3 GB of free space.
If the data folder was on the D: drive, then the same amount of free space is also necessary there because, by default, the temporary files are stored on the C: drive and both drives must have sufficient storage available.
In case the MS SQL database is used, the SQL Server handles the temporary databases, and the space requirements are not as large, but we still recommend having at least 2-3 the size of the SQL database of free storage on the disk.
You can use the MS Management Studio to determine the database size. This value is visible in the properties of the database.
Having insufficient storage will lead to unexpected issues during the upgrade. Not only will the upgrade process likely fail, but it may also present a threat to the whole operating system as all the available storage will be depleted.
Customizations and Custom Reports
If any customizations are running in the current installation – such as customized reports, scripts, or anything else that is not included in the standard setup, contact MyQ support first to verify whether they are compatible with the version you are upgrading to.
Customizations are always created for a specific version, and they depend on its resources. These resources may not be present in the newer version and so the custom content may not work after the upgrade.
After finishing the upgrade, verify the MyQ Main Log to observe any errors and warnings, including those about incompatible customizations, and also test the customized functionality yourself.
Important Changes in this Release
Please note, that version 10.2 has major functional changes compared to previous versions, that will affect certain functions of the system.
See the list of changes and new features in Upgrade to MyQ X 10.2.
Please read this document carefully to understand the impact of such changes.
Backup
Before proceeding to the actual upgrade, do a backup first. This will ensure that in case of an unsuccessful upgrade process, there will be a backup set of data to return to.
It is recommended to physically copy the created backup files to a separate file storage.
Backup can be manually created either by using the MyQ web interface or the Easy Config.
Web interface
Login as *admin and in Settings > Scheduler run the backup tasks for
Database and settings backup
Log backup
Check the log to see when the backup operations are finished.
Easy Config
Log in as a user with local administrator privileges on the server running MyQ and run the Easy Config application.
In the Database menu, open the Main database submenu and run the Backup command. The log database cannot be backed up using Easy Config.
If you are running MyQ in a virtual environment, it is recommended to create a Snapshot/Checkpoint before upgrading. This will present the easiest method if a rollback is required.
Upgrade Steps
Following the upgrade steps one by one in the correct order will ensure the most reliable outcome of the upgrade. Though the process itself is simple, it should still be considered critical, and the administrator should pay attention to each step. Doing it right will minimize necessary downtime and help prevent unexpected issues.
Disable Scheduled Tasks
At the very beginning of the upgrade process, it is the best practice to disable all scheduled tasks. This is to avoid accidentally running a task that might require a lot of time to finish at some point that is not convenient. Also, if other components of the system are going to be upgraded (for example Central server and Site servers simultaneously), user synchronization and data replication might start when not desired.
In Settings > Task Scheduler, right-click all the tasks and click the Enable button to disable the given tasks.
Some default tasks cannot be disabled, for those, it is recommended to check the next scheduled run time and alter it, if necessary.
Stop Services
The installation wizard will attempt to stop all application services so it may proceed with overwriting files and application components. It is best to do this step manually first and verify that all the services were stopped correctly and that there is no operation running in the background.
Until the services are stopped, and all the running tasks finished, the files are blocked, and the installation wizard will not be able to overwrite them.
To manually stop services, use the Easy Config application and click on the Stop button in the Services tab.
Stopping all the services may take time as the services are not terminated right away, but the system will wait for any running task to correctly finish. Do not force-stop the processes using Task Manager as it may leave some tasks in a half-finished inconsistent state.
Stopping services will prevent users from using the system.
When services are stopped, it is possible to proceed with the following steps of the upgrade process. In this state it is ensured that no user is logged in and no task is running, so all the files and system components can be overwritten with an updated version.
After stopping all the services, manually run only the Database Server service.
This service is necessary so the installation wizard can verify the version of the system, which is currently installed, and properly perform the upgrade, as well as run the database upgrade afterward.
In case you’re using the MS SQL database, this option is not available in the Easy Config. Still, the database server must remain up and running for the upgrade to proceed.
At this point, it is the ideal time to create the database backup – because if such a backup must be restored, it will contain all the data since no one is using the system. This backup cannot be done via web UI since it is not currently running, it must be done via Easy Config.
Verify Nothing is Running
When services are stopped, verify all the processes are stopped using the Task Manager and the Details tab. Technically, some stuck processes may be still running and blocking the files, even though the related service is stopped.
In this state, only the two following processes should be running:
firebird.exe
MyQ EasyConfig.exe
Make sure that there are none of the following processes or related services running:
httpd.exe
MyQCentral.exe
php.exe
php-cgi.exe
rotatelogs.exe
If any of the previously listed processes is running, despite all the services are stopped, then it is most likely a stuck process and will block the correct execution of the upgrade installation wizard.
In such a case, it is recommended to restart the whole server. After restarting the server, go back to stop the proper services again and check for any running processes.
Upgrade
When it is verified that the system meets all the requirements, a backup is made and all the services, except for the Database engine, are stopped and there are no running stuck processes that would block the installation wizard, we can proceed to the actual upgrade.
First, close the Easy Config application.
Make sure that the logged-in user has Local Administrator access rights and run the installation wizard.
Installation Wizard File
First, choose the desired language of the installation wizard.
In the second step, you will be presented with a message that the previous version was detected, and an upgrade will be performed.
Continue through the license agreement to the Options steps.
Here, it is possible to choose from various options regarding how to handle different parts of the system. These options will vary in each version and will also depend on the version from which the upgrade is being made.
The dialogue step may look like this:
Backup of the database will create a standard backup as if run via Easy Config. This step is generally not required because the backup was done manually before starting the upgrade. In some cases, when the database engine is also upgraded, this option is forcibly enabled because the backup and then following restore is done to change the database engine version.
Clear the log option is generally recommended, since in most cases it is not necessary to keep the old log data. If the requirement appears for any reason in the future, there is a backup of the log database which can be used for this purpose. Deleting contents of the log database will free up some disk storage space and make the upgrade process faster.
Start services after installation option is generally recommended. Only in case the previous upgrade was not successful for some reason, it is possible not to start the services right away and troubleshoot.
Continue with the Install button. After the installation wizard is finished, the Easy Config application will start.
You may be presented with the computer restart dialogue – in this case, make sure that Easy Config is not running, and it is not upgrading the database or doing other steps as the server restart will force stop this process and leave the database most likely inoperable. If the Easy Config is not running, confirm the server restart. Do not skip the restart entirely, if prompted. After restart, the Easy Config application will automatically launch.
Easy Config will perform the database upgrade steps. This process will take some time, especially with larger databases. Some of the upgrade steps can take a lot of time – do not forcibly end this process.
After the database upgrade is done, Easy Config will open on the Home tab where you can check basic details. It is recommended to go to the Services tab and verify that all the services are running. If not, click the Start All button.
Then open the Database tab and submenus Main Database and Log Database – verify that the database status is OK for both the Main database and the Log database.
On the About tab, you can check the currently installed version to make sure that the upgrade was successful.
After this, proceed to the web interface, log in as *admin, and verify that everything is running as it should.
We recommend checking the following areas, and whether they run correctly:
Log – for any error messages
Licenses
User synchronization
Site-Central connection and data replication
Scheduled reports generation
With all the previous steps finished, the upgrade is done. Congratulations!