Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>

Command Line, Long Form

<Format / Value>

Environment Variable

<Format / Value>

Configuration File Keyword

<Format / Value>

Option

Description

ABAP_NAME

Name of an ABAP program in an SAP system.

ACTIVITY_MONITORING

Specification for whether or not product activity monitoring events are generated.

ALLOW_AUTO_RESTART

Specification for whether or not a RESTART value of AUTO will be allowed.

AS_HOST

Host name of an SAP application server for a Type A RFC connection.

BATCH_MONITOR

Causes USAP to perform batch input monitoring for the job being started.

BIF_DIRECTORY

Broker Interface Directory that specifies the location of the Universal Broker interface file.

CFIT

Substitute symbol to use if the ON_CCE option value is 2 (replace the character).

CFT_ABAP_PROGRAM

ABAP program to use for the command ID job step.

CFT_COMMAND_PREFIX

In pre-XBP 2.0 CFT mode, the prefix command required for the operating system of the target host.

CFT_TARGET_HOST

In pre-XBP 2.0 CFT mode, the target host to use for the command ID job step when the command ID option is used.

CLIENT

Host name of a specific SAP application server for a Type A RFC Connection.

CHAIN_DESCRIPTION

Text description mask for process chains to be displayed.

CHAIN_ID

ID mask of process chains to be displayed.

CHAIN_LOG

Specification for whether or not the process chain log will be returned.

CODEPAGE

As documented by SAP: The CODEPAGE option is similar to the PCS option. It is needed only if you want to connect to a non-Unicode back-end using a non-ISO-Latin-1 username or password. The RFC library will then use that codepage for the initial handshake, thus preserving the characters in username/password. |

COMMAND_ID

Identifier used to identify the unit of work represented by a USAP command and the associated SAP job.

DATA_SOURCE

Data Source mask for which the InfoPackages were created.

DELTA

Specification for whether or not to use delta-manager when serializing / deserializing table parameters passed by using TABLES clause.

DESTINATION

Name of a destination defined in the saprfc.ini file.

DISPLAY_CLIENT

Identify a specific SAP client whose intercepted jobs will be reported.

ENABLE_JOB_STATUS_CHECK

Specification to enable or disable calls to SAP function module BAPI_XBP_JOB_STATUS_CHECK, which are used to synchronize the actual job status with the R/3 stored status.

ENCRYPT_FILE

Name of an encrypted text command file.

ENCRYPTION_KEY

Key used to encrypt the command file.

EVENT_ACTION

Specification for whether or not the status of return events should be changed on the SAP system.

EVENT_GENERATION

Events to be generated as persistent events.

EVENT_ID

Name of the event.

EVENT_PARAMETER

Optional parameter value for the event.

EVENT_SELECT_STATE

Event status of the events which should be read.

EXIT_JOB_ACTIVE

USAP exit code for the SAP job active status.

EXIT_JOB_FINISHED

USAP exit code for the SAP job finished status.

EXIT_JOB_READY

USAP exit code for the SAP job ready status.

EXIT_JOB_RELEASED

USAP exit code for the SAP job released status.

EXIT_JOB_SCHEDULED

USAP exit code for the SAP job scheduled status.

EXIT_JOB_TERMINATED

USAP exit code for the SAP job terminated status.

EXIT_MAX_SPOOL_SIZE_EXCEEDED

Minimum exit code that will be set if an attempt is made to return a spool list that exceeds the maximum size for job logs as specified by the MAX_SPOOL_LIST_SIZE USAP configuration option.

EXIT_QUEUE_BACKGROUND

USAP exit code for the SAP queue state S (in background).

EXIT_QUEUE_CREATED

USAP exit code for the SAP queue state C (to be created).

EXIT_QUEUE_ERROR

USAP exit code for the SAP queue state E (error).

EXIT_QUEUE_FINISHED

USAP exit code for the SAP queue state F (finished).

EXIT_QUEUE_UNPROCESSED

USAP exit code for the SAP queue state [    ] (unprocessed).

EXTERNAL_COMMAND

Complete command name or a mask used to select SAP external commands that match the mask.

FILE_NAME

Name of a plain text command file.

FIRST_PAGE

Starting page from which a spool list will be returned.

FORCE

Specification for whether or not the process chain instance associated with a client fault tolerant process chain job is restarted on the SAP system.

FROM_DATE

Earliest date to use for job selection or syslog request.

FROM_TIME

Earliest time to use for job selection or syslog request.

GROUP

Name of the group of application servers for a Type B RFC connection.

GW_HOST

Host name of the SAP gateway for a Type A RFC connection.

GW_SERV

Service name of the SAP gateway for a Type A RFC connection.

HELP

Displays a description of command line options and their format.

IMMEDIATE_JOB

Causes the job to be started immediately.

INFO_PACKAGE

Name of the mask InfoPackage to select.

INFO_SOURCE

InfoSource mask for which the InfoPackages were created.

INSTALLATION_DIRECTORY

Location in which USAP is installed.

JOB_ID

Job ID of an existing SAP job.

JOB_ID_PATTERN

