Call API Windows

Structure of the INI File ucxbxxxc.ini

Parameter Name Description
[ GLOBAL ]
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

  • E: english
  • D: german
  • F: french

Default: (E,D)

helplib =

name of the message text library

may have different names dependent on platform rules.

Default: .\uc.msl

queue =

The specification of a particular Queue object in which the Call API script should be executed.

This parameter overrides the setting API_QUEUE in the variable UC_CLIENT_SETTINGS

Default:

timeout =

The time in seconds during which the CallAPI waits for a response from AE. If this is exceeded, the CallAPI ends with a timeout error.

If no timeout or timeout=0 is set, the default value of 60 seconds will be used. To set the timeout to the maximum possible wait time, please use timeout=9999

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))

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\ucxbxxxc_trace_##.txt

trccount =

Number of stored trace files

Default: 10

[ USER ]
client =

Login specifications: Client

Default:

user =

Login specifications: Name of the user

Default:

dept =

Login specifications: Department of the user

Default:

pass =

Login specifications: Password (optional)

The password can be encrypted using the program UCYBCRYP.

Default:

[ CP_LIST ] This section is self maintained and contains the port to host mapping of all available Communication Processes

Allowed formats:

Port number=DNS Name

Port number=TCP/IP Address