Connection properties for the wizard, WebSphere Adapter for SAP Software

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > SAP Software > Reference > Inbound configuration properties
Connection properties for the wizard

External service connection properties establish a connection between the external service wizard of IBM Integration Designer, a tool used to create business objects, and the SAP server. The properties you configure in the external service wizard specify such things as connection configuration, bidi properties and tracing and logging options.

Once a connection between the external service wizard and the SAP server is established, the external service wizard is able to access the metadata it needs from the SAP server to create business objects.
Some of the properties that you set in the external service wizard are used as the initial value for resource adapter, managed connection factory, and activation specification properties that you can specify at a later time in the wizard.
The external service 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. For information on how to read the property detail tables in the sections that follow, see Guide to information about properties.
If you set any of these connection properties using bidirectional script, you must set values that identify the format of the bidirectional script entered for that property.

External service connection properties Adapter for SAP Software
Property name Description
Bidi direction
The orientation component of the bidi format specification.
Bidi ordering schema
The ordering scheme of the bidi format specification.
Bidi numeric shaping
The numeric shaping component of the bid format specification.
Bidi shaping
The shaping component of the bidi format specification.
Bidi symmetric swapping
The symmetric swapping component of the bid format specification.
Client
The client number of the SAP system to which the adapter connects.
Codepage number
Indicates the numeric identifier of the code page.
Folder for RFC trace files
Sets the fully qualified local path to the folder into which the RFC trace files are written.
Host name
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 Specifies the location of the log file for external service.
Logging level property Specifies the type error for which logging will occur during external service.
Password
The password of the user account of the adapter on the SAP application server.
RFC trace level
Specifies the global trace level.
RFC trace on
Specifies whether to generate a text file detailing the RFC activity for each event listener.
SAP interface name
Indicates the SAP interface to be used.
System number
The system number of the SAP application server.
User name
The user account for the adapter on the SAP server.

The external service wizard uses the bidirectional connection properties to apply the proper bidirectional transformation on the data passed to the SAP server.
For more details on how to set the character code set on IBM BPM or WebSphere Enterprise Service Bus for processing multilingual data (including bidirectional data), see the technical article titled "Overview of Bidirectional script support in WebSphere Process 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 supported by this adapter.
You should accept the default values for the bidirectional formatting properties on the external service wizard providing SAP server bidirectional format specification. When combined, these bidirectional properties define one single bidirectional format.
The default values for bidirectional formatting properties listed below 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 listed below.

Bidi direction

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

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 that is located between two strong characters with a different writing direction, will inherit the main context's writing direction (in an LTR document the character will become LTR.
contextualRTL
The orientation is right-to-left because of the context. A character that is not categorized as RTL that is located between two strong characters with a different writing direction, will inherit the main context's writing direction (in an RTL document the character will become 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 scheme of the bidi format specification.

Bidi ordering schema details
Required No
Possible values
Implicit
Visual
Default Implicit
Property type String
Usage Specifies the ordering scheme 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.

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.

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.

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.

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 SAP server requires that the application 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

The numeric identifier of the code page.

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 codepage numbers supported by SAP, access SAP If 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 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 codepage number value associated with it.
For example, the language code for English, is EN. If you selected EN (English) as your language code, the codepage number is automatically set to the numeric value 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

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

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.
This field cannot be edited if you are modifying existing artifacts
Example c:\temp\rfcTraceDir
Globalized Yes
Bidi supported No

Host name

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

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.

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 that display 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 service discovery.

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 will list 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:\IBM\wid6.0\workspace\.metadata\SAPMetadataDiscovery.log
Globalized Yes
Bidi supported No

Logging level property

This property specifies the type error for which logging will occur during external service.

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. By specifying an error type, you are indicating that trace operations will occur only for errors of the type specified.
Example
Accepting the default value of SEVERE will provide trace information on errors that fall into the SEVERE category. Severe errors mean that an operation cannot continue, though the adapter can still function. Severe errors also include error conditions that indicate an impending fatal error, such as reporting on situations that strongly suggest that resources are on the verge of being depleted.
Other error descriptions are as follows:

Fatal
Adapter cannot continue. Adapter cannot function
Warning
Potential error or impending error. This also includes 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.

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

This property specifies the global trace level.

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

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

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.

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 and or inbound processing by enabling the exchange of data in the form of business objects.
This field cannot be edited if you are modifying existing artifacts
Globalized No
Bidi supported No

System number

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

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

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

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

Inbound configuration properties

Property name	Description
Bidi direction	The orientation component of the bidi format specification.
Bidi ordering schema	The ordering scheme of the bidi format specification.
Bidi numeric shaping	The numeric shaping component of the bid format specification.
Bidi shaping	The shaping component of the bidi format specification.
Bidi symmetric swapping	The symmetric swapping component of the bid format specification.
Client	The client number of the SAP system to which the adapter connects.
Codepage number	Indicates the numeric identifier of the code page.
Folder for RFC trace files	Sets the fully qualified local path to the folder into which the RFC trace files are written.
Host name	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	Specifies the location of the log file for external service.
Logging level property	Specifies the type error for which logging will occur during external service.
Password	The password of the user account of the adapter on the SAP application server.
RFC trace level	Specifies the global trace level.
RFC trace on	Specifies whether to generate a text file detailing the RFC activity for each event listener.
SAP interface name	Indicates the SAP interface to be used.
System number	The system number of the SAP application server.
User name	The user account for the adapter on the SAP server.

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 that is located between two strong characters with a different writing direction, will inherit the main context's writing direction (in an LTR document the character will become LTR. contextualRTL The orientation is right-to-left because of the context. A character that is not categorized as RTL that is located between two strong characters with a different writing direction, will inherit the main context's writing direction (in an RTL document the character will become RTL).
Default	LTR
Property type	String
Usage	Specifies the orientation component of the bidi format specification.
Globalized	Yes
Bidi supported	No

Required	No
Possible values	Implicit Visual
Default	Implicit
Property type	String
Usage	Specifies the ordering scheme of the bidi format specification.
Globalized	Yes
Bidi supported	No

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

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

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

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 SAP server requires that the application 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

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. This field cannot be edited if you are modifying existing artifacts
Example	c:\temp\rfcTraceDir
Globalized	Yes
Bidi supported	No

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

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 that display 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

Required	Yes
Default	The .metadata directory of the workspace.
Property type	String
Usage	Use this directory to hold the log file that will list 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:\IBM\wid6.0\workspace\.metadata\SAPMetadataDiscovery.log
Globalized	Yes
Bidi supported	No

Required	No
Possible values	FATAL SEVERE WARNING AUDIT INFO CONFIG DETAIL
Default	SEVERE
Property type	String
Usage	Use this property to tailor tracing capabilities. By specifying an error type, you are indicating that trace operations will occur only for errors of the type specified.
Example	Accepting the default value of SEVERE will provide trace information on errors that fall into the SEVERE category. Severe errors mean that an operation cannot continue, though the adapter can still function. Severe errors also include error conditions that indicate an impending fatal error, such as reporting on situations that strongly suggest that resources are on the verge of being depleted. Other error descriptions are as follows: Fatal Adapter cannot continue. Adapter cannot function Warning Potential error or impending error. This also includes 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

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

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 and or inbound processing by enabling the exchange of data in the form of business objects. This field cannot be edited if you are modifying existing artifacts
Globalized	No
Bidi supported	No

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