Proxy

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:

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

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)

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

The path and name of the server Proxy's log file.

If not specified, the client Proxy's log file is used (see the description of logging=). The ## placeholder may also be used here.

Default:

number of log files being kept on disk

Default: 10

name of the message text library

may have different names dependent on platform rules.

Default: uc.msl

Name of the segment in case of Proxy segmentation.

Segment names must follow the Automation Engine Object Naming conventions.

Default:

Load balancing switched on or off.

The Proxy is capable of a load balancing process. This means that the Proxy automatically selects the communication process that has the fewest connections. If switched on the cpName= setting must be set to a value that is unique for each Proxy instance.

If switched off a load-dependent CP selection is not performed and the client Proxy connects to the communication process that was defined in the [CP_LIST] section

load balancing may be used if only agents connect to the Proxy

Values

• Y: on
• N: off

Default: N

The name of a Proxy pair that is unique within a netArea or the entire AE system.

This setting may only be set, if the cpSelection parameter has been set to "Y".

The name may comprise up to 32 characters.

Default:

The address of the server Proxy to which the client Proxy should connect.

Permissible format: <IP address or host name>:<Port>

If a segment has been defined in the [GLOBAL] section, you should only use IPv4 addresses or host names in this parameter. The usage of IPv6 addresses might lead to problems with older agents (version < 12.1).

Default:

The number of the server Proxy's routing port.

The server Proxy monitors the routing port for incoming connections from AE components (agents, UserInterfaces, etc.).

The routing port and the service port may not be identical

Default: 2217

The period of time in seconds between memory consumption checks.

Each check calculates the current Java memory consumption and writes it to the log file. If memory consumption is over 90 percent, the server Proxy no longer accepts connections until consumption drops below 80 percent.

Default: 30

The number of days after which the log file should be automatically switched.

Default: 1

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:

Allow or deny Agent connections

If the section [AGENT_LIST] is completely empty setting is applied for ALL connections. i.e. 'allow' would represent a general whitelist

Values

• allow: Agents listed in section [AGENT_LIST] are allowed
• deny: Agents listed in section [AGENT_LIST] are denied

Default: deny

Allow or deny User Interface connections

If the section [UI_LIST] is completely empty setting is applied for ALL connections. i.e. 'allow' would represent a general whitelist

Values

• allow: User Interface connections listed in section [UI_LIST] are allowed
• deny: User Interface connections listed in section [UI_LIST] are denied

Default: deny

Period of time in milliseconds that should be waited between setting up multiple simultaneous connections to the CP.

Default: 10

The period of time in seconds in which packets are sent between the server and client Proxy to maintain the service connection.

Default: 60

Maximum number of connections the Proxy will accept.

Default: 2000

Controls the sending of keep alive packets for the TCP/IP sockets

Default: Y

Activates additional debug outputs in the log file.

A separate trace file is not created!

Values

• 0: No additional outputs
• 1: Source, destination, and size are logged when a packet is sent or received
• 2: The hex dump of the packet content is logged when a packet is sent or received.
• 3: The relevant socket, option (for example, soKeepAlive=), and value are logged when modifying the socket options.
• 4: If an SSL action takes place, the action, resulting status, and the number of consumed/generated bytes are logged.

Default: 0

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

The maximum length of time in seconds that is waited to see whether a CP responds to a connection attempt.

If the CP does not send any packets during this time, it is assumed that it is not accessible. The Proxy no longer accepts new connections if this is the case.

Default: 10

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

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

The size of the TCP/IP input buffer for the messages that should be sent (in bytes).

The default value that depends on the system environment is used when you do not define this setting or when you define the value 0.

Default: 1024k

The size of the TCP/IP input buffer for the message that should be received (in bytes).

The default value that depends on the system environment is used when you do not define this setting or when you define the value 0.

Default: 8192

This defines the use of the Nagle algorithm for the connections of the Automation Engine.

Values

• 0: Activates Nagle algorithm on all sockets.
• 1: Deactivates the Nagle algorithm on all sockets.

Default: 1

Path to the KeyStore file, which contains a certificate that was created using the Java keytool.

This parameter ensures that the connections between the server Proxy and the client Proxy are encrypted with SSL and authenticated. The client and server Proxy require the same KeyStore file.

Default:

KeyStore file password

The password is set when creating the KeyStore file.

Default:

Allowed formats:

Port number=DNS Name

Port number=TCP/IP Address

Allowed values: IPv4 address or address ranges

Format:

Single IPv4 address:<IP address>

IPv4 address range: <IP address-IP address>

IPv4 address range in CIDR notation: <IP address/prefix size>

Section might have multiple entries. Parameter names in this section are meaningless. The only requirement is that they have unique names (e.g. ag1, ag2, ...)

All parameters in this section are re-read at runtime without restarting the component.

Allowed values: IPv4 address or address ranges and (optional) AE client number or range.

Format:

Single IPv4 address: <IP address>

Single IPv4 address with a single AE client definition: <IP address,[client]>

Single IPv4 address with a range of AE clients: <IP address,[client]-[client]>

Section might have multiple entries. Parameter names in this section are meaningless. The only requirement is that they have unique names (e.g. ui1, ui2, ...)

All parameters in this section are re-read at runtime without restarting the component.

Valid format:

spx = <Server name or IP address>:<Routing port>

If a segment has been defined in the [GLOBAL] section of a client Proxy's INI file, as of v2.0 the [OTHER_SP_LIST] will be overruled by the information the client Proxy as agent manages.

Section might have multiple entries. Parameter names in this section are meaningless. The only requirement is that they have unique names (e.g. sp1, sp2, ...)