Topic updated on September 17, 2021

Enabling MySQL support

If you see MySQL as an available option in the Workbench transport definition panel "DB Type" field, MySQL is enabled and no further action is necessary.

If you are using a node at a release level prior to 20.1.1, or an embedded node (MESIT CCPU or Siemens ERPC) and want MySQL support enabled on your node, you must add the MySQL jar file to the Staging Browser. Once the jar file is available on the node, you will be able to create database transports with MySQL support.


The following is assumed:

  • You are familiar with Structured Query Language (SQL) used by the MySQL relational database.
  • You know how to create MySQL database tables.

Downloading the jar file

You can download the MySQL support jar file from the MySQL web site Downloads page. This site will provide a tar or a zip file that contains the latest MySQL jar file. For example, version 5.1.30. Once downloaded, you can use the Workbench to add the jar file to your node, in the staging browser area.

Follow these steps:

  1. Start a browser, and then go to the following site:
    The MySQL Downloads page appears.

  2. In the Select Platform list, select Platform Independent (and not Microsoft Windows), even if the destination node is a Windows computer.
    This is to download a compressed .tar file format instead of a Microsoft install file format.
  3. Select the Download button for the appropriate Tar or Zip file.
  4. Extract the mysql-connector-java-XXX-bin.jar file.

You are ready to put the jar file on the Staging Browser.

Putting the jar file in the staging browser area

In order for the MySQL support to become available in your node, you must transfer the extracted MySQL support jar file system/jars folder in the Staging Browser.

Follow these steps:

  1. From the Workbench left pane, expand the appropriate node.
  2. Select Administration.
    The Administration window appears with a set of tabs.
  3. Select the Staging Browser tab, and then locate the system/jars folder.

  4. From the Staging Browser tab, expand system, right click the jars folder to display its pop-up menu, and then click Put.
    The Select Files window appears.
  5. Change to the location where the jar file resides, and then select the file.
    The name of the file is added to the File Name box.
  6. Select Select.
  7. A message will ask you if you want to upload the selected file. Select Yes.
  8. Another message will tell you that the file was uploaded to the target folder. Select OK.
    The file is copied into the node and appears in the system/jars folder.

Restarting the Node

The next step is to restart the node. See Restarting a node for instructions.

Once restarted you can verify support is enabled.

Verifying the MySQL support is enabled

You will be able to verify that the MySQL support is enabled on the node. At this point, you do not have any MySQL database tables created as you will not be testing the connection to the database.

  1. From the Workbench left pane, expand the node that you want to verify the MySQL support is enabled.
  2. Expand Enterprise, right-click the Transports icon to display its pop-up menu, and then click New.
    The Transport window appears.

  3. Select the Type down arrow, and then select DB.
    The Transport window changes to accommodate the definition of a database transport.

  4. Select the DB type down arrow. You will see the MySQL option.

Exception for Enterprise Gateway for Siemens ERPC nodes

For Enterprise Gateway for Siemens EPRC nodes, once the MySQL jar file is uploaded to the Staging Browser and the node is restated, the system/jars folder on the Staging Browser will be empty. This is because when the node is restarted, the MySQL jar file is physically copied to an internal directory and then erased from the systems/jars location.

In order to verify that you have the MySQL support enabled, you can use the Workbench and create a new database transport. The MySQL support will be available from the DB Type drop-down list.

For more in formation, refer to Verifying the MySQL support is enabled above.

If you upload another copy of the MySQL jar file to the system/jars folder on the Staging Browser and restart the node, the copy and delete process will be repeated and the previously copied MySQL jar file will be overwritten.

To ensure that a certain version of the MySQL jar file is used by The Transaction Server, repeat this procedure.