Administration Guide > Installation > Service Pack and Hotfix Installation > Installing the Agent for Databases

Installing the Agent for Databases

The following document describes the hotfix installation process for databaseA database is an organized collection of data including relevant data structures. agents.

This installation guide can be used for Windows and for Unix.

Agents for Databases can be used either to execute jobs and events or to retrieve values of dynamic Variable objects (source: SQL). Note that different configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. and start parameters are required depending on the intended use.

Database Agent for Jobs and Events
The database agent for jobs and event is only available for a particular database type (such as MS SQL) which can be specified in the agent's INI file. A separate agent must be installed for each database type that should be accessed by using jobs or events. The names of the database, Server etc. must be determined in the particular Job or Event object.
Database Agent for Variables
The agent for SQL variables can access any supported database type. The particular type must be defined in the Connection objectfor databases that is assigned to the variables. Therefore, you must only install one agent for variables. The database name and the connection parameters (Server name, port number etc.) are also defined in the DB-type Connection object. Note that the agent is configured in the Automation Engine's INI file.
The agent is only required for Variable objects that use the source SQL. SQLI variables do not require an agent.

Automic strongly recommends installing the agent in a separate directory.

Supplied Files

The files that belong to the database agent are stored in the directory IMAGE:AGENTS\SQL.

Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the JDBC driver must be installed in the JDBC folder.

Procedure

	1.	Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, this step of the installation process can be ignored.

Admin computer and/or user computer
The version of the current Java Virtual Machine (VM) of the system can be checked using the following command:

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 settings of %PATH% or $PATH. The particular Java Runtime Environment that is found first in the list of directories is used.

Download the required Java Runtime Environment from http://java.sun.com and install it. The installation process includes the automatic installation of the Java Plug-in for Web browsers. You can deactivate it in the system control. AE does not need it.

	2.	Installing the Agent

Host
Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or UC4/AGENTS/SQL/BIN).
Copy the content of IMAGE:AGENTS\SQL to this new directory. Under Windows, you can also use the program SETUP.EXE for the installation. It is available in the directory IMAGE:AGENTS\SQL\WINDOWS.

	3.	Installing the JDBC driver

Host
A suitable JDBC driver must be installed for all databases the agent should use. Refer to the particular vendor's installation guide.
Create the folder JDBC in the database agent's BIN folder. Copy the JDBC driver files to this folder after successful installation.

Microsoft SQL Server
Install the driver.
Copy the file sqljdbc.jar to the folder's JDBC directory after you have installed the driver.
The SQL Server 2000 JDBC driver cannot be used with this agent because of a program error in the driver.
If the agent starts under Windows, you can use the OS user in order to log on to the MS SQL database (Windows authentication). If you install the JDBC driver, you must copy the file "sqljdbc_auth.dll" to the agent's BIN directory. Ensure that this file's architecture complies with the architecture of the JVM that is used (for example, x64).
Oracle
Install the driver.
Copy the file ojdbc14.jar to the folder's jdbc directory after you have installed the driver.
The JDBC driver of version 9.0.1 or earlier cannot be used with this agent because of a program error in the driver.

MySQL
Install the driver.
Copy the file mysql-connector-java-5.0.3-bin.jar to the folder's JDBC directory after you have installed the driver.

DB2
The JDBC driver is part of the DB2 installation. It is available in the directory SQLLIB/java (under Windows: C:\Program Files\IBM\SQLLIB\java).
Copy the following two files shown below to the agent's JDBC directory:

db2jcc.jar (JDBC Type 4 Driver)
db2jcc_license_cu.jar (Server license)

The JDBC driver can be downloaded from IBM's homepage.
Click the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."

Sybase
Install the driver (jConnect 5.5/6.05).
Copy the file jconn2.jar or jconn3.jar to the folder's JDBC directory after you have installed the driver.

Informix
Install the driver (V3.5).
When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the agent's JCDBC directory.
Note that the agent requires Informix databases with transaction support.
Because of an Informix error, you must specify the value for the environment variable DB_LOCALE in particular versions. The error "Database locale information mismatch" occurs if DB_LOCALE has not been correctly set.
In this case, set the corresponding value in the agent's INI file, section [INFORMIX], using the parameter db_locale= (use lower case).
Example: [INFORMIX] db_locale=EN_US.CP1252

Ingres
Install the JDBC driver.
When the driver is installed, copy the file iijdbc.jar to the agent's JDBC directory.

SAP HANA
Copy the file ngdbc.jar from the HANA client's installation directory to the agent's jdbc directory.

EXASOL
Download the driver from EXASOL.
Copy the JDBC driver exajdbc.jar to the agent's JDBC directory.
Set the database type in the configuration file to EXASOL.
Set the values for
connect=60
and
retention_time=180

PostgreSQL
Download the driver from PostgreSQL.
Copy the JDBC driver to the agent's JDBC directory (postgresql-9.3-1100.jdbc4.jar for example).
Set the database type in the configuration file to POSTGRESQL.
Set the values for
connect=60
and
retention_time=180

	4.	Additional important notes

Oracle RAC
The agent can also be configured so that it can connect to an Oracle database in RAC.

	5.	Setting up the system environment

Database Agent for Jobs and Events

Host
Adjust the INI file UCXJSQLX.INI to the system environment.
If the agent starts under Windows and accesses an MS SQL database, you can use the relevant Windows user in order to log on to the database. The following measures are required:
- Install the JDBC driver as described above.
- Agent's INI file: WindowsAuthentication=1
- UC_HOSTCHAR_DEFAULT: ANONYMOUS_JOB=Y
- In database jobs, you must specify a Login object that includes a suitable entry for the particular agent even if you use the Windows authentication. The Login object's user and passwordA secret combination of characters for a Automation Engine user. are neither used nor checked.

Admin computer or Server computer
Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary. See: Job - Execution.

Database Agent for Variables

Server computer
Database agents for variables use the INI fileof the Automation Engine. Adjust the section [DB_SERVICE] which contains the specific parameters for the database agent. The agent's INI file is not required.
Now create a DB-type Connection object in the AE system for each database in use. You can also create connections for different database types.
If the agent starts under Windows, you can use the Windows user in order to log on to the MS SQL database. The corresponding DB-type Connection object requires the additional parameter "IntegratedSecurity" to be specified (value "true").

	6.	Starting the Agent

Server computer
The AE system must be running.
Host
Start the agent for jobs or events:
java -jar ucxjsqlx.jar

To start the agent in the mode for Database variables, specify the parameter -service and the path and name of the Automation Engine's INI file.
Example: java -jar ucxjsqlx.jar -iC:\AUTOMIC\server\bin\ucsrv.ini -service

An Agent object is automatically created in system client 0000 and stored in the folder HOST.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents (Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications by using the start parameter -XmX. Specifying a value that is too low can cause the agent to crash. The default value depends on the Java version that is used.The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated. Automic recommends using this parameter. More detailed information is provided in the Java documentation.
Admin computer or Server computer
Check that the agent is logged on to the AE system.
Start the UserInterface for client 0000. Call information about agents in the System Overview. Newly logged-on agents have not yet been assigned to a client; they can only be viewed in client 0000. The newly installed agent can now be assigned to clients with the required rights via the Agent object.

Use the ServiceManager to start or end the agent as a service.