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 > Outbound configuration properties

Managed connection factory properties

Managed connection factory properties are used by the adapter at run time to create an outbound connection instance with the SAP server.

The following property that was specified as a Managed connection factory property in version 6.2.x applies to the interaction specification property group in version 7.5.0.2.

You set the managed connection factory properties using the external service wizard and can change them using the IBM Integration Designer Assembly Editor, or after deployment through the IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console.

The following table lists and describes the managed connection factory properties. A more detailed 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.

The external service wizard refers to these properties as managed connection factory properties and IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console refers to these as (J2C) connection factory properties.

Managed connection factory properties for Adapter for SAP Software
Property name Description
In the wizard In the Process Administrative Console
Adapter ID

AdapterID

Identifies the adapter instance for PMI events and for logging and tracing.

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.

Disguise user data as "XXX" in log and trace files HideConfidentialTrace Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Maximum Number of retries in case of system connection failure

connectionRetryLimit

The adapter will try connecting to the Enterprise Information System (EIS) for a specified number of tries. Select only if you want to reduce the number of connection exceptions in the outbound operation. If selected, adapter will validate the connection for each outbound request.

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.

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.

Language code

Language code

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

Load Balancing

loadBalancing

Specifies if your SAP configuration uses load balancing

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.

Reset JCo Client after closing Connection Handle

resetClient

This property optionally invokes the reset method on the JCo client to make sure changes on the SAP EIS are reflected in the client during an outbound transaction

RFC trace level

RfcTraceLevel

Specifies the global trace level.

RFC trace on

RfcTraceOn

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.

Enable Single Sign On (SSO)

SsoMode

Enables the adapter to use Single Sign On as the authentication method.

SSO Logon Ticket

SsoLogonTicket

Specifies the SSO logon certificate to be used as the logon ticket.

System number

SystemNumber

The system number of the SAP application server.

User name

userName

The user account for the adapter on the SAP server.

Wait until commit call to SAP database is completed and returned

WaitOnCommit

Enables adapter to wait until all time critical updates to SAP database are completed before calling commit on it.

X509 certificate

X509cert

Specifies the X509 certificate to be used as the logon ticket.


Adapter ID (AdapterID)

This property identifies a specific deployment or instance of the adapter.

Adapter ID details
Required Yes
Default 001
Property type String
Usage This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, SAPRA, to form the component name used by the Log and Trace Analyzer tool.

For example, if the adapter ID property is set to 001, the component ID is SAPRA001.

If you run multiple instances of the same adapter, ensure that the first eight characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter.

For example, when you set the adapter ID property of two instances of WebSphere Adapter for SAP Software to 001 and 002. The component IDs for those instances, SAPRA001 and SAPRA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to SAPRAInstance.

For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.

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


Disguise user data as "XXX" in log and trace files (HideConfidentialTrace)

This property specifies whether to replace user data in log and trace files with a string of X's to prevent unauthorized disclosure of potentially sensitive data.

Disguise user data as "XXX" in log and trace files details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files.

For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.

Globalized No
Bidi supported No


Load Balancing

This property specifies if your SAP configuration uses load balancing

Load balancing details
Required Yes
Possible values True False
Default False
Property type Boolean
Usage

This value should be set to true if the SAP configuration uses load balancing. If set to true, Message server host, Logon group and SAP System ID need to be specified.

Globalized No
Bidi supported No


Maximum Number of retries in case of system connection failure

This property specifies the number of times the adapter attempts to create a connection to the Enterprise Information System (EIS). The adapter will try connecting to the EIS for the specified number of times. Select only if you want to reduce the number of connection exceptions in the outbound operation.

If selected, the adapter will validate the connection for each outbound request.

Reset Client details
Required No
Possible values Integers
Default 0
Property type Integer
Usage

Only positive values are valid.

When the adapter encounters an error related to the outbound connection, it retries to establish a physical connection (when physical connection is not established) for the number of times specified for this property with a time delay specified in the property Time between retries in case of system connection failure (milliseconds).

If the value is 0, the adapter does not perform any EIS connection validation and executes the outbound operation.

if the value is > 0, then during each request the adapter validates if the EIS connection is active.

  • If the connection is valid the operation is completed.
  • if connection is invalid, the adapter invalidates the current managed connection and a new managed connection is created (new physical connection)

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


Gateway host

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

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

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

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

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

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

Language code details
Required Yes
Possible values

For a full listing of languages and associated codepage numbers supported by SAP, access SAP If 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 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.

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

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


Message server host

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

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

This property specifies the partner character set encoding.

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.

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


Reset JCo Client after closing Connection Handle

This property optionally invokes the reset method on the JCo client to make sure changes on the SAP EIS are reflected in the client during an outbound transaction

Reset Client details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage

When the property is set to True, the adapter invokes the reset method on the JCo client to make sure changes on the SAP EIS are reflected in the client during an outbound transaction.

When this property is set to False the adapter does not invoke the reset method on the JCo client, therefore any changes on the SAP EIS are not reflected in the client during an outbound transaction.

This property is supported on the ALE interfaces - ALE and ALE Passthrough, and the BAPI interfaces - simple BAPI, BAPI work unit and BAPI ResultSet.

Globalized NA
Bidi supported No


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 system ID

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

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


Enable Secure Network Connection

This property indicates whether secure network connection mode is enabled.

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:

  • SncLib

  • SncMyname

  • SncPartnername

  • SncQop

Globalized No
Bidi supported No


Secure Network Connection library path

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

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

This property specifies the name of the secure network connection.

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

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

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

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

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


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


Time between retries in case of system connection failure (milliseconds)

This property specifies the time interval between attempts to connect to the Enterprise Information System (EIS).

Time between retries in case of system connection failure details
Required No
Possible Values Positive Integers
Default 60000
Unit of measure Milliseconds
Property type Integer
Usage When the adapter encounters an error related to the outbound connection, this property specifies the time interval that the adapter waits in between attempts to reestablish an outbound connection. It is disabled by default and is only enabled when the value of Maximum Number of retries in case of system connection failure is greater than 0.
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


Wait until commit call to SAP database is completed and returned

For BAPI outbound processing, this property specifies whether the commit call from the adapter should wait until all the time-critical (V1) updates to the SAP database have been completed. When this property is set to true, the commit to call to SAP waits until all updates are completed and returned. If it is set to false, the commit call returns immediately from the SAP database.

This property is only active when you use the CWYAP_SAPAdapter_Tx.rar file.

WaitOnCommit property details
Required No
Default False
Property type Boolean
Globalized No
Bidi supported No


X509 certificate

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

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


SSO Logon Ticket

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

Enable Single Sign On details
Required Yes, if SSO is used for authentication; no otherwise.
Default False
Property type Boolean
Usage If this property is set to true, the adapter authenticates with the SAP system using SSO tokens.
Globalized No
Bidi supported No


Enable Single Sign On (SSO)

This property enables Single Sign On as the authentication method.

Enable Single Sign On details
Required Yes, if SSO is used for authentication; no otherwise.
Default False
Property type Boolean
Usage If this property is set to true, the adapter authenticates with the SAP system using SSO tokens.
Globalized No
Bidi supported No

Outbound configuration properties


Related concepts:

Globalization and bidirectional transformation