Overview

The Connection Add page is used to create a new database connection profile.

Administrators must provide the database type, database name or SID, server address, port, and authentication credentials. Additional connection parameters can also be provided when required by the database driver or environment.

Connection Add Fields

Connection Name

The Connection Name field defines a friendly name for the database connection.

Use a clear name that helps administrators identify the database environment, database type, or deployment location.

Example:

mysql-local
pg-local
postgresql-local
Oracle-On-Cloud
MsSQL-On-Cloud
PostgreSQL-On-Cloud

Recommended naming convention:

<DatabaseType>-<Environment>-<Purpose>

Example:

PostgreSQL-Prod-CustomerDB
MySQL-UAT-CRM
Oracle-Dev-CoreBanking
MSSQL-Prod-HR

Database Type

The Database Type field defines the database platform used by the connection.

Supported database types include:

The selected database type determines the connection behavior and expected connection parameters.

Database Name

The Database Name field defines the target database name.

For Oracle connections, this value may be used as the SID or service-related identifier depending on the connection format supported in the environment.

Examples:

Use the database name, or enter the SID if the database type is Oracle.

IP Address

The IP Address field defines the target database server address.

This can be an IP address or hostname.

Example:

127.0.0.1
192.168.10.25
db-prod.company.local

For production environments, use the database address approved by the infrastructure or database administration team.

Port

The Port field defines the database listener port.

Common default ports include:

The actual port may be different depending on the database server configuration.

Username and Password

The Username and Password fields define the database credentials used by OneDB to connect to the target database.

The database user should have only the required permissions needed for the intended OneDB use case.

Recommended practice:

Additional Connection String

The Additional Connection String field allows administrators to define optional key-value parameters that are appended to the JDBC URL.

This is useful when the database connection requires additional driver options, timeout values, secure connection parameters, SSL/TLS settings, or other connection-level parameters.

Example:

connectTimeout=10&socketTimeout=30

Common use cases may include:

Parameters must follow the supported key-value format for the selected database driver. Incorrect parameters may cause the connection test or database access to fail.

Secure Connection

The Secure Connection option allows OneDB to connect to the target database using an encrypted database connection when supported and required by the database server.

This setting is used for communication between the OneDB appliance and the target database server. It is different from secure listener connections, which are used between a client application and the OneDB Listener.

When Secure Connection is enabled, OneDB will attempt to establish a secured database connection using the supported database driver configuration.

Secure Connection may be required in environments where database traffic must be encrypted across the network, especially for production, cloud, hybrid, or regulated environments.

When to Enable Secure Connection

Enable Secure Connection when the target database server requires or supports encrypted client connections.

Common use cases include:

Test Connection

The Test Connection button is used to verify whether OneDB can connect to the target database using the provided configuration.

Administrators should test the connection before saving or using it in production configuration.

Test Connection Result

The Test Connection function is used to verify whether OneDB can successfully connect to the target database using the configured connection settings.

To test a connection:

1. Open the Connection Management page.
2. Locate the connection to be tested.
3. Click the Test Connection icon on the selected row.

OneDB will attempt to connect to the target database using the configured parameters.

Successful Connection Test

If the test is successful, a notification message will be displayed indicating that the database connection has been established successfully.

Example:

Notification
Connection database <database_type> succeed!

This indicates that OneDB was able to establish a connection to the target database successfully.

Click OK to close the notification.

Failed Connection Test

If the test fails, a notification message will be displayed indicating that the connection attempt was unsuccessful.

Example:

Oops...
Connection database <database_type> failed!

This indicates that OneDB was unable to connect to the target database using the current configuration.

Click OK to close the notification.

Possible Causes of Connection Failure

If the connection test fails, check the following items:

Database Detail

The Database Detail function displays additional information about the connected database instance.

To view database details:

1. Open the Connection Management page.
2. Locate the required connection.
3. Click the Database Detail icon on the selected row.

A Database Detail window will be displayed.

Database Detail Information

The Database Detail window may display information such as:

This information helps administrators verify the connected database platform and version.

How to Add a Connection

1. Open Connection from the Database Server menu.
2. Click Add connection.
3. Enter the Connection Name.
4. Select the Database Type.
5. Enter the Database Name.
6. Enter the database server IP Address or hostname.
7. Enter the database Port.
8. Enter the database Username.
9. Enter the database Password.
10. Add optional parameters in Additional Connection String, if required.
11. Click Test Connection to verify connectivity.
12. Click Submit to save the connection.

How to Edit a Connection

1. Open Connection from the Database Server menu.
2. Find the connection that needs to be updated.
3. Click the Edit icon.
4. Update the required fields.
5. Click Test Connection if connection parameters were changed.
6. Save the changes.

How to Delete a Connection

1. Open Connection from the Database Server menu.
2. Find the connection that should be removed.
3. Click the Delete icon.
4. Confirm the deletion if prompted.

Before deleting a connection, ensure that it is no longer used by Field Settings, Database Browser, templates, applications, or other OneDB operations.

Important Notes

• A connection profile defines how OneDB reaches a target database server.
• A successful connection test confirms that the OneDB appliance can reach and authenticate to the target database using the provided parameters at the time of testing.
• A successful connection test does not guarantee that all database objects, schemas, tables, or records are accessible. Access depends on the database user permissions and database configuration.
• Since OneDB is delivered as an OVA-based appliance, connectivity depends on the appliance network configuration, routing, firewall rules, DNS resolution, and database server availability.
• Additional connection string parameters are appended to the JDBC URL and should only be configured by administrators who understand the selected database driver requirements.
• Incorrect database type, database name, SID, port, credentials, or connection string parameters may cause connection failure.
• Database credentials should be protected and managed according to the organization’s security policy.
• Avoid using highly privileged database administrator accounts unless explicitly required and approved.

Recommended Practice