Overview

Database Connections provide all database server information required for Universal Controller to execute an SQL task or a Stored Procedure Task.

Database Connections can receive Email Notifications when:

An Agent or OMS Server goes down or comes back up.
A Cluster Node goes Offline or becomes Active.

Creating a Database Connection

Step 1	From the Agents & Connections navigation pane, select System > Database Connections. The Database Connections list displays. Below the list, Database Connection Details for a new Database Connection displays.
Step 2	Enter / select Details for a new Database Connection, using the field descriptions below as a guide. Required fields display an asterisk ( * ) after the field name. Default values for fields, if available, display automatically. To display more of the Details fields on the screen, you can either: Use the scroll bar. Temporarily hide the list above the Details. Click the New button above the list to display a pop-up version of the Details.
Step 3	Click a Save button. The Database Connection is added to the database, and all buttons and tabs in the Database Connection Details are enabled.

Note

To open an existing record on the list, either:

Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Database Connection Details

The following Database Connection Details is for an existing Database Connection. See the field descriptions, below, for a description of all fields that display in the Database Connection Details.

For information on how to access additional details - such as Metadata and complete database Details - for Database Connections (or any type of record), see Records.

Database Connection Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Database Connection Details.

Field Name	Description
Details	This section contains detailed information about the Database Connection.
Name	Name (maximum 40 alphanumeric characters) used within the Controller to identify this resource. It is the responsibility of the user to develop a workable naming scheme for resources.
Version	System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.
Description	Description of this record. Maximum length is 255 characters.
Member of Business Services	User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.
Database Type	Type of database. Options: MySQL MS SQL Server Oracle DB2 Sybase SQL Anywhere Other Note When using the database type Other, you will need to source the JDBC driver from your database vendor. Simply place the JDBC driver .jar file into the `$CATALINA_HOME/webapps/uc/WEB-INF/lib` directory and restart Tomcat. Format the Connection URL and Driver fields per the database vendor's documentation. Note Customers have reported difficulty establishing secure SQL connections using the jTDS open source JDBC driver for Microsoft SQL Server (Driver=net.sourceforge.jtds.jdbc.Driver) when SSL/TLS is enabled on the server. We have received feedback that the issue can be resolved by installing a patched version of the jTDS driver from bug report https://sourceforge.net/p/jtds/bugs/725/. Stonebranch only bundles the official jTDS release, currently 1.3.1, with the Universal Controller. We do not include unofficial patches, and if you decide to use them, you do so at your own risk.
Credentials	Credentials for this Database Connection. Click the Details icon to create a new Credentials record, or select an existing Credentials record from the drop-down list.
Connection URL	URL of the database. If you are using a MySQL database and want the ability to issue multiple SQL commands from a single task, you need to enable this by appending the following string to the end of the connection string: ?allowMultiQueries=true For example: jdbc:mysql://localhost:3306/uc?allowMultiQueries=true
Driver	Name of the JDBC driver.
Maximum Rows	If necessary, specifies a limit to the number of rows you want returned by the SQL statement.
Metadata	This section contains Metadata information about this record.
UUID	Universally Unique Identifier of this record.
Updated By	Name of the user that last updated this record.
Updated	Date and time that this record was last updated.
Created By	Name of the user that created this record.
Created	Date and time that this record was created.
Buttons	This section identifies the buttons displayed above and below the Database Connection Details that let you perform various actions.
Save	Saves a new Database Connection record in the Controller database.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Save & View	Saves a new record in the Controller database and continues to display that record.
New	Displays empty (except for default values) Details for creating a new record.
Update	Saves updates to the record.
Test Connection	After saving the record to the database, click Test Connection to run a connection test.
Copy	Creates a copy of this Database Connection, which you are prompted to rename.
Delete	Deletes the current record.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this Database Connection.
Tabs	This section identifies the tabs across the top of the Database Connection Details that provide access to additional information about the Database Connection.
SQL Tasks	Lists all SQL tasks that are using this Database Connection.
Stored Procedure Tasks	Lists all Stored Procedure tasks that are using this Database Connection.
Versions	Stores copies of all previous versions of the current record. See Record Versioning.

Browser not supported