Structure of the INI File ucxjo41
| 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: OS401 |
| 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: AUTOMIC |
| 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: ../temp/ucex_log_##.txt |
| 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: ./uc.msl |
| CheckLogon = |
This parameter checks the user data in the Login object. OS/400 jobs: The User ID that is specified in the Login object must also be activated on the OS/400 platform as otherwise, you will not be able to start jobs. Values
Default: 1 |
| sbmjob = |
You can specify here whether the submitted job is written to the log file. Values
Default: 1 |
| sbmmsk = |
The start parameter for the submitted job. Default: OUTQ(*JOBD) PRTDEV(*JOBD) |
| JOBMONQ = |
User defined message queue, used for additional Job monitoring. This message queue is added to the SBMJOB command and used for additional monitoring of ended jobs. Default: UC4/JOBMONQ |
| spool = |
This parameter refers to the spool files of a job run. Values
Default: delete |
| store_Type = |
You use this parameter to determine the locations where the StatusStore files of file transfers should be stored. Values
Default: QSYS |
| 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 |
| TcpKeepAliveTime = |
Send TCP packets to keep the agent connections alive. Default: yes |
| userid_Type = |
This is an additional parameter that allows to allow or reject particular users. Values
Default: EXCL |
| console = |
The name of one or more message queues that should be monitored with a "Console" event type. The message queue names are separated by ";". Default: QSYS/QSYSOPR |
| dqname = |
The name of the data queue of the agent's job. If several instances of an agent are run from the same library, a data queue name must be provided for each instance. If this entry is deactivated in the INI file, the agent sets the data queue name in the form "DQ######" (###### = 6 figure job number). Default: DQ |
| ft_Temp_File_Ifs = |
Creates temporary files in file transfers for IFS file system. Values
Default: no |
| eventBatch = |
Represents a maximal number of messages processed from Message Queue (represented by parameter 'console=') in one transaction. Maximal value is 164. Default: 8 |
| eventRetry = |
Represents a period of time (in seconds) when the Agent tries to resend uncommitted events to Automation Engine. Default: 60 |
| [ 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: ../temp/ucex_trace_##.txt |
| 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 |
| memory = |
traceflag Default: 0 |
| message = |
traceflag Default: 0 |
| miscellaneous = |
traceflag Default: 0 |
| variable = |
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 |
| 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 |
| maxRepCnt = |
The maximum number of report blocks that should be transferred to the Automation Engine at the same time. Default: 8 |
| 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 |
| sendBufferSize = |
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: 1048576 |
| recvBufferSize = |
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: 1048576 |
| [ AUTHORIZATION ] | |
| 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: |
| keyPassword = |
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: |
| [ 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. |
| [ USERID ] | The definition of the authorized/unauthorized users Format: user=START|NO_START User has to be defined in the notation of the Operating System, Windows: Domain\User Unix : user BS2000 : Userid TSOS SAP : client number/user name Examples: Windows: home\ni=START BS2000 : TSOS=NO_START SAP : 001/NI=START This section only affects Job objects. File Transfer or FILE Event Objects are not affected. |
| [ VARIABLES ] | This section contains the agent variables that include agent settings and information. |
| UC_EX_JOB_MD = |
Path and file name of the Job Messenger Default: UC4/UCXJO41M |
| 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_CACHE = |
Directory is used to store client-wide resources. Default: |
| UC_EX_PATH_TEMP_IFS = |
IFS directory in which the StatusStore files of File Transfers should be stored. Default: |
| UC_EX_PATH_BIN = |
Path to Agent binaries Default: . |
| UC_EX_PATH_JOBREPORT = |
Path to which the Agent writes job reports Default: ../temp |
| UC_EX_PATH_TEMP = |
Path to which the Agent writes log and trace files Default: ../temp |
| 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: EBCDIC_00273 |
| 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: OS400 |
| [ 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 |