Database Agent

Name of the agent.

The agent name is limited to 32 of the following characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#"

Name of the AE system.

This entry must be identical to the entry in the Automation Engine's INI file.

Language that is used to log on. Entries for primary and secondary language.

Allowed values: "E", "D", "F"
Default: "E,D" (primary: English, secondary: German)

If there is no message in the primary language, a message in the secondary language is searched for.

Path and file name of the log file.

The number signs serve as placeholders for a series in numerical order. If you start the agent, the log files are renamed so that the most current log file is always the one with the number 00.

LogMaxSize=

The maximum size of the log file in bytes.

A new log file will be created when the limit that has been defined here is reached.

Default value: 10 MB

The default value will be used when you set the value "0".

You can use one of the following prefixes with this value:
k...kilo, M...mega, G...giga

Examples: 100k corresponds to 100 kilobytes, 20M to 20 megabytes and 1G to 1 gigabyte.

The agent reads LogMaxSize, if a value is set, and is not 0, the value is used. If LogMaxSize doesn't exist, or is 0, the agent uses the max_logging_kb setting.

The maximum size of the log file.

A new log file is created when the size that you specify here has been reached.

Default value: 1000 KB

The agent reads LogMaxSize, if a value is set, and is not 0, the value is used. If LogMaxSize doesn't exist, or is 0, the agent uses the max_logging_kb setting.

log_to_file=

Creation of log files.

Allowed values: "0", "1" (default values)

"0" = No log files are created.
"1" = Log files are created.

Logging contents are always sent to the Automation Engine regardless of the specifications made here. These contents are available in the System Overview.

helplib=

Name of the message file.

The name and the path of the file that includes the authentication package (company-key file).

This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Any attempt to log in fails if the company-key file cannot be found.

When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward.

The name and the path of the file that includes the information of the authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended.

The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview.

Java agents (SAP, RA, databaseA database is an organized collection of data including relevant data structures. and JMX) that run under UNIX create a keystore file with the following right: "-rw-r--r—". In doing so, other OS users can also access this file.

[TRACE]

Path and file name of the trace file.

The number signs serve as placeholders for a series in numerical order. When you start a trace, the trace files are renamed so that the most current trace file is always the one with the number 00.

Number of stored trace files.

TraceMaxSize=

The maximum size of the trace file in bytes.

A new trace file will be created when the limit that has been defined here is reached.

Default value: 10 MB

The default value will be used when you set the value "0".

You can use one of the following prefixes with this value:
k...kilo, M...mega, G...giga

Examples: 100k corresponds to 100 kilobytes, 20M to 20 megabytes and 1G to 1 gigabyte

tcp/ip=

Trace flags of the agent.

Allowed values: "0" (default value) to "9"

Set trace flags only in close cooperation with Automic Support.

bindaddr=

IP address or host name for communication process connection.

Use this parameter if the connection should be established via a particular IP address (for example, the computer has more than one network interface card).

connect=

Time interval in seconds during which the agent attempts to establish connection to the Automation Engines. Affects the connection setup for a restart or after a lost connection.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE system has been made. Afterwards, you can use the parameter RECONNECT_TIME in the Host Characteristics for this purpose.

cp=

Address of the AE system's communication process to which the agent should connect.

Allowed formats:
DNS name:port number
TCP/IP address:port number

[ORACLE]

enable_output=

Transfer of outputs that are made by stored procedures.

Allowed values: "0" and "1" (default)

"0" - The output is not written to the job report.
"1" - The agent writes outputs to the job report.

buffer_size=

Buffer size in bytes for the outputs that should be written to the job report.

Default value: 8000

Determines the value that the agent returns if a SELECT is made to the MACHINE column of the V$SESSION view.

The MACHINE column is defined as VARCHAR2(64). To define a shorter value, you can use this parameter.

This setting is only relevant if you use the Avaloq Agent.

[SQL]

connect=

Time interval in seconds during which the job tries to establish a connection to the database.

retention_time=

Number of seconds after which an unused database connection should be terminated.

type=

Database type.

Allowed values: "MSSQL", "ORACLE", "DB2", "MYSQL", "INFORMIX", "INGRES", "HANA" and "SYBASE", "POSTGRESQL", "EXASOL"

Number of connection attempts to the database.

The number that is specified in this parameter determines how often the agent tries to connect to the database. After the nth failure, the job ends with status ENDED_NOT_OK.

The agent continues to connect to the database if this parameter is not specified in the INI file. The job remains active until the database is available again or until it is canceled.

Output of blank lines after tables that are used in reports.

Allowed values: "0" and "1" (default value)

"0" - The agent does not insert a blank line after a table.
"1" - A blank line is inserted after each table.

Connection method to Oracle databases.

Allowed values: "0" (default) and "1"

"0" - The agent can only connect to an Oracle Database Instance. The Job object contains the relevant connection data.
"1" - The agent can connect to Oracle RAC nodes. The Oracle file tnsnames.ora contains the relevant connection data.

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

The Windows user under which the agent has started is used to log on to MS SQL databases.

Allowed values: "0" (default) and "1"
"0" - SQL Server authentication: Login data used to log on to the database is retrieved from the Login objects that are used in database jobs.
"1" - Windows authentication: The Windows login of the OS user under which the agent runs is used.

Requirements:

• An MS SQL Server database is used (type=MSSQL).
• The database agent runs on a Windows operating system.
• UC_HOSTCHAR_DEFAULT: ANONYMOUS_JOB = "Y"

If you install the JDBC driver, you must also copy the file "sqljdbc_auth.dll" to the database agent's BIN directory. This file's architecture must comply with the architecture of the Java Virtual Machine that is used. For example: If you start the agent using a JVM with an x64 architecture, the DLL must also be an x64 file.

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.

[VARIABLES]

This section contains agent variables with agent information and settings.

[CP_LIST]

List of communication processes.

This list is created when the agent starts and extended when new communication processes are activated. More detailed information about establishing a connection is provided in the chapter Multi-Server Operation.

The communication process that has been defined in the parameter cp= (section [TCP/IP]) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address