SQL Connection Objects

{"URL":["/*.*/awa/pa_view_CONN_SQL"],"heroDescriptionIdentifier":"ice_connection_sql","customCards":[{"id":"ice_connsql_database","title":"Defining the SQL Database Page","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_Connection_SQL.htm","languages":["en-us"]},{"id":"ice_advancedsettings_connsql","title":"Defining Advanced Settings for SQL Connection Objects","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_Connection_SQL.htm","languages":["en-us"]},{"id":"ice_working_with_objects","title":"Working with Objects","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_WorkingWithOverview.htm","languages":["en-us"]},{"id":"ice_AWIs_CommonFunctions","title":"Common Functions","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/_Common/CommonFunctions/CF_OverviewOfChapter.htm","languages":["en-us"]},{"id":"ice_UnderstandingPA","title":"Understanding the Process Assembly Perspective","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/ProcessAssembly.htm","languages":["en-us"]},{"id":"ice_Overview_AWI","title":"Understanding the User Interface","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/_Common/GettingStarted/GS_OverviewAWI.htm","languages":["en-us"]}]}

Connection objects contain the parameters that make the communication between Automic Automation and external systems possible. As an administrator, you create the Connection objects that developers and object designers use to configure executable objects.

As a developer and object designer you need SQL Connection (CONN) objects when you define VARA objects that retrieve values from an SQL database. As an administrator user, you create the SQL Connection objects that provide the required connection data.

Defining the SQL Database Page

sql connection object,sql connection,sql agent

On this page you enter the values that build the base connection string that the SQL Agent will use to connect to the target database.

  1. In the Connection section you specify the type of database and the connection data.

    Automic Automation supports multiple database types. If you do not find yours in the Database Type dropdown list, select Generic JDBC and enter the Connection String as indicated by your provider.

    For all other database types in the dropdown list the following must be specified:

    1. Server:Port

      Name of the computer on which the database is available and the port number. If you specify Port 0 the database agent itself attempts to find a suitable port.

    2. Database Name

      Name of the database that should be used.

  2. In the Login Data section specify:

    • Login Object

      Optionally, enter the Login (LOGIN) that provides the login data (client, user, password).

      Important! In this case, the Login object must use a DB service agent and not an SQL agent.

    • Alternative User Name and Alternative Password

      Alternative user and password in case the data delivered by the Login object fails.

  3. In the Connection Test section click the Test button to try the connection. A message displays the results of the test.

Defining Advanced Settings for SQL Connection Objects

sql connection object,sql connection,sql agent,sql connection string extension,sql connection properties extension

On this page you can extend the base connection string that will be built based on the values you entered in the Connection section of the Database page.

  • Connection String Extension

    The values that you enter here are appended at the end of the base connection string before the Agent establishes the connection to the database. A semicolon (;) is added between the connection string parameters automatically.

  • Connection Properties Extension

    The Agent uses the values that you enter here to set Java properties prior to loading the JDBC driver. These properties can be used to change the behavior of the JDBC driver. The JDBC properties vary by database vendor and version.

    Example: If you want to enable TLS v1.2 for MySQL, enter enabledTLSProtocols here.

For detailed information, please refer to your official database documentation, for example MSSQL or MySQL.

See also: