Software Update
This topic provides guidelines on the installation management use cases.
We recommend that you keep the software version up to date, as new versions include new features, various improvements and optimizations, as well as the latest bug fixes.
We strongly advise that you keep the software versions (e.g., 1.x.x) and subversions (e.g., 1.2.x) across your system match exactly. Software build numbers (e.g., 1.2.0.xxxxx) may differ slightly in case your are using 64- bit and 32-bit editions.
Before starting the upgrade/uninstall procedure, ensure that all Macula processes have been terminated and that Macula files are not in use: this is necessary in order to upgrade all files to the newer versions. This includes any Macula processes or related applications that are running, and also any third-party applications that have access to Macula files, e.g., antivirus scanners, third-party integrations, etc. Macula processes can be found via Task Manager->Details tab: these start with VMS, e.g., VMSServer.exe.
If the processes are not stopped, or if other applications are still interfering with the process, you may be asked for a reboot: in that case, please restart your server machine afterwards to complete the action. This will not affect the overall process quality.
Upgrade Software
This section describes manual software update (newer version installation on top of the older one) by running the installation locally.
Before starting the software upgrade:
Make sure there are no other running installations and that the operating system is not in the middle of installing updates. If Windows updates are pending, apply them, then restart the computer (if required), and start the Macula upgrade.
Verify that the operating system is stable and is running normally (check system logs, overall health) - these must be no "blue screens", unexpected shutdowns, slowdowns etc. (Normally, we recommend that you regularly run such system checkups, not only before upgrade).
Ensure stable power and connectivity (the latter is essential if you are connected via RDP).
See if there are any special requirements or recommendations from GSF regarding the target version. Usually, these are either mentioned on the download page, or provided alongside the download links in case the new version was recommended and sent by our engineers.
Check your software license subscription, and renew it, if necessary: the subscription must not run out before the target version release date. You can check the software release date by right-clicking the installation file > Properties > Digital signatures > see timestamp. The license information is available via license manager, Macula Activation Wizard.
If you launch a newer version installation package of the same kind as the already installed Macula edition, you will be given the option to upgrade the product. It is not possible to install another type of package on top of the existing one, e.g., Macula Recording Server on top of Macula Professional: if you wish to change the server type, uninstall the old software package first.
Press Next to go through the steps and complete the wizard, which is very much alike the installation wizard. At each step, read all the information displayed and press Next until finished.
If you want a clean installation, choose to ignore the existing configuration: the current database will not be used and will be replaced with an empty one, as if you were installing the software from scratch. Otherwise, leave the wizard to use the existing configuration. In either case, the old database is not actually removed but is saved as a backup, so you will be able to load it anytime later via Backup and Restore Wizard.
In case the installation wizard detects your license subscription has run out, you will get a warning about license compatibility. By default, the initial subscription will allow for version upgrades during 2 years, starting from the license activation date. Hence, if the target upgrade version is newer, this warning will pop up.
If you have already acquired a subscription upgrade, proceed with the installation, then run the license manager and upgrade your license in either online or offline mode
Otherwise, cease the installation and choose another software version that was released before the license subscription ran out (or continue using the existing version)
If you proceed with the upgrade but do not provide a valid license after the installation is complete, the software will not operate. Therefore, do not proceed with the upgrade until you have renewed the subscription.
If some of the files cannot be upgraded because they are in use, you will get a corresponding warning.
Choose Ignore to proceed with the installation: reboot may be required afterwards but it is safe to select this option, esp. if the processes are from Macula; or
Stop the listed applications/services and click Retry to continue installing the software, or
Click Abort to roll back the installation (the process will be cancelled and you will get a corresponding error in the wizard's dialog box).
The upgrade process will then continue and replace your Macula software version to the newer one.
Uninstall/Change Software
Software can be uninstalled in two ways:
From the Windows Control Panel
By launching the same package that was used for installation
In either case, you have a choice between changing and uninstalling the product.
Before making any changes to the installation, make sure to close and stop all software services and applications. If processes are not stopped, some of the software components may not be removed or replaced during the installation process.
In order to check this, open Windows Task Manager, select 'Show processes from all users' and make sure there are no processes starting with 'VMS..'. If there are any, stop them manually and then proceed with the installation changes.
Select Change if you wish to re-install or add software components. The process will be similar to the initial installation.
Select Change if you wish to re-install or add software components. The process will be similar to the initial installation.
Select Uninstall to remove all software components. You will be asked if you wish to keep the configuration and the current license; the following common use cases apply:
keep the license and remove the configuration if you wish to re-configure everything from scratch after reinstallation (e.g., in event of a corrupt database or having to move the server to a different system);
keep both if you are going to clean install the software; remove both if you do not intend to use the software on this machine anymore.
Press Next to proceed with the de-installation process. Note that you may have to confirm these changes if UAC has been turned ON.
If you did not stop the GSF Macula server before starting the uninstall process or if some third-party software (e.g., antivirus) has locked GSF Macula files, you will get a warning.
In this case:
choose Abort to cancel the uninstall process
stop the processes manually yourself and then click Retry
click Ignore to let the wizard handle the files automatically (recommended, an reboot may be required)
Generally, if you see that the process mentioned in the warning is Macula own process, simply choose the Ignore option and let the wizard do the job.
When the wizard finishes removing software components, hit Finish to exit
Clean Install
Sometimes it is necessary to install software anew, i.e., to change software bit version, roll back version, and also in event of major software-related troubles.
To perform a clean installation, it is crucial to make sure that no Macula software processes are running, whether explicitly or in the background. Follow these steps:
Stop all Macula software services and/or applications;
Open Windows Task Manager, click 'Show processes from all users' and check that there are no processes starting with 'VMS..'; if there are any, stop them;
Uninstall software as described above, keeping your license and configuration;
Install [new] software version, carefully following all steps and recommendations;
Start the software and check if the desired change has been carried out.
Last updated