Universal Connector for SAP 7.6.x Quick Reference Guide - Configuration Options for Program Execution
OPTIONS { HOST USER [CFT] [COMMAND FILE] [EXIT CODES] [INFORMATIONAL] [LOCAL] [MESSAGE] [RFC] }
HOST {-dest -client | -ashost -sysnr -client [-gwhost] [-gwserv] | -r3name -mahost [-group]} -max_xbp -saplang -xmiaudit
Long Form | Short Form | Description |
---|---|---|
-dest destination | -e destination | Destination name in the saprfc.ini. |
-client client | -c client | SAP client number for a Type A RFC connection. |
-ashost hostname | n/a | Host name of an SAP application server for a Type A RFC connection. |
-sysnr number | n/a | SAP system number of an SAP application server for a Type A RFC Connection. |
-gwhost host | n/a | Host name of the SAP gateway for a Type A RFC connection. |
-gwserv service | n/a | Service name of the SAP gateway for a Type A RFC connection. |
-r3name name | n/a | System ID of the SAP system to which you want to connect for a Type B RFC connection. |
-mshost host | n/a | Host name of the message server for a Type B RFC connection. |
-group groupname | n/a | Name of the group of application servers for a Type B RFC connection. |
-max_xbp version | n/a | Maximum version of the SAP XBP interface that will be used during USAP execution. |
-saplang language | n/a | SAP logon language used for the USAP session |
-xmiaudit level | n/a | Sets the XMI audit level to be used for the execution of the command. The amount of information logged in the XMI log increases with higher audit level values. Valid values are 0, 1, 2, and 3. Default is 0. |
USER -userid -pwd
Long Form | Short Form | Description |
---|---|---|
-userid userid | -u userid | Remote SAP user ID with which the command runs. |
-pwd password | -w password | Remote SAP user ID's password. |
CFT [-cmdid] [-restart] [-autorestartok] [-cft_abap] [-cft_cmd_prefix] [-cft_secure_cft] [-cft_target_host]
Long Form | Short Form | Description |
---|---|---|
-cmdid id | -C | Command identifier: associates an SAP job with the Universal Connector command that started it. This value facilitates fault tolerance/restartability. |
-restart option | n/a | Identifies whether or not this instance of the USAP job is a restart attempt. Valid values are YES, NO, and AUTO. If YES or AUTO, -cmdid is required. |
-autorestartok option | n/a | Controls whether or not 'AUTO' is allowed for the -restart option. Valid values are YES and NO. Default is NO. |
-cft_cmd_prefix prefix | n/a | Prefix command required for the operating system of the target host. This option is used with (and only applies to) the command ID option. |
-cft_target_host host | n/a | Target host to use for the command ID job step when the command ID option is used. |
-cft_abap program | n/a | ABAP program to use for the command ID job step.. |
-cft_secure_cft option | n/a | Mode of client fault tolerance to be used for the command invocation. |
COMMAND FILE [-file | -encryptedfile [-key] ]
Long Form | Short Form | Description |
---|---|---|
-file file | -f | Name of a plain text command options file. |
-encryptedfile file | -x | Name of an encrypted command options file. |
-key key | -K | Key used to encrypt the encrypted command options file. |
EXIT CODES [-activeec] [-readyec] [-scheduledec] [-releasedec] [-terminatedec] [-finishedec]
Long Form | Short Form | Description |
---|---|---|
-activeec exitcode | n/a | USAP exit code for the job active status. |
-readyec exitcode | n/a | USAP exit code for the job ready status. |
-scheduledec exitcode | n/a | USAP exit code for the job scheduled status. |
-releasedec exitcode | n/a | USAP exit code for the job released status. |
-terminatedec exitcode | n/a | USAP exit code for the job terminated status. |
-finishedec exitcode | n/a | USAP exit code for the job finished status. |
INFORMATIONAL { -help | -version }
Long Form | Short Form | Description |
---|---|---|
-help | -h | Writes help text. |
-version | -v | Writes program version and exit. |
LOCAL [-system_id] [-bif_directory] [-plf_directory]
Long Form | Short Form | Description |
---|---|---|
-system_id id z | n/a | Local Universal Broker with which USAP must register. |
-bif_directory directory u | n/a | Broker Interface File (BIF) directory where the Universal Broker interface file is located |
-plf_directory directory u | n/a | Program Lock File (PLF) directory where the program lock files are located. |
z Valid only with z/OS. u Valid only with UNIX. |
MESSAGE [-level] [-lang] [-trace_file_lines] [-trace_table]
Long Form | Short Form | Description |
---|---|---|
-level level | -l <level> | Message level: trace, audit, info, warn, or error. |
-lang language | -L <lang> | Message and text language. |
-trace_file_lines lines | n/a | Maximum number of lines to write to the trace table. |
-trace_table size,condition | n/a | Trace table size, and under what condition it is written to a file. |
RFC [-rfc_listen_interval] [-rfc_logon_retry_count] [-rfc_logon_retry_interval] [-rfc_retry_count] [-rfc_retry_interval] [-rfc_timeout] [-rfc_trace_dir]
Long Form | Short Form | Description |
---|---|---|
-rfc_listen_interval interval | n/a | Number of seconds that will elapse between RFC listen calls. These are polling calls that are performed repeatedly to determine if an RFC event is available. |
-rfc_logon_retry_count count | n/a | Number of unsuccessful RFC logon retry attempts that can occur before USAP terminates the logon process and ends unsuccessfully. |
-rfc_logon_retry_interval interval | n/a | Number of seconds that will elapse between a failed RFC logon attempt and the retry of that logon attempt. |
-rfc_retry_count count | n/a | Number of unsuccessful RFC call retry attempts that can occur before USAP terminates the RFC call retry process and ends unsuccessfully. |
-rfc_retry_interval interval | n/a | Number of seconds that will elapse between a failed RFC call and the retry of that RFC call. |
-rfc_timeout interval | n/a | Time constraint on all RFC functions, with the exception of blocking connection calls: the number of seconds that can elapse before USAP considers an RFC call to have timed out. |
-rfc_trace_dir path | n/a | Directory where RFC trace files will be written. Default is /tmp. |