Structure of the INI File UCXJWI3.INI (32-Bit) UCXJWX6.INI (64-Bit)
| 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: WIN01 |
| 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\ucxjwx6_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 |
| helpcache = |
Availability of the messages and language dependent strings. Values
Default: ALL |
| logon = |
The settings for the execution of jobs / file transfers. See: Description of the settings ANONYMOUS_FT and ANONYMOUS_JOB in the variable UC_HOSTCHAR_DEFAULT. Values
Default: 1 |
| useJobObject = |
The setting jobs starts in a Windows Job object. The value that are defined here serves as the default value for all AE jobs under Windows. A setting that should apply for a particular job can be specified in the Job tab. Values
Default: 0 |
| userid_Type = |
This is an additional parameter that allows to allow or reject particular users. Values
Default: EXCL |
| ecpexe = |
The path and the name of the interpreter that processes the script. With the default setting, Windows jobs, starting with "Interpreter" selection are able to execute PowerShell commands. The parameter " -ExecutionPolicy bypass " guarantees that the generated script (Windows job) will run regardless of security settings setup by the administrator. When this parameter is not set, the Windows administrator must explicitly allow starting Powershell scripts on host. Otherwise Powershell jobs won't be able to start. Also refer to the information contained on Microsoft's website regarding Powershell execution policies: https://technet.microsoft.com/library/hh847748.aspx Default: powershell.exe -NonInteractive -ExecutionPolicy bypass -NoLogo -file |
| ecpext = |
The extension of the file that is passed on to the interpreter. This file contains the job script. File ends should be specified without dot. Default: ps1 |
| fileProcessingMaxDepth = |
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
Default: 0 |
| fileProcessingTimeout = |
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 |
| ft_Check_Free_Disk_Space = |
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
Default: no |
| ft_Omit_User_Home = |
Determine the user home Values
Default: no |
| ft_Suppress_Report = |
Determines whether you suppress file transfer reports. The setting has to be done on the source agent and is only available for Windows agents. Values
Default: no |
| 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 |
| homeDirCache = |
You can use this parameter to determine whether the home directory of the login user is stored. Specify a period of time (in minutes) after which the agent should store the name of the home directory. This will increase performance. If you use "0", this information is not stored. Note that any changes that are made in the home directory only become effective after the specified period of time. Default: 10 |
| [ 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\ucxjwx6_trace_##.txt |
| trccount = |
Number of stored trace files Default: 10 |
| tcp/ip = |
traceflag Default: 0 |
| compress = |
traceflag Default: 0 |
| event = |
traceflag Default: 0 |
| filetransfer = |
traceflag Default: 0 |
| mail = |
traceflag Default: 0 |
| memory = |
traceflag Default: 0 |
| [ TCP/IP ] | |
| connection = |
Connection Parameter: Address of the endpoint used to connect to the AE system. Allowed formats: DNS Name:Port number TCP/IP Address:Port number Default: jcphost:8443 |
| 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: |
| 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: 60 |
| maxMsgSize = |
Maximum length of messages (in bytes) that a CP (Server communication process) or an Agent accepts in Bytes. Default: 500000 |
| 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 ] | |
| 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: |
| trustedCertFolder = |
The path to the folder where additional trusted certificates are stored (optional). Certificates must be PEM encoded. Default: |
| agentSecurityFolder = |
The path to the folder where the agent can store security related files needed for authentication. E.g., private key, signed certificate, root certificate. If the folder does not exist, it will be created when the agent starts for the first time. The folder should not be deleted, renamed or moved. Default: .\security |
| 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: |
| [ BACKEND ] | |
| useDesktop = |
Definition of whether the execution of the Windows commands of backend-type Variable objects should be shown on the desktop. This function is only available when the Windows agent has not been started via a ServiceManager (the option "Show job on desktop" of Windows jobs reacts in the same way). The commands are shown on the agent desktop. Activating this parameter is only useful when the agent has not been started with the system user. Values
Default: 0 |
| [ 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. |
| [ STATUS_CHECK ] | |
| time = |
Internal timer cycle that can be used to check the status of a job. For PeopleSoft: The status within Peoplesoft For Windows: If the job runs in the context of a Windows Job Object. The agent's internal job table is checked in this interval. It depends on a job's runtime whether a status check is made. The job is checked while it is running at constantly increasing time intervals (the "time" value is doubled). These intervals never exceed the value specified for the agent with JOB_CHECKINTERVALin the host characteristics. For example: time=1, JOB_CHECKINTERVAL=60 The job table is checked each second Status check after: 1s, 2s, 4s,..., 60s, 60s.... Default: 1 |
| [ 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: .\UCXJWX6M.EXE |
| 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_JOB_MD_IP_ADDR = |
IP address used by the Job Messenger to contact Agent's listen port. This setting is necessary when UC_EX_IP_ADDR should be used by other agents for File Transfers, but the Job Messenger should use a different value (i.e. localhost). This setting overwrites UC_EX_IP_ADDR for the Job Messenger. Default: localhost |
| UC_EX_JOB_MD_IP_PORT = |
Port used by the Job Messenger to contact Agent's listen port. This setting is used by the agent automatically when UC_EX_JOB_MD_IP_ADDR is set with the value of PORT. This setting overwrites UC_EX_IP_PORT for the Job Messenger. 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_BACKUP = |
Path to the backup directory for file backup/restore feature Default: ..\backup\ |
| UC_EX_PATH_CACHE = |
Path to the cache directory for storage resource files Default: ..\Resources\ |
| 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: 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: WINDOWS |
| [ JCPLIST ] | This section is self-maintained and contains port-to-host mappings of either all available Java communication processes or TLS-Gateways depending on the Agent's server connection setup. When an Agent starts using the value defined in the connection= parameter, it receives a list of all JCPs available from the Automation Engine. On connection attempts from that point forward the agent will connect to a random JCP from the JCPLIST. You can also use the JCP_ENDPOINT parameter in the UC_SYSTEM_SETTINGS variable to define where to reach the JCPs. In this case, the Agent receives all entries from the JCP_ENDPOINT definition and stores the information in this section. If the JCP_ENDPOINT points to the location of only one load balancer, the JCP sends this location to the connecting Agent. However, if the JCP_ENDPOINT points to more than one load balancer, the JCP sends the location of all the load balancers available to the connecting Agent. Allowed formats: JCP1=host-name:port JCP2=host-name:port ... or JCP1=https://host-name:port/ JCP2=https://host-name:port/ |