Upgrade guide : External Database – KB4101b
This document describes the upgrade of OpenLM installations to version 5 that also use an external database, i.e.: MS-SQL or MySQL. For installations that use the embedded Firebird database see this application note instead.
1. Before upgrading, please make sure your system is compliant and has the correct .NET Core runtimes installed as listed on the OpenLM System requirements page.
2. If the OpenLM server (of any version) has been already installed on the machine for a period longer than the Evaluation period, a new license file will be required. Please make sure you have one before proceeding with the upgrade process. In order to obtain a valid OpenLM license file, please contact OpenLM support with your MAC address and hostname (case sensitive) of the designated installation machine.
Download the latest OpenLM v5 system components
The OpenLM System components are available for download on the OpenLM site.
OpenLM Server upgrade procedure
1. Backup the database – VERY Important
Note that the backup stage is mandatory since the database upgrade process can be sensitive to hardware and software changes. Starting the upgrade process without backing up the database file may compromise any accumulated data. Stop the “OpenLM Server” Windows Service, and back up the OpenLM Database.
2. Upgrade the database
Upgrading the OpenLM database from v4.x to v5.x can be done either manually or automatically. After backing the database up (see above), employ one of these methods:
a. The user that employs the OpenLM Server and connects to the database must have Read, Write and Create permissions on the external database.
b. Verify that the OpenLM database configuration tool (Windows’ Start –> OpenLM –> Server –> OpenLM Server DB Configuration) points to the external database. This is the database that will be upgraded.
c. Run the new OpenLM Server installation file (e.g. OpenLM_Server_126.96.36.199.exe) to upgrade the OpenLM Server. This will also automatically upgrade the external database tables.
d. In case of a successful upgrade, no error notifications will pop up.
e. In case of failure, the “AllDBUpgrade.txt” file will open. Please send this document to firstname.lastname@example.org. Uninstall the OpenLM Server, install the previous working versoin of OpenLM Server version and revert to the previously backed up OpenLM database.
OpenLM reserves a manual method for database upgrade. This is especially useful when the OpenLM user does not have Read, Write and Create permissions on the External Database.
a. Open the Scripts folder in the OpenLM Server installation folder. This is normally located at:
C:\Program Files (x86)\OpenLM\OpenLM Server\bin\Scripts
b. Select the required scripts according to the external database’s type and the current OpenLM Server version;
For MS-SQL this is: OpenLM_SQLServer_*_Upgrade.SQL.
For MySQL this is: OpenLM_MySQL_*_Upgrade.SQL.
c. Stop the OpenLM Server service.
d. Run the upgrade script(s) on the External DB administration tool.
If no error notifications pop up, the upgrade has been successful.
1. During upgrade of an OpenLM MS-SQL database, transaction logs may grow to be quite large in size. Please consider adding additional disk space for the upgrade procedure.
2. In order to evaluate newer OpenLM versions prior to upgrading, please refer to the “Side-by-side” section below.
3. When upgrading mirrored SQL Server databases, which are below version 4.0.35, make sure to first shut down the mirrored server, then run the upgrade. After the upgrade process is done, start up the mirrored database.
OpenLM Broker upgrade
The OpenLM Broker is an optional component that highly enhances the capabilities of the OpenLM system. Download the latest OpenLM Broker version from the downloads section and install it on each license server machine. On Windows’ machines, the OpenLM Broker will automatically detect the license managers that exist on that machine and will just need to be configured to interface with the OpenLM Server.
1. Broker interoperability
- It is recommended to get the latest available version of OpenLM Broker.
- Broker versions older than v4.9 are compatible with OpenLM Server v5, however you might have to update the port number in the configuration for the OpenLM Server (the new Server communications port is 5015)
2. Broker installation
In order to install the Broker, simply run the OpenLM Broker installation file (e.g.: OpenLM_Broker_188.8.131.52.msi) on the designated license server machine and follow the wizard’s instructions. It is also possible to deploy OpenLM Broker installations silently.
The OpenLM Broker will also install Java JRE on the designated machine.
3. Side-by-side installation for evaluation purposes
It is possible to install a new OpenLM Broker version side-by-side with an older version. This can be done in order to evaluate the performance of the new version prior to upgrading. In order to do so:
- The new OpenLM Server version must be installed on a machine separate from the production OpenLM Server.
- The new OpenLM Broker version can be installed on the same license server machine, side by side with the older, production-version of OpenLM Broker.
Please refer to this document for an elaborate explanation on the Broker “side by side” installation process.
OpenLM Agent upgrade
- OpenLM Agent versions prior to v5 are not compatible with OpenLM Server v5. In such cases upgrading is compulsory.
- Please refer to this document for more information on silent Agent installation.
1. During upgrade of an OpenLM MS-SQL database, transaction logs may grow to be quite large. Please consider adding disk space for the upgrade procedure.
2. After upgrading the OpenLM server to version 5.x, the EasyAdmin web application may in some cases throw errors. In that case, it is recommended to clear the web browser’s cache.
3. The OpenLM Software is delivered with Lighttpd: a built-in web server that runs at start-up as a service. Users can continue and use the built-in web server or use a standard web server such as Microsoft IIS
4. LDAP Directory Synchronization has been split from OpenLM Server v5 into the Directory Synchronization Service (DSS) & Directory Synchronization Agent (DSA) components. Your sync definitions and data is preserved however syncs will not run until you install these components. A migration wizard is built-in the DSS component.
If you encounter any other issue during the upgrade process, or require technical assistance please refer to our support team: