Foreword #
OpenLM products will no longer support Firebird embedded database engines. Version 5.6 of OpenLM Server includes a utility that will allow transferring Firebird data to MariaDB. This is a quick guide on how to use this utility to transfer and switch from the existing Firebird database to MariaDB.
If you are still using OpenLM Server with the Firebird database engine you can continue doing so, but we advise you to schedule switching at the earliest possible time. Installing version 5.6 is a mandatory step for all OpenLM users who will further wish to upgrade to all the upcoming versions.
In case you are using a different supported database engine, you don’t need to take any actions.
- The general process in case you still use Firebird will be:
- Contact sales@openlm.com to request a v5.6 license file
- Upgrade to OpenLM Server 5.6 and continue using it like normal
- Schedule in your agenda time to install MariaDB and switch to the database engine
- Refer to the sections about installing MariaDB below.
- Once MariaDB is available and you start the database transfer, stop the OpenLM Server service
- Use the fb2mariadb utility provided with your OpenLM Server 5.6 installation to transfer data
- If database transfer succeeded, use the DB configuration utility provided with your OpenLM Server 5.6 installation to switch to MariaDB and start the OpenLM Server Service. The FbToMariadb utility includes a quick access button for this in case of success
- If database transfer failed:
a) restart OpenLM Server service (using the Firebird DB still) and
b) contact OpenLM Support with details about the failure at support@openlm.com
Install and configure MariaDB #
Download MariaDB from the official source. Opt for the latest version.
Select the way you wish the features to be installed then click Next
Set a password for the database. UTF8 should be kept as the default character set. Click Next, then in the next prompt Install:
Once completed the installation, hit the Finish button.
Installing MySQL Workbench #
For ease of use, we recommend downloading the MySQL Workbench (no need to login):
- Double click on the package to trigger the installation. Follow the Next instructions:
Immediately after completion, the workbench will be launched automatically:
1. Click on the + to create a new connection
2. Type in a connection name.
3. Provide the password.
4. Test the connection.
5. Click OK.
6. A prompt will appear stating that the connection was successfully created.
7. Click on the newly added connection
8. Click on the below sign marked in red to create a new schema in the connected server
Name the schema –> Set Charset as utf8mb4 –> Set Collation as Default Collation (For case sensitive databases –> Set Collation as utf8mb4_bin)
9. Review the script then click Apply
Now that MariaDB is installed and configured, we are ready to transfer the data from Firebird.
Transfer data from Firebird to MariaDB #
The OpenLM v5.6 is delivered with a utility called FbToMariaDB.
- Start FbToMariaDB either using the menu link or the icon on your desktop.
2. The utility will perform some initial checks to ensure that the Firebird database engine is used then it will pre-populate the form below with the details. Make any necessary changes as needed.
3. Provide connection details to your MariaDB server and the new database then click Next.
4. Wait for the migration process to complete (it might take up to two minutes):
5. Close the Box Dialog then click Next.
Configure the OpenLM Server to use MariaDB #
- FbToMariaDB utility will prompt with an easy step to configure the new MariaDB
- IMPORTANT: Do not switch to MariaDB if the FbToMariaDB failed in any way
3. Hit the DB configuration button.
4. From the drop-down list, select MariaDB as a provider.
5. Define the Server and Database.
6. Provide the previously created User Id and password
7. Test the connection.
8. If successful, strike the Apply button.
Check if the switch to MariaDB was successful #
To check if the migration is successful, go to the EasyAdmin, and close all the tabs to see in the upper left corner the OpenLM Logo
Hover over the version number to see the related database