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

See information about the latest product version

Inbound adapter properties for SAP

Inbound adapter properties hold the inbound event processing configuration information for a message endpoint. These properties also control the general operation of the adapter. Use the Adapter Connection wizard to set these properties.

These 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 it forwards them to the endpoint.

The following table lists the properties for inbound processing that you set by using the Adapter Connection wizard. A more detailed description of each property is provided in the sections that follow the table.

Table 1. Activation specification properties for ALE inbound processing
Property name	Description
Adapter ID to use for logging and tracing (AdapterID)	A specific deployment, or instance, of the adapter
ALE packet audit (alePacketUpdate)	Specifies if the adapter should send ALEAUD per IDoc or per packet (TID)
ALE update status (aleUpdateStatus)	Specifies whether an audit trail is required for all message types
Assured once-only delivery (AssuredOnceDelivery)	Specifies whether to provide assured once-only delivery for inbound events
Auto create event table (EP_CreateTable)	Specifies whether the adapter should create the event recovery table automatically if it does not already exist
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
Database schema name (EP_SchemaName)	The schema that is used for automatically creating the event recovery table
Delivery type (DeliveryType)	Determines the order in which events are delivered by the adapter to the export component.
Enable secure network connection (SncMode)	Indicates whether secure network connection mode is used
Event recovery data source (JNDI) name (EP_SchemaName)	The JNDI name of the data source that is configured for event recovery
Event recovery table name (EP_TableName)	The name of the event recovery table
Event types to process (EventTypeFilter)	A delimited list of event types that the WebSphere® Adapter for SAP Software should deliver.
Failure code (aleFailureCode)	The status code for dispatch failure
Failure text (aleFailureText)	The descriptive text for dispatch failure
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
IDoc empty tags (iDocEmptyTag)	Includes empty tags to the unpopulated fields in the IDoc segment, which are sent to a configured endpoint, based on the option selected.
Ignore IDoc packet errors (IgnoreIDocPacketErrors)	Specifies what the adapter does when it encounters an error while processing the IDoc packet
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
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
Maximum number of events collected during each poll (PollQuantity)	The number of events that the adapter delivers to the export during each poll period.
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
Password used to connect to event data source (EP_Password)	The user password for connecting to the database
RFC program ID (RfcProgramID)	The remote function call identifier under which the adapter registers in the SAP gateway
RFC trace level (RcfTraceLevel)	Specifies the global trace level
RFC trace on (RcfTraceOn)	Specifies whether to generate a text file detailing the RFC activity for each event listener
SAP system ID (SAPSystemID)	Specifies the system ID of the SAP system for which logon load balancing is allowed
Secure network connection library path (SncLib)	Specifies the path to the library that provides the secure network connection service
Secure network connection name (SncMyname)	Specifies the name of the secure network connection
Secure network connection partner (SncPartnername)	Specifies the name of the secure network connection partner
Secure network connection security level (SncQop)	Specifies the level of security for the secure network connection
Selective update (aleSelectiveUpdate)	The IDoc Type and MessageType combinations that are to be updated when the adapter is configured to update a standard SAP status code
Status message code (aleStatusMsgCode)	If required, the message code to use when the adapter posts the ALEAUD Message IDoc (ALEAUD01)
Stop the adapter when an error is encountered while polling (StopPollingOnError)	Specifies whether the adapter stops polling for events when it encounters an error during polling.
Success code (aleSuccessCode)	The success status code for Application Document Posted
Success text (aleSuccessText)	The descriptive text for successful Application Document Posted
System number (SystemNumber)	The system number of the SAP application server
Time between polling for events (PollPeriod)	The length of time that the adapter waits between polling periods.
Time between retries in case of system connection failure (RetryInterval)	The length of time that the adapter waits between attempts to establish a new connection after an error during inbound operations.
Trim ALE Idoc field data (trimAleData)	Specifies if the leading white spaces are to be trimmed by the adapter before sending it to endpoint.
User name (userName)	The user account for the adapter on the SAP server
User name used to connect to event data source (EP_UserName)	The user name for connecting to the database
X509 certificate (X509cert)	Specifies the X509 certificate to be used as the logon ticket

Adapter ID to use for logging and tracing (AdapterID)

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

Table 2. Adapter ID to use for logging and tracing 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, this property is retrieved from the resource adapter properties. For outbound processing, it is retrieved from the managed connection factory properties.
Globalized	Yes
Bidi supported	No

ALE packet audit

ALE update per packet indicates whether the adapter should send ALEAUD audit IDocs per packet or per IDoc.

Table 3. ALE packet audit details
Required	No
Default	`False` (send ALEAUD per IDoc).
Property type	Boolean
Usage	You can enable and disable this property only if the ALE update status property is set to `True`. When you set this property to `true`, the adapter sends one ALEAUD per IDoc packet which contains confirmations for all IDocs in the packet. When you set this property to `false`, the adapter sends one ALEAUD for each IDoc received at the adapter.
Globalized	No
Bidi supported	No

ALE update status (aleUpdateStatus)

This property specifies whether an audit trail is required for all message types.

Table 4. ALE update status details
Required	Yes
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	Set this property to `True` if you want the adapter to update a standard SAP status code after the ALE module has retrieved an IDoc object for event processing. If you set this value to `True`, you must also set following properties: ALE failure code ALE Success code ALE failure text ALE success text.
Globalized	No
Bidi supported	No

Assured once-only delivery (AssuredOnceDelivery)

This property specifies whether to provide assured once-only delivery for inbound events.

Table 5. Assured once-only delivery details
Required	Yes
Default	`True`
Property type	Boolean
Usage	When this property is set to `True`, the adapter provides assured once-only event delivery, so that each event is delivered only once. A value of `False` does not provide assured once-only 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

Note: The Assured once-only delivery property applies only to asynchronous transactional RFC processing.

Auto create event table (EP_CreateTable)

This property determines if the event table is created automatically.

Table 6. Auto create event table details
Required	Yes if Assured once-only event delivery is set to `True`; otherwise, no.
Possible values	`True` `False`
Default	`True`
Property type	Boolean
Usage	This property indicates whether the adapter should create the event recovery table automatically if it does not already exist. 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 that is provided in Event recovery table name property is used to create the table.
Globalized	No
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

Database schema name (EP_SchemaName)

This property is the schema that is used to create the event recovery table automatically.

Table 9. Database schema name details
Required	No
Default	No default value.
Property type	String
Usage	Specifies the schema name for the database used by the adapter's event persistence feature.
Example	`ALE_SCHEMA`
Globalized	Yes
Bidi supported	No

Delivery type (DeliveryType)

This property specifies the order in which events are delivered by the adapter to the export component.

Table 10. Delivery type details
Required	No
Possible values	`ORDERED` `UNORDERED`
Default	`ORDERED`
Property type	String
Usage	The following values are supported: `ORDERED`: The adapter delivers events to the export component one at a time. `UNORDERED`: The adapter delivers all events to the export component at once. If you set this property to `UNORDERED`, the properties Minimum connections and Maximum connections must be greater than `1`.
Globalized	No
Bidi supported	No

Enable Secure Network Connection

This property indicates whether secure network connection mode is enabled.

Table 11. Enable Secure Network Connection details
Required	No
Possible values	`0` (off) `1` (on)
Default	`0`
Property type	String
Usage	Set the value to `1` (on) if you want to use secure network connection. If you set this value to `1`, you must also set following properties: Secure Network Connection library path Secure Network Connection name Secure Network Connection partner Secure Network Connection security level
Globalized	No
Bidi supported	No

Event recovery data source (JNDI) name (EP_DataSource_JNDIName)

This property is the JNDI name of the data source that is configured for event recovery.

Table 12. 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 IBM® Integration Bus. The adapter uses the data source for persisting the event state.
Example	`jdbc/DB2`
Globalized	No
Bidi supported	No

Event recovery table name (EP_TableName)

This property is the name of the event recovery table.

Table 13. 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. Configure a separate event recovery table 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

Event types to process (EventTypeFilter)

This property provides a delimited list of business object types for which the adapter should deliver events.

Table 14. Event type filter details
Required	No
Possible values	A comma-delimited (,) list of business object types.
Default	`null`
Property type	String
Usage	If this property is set, the adapter uses the delimited list as a filter, delivering events for only those business object types that are contained in the list. If the list is empty (null), the adapter does not apply filtering, and delivers events for all business object types.
Globalized	No
Bidi supported	No

Failure code (aleFailureCode)

This property determines how the adapter updates the SAP failure status code after the ALE module has retrieved an IDoc object for event processing.

Table 15. ALE failure code details
Required	Yes if AleUpdateStatus is set to `True`; otherwise, no.
Possible values	`68` `58` `51`
Default	51
Property type	Integer
Usage	Set a value for this property only if you set the value for the ALE update status property to `True`. Specify a value of `68` for this property to cause the adapter to update the SAP failure status code after the ALE module has retrieved an IDoc object for event processing. SAP converts this value to 40 (Application Document not created in receiving system). When you set the AleUpdateStatus property to `True`, the adapter updates a standard SAP status code after the adapter retrieves an IDoc object for event processing. An IDoc that is not sent successfully to the endpoint is considered to be a failure. Use the ALE failure code property to specify the code that is used to signify this failure.
Globalized	No
Bidi supported	No

Failure text (aleFailureText)

The property specifies the text that appears when an IDoc is not sent successfully to the endpoint.

Table 16. ALE failure text details
Required	Yes if AleUpdateStatus is set to `True`; otherwise, no.
Default	No default value.
Property type	String
Usage	Use this property only if you set the ALE update status property to `True`. The length of the text string cannot exceed 70 characters. When you set the AleUpdateStatus property to `True`, the adapter updates a standard SAP status code after the adapter retrieves an IDoc object for event processing. An IDoc that is not sent successfully to the endpoint is considered to be a failure. Use the ALE failure text property to specify the descriptive text that is used to signify this failure.
Example	`ALE Dispatch Failed`
Globalized	Yes
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 17. 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

Gateway host (GatewayHost)

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

Table 18. Gateway host details
Required	Yes
Default	No default value
Property type	String
Usage	This property is the host name of the SAP gateway. The gateway enables communication between work processes on the SAP system and external programs. The host identified is used as the gateway for the resource adapter. Maximum length of 20 characters. If the computer name is longer than 20 characters, define a symbolic name in the THOSTS table.
Globalized	No
Bidi supported	No

Gateway service (GatewayService)

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

Table 19. Gateway service details
Required	Yes
Default	`sapgw00`
Property type	String
Usage	These services enable communication between work processes on the SAP server and external programs. The service typically has the format of `sapgw00`, where 00 is the SAP system number. Maximum of 20 characters.
Globalized	No
Bidi supported	No

Host name (ApplicationServerHost)

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

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

IDoc empty tags

This property includes empty tags to the unpopulated fields in the IDoc segment, which are sent to a configured endpoint, based on the option selected.

Table 21. IDoc empty tags
Required	No
Possible Values	`BEFORE_AND_AFTER` `ONLY_BEFORE` `ALL_UNPOPULATED_FIELDS_SEGMENTS`
Default	`ONLY_BEFORE`
Property type	String
Usage	Use this property to select the following IDoc empty tag options: `BEFORE_AND_AFTER` - Include empty tags to the unpopulated fields before and after the populated fields within the IDoc segments. `ONLY_BEFORE` - Include empty data for the unpopulated fields within an IDoc segment before the populated field. `ALL_UNPOPULATED_FIELDS_SEGMENTS` - Include empty tags to the unpopulated fields in all the IDoc segments.
Globalized	No
Bidi supported	No

Ignore IDoc packet errors (IgnoreIDocPacketErrors)

This property determines whether IDoc packet errors are to be ignored.

Table 22. Ignore IDOC packet errors details
Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	If the adapter encounters an error while processing the IDoc packet, it can behave in two different ways. When this property is set to `False`, the adapter stops processing further IDocs in that packet and reports an error to the SAP system. When this property is set to `True`, the adapter logs an error and continues to process the rest of the IDocs in that packet. The status of the transaction is marked as `INPROGRESS`. The adapter log displays the IDoc numbers that failed and you need to resubmit those individual IDocs separately. You need to manually maintain these records in the event recovery table. This property is not used for single IDocs and for non-split IDoc packets.
Globalized	No
Bidi supported	No

