Agent z/OS

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

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.WORK.LOG##'

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: 'UC4.UCX.MSL'

Availability of the messages and language dependent strings.

Values

• ALL: The complete message file is held in the RAM.
• NONE: Always read from the hard drive.
• CONTROLS: All language dependant strings that are necessary in order to display the dialog program are held in the RAM (not relevant for the Automation Engine).

Default: ALL

Verification of the access authorizations with RACF.

For jobs and file transfers before the agent starts (password verification for the user of the job/file transfer and dataset authorization check in file transfers).Doing so generates more accurate agent error messages and avoids useless task starts if there is no appropriate authorization. The security system checks the running job in any case.Allowed values 0..15 where 0 is no verification and 15 is the strongest verification.

Values

• 0: no verification
• 1: Login check for jobs
• 2: Login check for file transfers
• 3: Login check for jobs and file transfers
• 4: File access check for file transfers with the Login's userid
• 5: Login check for jobs and file access check for file transfers with the Login's userid
• 6: Login check for file transfers and file access check for file transfers with the Login's userid
• 7: Login check for jobs and file transfers and file access check for file transfers with the Login's userid
• 8: File access check for file transfers with the Agent's userid
• 9: Login check for jobs and file access check for file transfers with the Login's userid
• 10: Login check for file transfers and file access check for file transfers with the Agent's userid
• 11: Login check for jobs and file transfers and file access check for file transfers with the Agent's userid
• 12: File access check for file transfers with the Login's and Agent's userid
• 13: Login check for jobs and file access check for file transfers with the Login's and Agent's userid
• 14: Login check for file transfers and file access check for file transfers with the Login's and Agent's userid
• 15: Login check for jobs and file transfers and file access check for file transfers with the Login's and Agent's userid

Default: 7

Allocation of the job's output (first extent cylinders, secondary cylinders).

Format: (number of cylinders, number of cylinders)

Default: (1,1)

Job-log deletion in the JES spool.

This setting can be overruled in the Job object and in the script using attributes. More detailed information is provided in the document that describes the message classes.

Values

• 0: The job log remains in the JES without changes.
• 1: The job log is deleted from the JES.

Default: 0

User context in which the job gets submitted to the internal reader

Values

• AGENT: The Job is submitted to the internal reader in the agent context.
• USER: The Job is submitted to the internal reader in the context of the Job user specified in the Login object used in the Job.

Default: AGENT

MVS Sysout class for log files.

This parameter can be used to route log files to the specified MVS Sysout class.

The parameter logcount= is important when you route log files. The number of log files that has been defined in this parameter is created. The oldest log file is routed to the Sysout class if this number is exceeded.

Example:

The parameter logcount= is set to 3. The first log file is routed to the Sysout class when the fourth log file is created.

The Sysout class is only considered if the parameter logging= has been commented using ";".

Values

• A..Z:
• 0..9:

Default: A

Usage of uppercase and lowercase letters in passwords.

Values

• 0: The agent converts all passwords into upper-case letters.
• 1: The password remains unchanged.

Default: 0

This parameter releases the job log for printing.

This setting can be overruled in the Job object and in the script using attributes. More detailed information is provided in the document that describes message classes.

Values

• 0: The job log is not released.
• 1: The job log is released for printing.

Default: 0

Message classes to which the class should be routed.

This setting can be overruled in the Job object and in the script by using attributes. More detailed information is provided in the document that describes the message classes.

Default: GH

Nagle algorithm usage for file transfers and all the agent's other sockets.

Activating the Nagle algorithm can improve the performance of file transfers, especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not include this INI-file parameter.

Values

• no: Activates the Nagle algorithm.
• yes: This procedure is not applied.

Default: yes

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

If the agent runs across a status change or an erroneous attempt to retrieve the status while checking a job (rarely occurs), the job's status cannot clearly be determined. This parameter can be used to specify how often the agent retries to check the status before it reports the status "ENDED_VANISHED".

Values

• 0..9999: number of retries

Default: 6

Waiting for the job's end.

By default, the agent waits until the job is available in the output queue or disappears. Occasionally, the job has already ended but cannot be found in the output queue because it is still waiting for a system event (e.g. tape swapping). Use this parameter to define whether the agent should check the job's end status after it has ended. If the job is not found in the output queue, it is monitored via the periodical job checking.

Values

• 0: The agent does not wait.
• 1: The agent waits for the job to end.

Default: 0

Repetition of the waiting time (see parameter waitSpoolReady)

Values

• 0..99:

Default: 50

Repetition of the waiting time (see parameter waitSpoolReady)

Values

• 0..99:

Default: 6

This parameter determines the complexity of the job protocol.

This setting can be overruled in the Job object and in the script using attributes. More detailed information is provided in the document that describes message classes.

Values

• 0: Only JES statistics (JESMSGLG, JESJCL and JESYSMSG) are stored in AE.
• 1: The entire job protocol (JES statistics+ job output) is stored in AE.

Default: 0

Creates temporary files in file transfers.

The OSS file system requires the parameter file_temp_file_oss to be used

on z/OS the temp file name contains the dataset name of the file to be transferred.

on z/OS The file immediately obtains its final name if the temporary file name would exceed maximum of 44 characters.

Values

