IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Outbound adapter properties for SAP

Outbound adapter properties define how the adapter creates an outbound connection instance with the SAP server, and how operations are run on the server. Use the Adapter Connection wizard to set these properties.

The following table describes the outbound adapter properties. A more detailed description of each property is provided in the sections that follow the table.
Table 1. Interaction specification properties for Adapter for SAP Software
Property name Description
ABAP debug (ABAPDebug) The ABAP debugger property

Client (Client)

The client number of the SAP system to which the adapter connects

Codepage number (Codepage)

Indicates the numeric identifier of the code page

Custom retrieve function name (customFunctionName) The name of a custom function to be used by the Query interface to SAP Software to retrieve data from an SAP table.

Enable secure network connection (SncMode)

Indicates whether secure network connection mode is used

Folder for RFC trace files (RfcTracePath)

Sets the fully qualified local path to the folder into which the RFC trace files are written

Function name (functionName) The function name for a specific SAP interface.

Gateway host (GatewayHost)

The host name of the SAP gateway

Gateway service (GatewayService)

The identifier of the gateway on the gateway host that carries out the RFC services

Host name (ApplicationServerHost)

Specifies the IP address or the name of the application server host that the adapter logs on to

Ignore errors in BAPI return (IgnoreBAPIReturn) Specifies if errors in BAPI return are ignored.

Language code (Language code)

Specifies the Language code in which the adapter logs on to SAP

Maximum number of hits for the discovery (ResultSetLimit) The maximum number of result sets to return during a RetrieveAll operation.

Message server host (MessageServerHost)

Specifies the name of the host on which the message server is running

Partner character set (PartnerCharset)

Specifies PartnerCharset encoding

Password (Password)

The password of the user account of the adapter on the SAP application server

RFC trace level (RcfTraceLevel)

Specifies the global trace level

RFC trace on (RcfTraceOn)

Specifies whether to generate a text file detailing the RFC activity for each event listener

SAP system ID (SAPSystemID)

Specifies the system ID of the SAP system for which logon load balancing is allowed

Secure network connection library path (SncLib)

Specifies the path to the library that provides the secure network connection service

Secure network connection name (SncMyname)

Specifies the name of the secure network connection

Secure network connection partner (SncPartnername)

Specifies the name of the secure network connection partner

Secure network connection security level (SncQop)

Specifies the level of security for the secure network connection

Select the queue name (QRFCQueueName) The name of a customer-defined queue on the SAP server.

System number (SystemNumber)

The system number of the SAP application server

Use wait parameter before calling BAPI commit Specifies whether the WAIT parameter is set on a BAPI_TRANSACTION_COMMIT.

User name (userName)

The user account for the adapter on the SAP server

X509 certificate (X509cert)

Specifies the X509 certificate to be used as the logon ticket

ABAP debug

This property specifies whether the adapter invokes the ABAP Debugger for the appropriate function module when the adapter starts to process a business object.

Table 2. ABAP debug details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage When the property is set to True, the adapter opens the SAP GUI in debug mode.

You must have appropriate authorization to use the debugger. Create a dialog user ID because a CPI-C user ID cannot open an SAP GUI session. You must have authorization to run in debug mode as well as any authorizations that are required by the ABAP code that is being debugged. For example, if a BAPI_CUSTOMER_CREATEFROMDATA1 is being debugged, you must have authorization to create customers.

You can add breakpoints only after the debugger opens.

Always set this property to False in a production environment.

This property is supported on Windows systems only.

Globalized No
Bidi supported No

Client

This property is the client number of the SAP system to which the adapter connects.

Table 3. Client details
Required Yes
Possible values You can enter a range of values from 000 to 999.
Default 100
Property type Integer
Usage

When an application attempts to log on to the SAP server, the application must have a Client number associated with it. The Client property value identifies the client (the adapter) that is attempting to log onto the SAP server.

Globalized No
Bidi supported No

Codepage number (Codepage)

The numeric identifier of the code page.

Table 4. Codepage number details
Required No
Possible values You can enter a range of values from 0000 to 9999.

For a full listing of languages and associated code page numbers that are supported by SAP, see SAP Note 7360.

Default The default value for this property is conditionally determined by the value set for the Language code property.
Property type Integer
Usage

The value that is assigned to the Codepage number defines the code page to be used and has a one-to-one relationship with the value set for the Language code property. The Codepage number establishes a connection to the appropriate language.

Each language code value has a code page number value associated with it. For example, the language code for English is EN. If you select EN (English) as your language code, the code page number is automatically set to the numeric value that is associated with EN (English). The SAP code page number for EN (English) is 1100.

Example

If Language code is set to JA (Japanese), Codepage number is set to 8000.

Globalized No
Bidi supported No

