WebSphere Adapter for SAP Software

Activation specification properties

Activation specification properties hold the inbound event processing configuration information for a message endpoint. They can be set through the enterprise service discovery wizard or the WebSphere® Process Server administrative console.

J2C activation specification properties (also referred to as message endpoint properties) correspond to the ActivationSpec interface of the J2EE Connector Architecture Specification. These properties are relevant to working with the ALE interface because an activation specification is used during endpoint activation. Endpoint activation is the process of notifying the adapter of eligible event listeners. For inbound processing, the adapter uses these event listeners to receive events from SAP before forwarding them to the endpoint (a message driven bean).

When you configure the adapter, specify the activation specification properties listed below.

Table 1. Activation specification properties
Property name in enterprise service discovery Property name in administrative console Type Description Default value
Ale Failure Code aleFailureCode String Specifies the status code for dispatch failure. You must specify a value for this property (68 or 58) to cause the adapter to update the SAP failure status code after the adapter has retrieved an IDoc object for event processing. SAP converts this value to 40. None
Ale Failure Text aleFailureText String Specifies the descriptive text for dispatch failure. Specifying a value for this property is optional, even when you set AleUpdateStatus to true. None
Ale Selective Update aleSelectiveUpdate String Specifies which IDoc Type and MessageType combinations are to be updated when the adapter is configured to update a standard SAP status code. You can define values for this property only if AleUpdateStatus has been set to true.

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.

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

 
Ale Status Message Code aleStatusMsgCode String If required, this property specifies the message code to use when the adapter posts the ALEAUD Message IDoc (ALEAUD01). Configure this message code in the receiving Partner Profile. You can set a value for this property only if AleUpdateStatus has been set to true. None
Ale Success Code aleSuccessCode String Specifies the success status code for Application Document Posted. You must specify a value for this property (52 or 53) to cause the adapter to update the SAP success status code after the interface has retrieved an IDoc object for event processing. SAP converts this value to status 41 (Application Document Created in Receiving System). None
Ale Success Text aleSuccessText String Specifies the descriptive text for successful Application Document Posted. Specifying a value for this property is optional, even when you set AleUpdateStatus to true. None
Ale Update Status aleUpdateStatus Boolean Specifies whether an audit trail is required for all message types. Set this property to true if you want the adapter to update a standard SAP status code after the adapter has retrieved an IDoc object for event processing. False
Application Server Host applicationServerHost String 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 in to. Regardless of whether it is configured for load balancing, the adapter assumes that the name of the gateway host is the same as the value specified for this property. None
Assured Once only Delivery assuredOnceDelivery Boolean If this property is set to true, the adapter attempts to store XID information in the event store. If it is set to false, the adapter does not attempt to store the information. A value of true provides assured once event delivery. A value of false does not provide assured once event delivery, but it provides better performance. This property is used only if the MDB is transactional. If it is not, no transaction can be used, regardless of the configuration. True
Auto Create Event Table EP_CreateTable Boolean Flag that indicates whether the adapter should create the event recovery table automatically if it does not already exist. True
Client client String SAP Client number under which the adapter logs in. This value is often 100. 100
Codepage Number codepage Integer Establishes a connection to the appropriate language. This property must correspond to the value specified in the Language property.

For example, if Language is set to JA (Japanese), then Codepage must be set to 8000, as dictated by the SAP application.

