Call API SAP

Structure of the INI File ucxsapc.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)

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

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\sapc_logg##.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

change_Logging_Days =

The number of days, after which the log file should be changed.

Default: 365

change_Logging_MB =

The size in MB, when the log file should be changed.

The parameter "max_logging_kb" is used for log-file changes if this parameter is not specified.

Default: 100

log_To_File =

Creation of log files on disk.

Logging contents are always sent to the Automation Engine regardless of the specifications made here. These contents are available in the System Overview

Values

  • 0: No log files are created.
  • 1: Log files are created

Default: 1

max_logging_kb =

The maximum size of the log file in kilobytes.

A new log file is created when the size that you specify here has been reached.

The default value will be used when the value "0" is set.

Default: 10000

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

trccount =

Number of stored trace files

Default: 10

xml =

creates an XML trace.

Values

  • 0: no trace
  • 1: xml trace is created

Default: 0

[ RFC ]
gwserv =

Gateway Service Number

This data must comply with the RFC destination data in transaktion SM59 on the SAP system

Default:

hostname =

Name of the computer on which the SAP Gateway runs.

Default:

progid =

Program ID which is specified in the complimentary RFC destination within SAP

Default:

rfc_Trace =

traceflag

Default: 0

unicode =

Use of "Unicode"- coding in the SAP system.

This information can also be retrieved via the SAP system's RFC connection. In this case, the INI-file parameter must only be specified if there is no RFC connection parameter.

Values

  • 0: Unicode is not used in the SAP system.
  • 1: The SAP system to which a connection is established is a Unicode system.

Default: 0

[ 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