Custom retrieve function name (customFunctionName)

For the Query interface for SAP Software, this property specifies the name of a custom function that must be used to retrieve data from an SAP table.

Table 5. Custom retrieve function name details
Required No
Default No default value
Property type String
Usage

This property applies to Query interface for SAP Software only.

On non-Unicode systems, the default function used to retrieve data from SAP tables (RFC_READ_TABLE) might produce an exception. To avoid the problem, you can create another function on the SAP server and indicate, during configuration, that the adapter must use this custom function to retrieve data. This property specifies the name of the custom function.

You must create the function on the SAP server before you specify this property on the Adapter Connection wizard. Follow the steps listed in SAP note 758278 to make a copy of RFC_READ_TABLE and modify the copy in line with the note.

Globalized No
Bidi supported No

Enable Secure Network Connection (SncMode)

This property indicates whether secure network connection mode is enabled.

Table 6. Enable Secure Network Connection details
Required No
Possible values

0 (off)
1 (on)

Default 0
Property type String
Usage Set the value to 1 (on) if you want to use secure network connection.
If you set this value to 1, you must also set following properties:
  • Secure Network Connection library path (SncLib)
  • Secure Network Connection name (SncMyname)
  • Secure Network Connection partner (SncPartnername)
  • Secure Network Connection security level (SncQop)
Globalized No
Bidi supported No

Folder for RFC trace files (RfcTracePath)

This property sets the fully qualified local path to the folder in which to write RFC trace files.

Table 7. Folder for RFC trace files details
Required No
Default No default value
Property type String
Usage Identifies the fully qualified local path into which RFC trace files are written.

If RFC trace on is set to False (not selected), you are not permitted to set a value in the Folder for RFC trace files property.

Example c:\temp\rfcTraceDir
Globalized Yes
Bidi supported No

Function name (functionName)

The functionName interaction specification property controls the interaction by associating operations with the correct interface.

Table 8. Function name details
Required Yes
Possible values

True
False

Default Null
Property type String
Usage
The BAPI/RFC supports the following values for the functionName interaction specification property:

WBIInteractionSpec.CREATE
WBIInteractionSpec.UPDATE
WBIInteractionSpec.RETRIEVE
WBIInteractionSpec.DELETE

The BAPI result set supports the following value for the functionName interaction specification property:

WBIInteractionSpec.RETRIEVEALL

The ALE outbound interface supports the following value:

WBIInteractionSpec.EXECUTE

The ALE inbound interface supports the following values for the functionName interaction specification property:

WBIInteractionSpec.CREATE
WBIInteractionSpec.UPDATE
WBIInteractionSpec.RETRIEVE
WBIInteractionSpec.DELETE

The Query interface for SAP software (QISS) interface supports the following values for the functionName interaction specification property:
  • WBIInteractionSpec.EXISTS

    Throws the exceptions NotExistsException and QISSQueryFailedException

  • WBIInteractionSpec.RETRIEVEALL

    Throws the exceptions QISSQueryFailedException

The Advanced event processing interface for inbound processing supports the following values for the functionName interaction specification property:

WBIInteractionSpec.CREATE
WBIInteractionSpec.UPDATE
WBIInteractionSpec.DELETE

The Advanced event processing interface for outbound processing supports the following values for the functionName interaction specification property:

WBIInteractionSpec.CREATE
WBIInteractionSpec.UPDATE
WBIInteractionSpec.RETRIEVE
WBIInteractionSpec.DELETE

Globalized No
Bidi supported No

Gateway host (GatewayHost)

This property is the Gateway host name. Enter either the IP address or the name of the Gateway host. Consult your SAP administrator for information on the Gateway host name.

Table 9. Gateway host details
Required Yes
Default No default value
Property type String
Usage

This property is the host name of the SAP gateway. The gateway enables communication between work processes on the SAP system and external programs.

The host identified is used as the gateway for the resource adapter.

Maximum length of 20 characters. If the computer name is longer than 20 characters, define a symbolic name in the THOSTS table.

Globalized No
Bidi supported No

Gateway service (GatewayService)

This property is the identifier of the gateway on the gateway host that carries out the RFC services.

Table 10. Gateway service details
Required Yes
Default sapgw00
Property type String
Usage

These services enable communication between work processes on the SAP server and external programs. The service typically has the format of sapgw00, where 00 is the SAP system number.

Maximum of 20 characters.

Globalized No
Bidi supported No

Host name (ApplicationServerHost)

Specifies the IP address or the name of the application server host that the adapter logs on to.

Table 11. Host name details
Required Yes (when load balancing is not used).
Default No default value
Property type String
Usage

When the adapter is configured to run without load balancing, this property specifies the IP address or the name of the application server that the adapter logs on to.

Example sapServer
Globalized No
Bidi supported No

Ignore errors in BAPI return (IgnoreBAPIReturn)

This property indicates whether to ignore errors that are specified in a BAPI return operation. The return structure can be data or a table.

Table 12. Ignore errors in BAPI return details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage This property applies to BAPI outbound synchronous RFC processing only.

When you set this property to True, the Adapter for SAP Software ignores the checking of error codes in the BAPI RETURN structure after BAPI has run, and returns this structure to the user as it is. The RETURN structure is part of every BAPI and contains the status of the BAPI execution.

If you accept the default value of False, the Adapter for SAP Software processes the RETURN structure and throws an exception if an error code is found.

Globalized No
Bidi supported No

Language code

This property specifies the Language code in which the adapter logs on.

Table 13. Language code details
Required Yes
Possible values

For a full listing of languages and associated code page numbers that are supported by SAP, see SAP Note 7360.

Default The default value for the Language code property is based on the system locale.
Property type String
Usage

Each of the supported languages is preceded by a two-character language code. The language itself is displayed in parentheses.

If you enter a language code manually, you do not need to enter the language in parentheses.

The language codes that are listed represent the SAP default set of 41 languages for non-Unicode systems plus Arabic.

The value that you select determines the value of the Codepage number property.

Example

If the system locale is English, the value for this property is EN (English).

Globalized No
Bidi supported No

Maximum number of hits for the discovery (ResultSetLimit)

For the Query interface for SAP Software, this property specifies the maximum number of result sets, which represents data for each row that is retrieved from a table through a RetrieveAll operation.

Table 14. Result set limit details
Required Yes
Default 100
Property type Integer
Usage This property applies to Query interface for SAP Software only.

If the number of hits in the table on the SAP server exceeds the value of the ResultSetLimit property, the adapter returns the error: MatchesExceededLimitException. The adapter uses this property to help avoid out-of-memory issues.

Globalized No
Bidi supported No

Message server host (MessageServerHost)

This property specifies the name of the host on which the message server is running.

Table 15. Message server host details
Required Yes (if load balancing is used)
Default No default value
Property type String
Usage

This property specifies the name of the host that will inform all the servers (instances) belonging to this SAP system of the existence of the other servers to be used for load balancing.

The message server host contains the information about load balancing for RFC clients so that an RFC client can be directed to an appropriate application server.

Example SAPERP05
Globalized No
Bidi supported No

Partner character set (PartnerCharset)

This property specifies the partner character set encoding.

Table 16. Partner character set details
Required No
Default

UTF-8

Property type String
Usage When an encoding is specified, it is used; otherwise, the default encoding is used.
Globalized No
Bidi supported No

Password

This property is the password of the user account of the adapter on the SAP application server.

Table 17. Password details
Required Yes
Default No default value
Property type String
Usage

The restrictions on the password depend on the version of SAP Web Application Server.

  • For SAP Web Application Server version 6.40 or earlier, the password:
    • Must be uppercase
    • Must be 8 characters in length
  • For versions of SAP Web Application Server later than 6.40, the password:
    • Is not case-sensitive
    • Can be up to 40 characters in length
Globalized No
Bidi supported Yes

RFC trace level (RcfTraceLevel)

This property specifies the global trace level.

Table 18. RFC trace level details
Required No
Possible values

0 - No error
1 - Errors and warnings
2 - Execution path, errors and warnings
3 - Full Execution path, errors and warnings
4 - Execution path, info messages, errors and warnings
6 - Full execution path, info messages, errors and warnings
7 - Debug messages, full execution path, info messages, errors and warnings
8 - Verbose debug messages, full execution path, info messages, errors and warnings

Default 1
Property type Integer
Usage If RFC trace on is set to False (not selected), you cannot set a value in the RFC trace level property.
Globalized No
Bidi supported No

RFC trace on (RcfTraceOn)

This property specifies whether to generate a text file detailing the RFC activity for each event listener.

Table 19. RFC trace on details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage A value of True activates tracing, which generates a text file.

This file is created in the directory in which the adapter process was started. The file has a prefix of rfx and a file type of trc (for example, rfc03912_02220.trc).

Use these text files in a development environment only, because the files can grow rapidly.

If RFC trace on is set to False (not selected), you cannot set values in the Folder for RFC trace files or RFC trace level properties.

Example

Examples of the information in the file are RfcCall FUNCTION BAPI_CUSTOMER_GETLIST, followed by the information for the parameters in the interface, or RFC Info rfctable, followed by the data from one of the interface tables.

The trace file is created in the directory where the adapter process has been started. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Globalized No
Bidi supported No

SAP system ID (SAPSystemID)