Locates the header record and determines the offset of the job ID in the RSBDCSUB batch input processing report.

JOB_LOG_CHILD

Controls the writing of job logs for child jobs.

JOB_NAME

Name of an existing SAP job.

JOB_NAME_PATTERN

Locates the header record and determines the offset of the job name in the RSBDCSUB batch input processing report.

JOB_NETWORK_ID

Network identifier for the pre-existing SAP FS job network being started.

JOB_PROCESS_ID

Process ID of an existing SAP FS job network process to start.

JOB_STATUS

SM37-batch-status.

LAST_PAGE

Last page of a spool list to be returned.

LAYOUT_NAME

Complete layout name or a mask used to select printer layouts that match the mask.

LISTEN_INTERVAL

Number of seconds that will elapse between RFC listen calls.

LOG_ID

Log ID for process instance data.

LOGON_LANGUAGE

SAP logon language used for the USAP session.

LOGON_RETRY_COUNT

Number of unsuccessful RFC logon retry attempts that can occur before USAP terminates the logon process and ends unsuccessfully.

LOGON_RETRY_INTERVAL

Number of seconds that will elapse between a failed RFC logon attempt and the retry of that logon attempt.

LONG_DEVICE_NAME

Complete device name or a mask used to select SAP output devices that match the mask.

MASS_ACTIVITY_WAIT

Causes USAP to wait for the SAP mass activity jobs to complete processing.

MAX_CHILD_DEPTH

Controls the maximum relationship depth that will be monitored by USAP.

MAX_HIT_COUNT

Maximum number of ABAP reports to be returned.

MAX_JOB_LOG_SIZE

Maximum size for job logs.

MAX_SPOOL_LIST_SIZE

Maximum size for spool lists.

MAX_XBP

Maximum version of the SAP XBP interface that will be used during USAP execution.

MESSAGE_LANGUAGE

Language in which messages are written.

MESSAGE_LEVEL

Level of messages to written.

MODEL_STATUS

For operations that work with model jobs without providing a job ID to explicitly target a specific job on the SAP system, restricts the model job candidates to the specified job status.

MS_HOST

Host name of the message server for a Type B RFC connection.

MYSAPSSO2

Path to a file containing the credentials to log on with an SSO2 ticket (Single-Sign_On) - instead of USER&PASSWORD - or with an "Assertion" ticket (starting with back-end release 7.00).

NO_COMPRESSION

Specification for whether or not the RC protocol compress tables.

NO_START_DATE

Specification for whether or not to include jobs with no start date in selection criteria.

ON_CCE

Specification for what the NW RFC library will do when it encounters a character that either does not exist in the target codepage, is a broken character or is a control character (0x00 - 0x19).

OPERATING_SYSTEM

Name of the operating system for which external commands are searched.

OUTPUT_FIELD_LIST

Additional fields to write for the select command.

PAGE_LIMIT

Maximum number of pages that can be returned in the syslog report.

PASSWORD

Password for the SAP user ID.

PCS

As documented by SAP: The PCS option specifies a Partner Character Size. It is rarely needed, as during the initial handshake, the RFC library obtains the correct value from the back-end and uses it from then on.
 
However, a rare use case could be that the back-end is Unicode and you want to use a non-ISO-Latin-1 username or password for the initial logon. As the initial handshake is done with ISO-Latin-1, the characters in username/passwd would break, resulting in a refused logon. In that case, set PCS=2 and the RFC library will use Unicode for the initial handshake. |

PLF_DIRECTORY

Program Lock File directory that specifies the location of the USAP program lock file.

PRINTER_NAME

Name of a printer for which the print formats will be retrieved.

PROCESS_LOGS

Specification for whether or not the process logs will be returned.

PROFILE_ID

ID of the profile.

PROFILE_TYPE

Type of profile.

PURGE_BDC_MAP

Specification for whether or not to delete BDC Batch input session queues that have been processed successfully.

PURGE_CHILD_JOBS

Controls the purging of child jobs.

PURGE_JOB

Purge job that has completed processing from SAP system.

QUEUE_ID

Queue identifier associated with the batch input session.

QUEUE_ID_PATTERN

Locates the header record and determines the offset of the queue ID in the RSBDCSUB batch input processing report.

R3_NAME

System ID of the SAP system to which you want to connect for a Type B RFC connection.

RAW_SPOOL

Specification for whether the SAP spool lists will be returned from the SAP system in raw or plain format.

REQUEST_ID

Request ID for InfoPackage instance for which the status is to be displayed.

RESOLVE_MULTI_MODEL

For operations that work with model jobs without providing a job ID to explicitly target a specific job on the SAP system, controls the behavior when multiple candidate jobs are found.

RESTART

Specification for whether or not this execution of USAP is a restart of a previous client fault tolerant USAP command.

RETRY_CALL_COUNT

Number of unsuccessful RFC call retry attempts that can occur before USAP terminates the RFC call retry process and ends unsuccessfully.

RETRY_CALL_INTERVAL

Number of seconds that will elapse between a failed RFC call and the retry of that call.

