Installing the Avaloq Agent in an Existing Automation Engine System

This topic guides you through the installation of the Avaloq Agent used to execute jobs and events on the target Avaloq system.

Supplied Files

The files that are relevant for the Avaloq Agent are stored in the IMAGE:AGENTS\SQL directory. Additionally, the Templates and JDBC (empty) folders are supplied. The Templates folder stores template files for specific Avaloq jobs, while the JDBC folder is meant to store the JDBC driver installation.

Installing the Avaloq Agent

1. On the admin and/or user computer, install the Java Runtime Environment (JRE).

   You can download the required JRE from https://www.oracle.com/java/technologies/. This automatically installs the Java Plug-in for Web browsers. You can deactivate it in the system control since the AE does not need it. If you already have JRE installed, you can ignore this step.

   Use the following command to check the version of the current Java virtual machine (VM):

   java -version

   If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the directories is correct in the %PATH% or $PATH settings since the first JRE that is found in the list of directories is used.

2. On the host, install the Agent.

   1. Create a separate directory for the Agent (for example, C:\AUTOMIC\AGENTS\AVALOQ\BIN.

   2. Copy the content of IMAGE:AvaloqAgent to the directory you have just created.

3. On the host, install the JDBC driver.

   A suitable JDBC driver must be installed for all databases that the Agent uses. Refer to the particular vendor's installation guide.

   1. Create the JDBC folder in the BIN folder of the Avaloq Agent.

   2. Copy the JDBC driver files to the JDBC folder after successfully installing it.

   3. Restart the DB Service Agent after installing a new JDBC driver in its JDBC folder.

   Oracle

   1. Install the JDBC driver from the Oracle site.

   2. Copy the relevant .jar (ojdbc8.jar or ojdbc10.jar) file to the JDBC directory of the Agent after you have installed the driver.

      The Agent searches the relevant .jar file classes in the JDBC folder. The file name is irrelevant. It is important to use the most current .jar file. You might want to store only one jar file in the JDBC folder.

      Oracle RAC: The Agent can also be configured so that it can connect to an Oracle database in RAC. For more information, see

      Note: The agent's connection information itself has to be defined by using Connection objects (for example: in SQL variables). In the Connection object you would use Oracle or Oracle OCI as connection type.

4. On the server computer, set up the system environment.

   The Avaloq Agent uses its own Avaloq Agent INI file (UCXJAVALOQX.INI).

   1. Adjust the Avaloq Agent INI file (UCXJAVALOQX.INI) to your system environment. The INI file parameters are the same as those available for SQL Agents. For more information about the parameters see ..

      Note: All the parameter descriptions of the SQL Agent's INI file are also relevant for the Avaloq Agent with the exception of the [SQL] section.

   2. If the Agent starts on Windows, you can use the Windows user to log on to the database. The following steps are required:

      • Make sure the JDBC driver is installed as described above.

      • In the INI file, set the WindowsAuthentication= parameter to 1.

      • In the UC_HOSTCHAR_DEFAULT variable, set the ANONYMOUS_JOB parameter to Y. For more information, see .

   3. In the admin or server computer, adjust the HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary. For more information, see .

5. Start the Agent

   1. Make sure that the AE system is running on the server computer. For more information, see .

   2. On the host, start the Agent with the following command: java -Xrs -Xmx1G -jar ucxjavaloqx.jar.

      An Agent object is automatically created in the system Client 0 and stored in the HOST folder.

   3. On the admin or server computer, verify that the Agent is logged on to the Automation Engine.

      Newly logged on Agents are not assigned to a Client automatically and can only be viewed in Client 0. Once you have logged in to Client 0, access the Administration perspective and select Agents & Groups.

      Assign the new Agent to Clients with the required rights using the Agent object definition. For more information, see .

   Use the ServiceManager to start or end the Agent as a service. For more information, see .

Next Steps

The Avaloq Agent is installed now and an Agent object template is available in Client 0. You can use this template to create additional Avaloq Agent objects.

To enable the communication between the Avaloq system and the Automation Engine, you must create Connection objects.

Finally, you create the Avaloq jobs in the RA Avaloq solution.

See also:

• Creating Avaloq Connection Objects

• Configuring the RA Avaloq Agent

• Working with RA Avaloq Jobs