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


SAP connection properties for the Adapter Connection wizard

Connection properties establish a connection between the Adapter Connection wizard, a tool that is used to create business objects, and the SAP server. The properties that you configure in the Adapter Connection wizard specify such things as connection configuration, and tracing and logging options.

After you have established a connection between the Adapter Connection wizard and the SAP server, the wizard can access the metadata that it needs from the SAP server to create business objects.

Some of the properties that you set in the Adapter Connection wizard are used as the initial values for resource adapter, managed connection factory, and activation specification properties that you can specify at a later time in the wizard.

The connection properties and their purpose are described in the following table. A complete description of each property is provided in the sections that follow the table. If you set any of these connection properties using bidirectional script, you must set values that identify the format of the bidirectional script that is entered for that property.
Table 1. Connection properties for the Adapter for SAP Software
Property name Description
Bidi direction The orientation component of the bidi format specification.
Bidi ordering schema The ordering schema of the bidi format specification.
Bidi numeric shaping The numeric shaping component of the bidi format specification.
Bidi shaping The shaping component of the bidi format specification.
Bidi symmetric swapping The symmetric swapping component of the bidi format specification.
Client

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

Codepage number (Codepage)

Indicates the numeric identifier of the code page

Folder for RFC trace files (RfcTracePath)

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

Generate business objects according to SAP naming conventions Specifies that the adapter generates all business object names to be the same as the SAP XI standard.
Host name (ApplicationServerHost)

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

Language code

Specifies the language in which the adapter logs on.

Log file output location property The location of the log file for enterprise metadata discovery.
Logging level property The type error for which logging occurs during enterprise metadata discovery.
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 interface name

The SAP interface to be used.

System number (SystemNumber)

The system number of the SAP application server

User name (userName)

The user account for the adapter on the SAP server

The Adapter Connection wizard uses the bidirectional connection properties to apply the correct bidirectional transformation on the data that is passed to the SAP server.

The bidi properties specify the bidirectional format for data coming from an external application into the adapter in the form of any business object that is supported by this adapter.

Accept the default values for the bidirectional formatting properties on the Adapter Connection wizard that provides SAP server bidirectional format specification. When combined, these bidirectional properties define one single bidirectional format.

The default values for bidirectional formatting properties listed in this section are based on Windows bidirectional formatting. If the Enterprise Information System supports a bidirectional format other than the Windows standard bidirectional format, you must make appropriate changes to the bidi properties that are listed in the following sections.

Bidi direction

This property specifies the orientation component of the bidi format specification.

Table 2. Bidi direction details
Required No
Possible values Possible values include:
  • LTR

    The orientation is left-to-right.

  • RTL

    The orientation is right-to-left.

  • contextualLTR

    The orientation is left-to-right because of the context. A character that is not categorized as LTR, and hat is located between two strong characters with a different writing direction, inherits the main context's writing direction (in a LTR document the character becomes LTR).

  • contextualRTL

    The orientation is right-to-left because of the context. A character that is not categorized as RTL, and is located between two strong characters with a different writing direction, inherits the main context's writing direction (in a RTL document the character becomes RTL).

Default LTR
Property type String
Usage Specifies the orientation component of the bidi format specification.
Globalized Yes
Bidi supported No

Bidi ordering schema

This property specifies the ordering schema of the bidi format specification.

Table 3. Bidi ordering schema details
Required No
Possible values

Implicit
Visual

Default Implicit
Property type String
Usage Specifies the ordering schema of the bidi format specification.
Globalized Yes
Bidi supported No

Bidi numeric shaping

This property specifies the numeric shaping component of the bidi format specification.

Table 4. Bidi numeric details
Required No
Possible values

Nominal
National
Contextual

Default Nominal
Property type String
Usage Specifies the numeric shaping component of the bidi format specification.
Globalized Yes
Bidi supported No

Bidi shaping

This property specifies the shaping component of the bidi format specification.

Table 5. Bidi shaping details
Required No
Possible values