RETURN_APPLICATION_LOG

Specification for whether or not the job's application log is returned.

RETURN_APPLICATION_RC

Specification for whether or not the job's application return codes are returned.

RETURN_JOB_LOG

Specification for whether or not the job's job log is returned.

RETURN_SPOOL_LIST

Specification for whether or not the spoollists of all job steps are returned.

RFC_TRACE

Trace level of all connections / destinations.

SAPROUTER

SAPRouter string for the NW RFC connection.

SECURE_CFT

Mode of client fault tolerance to be used for the command invocation.

SERVER_STOP_CONDITIONS

Exit code(s) of the executing Universal Connector process that should trigger the locally running Universal Broker to cancel the corresponding SAP job.

SNC_LIB

Full path and name of a third-party security library to use for SNC communication (authentication, encryption, and signatures).

SNC_MODE

Specification for whether or not SNC should be activated for the SAP RFC connection.

SNC_MYNAME

Token/identifier representing the external RFC program.

SNC_PARTNERNAME

Token/identifier representing the back-end system.

SNC_QOP

Quality of protection level.

SNC_SSO

Specification for whether or not to use SNC single sign-on if SNC is enabled.

SOURCE_SYSTEM

Source system mask for which the InfoPackages were created.

SPOOL_CODEPAGE

Codepage to be used for transferring spool lists from the SAP system.

SPOOL_ID

Spool list request number in an SAP system.

SPOOL_LIST_CHILD

Controls the printing of spoollists for child jobs.

SPOOL_RECEIVE_BUFFER

Size of the blocks (number of pages) used when transferring spool lists.

START

Starts the newly defined job.

STATUS_ABORTED

Specification for whether or not to include jobs with status aborted in selection criteria.

STATUS_CHECK_INTERVAL

Length of time that can elapse, without a change in job status, before a call will be made to synchronize the actual job status with the SAP stored status.

STATUS_FINISHED

Specification for whether or not to include jobs with status finished in selection criteria.

STATUS_READY

Specification for whether or not to include jobs with status ready in selection criteria.

STATUS_RELEASED

Specification for whether or not to include jobs with status released in selection criteria.

STATUS_RUNNING

Specification for whether or not to include jobs with status running in selection criteria.

STATUS_SCHEDULED

Specification for whether or not to include jobs with status scheduled in selection criteria.

STEP_NUMBER

Step number of the SAP job step.

SUBMIT

Defines a job to the SAP system.

SYSLOG

Requests entries from an SAP System syslog for a specified date and time range.

SYSLOG_POST_TIME

Length of time to add to the job end time when calculating the to time for the syslog report.

SYSLOG_PRE_TIME

Length of time to subtract from the job release time when calculating the from time for the syslog report.

SYSTEM_ID

Local Universal Broker with which USAP must register before the Manager performs any request.

SYSTEM_NUMBER

SAP system number of an SAP application server for a Type A RFC connection.

TARGET_JOB_NAME

Name to give the newly created job.

TARGET_SERVER

Server on which the job will run.

TARGET_VARIANT

One or more replacement variants for ABAP program job steps in an SAP job.

TARGET_VARIANTNAME

Name given to a copied VARIANT on an SAP system.

TECHNICAL_DEVICE_NAME

Complete device name or a mask used to select SAP output devices that match the mask.

TIMEOUT_INTERVAL

Number of seconds that can elapse before USAP considers an RFC call to have timed out.

TO_DATE

Latest date to use for job selection or syslog request.

TO_TIME

Latest time to use for job selection or syslog request.

TRACE_DIRECTORY

Directory where RFC trace files will be written.

TRACE_FILE_LINES

Maximum number of lines to write to the trace file.

TRACE_TABLE

Trace table size and under what conditions it is written to a file.

TRANSLATION_TABLE

Spoollist translation table file to use for formatting returned spoollists.

USAP_POLL

Length of time to wait between job status calls to the SAP system.

USE_APPLICATION_RC

Specification for whether or not the job's application return codes are used to determine the exit code of the Universal Connector job.

USE_SYMBOLIC_NAMES

Specification for whether the NW RFC library, during group-logon, should use symbolic service names defined in /etc/services (such as sapgw33, or hard-coded port numbers derived from the instance number (such as 3300).

USER_ID

SAP user ID with which to logon to the SAP system.

USER_NAME

User ID associated with a job.

VARIANT

Pre-existing SAP variant name to use as the model variant.

VARIANT_LANGUAGE

Preferred language in which to return the variant description.

VARIANT_SELECTION

Specification to display either variants available for batch and dialog mode or variants available only for batch mode.

VERSION

Writes USAP version and copyright information.

WAIT

Wait for the SAP job to complete processing.

WAIT_FOR_CHILD_JOBS

Controls the monitoring of child jobs.

WITH_PREDECESSOR

Specification for whether or not to include jobs with start after predecessor in selection criteria.

X509CERT

Path to a file containing the credentials to log on with an X509 certificate ticket instead of USER&PASSWORD.

XMI_AUDIT_LEVEL

Sets the XMI audit level to be used for the execution of the command.