Agent SQL

Structure of the INI File ucxjsqlx.ini

Parameter Name Description
[ GLOBAL ]
name =

Name of the agent (or proxy agent)

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

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.

The host name is used instead if this parameter remains undefined. Lowercase letters are converted to uppercase letters.

Default:

system =

AE system name

The name can consist of a maximum of 8 characters. Allowed are the upper-case letters A to Z, numbers and "_".

System names must not contain the character "_" if you use a z/OS agent in combination with the SMF technique. By default, the job Includes convert "_" to "#". Should you intend to use "_" despite of this fact, you can bypass this situation by specifying the system name in the Event Monitor with "#".

Default: AUTOMIC

language =

The Language(s) in which the log messages are displayed.Always a pair of languages separated by comma enclosed in brackets.

if a message text is not available in the primary language the secondary language will be taken.

Values

  • E: english
  • D: german
  • F: french

Default: (E,D)

logging =

Full file name pattern for log file names

$$ is replaced by the purpose of a Process (CP or WP or JWP or DBSERVICE). No replacements in other components

* is replaced by the 3 digit number of a Worker Process.

## is replaced by the log file sequence number after the existing log files' corresponding numbers have been raised by one during startup of the component.

z/OS components only:

If you comment this parameter, this log file is stored in JES. Also refer to the parameter logpurgeclass= which is described below.

The following parameters can be added if the log is written to a dataset (after the dataset name and separated by semicolons):

"recfm" = (all 27 z/OS plus * and A record formats are valid)

"lrecl" = (0, each positive number up to 32760 and X for each reclen)

"blksize" = (0, each positive number up to 32760)

"space" = ([CYL,TRK],(prim,sec,directory))

For relative path indications the system uses the installation directory when creating files.

For BS2000/OSD Operation System the name may be specified with or without User ID. If without User ID the log file is written to the user ID under which the component has been started

Default: ./temp/log_##.log

logCount =

number of log files being kept on disk

Default: 10

helplib =

name of the message text library

may have different names dependent on platform rules.

Default: uc.msl

log_To_File =

Creation of log files on disk.

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

Values

  • 0: No log files are created.
  • 1: Log files are created

Default: 1

max_logging_kb =

The maximum size of the log file in kilobytes.

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

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

Default: 10000

LogMaxSize =

The maximum size of the log file.

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

You can use one of the following suffixes 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 parameter "max_logging_kb" is used for log-file changes if this parameter is not specified or the value is "0".

Default:

[ TRACE ]
file =

The path and the file name of the trace file.

Any file name for a text file with several place holders for current system information:

$$ is replaced by server process type (WP or CP) in the context of a server process.

* is replaced by the three-digit process number in the context of a server process.

## is replaced by 00 after the available trace files' corresponding numbers have been raised by one during startup of a trace.

xxx is replaced by the three-digit abbreviation of the respective unix version (unix agent only).

z/OS components only:

The following parameters can be added (after the dataset name and separated by semicolons) if the log is written to a dataset:

"recfm" = (all 27 record formats of z/OS plus * and A are valid)

"lrecl" = (0, each positive number up to 32760 and X for each reclen)

"blksize" = (0, each positive number up to 32760)

"space" = ([CYL,TRK],(prim,sec,directory))

Currently the External Monitoring Interface (EMI) does not produce any trace regardless of the settings here.

For BS2000/OSD the name might be specified with or without user ID. If without the trace file is written to the user ID under which the component has been started.

Default: ../temp/trace_##.txt

trccount =

Number of stored trace files

Default: 10

TraceMaxSize =

The maximum size of the trace file.

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

You can use one of the following suffixes 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 parameter "max_trace_kb" is used for trace-file changes if this parameter is not specified or the value is "0".

Default:

max_trace_kb =

The maximum size of the trace file in kilobytes.

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

The default value will be used the value "0" is set.

Default: 10000

tcp/ip =

traceflag

Default: 0

[ TCP/IP ]
cp =

Address of the communication process in the AE system to which the component should connect.

Allowed formats:

DNS Name:Port number

TCP/IP Address:Port number

Default: cphost:2217

bindAddr =

IP address the component uses to connect.

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).

Alternately, you can also specify the IP address or host name in PORT= (Format: PORT=IP address:port or DNS name:port). Specifications made in BINDADDR= are then ignored.

Default: 111.1.1.1

connect =

The time interval in seconds for the reestablishment of connections after a loss of connection.

For the Automation Engine: reconnect between Server Processes

For Agents: reconnect to the Engine

For the zOS Event Monitor: reconnect to the Agent

For the Proxy: reconnect to Automation Engine or Server Proxy

For Agents: This parameter is only effective until the first successful logon to the AE system. Afterwards, you can use the parameter RECONNECT_TIME in the host characteristics.

For z/OS Event Monitor: The Console command "MODIFY ..., EX=<addr>,:<port> serves to facilitate a new connection immediately. In this case, the attempt to re-connect to the specified agent is made immediately. A reconnection is established, even if the Event Monitor already has a connection to another agent. A new connection is then established. The old connection is ended if the new connection has successfully been established.

Default: 120

[ AUTHORIZATION ]
initialPackage =

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.

Default:

keystore =

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.

Default:

[ ORACLE ]
buffer_Size =

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

Default: 8000

enable_Output =

Transfer of outputs that are made by stored procedures.

Values

  • 0: The output is not written to the job report.
  • 1: The agent writes outputs to the job report.

Default: 1

vsession_Machine =

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.

Default:

[ SQL ]
connect =

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

Default: 60

newline =

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

Values

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

Default: 1

retention_Time =

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

Default: 180

retry =

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.

Default: 0

type =

Database type.

Values

  • MSSQL: Microsoft SQL Server
  • ORACLE: Oracle
  • DB2: IBM DB2
  • MYSQL: My SQL
  • HANA: SAP HANA
  • POSTGRESQL: PostgreSQL
  • EXASOL: EXASOL
  • GENERICJDBC: Generic JDBC Driver for any DB

Default: MSSQL

useOraClient =

Connection method to Oracle databases.

Values

  • 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.

Default: 0

WindowsAuthentication =

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

Requirements:

1)An MS SQL Server database is used (type=MSSQL).

2)The database agent runs on a Windows operating system.

3)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 password are neither used nor checked.

Values

  • 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.

Default: 0

[ VARIABLES ] This section contains the agent variables that include agent settings and information.
[ CP_LIST ] This section is self maintained and contains the port to host mapping of all available Communication Processes

Allowed formats:

Port number=DNS Name

Port number=TCP/IP Address