Database Profile
In a Database profile configuration, you can create database profiles for use in various agents, profiles and APL functions. These include:
- Callable Statements (APL)
- Database Bulk Functions (APL)
- Database Table Functions (APL)
- Database Agents
- Data Masking Profile
- Event Notifications
- Prepared Statements (APL)
- Data Veracity Profile
- SQL Agents
- SQL Loader Agent
- Task Workflows Agents (SQL)
What a profile can be used for depends on the selected database type. The supported usage for each database type is described in the section below, Database Types.
The Database profile is loaded when you start a workflow that depends on it. Changes to the profile become effective when you restart the workflow.
Configuration
To create a new Database profile, click the New Configuration button from the Configuration dialog available from Build View, and then select Database Profile from the menu.
The contents of the menus in the menu bar may change depending on which configuration type has been opened in the currently active tab. The Database profile uses the standard menu items and buttons that are visible for all configurations, and these are described in Common Configuration Buttons.
There is one menu item that is specific for Database configurations:
Item | Description |
|---|---|
External References  | Select this menu item to Enable External References in an agent profile field. Refer to Enabling External References in an Agent Profile Field in External Reference Profile for further information. |
The Database profile has two tabs; General and Properties.
The General Tab
In the General tab, the two radio buttons Default Connection Setup and Advanced Connection Setup make it possible to display different connection options.
Default Connection Setup
Select the Default Connection Setup radio button to use a preconfigured connection string.
The Database profile configuration - General tab
| Setting | Description |
|---|---|
Default Connection Setup | Select this option to configure a default connection. |
Advanced Connection Setup | Select this option to configure the data source connection using a connection string. For further information, see the section below, Advanced Connection Setup. |
Database Type | Select any of the available database types. You may need to perform some preparations before attempting to connect to the database for the first time. For information about required preparations, see the section below, Database Types. |
Database Name | Enter a name that identifies the database instance. For example, when you configure the profile for an Oracle database, this field should contain the SID. |
Database Host | Enter the hostname or IP address of the host on which the database is running. Type it exactly as when accessing it from any other application within the network. |
Port Number | Enter the database network port. |
Username | Enter the database user name. |
Password | Enter the database password. |
| Enable TLS Truststore | Enable TLS/SSL for connection to an SAP HANA Database. This option will be enabled by default. This option applies only to SAP HANA and will only be visible when SAP HANA is selected as the Database Type. For information about advanced connection for SAP HANA with TLS/SSL enabled, you can refer to SAP HANA DB. Note! If the TLS truststore is configured for SAP HANA default connection setup, the following SAP HANA JDBC connection string properties will be added as well:
For information about SAP HANA connection string properties, you can refer to the SAP HANA documentation at the SAP Help Portal. |
| TLS Truststore | Enter the path and filename to the TLS/SSL trust store file that contains the SAP HANA hosting server's certificate. This option applies only for SAP HANA and will only be visible when SAP HANA is selected as the Database Type. |
| TLS Truststore Password | Enter the password for the TLS/SSL trust store file. This option applies only to SAP HANA and will only be visible when SAP HANA is selected as the Database Type. |
Try Connection | Click to try the connection to the database, using the configured values. |
Advanced Connection Setup
The Advanced Connection Setup enables you to specify a customized connection string. It can be used for Oracle RAC and Snowflake connections, or when you need to add additional properties to a connection. For more information, see the relevant subsections.
Database profile configuration - Advanced Connection Setup
| Setting | Description |
|---|---|
Default Connection Setup | Select to configure a default connection. For further information, see the section above, Default Connection Setup. |
Advanced Connection Setup | Select to configure the data source connection using a connection string. |
Database Type | Select any of the available database types. You may need to perform some preparations before attempting to connect to the database for the first time. For information about required preparations, see the section below, Database Types. |
Connection String | Enter a connection string containing information about the database and the means of connecting to it. |
Notification Service | This field is used when the selected Database Type is Oracle. For more information, see Oracle. |
Username | Enter the database user name. |
Password | Enter the database password. |
Try Connection | Click to try the connection to the database, using the configured values. |
The Properties Tab
The Properties tab allows you to configure additional properties for certain database types.
The Database profile configuration - Properties tab
Currently, the following properties can be configured:
| Database Type | Properties |
|---|---|
| CSV | All properties described on the page http://csvjdbc.sourceforge.net/doc.html in the section section "Driver Properties" can be used. |
| MySQL | mysql.connectionpool.maxlimit |
| Oracle | oracle.pool.connectionwaittimeout oracle.pool.inactivitytimeout oracle.pool.maxlimit oracle.pool.minlimit oracle.pool.propertycheckinterval oracle.pool.refreshonsqlerror oracle.net.encryption_client oracle.net.encryption_types_client oracle.net.crypto_checksum_client oracle.net.crypto_checksum_types_client |
| PostgreSQL | postgresql.connectionpool.maxlimit |
| SAP HANA | sapdb.connectionpool.maxlimit |
Note!
If you have configured any of these properties using topo or the Connection String field when making an Advanced Connection Setup, the properties configured in the Properties tab will override these.
Database Types
The following table provides information on the database versions supported.
| Database | Version |
|---|---|
| Cassandra | 3.11.3 |
| CSV | - |
| DB2 | 10 |
| Derby | 10 |
| MS SQL Server | 2008, 2008R2, 2012, 2014, 2016, Azure SQL Database, Azure SQL Data Warehouse/Parallel Data Warehouse |
| MySQL | 8 |
| Netezza | - |
| Oracle | 12cR2/19c |
| PostgreSQL | 12/13/14/15 |
| Redshift | - |
| SAP Hana | - |
| Snowflake | - |
| Sybase IQ | The version of Sybase IQ support through the use of the JCONN4 driver |
| Teradata | 16.20 |
| TimesTen | 11.2 |
| Vertica | 8.1 |
This section includes the following subsections: