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
Activation specification properties for BAPI inbound processing
Activation specification properties hold the inbound event processing configuration information for a message endpoint.
Activation specification properties are used during endpoint activation to notify the adapter of eligible event listeners. During inbound processing, the adapter uses these event listeners to receive events before forwarding them to the endpoint.
You set the activation specification 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.
Table 1 lists and describes the activation specification properties that apply to both synchronous RFC and asynchronous transactional RFC. Table 2 applies only to asynchronous transaction RFC properties used for assured-once delivery.
A more detailed description of each property is provided in the sections that follow the tables. For information on how to read the property detail tables in the sections that follow, see Guide to information about properties.
Activation specification properties for BAPI inbound processing Property name Description In the wizard In the administrative console 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.
Enable Secure Network Connection SncMode
Indicates whether secure network connection mode is used.
Retry limit for failed events FailedEventRetryLimit The number of times the adapter attempts to redeliver an event before marking the event as failed. 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.
Logon group name Group
An identifier of the name of the group of application server instances that have been defined in transaction SMLG and linked together for logon load balancing.
Load Balancing loadBalancing
Specifies if your SAP configuration uses load balancing
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.
Message server host MessageServerHost
Specifies the name of the host on which the message server is running.
Number of listeners NumberOfListeners
Specifies the number of event listeners that are to be started.
Partner character set PartnerCharset
Specifies PartnerCharset encoding.
Password Password
The password of the user account of the adapter on the SAP application server.
Retry EIS connection on startup RetryConnectionOn
Startup
Controls whether the adapter retries the connection to the EIS if it cannot connect at startup
RFC program ID RfcProgramID
The remote function call identifier under which the adapter registers in the SAP gateway.
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.
System number SystemNumber
The system number of the SAP application server.
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.
The properties in the following table applies only to assured-once delivery. When you select assured-once delivery, the transaction ID sent from the SAP server is stored in a data source. You specify information about the data source with these properties.
Additional activation specification properties for assured-once delivery Property name Description In the wizard In the administrative console Assured once-only delivery AssuredOnceDelivery
Specifies whether to provide assured-once delivery for inbound events.
Auto create event table EP_CreateTable
Indicates whether the adapter should create the event recovery table automatically if it does not already exist.
Event recovery data source (JNDI) name EP_SchemaName
The schema used for automatically creating the event recovery table.
Event recovery data source (JNDI) name EP_DataSource_JNDIName
The JNDI name of the data source configured for event recovery.
Event recovery table name EP_TableName
The name of the event recovery table.
Password used to connect to event data source EP_Password
The user password for connecting to the database.
User name used to connect to event data source EP_UserName
The user name for connecting to the database.
Assured once-only delivery
This property specifies whether to provide assured once-only delivery for inbound events.
Assured once-only delivery details Required No Default True Property type Boolean Usage When this property is set to True, the adapter provides assured once event delivery. This means that each event will be delivered once and only once. A value of False does not provide assured once event delivery, but provides better performance.
When this property is set to True, the adapter attempts to store transaction (XID) information in the event store. If it is set to False, the adapter does not attempt to store the information.
This property is used only if the export component is transactional. If the export component is not transactional, no transaction can be used, regardless of the value of this property.
Globalized No Bidi supported No
The Assured once-only delivery property applies only to asynchronous transactional RFC processing.
Auto create event table
Determines if the event table is created automatically.
Auto create event table details Required Yes, if Assured once-only event delivery is set to True, No otherwise.
Possible values True
FalseDefault True Property type Boolean Usage This property indicates whether the adapter should create the event recovery table automatically if it does not already exist.
In the administrative console, this property is listed as "EP_CreateTable".
If you specify a value of True to automatically create the table, you must specify information about the event table (such as the event recovery table name).
The value provided in the Event recovery table name property is used to create the table.
Globalized No Bidi supported No
The Auto create event table property applies only to asynchronous transactional RFC processing.
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
Database schema name
This property is the schema used for automatically creating the event recovery table.
In the administrative console, this property is listed as "EP_SchemaName".
Database schema name details Required No Default No default value. Property type String Usage Specifies the schema name for the database used by the adapters event persistence feature.
Example ALE_SCHEMA Globalized Yes Bidi supported No
The Database schema name property applies only to asynchronous transactional RFC processing.
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
Event recovery data source (JNDI) name
This property is the JNDI name of the data source configured for event recovery.
In the Process Administrative Console, this property is listed as "EP_DataSource_JNDIName".
Event recovery data source (JNDI) name details Required Yes Default No default value. Property type String Usage Used in event recovery processing. The data source must be created in Process Administrative Console. The adapter utilizes data source for persisting the event state.
Example jdbc/DB2 Globalized No Bidi supported No
The Event recovery data source (JNDI) name property applies only to asynchronous transactional RFC processing.
Event recovery table name
This property is the name of the event recovery table.
In the administrative console, this property is listed as "EP_TableName".
Event recovery table name details Required Yes Default No default value. Property type String Usage Used in event recovery processing. Consult database documentation for information on naming conventions.
It is recommended that a separate event recovery table is configured for each endpoint. The same data source can be used to hold all of the event recovery tables.
Example EVENT_TABLE Globalized No Bidi supported No
The Event recovery table name property applies only to asynchronous transactional RFC processing.
Retry limit for failed events (FailedEventRetryLimit)
This property specifies the number of times that the adapter attempts to redeliver an event before marking the event as failed.
Retry limit for failed events details Required No Possible values Integers Default 5 Property type Integer Usage Use this property to control how many times the adapter tries to send an event before marking it as failed. It accepts the following values:
- Default
- If this property is not set, the adapter tries five additional times before marking the event as failed.
- 0
- The adapter tries to deliver the event an infinite number of times. When the property is set to 0, the event remains in the event store and the event is never marked as failed.
- > 0
- For integers greater than zero, the adapter retries the specified number of times before marking the event as failed.
- < 0
- For negative integers, the adapter does not retry failed events.
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
Logon group name
This property is an identifier for the name of the group of application server instances that have been defined in transaction SMLG and linked together for logon load balancing.
Logon group details Required Yes (if load balancing is used) Possible values Consult SAP documentation for information on creating Logon groups and on calling transaction SMLG. Default No default value Property type String Usage When the adapter is configured for load balancing, this property represents the name of the group of application server instances that have been defined in transaction SMLG and linked together for logon load balancing.
Logon load balancing allows for the dynamic distribution of logon connections to application server instances.
Maximum of 20 characters. On most SAP systems, the SPACE logon group is reserved by SAP.
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 tries to restart the event listeners. If the Retry EIS connection on startup property is set to true it also indicates the maximum number of times the adapter will retry the connection to the EIS if it cannot connect at startup.
Maximum number of retries in case of system failure 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 inbound connection, this property specifies the number of times the adapter tries to restart the connection. A value of 0 indicates an infinite number of retries.
Negative values indicate that the adapter will not attempt to establish the inbound connection
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
Number of listeners
This property specifies the number of listeners that are started by an event.
Number of listeners details Required No Default 1 Property type Integer Usage For event sequencing, this property should be set to 1.
To improve adapter performance, you can increase the number of listeners.
The adapter will not start if the number of listeners is 0
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
Retry EIS connection on startup
This property controls whether the adapter retries the connection to the EIS if it cannot connect at startup. This property is used in conjunction with Maximum number of retries in case of system connection failure and Time between retries in case of system connection failure (milliseconds).
Retry EIS connection on startup Required No Possible Values True
False
Default False Property type Boolean Usage If the value is true, it indicates that the adapter will retry the connection to EIS if it cannot connect at startup. The values for the following properties have to be specified:
- Maximum number of retries in case of system connection failure
- Time between retries in case of system connection failure (milliseconds)
If the value is false, it indicates that the adapter will not retry the connection to EIS if it cannot connect at startup.
Globalized No Bidi supported No
Password used to connect to event data source
This property is the user password for connecting to the database.
In the administrative console, this property is listed as "EP_Password".
Password to connect to event data source details Required Yes Default No default value. Property type String Usage This property specifies the password used by event persistence processing to obtain the database connection from the data source.
Globalized Yes Bidi supported No
The Password used to connect to event data source property applies only to asynchronous transactional RFC processing.
RFC program ID
This property is the program identifier under which the adapter registers in the SAP gateway.
RFC program ID details Required Yes Possible values Use the SAP transaction SM59 (Display and Maintain RFC Destinations) to see a list of available RFC program IDs. Default No default value. Property type String Usage The adapter registers with the gateway so that listener threads can process events from RFC-enabled functions. This value must match the program ID registered in the SAP application.
The maximum length is 64 characters.
Globalized No 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 warningsDefault 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
FalseDefault 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
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 restart the event listeners.
If the Retry EIS connection on startup property is set to true it also indicates the time interval that the adapter will wait in between attempts to retry the inbound connection to the EIS if it cannot connect at startup.
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 inbound connection, this property specifies the time interval the adapter waits in between attempts to reestablish an inbound connection. 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
User name used to connect to event data source
This property is the user name for connecting to the database.
In the administrative console, this property is listed as "EP_UserName".
User name to connect to event data source details Required Yes Default No default value. Property type String Usage User name used by event persistence for getting the database connection from the data source. Consult database documentation for information on naming conventions.
Globalized Yes Bidi supported No
The User name used to connect to event data source property applies only to asynchronous transactional RFC processing.
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