Create a JDBC connection

The JDBC Connection [jdbc_connection] table provides the information custom JDBC Orchestration activities need to connect to various target databases.

Before you begin

Role required: admin

About this task

JDBC connections do not supply credentials. The necessary credentials are retrieved separately by the activity designer template and support external credential storage, such as CyberArk.
Note: The Helsinki upgrade process copies all database connection information from existing JDBC data source records and uses the data to create new records in the JDBC Connection table and the Credentials table. Existing JDBC custom activities are then updated with the appropriate fields and configured to use the new connection and credential records. All new custom JDBC activities must use connection information from the jdbc_connection table and JDBC credentials from the discovery_credentials table. The original JDBC data source records are available for use elsewhere in the ServiceNow platform.

Procedure

  1. Navigate to Orchestration > Credentials & Connections > JDBC Connections and cick New.
  2. Complete the form using the fields in the table.
    Database selection determines which fields are available.
    Table 1. JDBC connection fields
    Field Description
    Name Unique name of this JDBC connection. For example, you might enter JDBC MySQLProd.
    Query timeout Maximum elapsed time the JDBC query is allowed to run without a response.
    Connection timeout Maximum elapsed time for the JDBC activity to wait while attempting to connect to the target database.
    Application Scope for this table. By default, the JDBC Connection [jdbc_connection] table runs in the Global scope.
    Domain Domain for this table. By default, the JDBC Connection [jdbc_connection] table runs in the global domain.
    Format Database type for this connection. The default choices are MySQL, Oracle, or SQLServer. You can customize the form and add Sybase or DB2 Universal to the choice list. However, if you select one of these databases, you must upload the appropriate JDBC driver JAR file to the instance. Orchestration is configured to recogize these drivers when they are loaded into the system.
    Server Host name or IP address of the database server.
    Oracle sid The Oracle database site identifier. The default value is orcl. This field is available when Oracle is selected as the Format.
    Oracle port Port that the Oracle database is using. The default value is 1521. This field is available when Oracle is selected as the Format.
    Database name Name of the database. This field is available when MySQL or SQLServer is selected as the Format.
    Database port Port that the selected database is using. This field is available when MySQL or SQLServer is selected as the Format.
    Instance name Instance name for the selected SQLServer.
    Connection URL URL that the MID Server uses to connect to the specified database. The URL is created automatically when you save the form, based on the information you supplied about the database. If the format selected is not one of the databases provided by Orchestration, you must create the connection URL manually so that the MID Server knows how to create the connection. This field is read-only for the provided databases.
    JDBC driver JDBC driver to use for this connection when it is unknown to the system. This field appears when the value in the Format field is set to None or to any database type not included by default in the table. If you add a database to the choice list, you must enter the driver name in this field and upload the driver JAR file to the instance.
    Figure 1. JDBC connection example
    JDBC connection example
  3. Click Submit.