Refer to SAP documentation for the exact Language and Codepage values.

 
Database Schema Name EP_SchemaName String Schema used for automatically creating the event recovery table. None
DataSource Name BiDi Special Format biDiContext_EDTDatasource BiDiSpecialFormat String Controls the bidirectional format specific for all EP properties.  
EIS BiDi Format biDiContextEIS String The bi-di format used by SAP for its business data.  
EIS BiDi Special Format biDiContextSpecialFormat String Specifies the category of values that are subject to special treatment during invocation of bi-di transformation to ensure accurate transformation of the category. Categories are predefined (for example: FTP, URLs, and e-mail addresses).  
EIS Connection Retry Interval retryInterval Integer Specifies the time delay before trying to restart the ALE event listeners. The value should be specified in milliseconds.  
EIS Connection Retry Limit retryLimit Integer Specifies the number of times the adapter tries to restart the ALE event listeners. A value of 0 indicates an infinite number of retries. 0
Event Persistence BiDi Format biDiContext_EDTTablenameEIS String Specifies the bidirectional format for the Event Persistence property. ILYNN
Event Recovery DataSource (JNDI) Name EP_DataSource_JNDIName String JNDI name of the data source configured for event recovery. None
Event Recovery Table Name EP_TableName String Name of the event recovery table.  
Gateway Host gatewayHost String SAP gateway host where the gateway service is running. None
Gateway Service gatewayService String The gateway server identifier. This value is often sapgw00. 00 is the system number of the server running the SAP gateway (which is usually an application server). This value cannot be 00 if you have more than one server. sapgw00
Logon Group logonGroup String When the adapter is configured for load balancing, this property specifies the name of the logon group that represents a group of application servers. None
Ignore IDoc Packet Errors ignoreIDocPacketErrors Boolean 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 processing the rest of the IDocs in that packet.

This property is not used for single IDocs and for non-split IDoc packets.

 
Language language String Language in which the adapter logs in. E for English
Message Server Host messageServerHost String When the adapter is configured for load balancing, this property specifies the name of the message server. None
Metadata BiDi format biDiContextMetadata String Specifies the bidirectional format of meta configuration data.  
Number Of Listeners numberofListeners Integer Specifies the number of event listeners that are to be started. 1
Partner Charset partnerCharset String Specifies PartnerCharset encoding. When an encoding is specified, it is used; otherwise the default encoding is used. None
Password password String Password for the adapter user account on the SAP system.  
Password BiDi Format biDiContext_PasswordEIS String Specifies the bidirectional format for the Password value. ILYNN
Password to connect to Event Datasource EP_Password String User password for connecting to the database. None
RFC Program ID rfcProgramID String Program identifier under which the RFC server program registers. None
RFC Trace On RFCTraceOn Boolean Specifies whether to generate a text file detailing the RFC activity for each event listener. You can specify a value of true or false. A value of true activates tracing, which generates a text file. Use these text files in a development environment only, because the files can grow rapidly. False
SAP System ID SAPSystemID String When the adapter is configured for load balancing, this property specifies the logical name of the SAP system (also known as R3name). None
Skip BiDi Transformation biDiContextSkip String Controls invocation of bi-di transformation. Possible values are true or false. A blank value invokes the lookup mechanism.  
Skip BiDi Transformation for DataSource Name biDiContext_EDTDatasourceEIS Boolean Controls invocation of support for bidirectional text transformation for the Password property. True
Skip BiDi Transformation for Event Persistence biDiContext_EDTTablenameSkip Boolean Controls invocation of support for bidirectional text transformation for the Event Persistence property. True
Skip BiDi Transformation for Password biDiContext_PasswordSkip Boolean Controls invocation of support for bidirectional text transformation for the Password property. True
Skip BiDi Transformation for User Name biDiContext_UserNameSkip Boolean Controls invocation of support for bidirectional text transformation for the User name property. True
System Number systemNumber String System number of the application server. The value, which is a two-digit number, is often 00. 00
User Name userName String Name of the adapter user account on the SAP system. None
User Name BiDi Format biDiContext_UserNameEIS String Specifies the bidirectional format for the User name property. ILYNN
Username to connect to Event Datasource EP_UserName String User name for connecting to the database. None
Related reference
Enterprise service discovery connection properties
Resource adapter properties
Managed (J2C) connection factory properties
Settings for controlling bidirectional transformation

Terms of use |

Last updated: Mon 30 Oct 2006 03:34:55

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)