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: PROXY01

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

AE and Java components only:

Logging to standard output can be enabled by setting the value to CON:

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/proxy_log_##.txt

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:

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: 8443

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.

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

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

Inidcate whether Agents which are denied by AGENT_LIST settings will be shutdown by the Proxy, so that the Agent does not try to reconnect immediatelly again.

Default: N

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

AE and Java components only:

Tracing to standard output can be enabled by setting the value to CON:

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/proxy_trace_##.txt

Number of stored trace files

Default: 10

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.

Default:

traceflag

Default: 0

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

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

Connection Parameter: Address of the endpoint used to connect to the AE system.

Allowed formats:

DNS Name:Port number

TCP/IP Address:Port number

Default: jcphost:8443

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.

In a distributed server environment, this value must be adapted with a valid IP address that is available to that specific host.

Default:

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: 60

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". Authentication will not succeed if the company-key file is missing.

When the agent starts, it reads the company-key file. The file is deleted after successful authentication.

Default:

The path to the folder where additional trusted certificates are stored (optional). Certificates must be PEM encoded.

Default:

The path to the folder where the agent can store security related files needed for authentication. E.g., private key, signed certificate, root certificate.

If the folder does not exist, it will be created when the agent starts for the first time. The folder should not be deleted, renamed or moved.

Default: ./security

The password used to encrypt the agent's private key.

Password might be encrypted with our encrypting tool (UCYBCRYP Utility).

A random password will be generated at runtime if this is left empty.

Default:

When an Agent starts using the value defined in the connection= parameter, it receives a list of all JCPs available from the Automation Engine. On connection attempts from that point forward the agent will connect to a random JCP from the JCPLIST.

You can also use the JCP_ENDPOINT parameter in the UC_SYSTEM_SETTINGS variable to define where to reach the JCPs. In this case, the Agent receives all entries from the JCP_ENDPOINT definition and stores the information in this section.

If the JCP_ENDPOINT points to the location of only one load balancer, the JCP sends this location to the connecting Agent. However, if the JCP_ENDPOINT points to more than one load balancer, the JCP sends the location of all the load balancers available to the connecting Agent.

Allowed formats:

JCP1=host-name:port

JCP2=host-name:port

...

or

JCP1=https://host-name:port/

JCP2=https://host-name:port/

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