Agent VMS

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

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]ucxjvxx_L##.TXT

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

when to read users from section [USERID].

You allow or reject User IDs by using the parameter userid_type= in the [USERID] section. You can use the parameter ReadUserAlways= in order to specify whether this section should always be read before a job starts or only once when the agent starts. Reading this section only once improves the performance of your system and is therefore the default value.

Values

• yes: The agent always reads the [USERID] section before a job starts.
• no: The agent reads this section only once when the agent starts.

Default: no

The option that can be used to allow or reject particular AE users.

Values

• INCL: Access must be granted to every single user in the [UC_USER] section.
• EXCL: No access is granted to the AE users who are specified in the [UC_USER] section. All other AE users can start jobs

Default: EXCL

The definition of the logical name (entries are converted to uppercase letters).

If this parameter is not specified, the logical name is created as shown below:

<UC4_AE system name>_<Agent name>_Agent

Default:

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 maximum level of sub-directories for FILE Events.

You use this setting in order to determine the extent to which the directory structure is included in your search for FILE Event files. The search directory serves as the basis for the maximum sub-directory level.

By limiting the directory level, you can improve the performance of FILE Events especially when their folder structure is deeply nested and includes numerous files.

This parameter is relevant for FILE Events and the script element GET_FILESYSTEM

Values

• 0: There is no limitation.
• 1: The files are only searched in the search directory. Sub-directories are not included in this search.
• 2: With this setting being used, the search for files includes the search directory and one directory level below.
• 3: The search includes the directory plus two sub-directory levels.
• 4...n: The search includes the directory plus n-1 levels

Default: 0

The time limit in second for the file search.

The file search aborts when the specified time limit is reached. No time limit applies when you either define the setting "0" or "-1".

This parameter is relevant for FILE Events and the script element GET_FILESYSTEM.

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

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]ucxjvxx_t##.txt

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

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

Encryption for transfer.

Values

• 0: Non-encrypted transfer.
• 1: Transfers are encrypted.

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

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

Default: 500000

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

Default: 8

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

This sends keep-alive packets in order to keep the agent connections.

This parameter is only checked when the agent runs under Linux.

Values

• Y: Keep-alive packets are sent.
• N: Keep-alive packets are not sent.

Default: Y

The time interval in seconds in which keep-alive packets are sent in order to keep connections.

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

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

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:

This parameter checks the available hard disk space before a file transfer is processed.

Checking the available space of network drives may occasionally lead to an incorrect result.

Values

• yes: The system checks whether there is sufficient hard disk space for the files that should be transferred. The files will only be transferred when there is enough space. Otherwise, the file transfer will abort with an error message.
• no: No check is made.

Default: no

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.

copy jobreport after jobexecution

possibly variables in filename:

&userid ....... userid ofjobexecution

&vms-jobname .. job-name in vms

&uc4-jobname .. object-name of uc4-job

&client ....... number of uc4-client

&runnr ........ job run-number

Default: [-.report]&vms-jobname_&client_&userid_&uc4-jobname_&runnr.log

file transfer: line breaks in text files

Values

• yes: The agent always adds an LF to the end of text files in file transfers in which it is the receiving agent.e It is irrelevant whether the files already end with an LF.
• no: The files are transferred without any changes.

Default: no

Convert filename to lower case.

The file name is important for the script functions PREP_PROCESS_FILENAME and wildcard file transfers. Use this parameter in order to specify whether the agent should leave the file name unchanged or convert it to lowercase letters.

Values

• yes: File names are always converted to lowercase letters.
• no: The agent does not adjust the file name's spelling.

Default: no

The maximum size of a trace file.

The agent creates a new file if this value has been reached. Bytes are used by default. Alternately, you can also append the letter "K" or kilobytes or "M" for megabytes to the number. You can use uppercase or lowercase letters for this purpose.

Default: 32M

Indication of file attributes for file transfers.

Combination of one or multiple settings separated by comma.

It is recommended to use the following values: alq=5000,deq=5000,mbc=64,mbf=64

Note that the INI file parameter is read with each file transfer execution. File attributes can be changed while the agent is running. If you specify the file attributes directly in the file transfer, these attributes are used instead of the attributes that are defined in the INI file.

Values

• alq: Number of disk blocks used for the file transfer by default (1 block = 512 Byte)
• deq: Number of disk blocks for extending the required memory
• mbc: Specifies the number of blocks allocated to the I/O buffer
• mbf: Indicates the number of I/O buffers that are to be allocated
• fop: This file attribute currently supports the following parameters: cbt (contiguous-best-try), ctg (contiguous) and tef (truncate at end-of-file). They are separated by commas (e.g. fop=ctg,tef).

Default:

VMS command for starting a job in batch mode. You can adjust is user-specifically by using additional SUBMIT parameters:

For example, you can set up and prioritize your own batch queue for AE and specify it as a parameter Example: /QUEUE=UC4$BATCH

If no queue parameter is specified, jobs start in the standard queue SYS$BATCH.

Default: submit &jobFile /LOG=&jobReport /USER=&user

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

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: [-.bin]

Path to which the Agent writes job reports

Default: [-.out]

Path to which the Agent writes log and trace files

Default: [-.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: UC_CODE

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

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