• yes: The file obtains a temporary name that is composed of the letter "T" and an alphabetic string that stems from the RunID. The new file transfer protocol additionally appends a file ID in order to obtain a unique file name because basically, only a RunID is provided.The file is renamed after it has successfully been transferred.
• no: The agent assigns the final file name when the file transfer starts.

Default: yes

security context of the user for file transfer threads.

Values

• No: The authorization of the user starting the File Transfer will be checked, but the File Transfer will be executed with the authorization of the user starting the agent.
• Yes: On starting the File Transfer a switch inside the File Transfer's thread will be executed to the user context of the user, whose data has been entered in the Login object, which is referenced in the File Transfer object. Any input and output will be executed with the permissions of the user starting the File Transfer.

Default: no

Max number of concurrent UserService threads.

Default: 5

Message classes that should be read and routed.

Enter one or several message classes. Examples: "A", "ABC", "X1". You can use any order.

This setting can be overruled in the Job object and in the script using attributes. More detailed information is provided in the document that describes the message classes.

Default: AB

Handling of blanks in JCL.

Values

• 0: The JCL remains the same
• 1: The agent automatically removes blanks in the JCL before it is processes.

Default: 1

Job Entry Subsystem (JES) that has been installed on the host.

Values

• JES2:
• JES3:

Default: JES2

Indicates whether the accounting information should be enclosed in parentheses.

Values

• 0: No parentheses are used for the accounting information
• 1: Parentheses are used for the accounting information

Default: 1

This parameter generates the job card in ACF2 format.

Values

• 0: There is no job-card generation in ACF2 format.
• 1: The job card is generated in ACF2 format.

Default: 0

Mask to generate job cancel console command

This setting used to generate cancel command for running jobs.

Keywords are substituted as followed:

&01 - job name

&02 - jobID

&03 - job number

Default value: C &01

Cancel job with cancel z/OS command.

Other example: $CJ&03

Cancel job with JES cancel command.

Default: $C &02

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.WORK.TRC##'

Number of stored trace files

Default: 10

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

traceflag

Default: 0

Method used for the trace files.

Values

• 0: The trace file is normally written.
• 1: All file buffers are written to the disk after each trace line.
• 2: Close/Open is used for the trace file after each trace line. Do not use this option in combination with FILE Events because it causes an event for each line which can lead to recursive endless loops.
• 3: Trace outputs are also written to the log file.

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 agent tries to connect to a communication process if the connection was lost. If it is not successful, it tries to log on to a different communication system after a particular waiting period. It is recommended to specify AsyncConnect=1 which causes the waiting period to be reduced.

Values

• 1: causes the waiting period to be reduced.

Default: 1

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

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

Specifies the maximum number of connection requests queued for the listening socket of the agent.

This parameter cannot be used to provide a higher number than the system parameter SOMAXCONN. For example, if Listen=500 is set here, and the system parameter SOMAXCONN is set to 10, the maximum of 10 is used.

Therefore, it makes the most sense to set both parameters to the same value. The value depends on the number of parallel connections of messengers and file transfers. However, the recommended technique is to use the SMF based messaging technique rather than IP messenger.

For more information on the SOMAXCONN statement in the system's TCP/IP profile, see http://www-01.ibm.com/support/knowledgecenter/SSLTBW_2.1.0/com.ibm.zos.v2r1.halz001/somaxconnstatement.htm.

Default: 10

The maximum number of report blocks that should be transferred to the Automation Engine at the same time.

Default: 500000

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

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

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

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:

Name of the JCL-Exit module based on Assembler.

The Assembler-based module is used when you do not specify the c-based JCL Exit (the parameter ExitModul= is missing or does not contain any value).

Default: UC4JCLE

Name of the module's function that implements the JCL Exit.

The agent calls this function before it runs the job JCL. If this function returns a code other than 0, the JCL will not be processed and the job aborts.

This parameter is optional and refers to the JCL Exit module that is specified in the parameter ExitModul=.

Default: jcl_exit

Name of the DLL file of the JCL Exit module based on the programming language C.

Default:

Function that initializes the JCL Exit module (allocating memory, for example) and is called when the agent starts.

If this function returns a code other than 0, the c-based JCL Exit is deactivated.

This parameter is optional and refers to the JCL Exit module that is specified in the parameter ExitModul=.

Default:

Function that should be called when the agent ends in order to run final processes such as releasing memory).

This parameter is optional and refers to the JCL Exit module that is specified in the parameter ExitModul=.

Default:

Size of the output area.

Default: 1000

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

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.UCXJM25.LOAD

Path to which the Agent writes job reports

Default: UC4.TEMP.

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

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

Specifies if agent should to block submitting a job if another job already active with the same job name.

Values

• NO: disabled
• YES: enabled

Default: NO

Specifies if agent should check that any initiator available before job is submitted.

Values

• NO: no initiator check
• SYSTEM: agent checks if any initiator available to submit job on specified LPAR.
• SYSPLEX: agent checks if any initiator available to submit job on whole SYSPLEX.

Default: NO

Specifies if agent should check scheduling environment availability before job is submitted.

Values

• NO: disabled
• YES: enabled

Default: NO

Specifies if agent should protocol detailed information into log about jobs that wait for remote resource ( duplicate job, initiator, schenv)

Values

• NO: disabled
• YES: enabled

Default: NO

Overrides default job class of system inquired by agent on startup. Job class used during initiator check in case there's no job class defined for a job.

Default: