Universal Connector for SAP Configuration Options
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 |
---|---|
Name of an ABAP program in an SAP system. | |
Specification for whether or not product activity monitoring events are generated. | |
Specification for whether or not a RESTART value of AUTO will be allowed. | |
Host name of an SAP application server for a Type A RFC connection. | |
Causes USAP to perform batch input monitoring for the job being started. | |
Broker Interface Directory that specifies the location of the Universal Broker interface file. | |
Substitute symbol to use if the ON_CCE option value is 2 (replace the character). | |
ABAP program to use for the command ID job step. | |
In pre-XBP 2.0 CFT mode, the prefix command required for the operating system of the 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. | |
Host name of a specific SAP application server for a Type A RFC Connection. | |
Text description mask for process chains to be displayed. | |
ID mask of process chains to be displayed. | |
Specification for whether or not the process chain log will be returned. | |
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. | | |
Identifier used to identify the unit of work represented by a USAP command and the associated SAP job. | |
Data Source mask for which the InfoPackages were created. | |
Specification for whether or not to use delta-manager when serializing / deserializing table parameters passed by using TABLES clause. | |
Name of a destination defined in the saprfc.ini file. | |
Specifies whether or not the user wants to be prompted to authenticate with username/password. | |
Identify a specific SAP client whose intercepted jobs will be reported. | |
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. | |
Name of an encrypted text command file. | |
Key used to encrypt the command file. | |
Specification for whether or not the status of return events should be changed on the SAP system. | |
Events to be generated as persistent events. | |
Name of the event. | |
Optional parameter value for the event. | |
Event status of the events which should be read. | |
USAP exit code for the SAP job active status. | |
USAP exit code for the SAP job finished status. | |
USAP exit code for the SAP job ready status. | |
USAP exit code for the SAP job released status. | |
USAP exit code for the SAP job scheduled status. | |
USAP exit code for the SAP job terminated status. | |
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. | |
USAP exit code for the SAP queue state S (in background). | |
USAP exit code for the SAP queue state C (to be created). | |
USAP exit code for the SAP queue state E (error). | |
USAP exit code for the SAP queue state F (finished). | |
USAP exit code for the SAP queue state [ ] (unprocessed). | |
Complete command name or a mask used to select SAP external commands that match the mask. | |
Name of a plain text command file. | |
Starting page from which a spool list will be returned. | |
Specification for whether or not the process chain instance associated with a client fault tolerant process chain job is restarted on the SAP system. | |
Earliest date to use for job selection or syslog request. | |
Earliest time to use for job selection or syslog request. | |
Name of the group of application servers for a Type B RFC connection. | |
Host name of the SAP gateway for a Type A RFC connection. | |
Service name of the SAP gateway for a Type A RFC connection. | |
Displays a description of command line options and their format. | |
Causes the job to be started immediately. | |
Name of the mask InfoPackage to select. | |
InfoSource mask for which the InfoPackages were created. | |
Location in which USAP is installed. | |
Job ID of an existing SAP job. | |
Locates the header record and determines the offset of the job ID in the RSBDCSUB batch input processing report. | |
Controls the writing of job logs for child jobs. | |
Name of an existing SAP job. | |
Locates the header record and determines the offset of the job name in the RSBDCSUB batch input processing report. | |
Network identifier for the pre-existing SAP FS job network being started. | |
Process ID of an existing SAP FS job network process to start. | |
SM37-batch-status. | |
Last page of a spool list to be returned. | |
Complete layout name or a mask used to select printer layouts that match the mask. | |
Number of seconds that will elapse between RFC listen calls. | |
Log ID for process instance data. | |
SAP logon language used for the USAP session. | |
Number of unsuccessful RFC logon retry attempts that can occur before USAP terminates the logon process and ends unsuccessfully. | |
Number of seconds that will elapse between a failed RFC logon attempt and the retry of that logon attempt. | |
Complete device name or a mask used to select SAP output devices that match the mask. | |
Causes USAP to wait for the SAP mass activity jobs to complete processing. | |
Controls the maximum relationship depth that will be monitored by USAP. | |
Maximum number of ABAP reports to be returned. | |
Maximum size for job logs. | |
Maximum size for spool lists. | |
Maximum version of the SAP XBP interface that will be used during USAP execution. | |
Language in which messages are written. | |
Level of messages to written. | |
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. | |
Host name of the message server for a Type B RFC connection. | |
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). | |
Specification for whether or not the RC protocol compress tables. | |
Specification for whether or not to include jobs with no start date in selection criteria. | |
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). | |
Name of the operating system for which external commands are searched. | |
Additional fields to write for the select command. | |
Maximum number of pages that can be returned in the syslog report. | |
Password for the SAP user ID. | |
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. | |
Program Lock File directory that specifies the location of the USAP program lock file. | |
Name of a printer for which the print formats will be retrieved. | |
Specification for whether or not the process logs will be returned. | |
ID of the profile. | |
Type of profile. | |
Specification for whether or not to delete BDC Batch input session queues that have been processed successfully. | |
Controls the purging of child jobs. | |
Purge job that has completed processing from SAP system. | |
Queue identifier associated with the batch input session. | |
Locates the header record and determines the offset of the queue ID in the RSBDCSUB batch input processing report. | |
System ID of the SAP system to which you want to connect for a Type B RFC connection. | |
Specification for whether the SAP spool lists will be returned from the SAP system in raw or plain format. | |
Request ID for InfoPackage instance for which the status is to be displayed. | |
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. | |
Specification for whether or not this execution of USAP is a restart of a previous client fault tolerant USAP command. | |
Number of unsuccessful RFC call retry attempts that can occur before USAP terminates the RFC call retry process and ends unsuccessfully. | |
Number of seconds that will elapse between a failed RFC call and the retry of that call. | |
Specification for whether or not the job's application log is returned. | |
Specification for whether or not the job's application return codes are returned. | |
Specification for whether or not the job's job log is returned. | |
Specification for whether or not the spoollists of all job steps are returned. | |
Trace level of all connections / destinations. | |
SAPRouter string for the NW RFC connection. | |
Mode of client fault tolerance to be used for the command invocation. | |
Exit code(s) of the executing Universal Connector process that should trigger the locally running Universal Broker to cancel the corresponding SAP job. | |
Full path and name of a third-party security library to use for SNC communication (authentication, encryption, and signatures). | |
Specification for whether or not SNC should be activated for the SAP RFC connection. | |
Token/identifier representing the external RFC program. | |
Token/identifier representing the back-end system. | |
Quality of protection level. | |
Specification for whether or not to use SNC single sign-on if SNC is enabled. | |
Source system mask for which the InfoPackages were created. | |
Codepage to be used for transferring spool lists from the SAP system. | |
Spool list request number in an SAP system. | |
Controls the printing of spoollists for child jobs. | |
Size of the blocks (number of pages) used when transferring spool lists. | |
Starts the newly defined job. | |
Specification for whether or not to include jobs with status aborted in selection criteria. | |
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. | |
Specification for whether or not to include jobs with status finished in selection criteria. | |
Specification for whether or not to include jobs with status ready in selection criteria. | |
Specification for whether or not to include jobs with status released in selection criteria. | |
Specification for whether or not to include jobs with status running in selection criteria. | |
Specification for whether or not to include jobs with status scheduled in selection criteria. | |
Step number of the SAP job step. | |
Defines a job to the SAP system. | |
Requests entries from an SAP System syslog for a specified date and time range. | |
Length of time to add to the job end time when calculating the to time for the syslog report. | |
Length of time to subtract from the job release time when calculating the from time for the syslog report. | |
Local Universal Broker with which USAP must register before the Manager performs any request. | |
SAP system number of an SAP application server for a Type A RFC connection. | |
Name to give the newly created job. | |
Server on which the job will run. | |
One or more replacement variants for ABAP program job steps in an SAP job. | |
Name given to a copied VARIANT on an SAP system. | |
Complete device name or a mask used to select SAP output devices that match the mask. | |
Number of seconds that can elapse before USAP considers an RFC call to have timed out. | |
Latest date to use for job selection or syslog request. | |
Latest time to use for job selection or syslog request. | |
Directory where RFC trace files will be written. | |
Maximum number of lines to write to the trace file. | |
Trace table size and under what conditions it is written to a file. | |
Spoollist translation table file to use for formatting returned spoollists. | |
Length of time to wait between job status calls to the SAP system. | |
Specification for whether or not the job's application return codes are used to determine the exit code of the Universal Connector job. | |
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). | |
SAP user ID with which to logon to the SAP system. | |
User ID associated with a job. | |
Pre-existing SAP variant name to use as the model variant. | |
Preferred language in which to return the variant description. | |
Specification to display either variants available for batch and dialog mode or variants available only for batch mode. | |
Writes USAP version and copyright information. | |
Wait for the SAP job to complete processing. | |
Controls the monitoring of child jobs. | |
Specification for whether or not to include jobs with start after predecessor in selection criteria. | |
Path to a file containing the credentials to log on with an X509 certificate ticket instead of USER&PASSWORD. | |
Sets the XMI audit level to be used for the execution of the command. |