Agent BS2000

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

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: $UC4.L.LOGG.UCXJB26.##

number of log files being kept on disk

Default: 10

Parameter that determines the password in BS2000 if there is no password in the Login object

Values

• 0: Do not determine password.
• 1: Determine password.

Default: 1

This is an additional parameter that allows to allow or reject particular users.

Values

• INCL: Access must be granted for every single user specified in (USERID).
• EXCL: Access is denied to the users that are specified in (USERID). All other users can start jobs.

Default: EXCL

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: $UC4.L.TRACE.UCXJB26.##

Number of stored trace files

Default: 10

traceflag

Default: 0

traceflag

Default: 0

traceflag

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

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:

Consideration of local host 127.0.0.1 (IPv4) or ::1 (IPv6).

Use this parameter together with BINDADDR=.

Values

• 0: No listen socket is created.
• 1: An additional listen socket is created on the local host.

Default: 0

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

Time interval in seconds during which the agent waits for a response from the communication partner (CP or another agent). If the time limit is exceeded, the connection to the communication partner will be terminated again.

Default: 20

Maximum length of messages (in bytes) that a CP (Server communication process) or an Agent accepts in Bytes.

Default: 31457280

Port number of the agent.

Other agents and the Job Messenger establish a connection with the agent by using this port number.

Default: 2300

The time interval in seconds in which an Agent sends or the Automation Engine saves the logging to the database.

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

Specify several assignments line by line, there is no upper limit for the number of assignments.

In file transfers, the sending agent obtains the destination agent's internal address from the Automation Engine.

The sending agent replaces this internal address by the external address that is defined here.

This setting is only required if you run file transfers with agents that cannot directly establish a TCP/IP connection between each other by using the address that they have received from the Server.

This can happen if the agents that are involved in the file transfer are located on different networks or if a firewall is used.

Additional parameters for the RFC task (see Enter command).

Example:

ENTERPAR=,JOB-PRIORITY=8,START=*STD,RESOURCES=*PAR(RUN-PRIORITY=248)

Default:

File transfer: Evaluation of the User ID from the "File Transfer Parameters" tab .

The User ID is not evaluated. The file transfer runs with the agent's rights. Note that AE cannot ensure full auditing ability when you use this function because theoretically you can specify any user - even an invalid user.

User ID is evaluated. File transfer is executed with the user's rights. An additional Enter (RFC task) is also started in the respective User ID.

Default: 0

Port number that the RFC task uses to establish the connection to the agent.

Default: 2400

Time period in seconds after which an RFC task stops.

An RFC task that is started by an agent can handle multiple file-transfers orders. It ends if it does not receive a task for the time period that is defined here.

Default: 900

Agent's maximum waiting time for the RFC task (seconds).

Default: 90

Format: user=START|NO_START

User has to be defined in the notation of the Operating System,

Windows: User/Domain

Unix : user

BS2000 : Userid TSOS

SAP : client number/user name

Examples:

Windows: ni/home=START

BS2000 : TSOS=NO_START

SAP : 001/NI=START

This section only affects Job objects. File Transfer or FILE Event Objects are not affected.

Path and file name of the Job Messenger

Default: *MOD(LIBRARY=$UC4.UCX26.LIB,ELEMENT=UCXJB26M,RUN-MODE=*ADVANCED)

IP address used to contact Agent's listen port.

Default:

Port used to contact Agent's listen port.

Default:

Role of the Agent, which is the name that can be used as a filter in Agent groups.

Default:

Suffix part of the UC_HOSTCHAR_<SUFFIX> variable which contains specific agent settings.

Default: DEFAULT

Path to Agent binaries

Default: $UC4.UCX26.LIB

Path to which the Agent writes job reports

Default: $UC4.JOB.REPORT.

Path to which the Agent writes log and trace files

Default: $UC4.TEMP.

Name of the code table object in client zero used for transporting jobs and job reports to the target system and vice versa

Default: BS2000_INTERNATIONAL

The reference to Includes that are used when the job is generated. (JCL Variant)

These are generally the Includes HEADER.*, TRAILER.* and RESTART.* of the system client 0000. User-defined Includes can also be used.

Default: BS2000

When an Agent starts using the value defined in the cp= parameter, it receives a list of all CPs available from the Automation Engine and it connects to one of them.

You can also use the CP_ENDPOINT parameter in the UC_SYSTEM_SETTINGS variable to define where to reach the CPs. In this case, the Agent receives all entries from the CP_ENDPOINT definition and stores the information in this section. The Agent can then select an available endpoint from the list the next time it starts or reconnects to the Automation Engine.

If the CP_ENDPOINT points to the location of only one load balancer, the CP sends this location to the connecting Agent. However, if the CP_ENDPOINT points to more than one load balancer, the CP sends the location of all the load balancers available to the connecting Agent. The Agent can then select an available endpoint from the list the next time it starts or reconnects to the Automation Engine.

Allowed formats:

Port number=DNS Name

Port number=TCP/IP Address