This property specifies the system ID of the SAP system for which logon load balancing is allowed.

Table 20. SAP system ID details
Required Yes (when load balancing is used)
Default No default value
Property type String
Usage Value must be three characters
Example DYL
Globalized No
Bidi supported No

Secure Network Connection library path (SncLib)

This property specifies the path to the library that provides the secure network connection service.

Table 21. Secure Network Connection library path details
Required Yes, if SncMode is set to 1; no otherwise.
Default No default value
Property type String
Usage If the SncMode property is set to 1 (indicating that you are using a secure network connection), specify the path to the library that provides the service.
Example /WINDOWS/system32/gssapi32.dll
Globalized No
Bidi supported No

Secure Network Connection name (SncMyname)

This property specifies the name of the secure network connection.

Table 22. Secure Network Connection name details
Required Yes, if SncMode is set to 1; no otherwise.
Default No default value
Property type String
Usage If the SncMode property is set to 1 (indicating that you are using a secure network connection), specify a name for the connection.
Example DOMAINNAME/USERNAME
Globalized No
Bidi supported No

Secure Network Connection partner (SncPartnername)

This property specifies the name of the secure network connection partner.

Table 23. Secure Network Connection partner details
Required Yes, if SncMode is set to 1; no otherwise.
Default No default value
Property type String
Usage If the SncMode property is set to 1 (indicating that you are using a secure network connection), specify a name for the connection partner.
Example CN=sap00.saperpdev, OU=Adapter, O=IBM, C=US
Globalized No
Bidi supported No

Secure Network Connection security level (SncQop)

This property specifies the level of security for the secure network connection.

Table 24. Secure Network Connection security level details
Required Yes, if SncMode is set to 1; no otherwise.
Possible values
  • 1 (Authentication only)
  • 2 (Integrity protection)
  • 3 (Privacy protection)
  • 8 (Use the value from snc/data_protection/use on the application server)
  • 9 (Use the value from snc/data_protection/max on the application server)
Default 3 (Privacy protection)
Property type String
Usage If the SncMode property is set to 1 (indicating that you are using a secure network connection), specify a value to indicate the level of security for the connection.
Globalized No
Bidi supported No

Select the queue name (QRFCQueueName)

For BAPI outbound processing, when Asynchronous queued RFC is selected, this property specifies the name of a queue on the SAP server to which BAPIs will be delivered.

Table 25. Select the queue name details
Required No
Default The first queue defined on the SAP server. If no queue is defined on the SAP server, no default value exists.
Property type String
Usage This property applies to BAPI outbound asynchronous queued RFC processing only.

When you want to deliver BAPI calls to a queue on the SAP server, you must specify the name of the queue. During configuration, you select an existing queue from a drop-down list. If no queues exist on the SAP server, you can type the name of a queue.

Globalized No
Bidi supported No

System number (SystemNumber)

This property is the system number of the SAP application server.

Table 26. System number details
Required Yes
Possible values You can enter a range of values from 00 to 99.
Default 00
Property type Integer
Usage

The system number further identifies the Gateway service.

Globalized No
Bidi supported No

Use wait parameter before calling BAPI commit

This property indicates whether the adapter calls a BAPI_TRANSACTION_COMMIT with the WAIT parameter set.

Table 27. Use wait parameter before calling BAPI commit
Required No
Possible values

True
False

Default False
Property type Boolean
Usage This property applies to BAPI outbound synchronous RFC processing only.

When you set this property to True, the Adapter for SAP Software calls a BAPI_TRANSACTION_COMMIT with the WAIT parameter set, so that other resource managers are committed only when the update has been completed in SAP.

If you accept the default value of False, message flow processing might continue before the update has been completed in SAP. Therefore, after calling a BAPI, the updated data might not be available when you next access the system.

Globalized No
Bidi supported No

User name (userName)

This property is the user account for the adapter on the SAP server.

Table 28. User name details
Required Yes
Default No default value
Property type String
Usage Maximum length of 12 characters. The user name is not case sensitive.

It is recommended that you set up a CPIC user account in the SAP application and that you give this account the necessary privileges to manipulate the data required by the business objects supported by the adapter. For example, if the adapter must perform certain SAP business transactions, the adapter's account in the SAP application must have the permissions set to allow it to perform these transactions.

Example SapUser
Globalized Yes
Bidi supported Yes

X509 certificate (X509cert)

This property specifies the X509 certificate to be used as the logon ticket.

Table 29. X509 certificate details
Required No
Default No default value
Property type String
Usage If the SncMode property is set to 1 (indicating that you are using a secure network connection), you can provide a value for the X509 certificate.
Globalized No
Bidi supported No

rbp_sap_outbound_props_wmb.htm | Last updated Friday, 21 July 2017