Nominal
Shaped
Initial
Middle
Final
Isolated

Default Nominal
Property type String
Usage Specifies the shaping component of the bidi format specification.
Globalized Yes
Bidi supported No

Bidi symmetric swapping

This property specifies the symmetric swapping component of the bidi format specification.

Table 6. Bidi symmetric swapping details
Required No
Possible values

True
False

Default True
Property type Boolean
Usage This property specifies the symmetric swapping component of the bidi format specification.
Globalized Yes
Bidi supported No

Client

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

Table 7. 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 8. 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

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 9. 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

Generate business objects according to SAP naming conventions

This property specifies that the adapter generates all business object names by using the same naming conventions as the SAP XI standard.

Table 10. . Generate business objects according to SAP naming conventions details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage Select this option to generate all business object names according to the SAP XI standard. This option is available only when ALE is selected as the interface name.
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

Language code

SAP logon language code.

Table 12. Language code details
Required Yes
Possible values

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

The language codes in the list represent the SAP default set of 41 languages for non Unicode systems plus Arabic.

For a full listing of supported language codes and languages, see the SAP documentation.

Default The default language code will be your current locale. If your current locale is not listed as one of the supported language codes, then a default language code of EN (English) is used.
Property type String
Usage

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

Example If the system locale is English, the value for this property is EN (English)
Globalized No
Bidi supported No

Log file output location property

This property specifies the location of the log file for external metadata discovery.

Table 13. Log file output location details
Required Yes
Default The .metadata directory of the workspace
Property type String
Usage Use this directory to hold the log file that lists the errors that occur during the discovery process.

The type of discovery errors for which logging occurs is controlled by the Logging level property

Example C:\Users\user_ID\IBM\IIBT10\workspace\.metadata\SAPMetadataDiscovery.log
Globalized Yes
Bidi supported No

Logging level property

This property specifies the type error for which logging occurs during enterprise metadata discovery.

Table 14. Logging level details
Required No
Possible values

FATAL
SEVERE
WARNING
AUDIT
INFO
CONFIG
DETAIL

Default SEVERE
Property type String
Usage Use this property to tailor tracing capabilities. When you specify an error type, you indicate that trace operations occur only for errors of the specified type.
Example If you accept the default value of SEVERE, trace information is provided on errors that fall into the SEVERE category. Severe errors mean that an operation cannot continue, although the adapter can still function. Severe errors also include error conditions that indicate an impending fatal error, that is, reporting on situations that strongly suggest that resources are on the verge of being depleted.
Other error descriptions are listed here:
  • Fatal

    Adapter cannot continue. Adapter cannot function

  • Warning

    Potential error or impending error, including conditions that indicate a progressive failure (for example, the potential leaking of resources).

  • Audit

    Significant event affecting adapter state or resources

  • Info

    General information outlining overall operation progress.

  • Config

    Configuration change or status.

  • Detail

    General information detailing operation progress

Globalized Yes
Bidi supported No

Password

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

Table 15. 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 16. 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 17. 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 interface name

This property indicates whether you are creating business objects for the ALE, BAPI, Advanced event processing, or Query interface for SAP Software.

Table 18. SAP interface name details
Required Yes
Possible values
For outbound:
  • Advanced event processing (AEP)
  • ALE
  • ALE pass-through IDoc
  • BAPI
  • BAPI work unit
  • BAPI result set
  • Query interface for SAP Software (QSS)
For inbound:
  • Advanced event processing (AEP)
  • ALE
  • ALE pass-through IDoc
  • BAPI
Default

For outbound: BAPI

For inbound:ALE

Property type String
Usage Specifies the interface used by the adapter.

The adapter interacts with the interface to support outbound or inbound processing by enabling the exchange of data in the form of business objects.

Globalized No
Bidi supported No

System number (SystemNumber)

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

Table 19. 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

User name (userName)

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

Table 20. 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

rbp_sap_esd_props.htm | Last updated 2015-03-27 19:28:52