Language code

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

Table 23. Language code details
Required	Yes
Possible values	For a full listing of languages and associated code page numbers that are supported by SAP, see SAP Note 7360.
Default	The default value for the Language code property is based on the system locale.
Property type	String
Usage	Each of the supported languages is preceded by a two-character language code. The language itself is displayed in parentheses. If you enter a language code manually, you do not need to enter the language in parentheses. The language codes that are listed represent the SAP default set of 41 languages for non-Unicode systems plus Arabic. The value that you select determines the value of the Codepage number property.
Example	If the system locale is English, the value for this property is `EN (English)`.
Globalized	No
Bidi supported	No

Load Balancing

This property specifies if your SAP configuration uses load balancing

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

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.

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

Maximum number of events collected during each poll

This property specifies the number of events that the adapter delivers to the export component during each poll period.

Table 26. Maximum number of events collected during each poll details
Required	Yes
Default	`10`
Property type	Integer
Usage	This value must be greater than 0
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.

Table 27. Maximum number of retries in case of system failure details
Required	Yes
Default	`0`
Property type	Integer
Usage	When the adapter encounters an error related to the inbound connection (if the SAP application is down for example), this property specifies the number of times the adapter tries to restart the event listeners. A value of 0 indicates an infinite number of retries. Note: Configure the Time between retries in case of system connection failure (milliseconds) appropriately when retrying infinitely. For each retry attempt, the adapter waits based on the time interval specified in the Time between retries in case of system connection failure (milliseconds). Note: If all the retry attempts fail, the adapter logs relevant messages and CEI events and stops attempting to recover the event listener. If you reach this point, you might have to restart the application manually.
Globalized	No
Bidi supported	No

Message server host (MessageServerHost)

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

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

Table 29. 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 zero (0).
Globalized	No
Bidi supported	No

Partner character set (PartnerCharset)

This property specifies the partner character set encoding.

Table 30. Partner character set details
Required	No
Default	UTF-8
Property type	String
Usage	When an encoding is specified, it is used; otherwise, the default encoding is used.
Globalized	No
Bidi supported	No

Password

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

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

Password used to connect to event data source (EP_Password)

This property is the user password for connecting to the database.

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

RFC program ID

This property is the program identifier under which the adapter registers in the SAP gateway.

Table 33. 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 (RcfTraceLevel)

This property specifies the global trace level.

Table 34. 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 35. RFC trace on details
Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	A value of `True` activates tracing, which generates a text file. This file is created in the directory in which the adapter process was started. The file has a prefix of `rfx` and a file type of trc (for example, rfc03912_02220.trc). Use these text files in a development environment only, because the files can grow rapidly. If RFC trace on is set to `False` (not selected), you cannot set values in the Folder for RFC trace files or RFC trace level properties.
Example	Examples of the information in the file are RfcCall FUNCTION BAPI_CUSTOMER_GETLIST, followed by the information for the parameters in the interface, or RFC Info rfctable, followed by the data from one of the interface tables. The trace file is created in the directory where the adapter process has been started. The trace file has a .trc file extension and the file name will start with the letters `rfc` followed by a unique identifier. For example, `rfc03912_02220.trc`.
Globalized	No
Bidi supported	No

SAP system ID (SAPSystemID)

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

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

Secure Network Connection library path (SncLib)

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

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

Secure Network Connection name (SncMyname)

This property specifies the name of the secure network connection.

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

Secure Network Connection partner (SncPartnername)

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

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

Secure Network Connection security level (SncQop)

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

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

Selective update (aleSelectiveUpdate)

This property specifies which IDoc Type and MessageType combinations are to be updated.

Table 41. ALE selective update details
Required	No
Default	No default value
Property type	String
Usage	You can set values for this property only if the ALE update status property is set to `True`. When you set the AleUpdateStatus property to `True`, the adapter updates a standard SAP status code after the adapter retrieves an IDoc object for event processing. Use the ALE selective update property to specify which IDoc Type and MessageType combinations are to be updated. The syntax for this property is: `IDocType: MessageType [;IDocType: MessageType [;...]]` where a slash (/) delimiter separates each IDoc Type and MessageType, and a semicolon (;) delimiter separates entries in a set.
Example	The following example illustrates two sets. In the example, MATMAS03 and DEBMAS03 are the IDocs, and MATMAS and DEBMAS are the message types: `MATMAS03/MATMAS;DEBMAS03/DEBMAS`
Globalized	No
Bidi supported	No

