Establishing the Connection to Avaloq

{"URL":["/*.*/awa/pa_view_sheet_connection_avaloq"],"heroDescriptionIdentifier":"ice_hero_CONN_Avaloq","customCards":[{"id":"ice_JDBC_CONN_Avaloq","title":"Creating JDBC Connection Objects","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AVALOQ/*.*/Agent%20Guide/Content/AVALOQ/AVALOQ_Connection.htm","languages":["en-us"]},{"id":"ice_Program_CONN_Avaloq","title":"Creating Program Connection Objects","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AVALOQ/*.*/Agent%20Guide/Content/AVALOQ/AVALOQ_Connection.htm","languages":["en-us"]},{"id":"ice_trouble_CONN_Avaloq","title":"Troubleshooting Avaloq Connections","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AVALOQ/*.*/Agent%20Guide/Content/AVALOQ/AVALOQ_Connection.htm","languages":["en-us"]},{"id":"ice_related_information_CONN_Avaloq","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AVALOQ/*.*/Agent%20Guide/Content/AVALOQ/AVALOQ_Connection.htm","languages":["en-us"]}]}

The communication between the Avaloq Agent and the target system is established by Connection objects. They contain the parameters (target system endpoint, login data and so on) required to authenticate on and connect to the target cloud solution. As an administrator user, you create the necessary Avaloq Connection objects. As a developer or object designer, you assign the respective Avaloq Connection object to the Automic Automation Run DAG Jobs to execute and monitor the jobs on the target cloud solution without leaving Automic Automation. This topic explains how to configure the Avaloq Connection object.

After installing the Agent, a Connection object template called CONN.AVALOQAGENT.JDBCCONNECTION is available by default in Client 0 > Process Assembly > Explorer > TEMPLATE. You use this template to create the Connection objects that you need.

Adding an Avaloq Connection Object

  1. In the Automic Web Interface, go to the Process Assembly perspective. It opens to the Explorer view that contains the list of jobs that are available to you in your system.

  2. You have two options:

    • Right-click anywhere on the list and select Add > Add Object.

    • Click the Add Object button on the toolbar.

  3. On the Add Object dialog, start typing Airflow in the Search field.

  4. Select Avaloq Connection and click Add. The Object Name dialog is displayed.

  5. Enter a descriptive Name.

  6. Optionally, enter a short and descriptive Title that helps you recognize the purpose of the object.

  7. Click OK. A new page opens where you can start with the object definitions.

Creating JDBC Connection Objects

To Create a JDBC Connection Object

  1. Click Add Object in the toolbar and, on the Add Object dialog, select Connection.

  2. Enter and Name and, optionally a Title that describes the purpose of the object.

    Tip: Give the Connection object a name that helps you identify the database to which it should connect.

    The object definition pages open to Avaloq Connection.

  3. In the Connection section select your Database Type. Depending on the database, the Connection settings change.

    Keep the Free from Entry check box unchecked. The Host, Port and SID fields are displayed. The values you fill in will populate the read-only JDBC Connect String field in the following 12c format for Oracle:

    jdbc:oracle:thin:@//{host}:{port}/{service}

    In previous releases, there was a SID field in place of the Service Name field. In those releases, the JDBC Connect String field was populated in the Oracle 9i/10g/11g format: jdbc:oracle:thin:@{host}:{port}:{sid}. If you need to continue using the older format going forward, you can enter the JDBC connect string manually as described below.

  4. In the Login Data section, enter the user credentials of the database. For information about how to create and configure this user in the database, please refer to the official product documentation.

  5. Save the object.

Creating Program Connection Objects

Create an AVALOQAGENT > AVALOQCONNECTION object in Client 0 as described in the Automic System documentation. Optionally create additional Connection objects that can be used for Job overrides in the Clients where you define jobs.

The Login field on the Attributes page is not used Automic System jobs of the Avaloq Agent.

Troubleshooting Avaloq Connections

For Oracle Databases

If you cannot connect to the Avaloq database after properly configuring the Connection object, make sure that the database in the system is compatible with the provided Oracle-JDBC driver.

In case of incompatibilities, replace the Oracle-JDBC-jar ojdbc*.jar with the latest version.

See also: