How to use IBM App Connect with MySQL

MySQL is a relational database management system. Use App Connect to pass key data between MySQL Enterprise v5.7 and other applications.

  • A connector in IBM App Connect on IBM CloudCloud-managed connector

Connecting to MySQL

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your MySQL administrator to obtain these values.

MySQL connection fields:

Endpoint URL
MySQL database host name and port in the format <hostname>:<port>
  • Required: True
  • Default value: localhost:1521
MySQL database name
  • Required: True
User name
MySQL database user name
  • Required: True
Password for the MySQL database user
  • Required: True
Network name:
Specifies the name of the network that IBM® App Connect on IBM Cloud will use to access your system. Required only if connecting to a system in a private network.

If you have already configured a network in IBM App Connect on IBM Cloud with access to the private network, you can select that network. Otherwise, you need to configure a network (download and configure a Secure Gateway) for use with a private network. For more information about how to configure a network, see Configuring a private network for IBM App Connect on IBM Cloud®.

Important: Ensure that the Secure Gateway Client has been started. If you need to, you can start the Secure Gateway Client as described in Configuring a private network for IBM App Connect: Finally, start and configure the Secure Gateway Client.
  • Required: False

To connect to a MySQL endpoint from the App Connect Designer Catalog page for the first time, expand MySQL, then click Connect. For more information about ways to connect to MySQL, see Managing accounts in App Connect.


Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with MySQL, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog depend on the environment (IBM Cloud Pak for Integration or App Connect on IBM Cloud) and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

MySQL events

These events are for changes in this application that trigger a flow to start performing the actions in the flow.

MySQL actions

These are actions on this application that you want a flow to complete.

Available items are listed when you have connected App Connect to MySQL.