Status message code (aleStatusMsgCode)

This property specifies the message code to use when the adapter posts the ALEAUD01 IDoc with message type ALEAUD.

Table 42. ALE status message code details
Required	No
Possible values	For a list of available codes, refer to the SAP table TEDS1.
Default	No default value.
Property type	String
Usage	You can set a value for this property only if the ALE update status property has been set to `True`. You must configure this message code in the receiving partner profile on SAP.
Globalized	No
Bidi supported	No

Stop the adapter when an error is encountered while polling (StopPollingOnError)

This property specifies whether the adapter stops polling for events when it encounters an error during polling.

Table 43. Stop the adapter when an error is encountered while polling details
Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	If this property is set to `True`, the adapter stops polling when it encounters an error. If this property is set to `False`, the adapter logs an exception when it encounters an error during polling and continues polling.
Globalized	No
Bidi supported	No

Success code (aleSuccessCode)

This property specifies the ALE success code for the successful posting of an IDoc.

Table 44. ALE success code details
Required	Yes if AleUpdateStatus is set to `True`; otherwise, no.
Possible values	`39` `41` `55`
Default	55 - Application document posted
Property type	Integer
Usage	Use this property only if you set the ALE update status property to `True`. When you set the AleUpdateStatus property to `True`, the adapter updates a standard SAP status code after the adapter retrieves an IDoc object for event processing. Use the ALE success code property to specify the code for IDoc posted as 53. After the IDoc is sent to the endpoint, the IDoc status remains as 03 (IDoc posted to port) in SAP. After posting the IDoc, the adapter posts the audit IDoc with the current IDoc number and status as 53. SAP converts the current IDoc status to 41 (Application Document Created in Receiving System).
Globalized	No
Bidi supported	No

Success text (aleSuccessText)

This property specifies the text that appears when an application document is posted successfully.

Table 45. ALE success text details
Required	Yes if AleUpdateStatus is set to `True`; otherwise, no.
Default	No default value.
Property type	String
Usage	Use this property only if you set the ALE status update property to `True`. When you set the AleUpdateStatus property to `True`, the adapter updates a standard SAP status code after the adapter retrieves an IDoc object for event processing. Use the ALE success text property to specify the descriptive text that is used to signify Application Document Posted.
Example	`ALE Dispatch OK`
Globalized	Yes
Bidi supported	No

System number (SystemNumber)

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

Table 46. 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 polling for events (milliseconds)

This property specifies the length of time that the adapter waits between polling periods.

Table 47. Time between polling for events (milliseconds)
Required	Yes
Possible values	Integers greater than or equal to `0`.
Default	`2000`
Unit of measure	Milliseconds
Property type	Integer
Usage	The time interval between polling events is established at a fixed rate, which means that if running the poll cycle is delayed for any reason (for example, if a prior poll cycle takes longer than expected to complete), the next poll cycle occurs immediately to make up for the time that is lost because of the delay.
Globalized	No
Bidi supported	No

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

This property specifies the time interval between attempts to restart the event listeners.

Table 48. 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 restart the event listeners.
Globalized	No
Bidi supported	No

Trim ALE Idoc field data

This property specifies if the leading white spaces are trimmed by the adapter before sending it to endpoint.

Table 49. Trim ALE Idoc field data
Required	No
Possible Values	`True` `False`
Default	`True`
Property type	Boolean
Usage	If you want the leading white spaces to be trimmed by the adapter before sending it to endpoint, set this property to `True`. By default, the property is set to `True`. If you do not want the leading white spaces to be trimmed by the adapter, set the value to `False`.
Globalized	No
Bidi supported	No

User name (userName)

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

Table 50. 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 (EP_UserName)

This property is the user name for connecting to the database.

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

X509 certificate (X509cert)

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

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

rbp_sap_inbound_props_wmb.htm |

Last updated Friday, 21 July 2017