Overview

This page provides links to detailed information for all configuration options of Universal Connector for Use with SAP® ERP.

The options are listed alphabetically, without regard to any specific operating system.

Configuration Options Information

For each configuration option, these pages provides the following information.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of the following information:

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>

Method

Identifies the different methods used to specify Universal Connector configuration options:

Command Line Option, Short Form
Command Line Option, Long Form
Environment Variable
Configuration File Keyword

Note

Each option can be specified using one or more methods.

Syntax

Identifies the syntax of each method that can be used to specify the option:

Format: Specific characters that identify the option.
Value: Type of value(s) to be supplied for this method.

Note

If a Method is not valid for specifying the option, the Syntax field contains n/a.

(Operating System)

Identifies the operating systems for which each method of specifying the option is valid:

IBM i
HP NonStop
UNIX
Windows
z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.

Command Usage

Provides links to the Universal Connector commands that use the option.

If the option is associated with program execution, not commands, this section provides a link to the appropriate option category in Universal Connector for SAP Configuration Options for Program Execution.

Configuration Options List

The following table identifies all Universal Connector configuration options.

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.
DISABLE_USERPWD_PROMPT	Specifies whether or not the user wants to be prompted to authenticate with username/password.
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.