Structure of the INI File UCXJNS1I
| Parameter Name | Description |
|---|---|
| [ GLOBAL ] | |
| name = |
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: NSK01 |
| system = |
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: BA |
| language = |
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
Default: (E,D) |
| logging = |
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: LOGA## |
| logCount = |
number of log files being kept on disk Default: 10 |
| helplib = |
name of the message text library may have different names dependent on platform rules. Default: UC1MSL |
| check_Pw_Always = |
Password check for jobs. Values
Default: Y |
| max_Open_Table_Size = |
The number of files that jobs can open at the same time. This limitation serves to avoid problems that can occur if jobs open files but do not close them because of an error in their JCL. Values
Default: 1000 |
| tacl = |
Use this parameter in order to specify the TACL Executable that should be used. The standard TACL environment is used if this parameter is missing or if no parameter has been specified. Default: |
| tacl_Time_to_live = |
Time (in 1/100 seconds) that a TACL that has been started by the agent can require to start a job process. An error message is sent and the job is canceled if this period of time is exceeded. Default: 6000 |
| tcp_Nodelay = |
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
Default: yes |
| uc4_Macro_File = |
NSK-file name (fully qualified) of the file including TACL macros that are supplied with the AE delivery package (usually the file name is UC4MACS; the volume and subvolume are installation-specific). Default: $DATA01.SBB.UC4MACS |
| user_Vterm = |
Process name of the virtual terminal emulation belonging to the Agent Default: $ZTN0.#PTNTB46 |
| vhterm = |
Process name of the virtual terminal emulation belonging to the particular Job The setting user_vterm can be overruled in the Job object and in the script by using attributes. Preferably, the virtual terminal "user_vterm" is defined in the NSK job. You can enter it directly in the Job object or specify it in the script using the attribute HOME_TERMINAL. An error occurs if the virtual terminal does neither exist in the job nor in the INI file. Default: $tsim |
| collector = |
NSK process name of the AE Output Collector process. This name must be clearly identified throughout the system and must be available at any time. Recommendation: $UC4OC Default: $UC4OC |
| collector_Cpu = |
CPU of the Output Collector. Another CPU than the agent's should be selected here. This increases the system's fault tolerance. The Output Collector and the agent mutually monitor themselves. If one of the processes fails (even if this happened because of a CPU failure, for example), the other one automatically restarts the troubled process (if EXECUTOR_RESTART is set). Default: |
| collector_Params = |
Leave this field blank because it is only relevant for diagnostic purposes. Default: |
| collector_Prio = |
Priority of the Output Collector Default: |
| cpu_Mask = |
This parameter indicates the CPUs that AE can use for batch processing. A chain of up to 16 0/1 values (such as 0001111). The first position refers to CPU 0, the second to CPU 1 etc. AE starts processes only in these CPUs , thereby facilitating the separation of online and batch applications. If no CPUs of value 1 are available, AE also uses other CPUs (processing is given priority over resource protection). Default: 11111111111111111 |
| default_User = |
hw=xxxsw=yyy Default: SBB.NULL |
| default_User_Fetch_Interval = |
Interval (in seconds) after which the erroneous attempt of logging on to the default user is repeated by the Server. Default: |
| executor_Restart = |
Indicates whether the automatic restart of the agent by the Output Collector should be allowed Values
Default: 0 |
| ft_Temp_File = |
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
Default: yes |
| jobFile_Sec = |
Security string for job files Values
Default: |
| [ TRACE ] | |
| file = |
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: TRACA## |
| trccount = |
Number of stored trace files Default: 10 |
| tcp/ip = |
traceflag Default: 0 |
| controlflow = |
traceflag Default: 0 |
| dump = |
traceflag Default: 0 |
| event = |
traceflag Default: 0 |
| filetransfer = |
traceflag Default: 0 |
| job = |
traceflag Default: 0 |
| message = |
traceflag Default: 0 |
| misc = |
Traceflag Default: 0 |
| msgconv = |
Traceflag Default: 0 |
| [ TCP/IP ] | |
| cp = |
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 |
| bindAddr = |
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: |
| bindLocal = |
Consideration of local host 127.0.0.1 (IPv4) or ::1 (IPv6). Use this parameter together with BINDADDR=. Values
Default: 0 |
| bufferSize = |
Input-buffer size in bytes for file transfers. For the input buffer, it is recommended to specify 33000 bytes in combination with TCP/IPv6 and 20000 bytes for the standard TCP/IP. Default: 3300 |
| chiffre = |
Encryption for transfer. Values
Default: 1 |
| connect = |
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: 30 |
| connwait = |
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: 200 |
| port = |
Port number of the agent. Other agents and the Job Messenger establish a connection with the agent by using this port number. Default: 2300 |
| report = |
The time interval in seconds in which an Agent sends or the Automation Engine saves the logging to the database. Default: 60 |
| tcp_KeepAlive = |
This sends keep-alive packets in order to keep the agent connections. This parameter is only checked when the agent runs under Linux. Values
Default: Y |
| tcp_Nodelay = |
This defines the use of the Nagle algorithm for the connections of the Automation Engine. Values
Default: 1 |
| [ AUTHORIZATION ] | |
| initialPackage = |
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: |
| keystore = |
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: |
| [ FT-STATUS-STORE ] | |
| filename = |
Name of the StatusStore file that stores the restart information The name of the sub-volume is already specifed in the file INSTINI during the installation process and generated in the agent's INI file using the default file names (UC4SST, UC4SSD, UC4SSL, UC4SSH). Default: |
| detail-filename = |
Status store detail name, max. 8 characters Default: |
| head-filename = |
Status store head name, max. 8 characters Default: |
| log-filename = |
Status store log name, max. 8 characters Default: |
| [ HOSTS ] | Assignment of an agent's name to its address (DNS name or TCP/IP address) if it cannot directly be accessed through the address that is stored in the server. 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. |
| [ MISC ] | |
| bindDelay = |
binddelay[sec] Default: 6; |
| bindRetry = |
internal only Default: 10; |
| fopenDelay = |
fopendelay [0.01 sec] Default: 200 |
| fopenRetry = |
internal only Default: 10 |
| fremoveDelay = |
fremovedelay [0.01 sec] Default: 100 |
| fremoveRetry = |
internal only Default: 50 |
| lastReport = |
internal only Default: 1 |
| paliveDelay = |
palivedelay [0.01 sec] Default: 200 |
| paliveRetry = |
internal only Default: 10 |
| prefileOpen = |
internal only Default: 25 |
| trcMemory = |
internal only Default: 1 |
| trcOpenClose = |
internal only Default: 1 |
| trcTimeLimit = |
trctimelimit [sec] Default: 80 |
| [ VARIABLES ] | This section contains the agent variables that include agent settings and information. |
| UC_EX_FILE_MASK_PROCESS = |
Mask for file names When the agent processes the script functions PREP_PROCESS or PREP_PROCESS_FILE, a file is created with the generated data sequence. You can specify the structure of the file name here. Default: TMM.ERRRRRRR |
| UC_EX_JOB_MD = |
Path and file name of the Job Messenger Default: UCXJVxxM |
| UC_EX_IP_ADDR = |
IP address used to contact Agent's listen port. Default: |
| UC_EX_IP_PORT = |
Port used to contact Agent's listen port. Default: |
| UC_EX_HOST_ROLE = |
Role of the Agent, which is the name that can be used as a filter in Agent groups. Default: |
| UC_EX_HOSTCHAR = |
Suffix part of the UC_HOSTCHAR_<SUFFIX> variable which contains specific agent settings. Default: DEFAULT |
| UC_EX_PATH_BIN = |
Path to Agent binaries Default: $system.uc4 |
| UC_EX_PATH_JOBREPORT = |
Path to which the Agent writes job reports Default: $system.uc4tmp. |
| UC_EX_PATH_TEMP = |
Path to which the Agent writes log and trace files Default: $system.uc4tmp. |
| UC_HOST_CODE = |
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 |
| UC_HOST_JCL_VAR = |
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: NSK |
| [ CP_LIST ] | This section is self-maintained and contains port-to-host mappings of either all available communication processes or TLS-Gateways depending on the Agent's server connection setup. 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 |