Skip to main content
Version: Current

MySQL Connection

Overview​

The MySQL connection allows IB-X Agents to connect to MySQL databases using username and password authentication.

The connection can be used by database activities to perform operations such as:

  • Selecting records
  • Inserting records
  • Updating records
  • Deleting records
  • Executing stored procedures

Prerequisites​

Before creating a MySQL connection:

  • Ensure that the MySQL server is accessible from the IB-X environment.
  • Obtain the database server, port, and database information required for the connection.
  • Obtain the database user credentials.
  • Ensure that the configured database user has the permissions required by the intended workflow operations.

Connection Properties​

Configure the following properties when creating a MySQL connection.

PropertyDescription
NameUnique name used to identify the MySQL connection in IB-X.
DescriptionOptional description of the connection and its intended usage.
Database Server NameHostname or IP address of the MySQL server.
Database NameName of the MySQL database to connect to.
PortPort used to connect to the MySQL server. The default value is 3306.
User NameUser name used to authenticate with MySQL.
PasswordPassword associated with the MySQL user.

Database Server Name​

Specify the hostname or IP address of the MySQL server that IB-X should connect to.

For example:

mysql.example.com

The MySQL server must be reachable from the IB-X environment.

Database Name​

Specify the name of the MySQL database that IB-X should access.

The configured MySQL user must have access to the specified database and the permissions required by the workflow activities that use the connection.

Port​

Specify the port used to connect to the MySQL server.

The default value is:

3306

If your MySQL server uses a different port, specify the port configured for your database environment.

Authentication​

The MySQL connection uses username and password authentication.

Provide:

  • User Name
  • Password

The configured MySQL user must have access to the specified database and the permissions required by the workflow activities that use the connection.

caution

The Password is a sensitive credential.

Protect the password from unauthorized access and manage it according to your organization's credential-management and security policies.

Testing the Connection​

After providing the required connection properties, click Test Connection to verify that IB-X can connect to the configured MySQL database.

Connection or authentication issues can result from:

  • An incorrect Database Server Name
  • An incorrect Database Name
  • An incorrect Port
  • An invalid User Name or Password
  • Network connectivity problems
  • MySQL access restrictions
note

A successful connection test confirms that IB-X can establish the database connection using the supplied configuration and credentials. The database user must still have the appropriate permissions for the operations performed by individual workflow activities.

Used By​

The MySQL connection can be used by IB-X database activities to interact with MySQL databases.

Depending on the activity, the connection can be used to:

  • Query database records
  • Insert records
  • Update existing records
  • Delete records
  • Execute stored procedures

The operations that can be performed depend on the selected database activity and the permissions granted to the configured MySQL user.

Security Considerations​

When configuring a MySQL connection:

  • Grant only the database permissions required by the Agent.
  • Protect the User Name and Password from unauthorized access.
  • Restrict access to connection management based on organizational requirements.
  • Rotate database credentials according to your organization's security policies.
  • Ensure that the MySQL server is accessible only from authorized environments.

For example, if an Agent only reads database records, the configured database user should not be granted write permissions unless they are required.

note

The AI Command Center must have network access to the configured MySQL server.

For self-hosted environments, ensure that the required database host and port are reachable from the AI Command Center deployment.

For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.