WebSphere Message Brokers
File: rbp_sap_activationspec_props
Writer: Karen Cameron

Reference topic

This build: July 31, 2007 21:40:37

Activation specification properties for ALE inbound processing

Activation specification properties are properties that hold the inbound event processing configuration information for a message endpoint. You can set activation specification properties either through the Adapter Connection wizard or the administrative console.

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.

The following table lists the activation specification properties for ALE inbound processing. A complete description of each property is provided in the sections that follow the table.
Table 1. Activation specification properties for ALE inbound processing
Descriptive name Property name Purpose
ALE failure code property AleFailureCode This property specifies the status code for dispatch failure.
ALE failure text property AleFailureText This property specifies the descriptive text for dispatch failure.
ALE selective update property AleSelectiveUpdate This property specifies which IDoc Type and MessageType combinations are to be updated when the adapter is configured to update a standard SAP status code.
ALE status message code property AleStatusMsgCode If required, this property specifies the message code to use when the adapter posts the ALEAUD Message IDoc (ALEAUD01).
ALE success code property AleSuccessCode This property specifies the success status code for Application Document Posted.
ALE success text property AleSuccessText This property specifies the descriptive text for successful Application Document Posted.
ALE update status property AleUpdateStatus This property specifies whether an audit trail is required for all message types.
Application server host property ApplicationServerHost 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.
Assured once only delivery property AssuredOnceDelivery 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.
Auto create event table property EP_CreateTable This property indicates whether the adapter should create the event recovery table automatically if it does not already exist.
Client property Client This property is the client number of the SAP system to which the adapter makes a connection.
Code page number property Codepage This value must correspond to the value specified in the Language property.
Database schema name property EP_SchemaName This property is the schema used for automatically creating the event recovery table.
EIS connection retry interval property RetryInterval This property specifies the time delay before trying to restart the ALE event listeners.
EIS connection retry limit property RetryLimit This property specifies the number of times the adapter tries to restart the ALE event listeners.
Event recovery data source (JNDI) name property EP_DataSource_JNDIName This property is the JNDI name of the data source configured for event recovery.
Event recovery table name property EP_TableName This property is the name of the event recovery table.
Gateway host property GatewayHost This property is the name of the SAP system that will be used as the gateway for the resource adapter.
Gateway service property GatewayService This property is the identifier of the gateway on the gateway host that carries out the RFC services.
Logon group property Group When the adapter is configured for load balancing, this property specifies the name of the logon group that represents a group of application servers.
Ignore IDOC packet errors property IgnoreIDocPacketErrors This property determines what the adapter does when it encounters an error while processing the IDoc packet.
Language property Language This property is the language in which the adapter logs on.
Message server host property MessageServerHost When the adapter is configured for load balancing, this property specifies the name of the host on which the message server is running.
Number of listeners property NumberOfListeners This property specifies the number of event listeners that are to be started.
Partner charset property PartnerCharset This property specifies PartnerCharset encoding. When an encoding is specified, it is used; otherwise the default encoding is used.
Password property Password This property is the password of the user account of the adapter on the SAP server.
Password to connect to event data source property EP_Password This property is the user password for connecting to the database.
RFC program ID property RfcProgramID This property is the program identifier under which the RFC server program registers.
RFC trace on property RFCTraceOn This property specifies whether to generate a text file detailing the RFC activity for each event listener.
SAP system ID property SAPSystemID This property specifies the system ID of the SAP system for which logon load balancing is allowed.
System number property SystemNumber This property is the system number of the application server.
User name property Username This property is the user account for the adapter on the SAP server.
User name to connect to event data source property EP_UserName This property is the user name for connecting to the database.

ALE failure code property

Use this property only if you set the AleUpdateStatus 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. An IDoc that is not successfully sent to the endpoint is considered a failure. You use the ALE failure code property to specify the code used to signify this failure.

Specify a value 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).

Required? Yes if AleUpdateStatus is set to true; no otherwise
Default None
Property type String
Possible values
  • 68
  • 58
Related properties ALE update status property

ALE failure text property

Use this property only if you set the AleUpdateStatus 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. An IDoc that is not successfully sent to the endpoint is considered a failure. You use the ALE failure text property to specify the descriptive text used to signify this failure.

Specifying a value for this property is optional, even when you set AleUpdateStatus to true.

Required? Yes if AleUpdateStatus is set to true; no otherwise
Default None
Property type String
Restrictions  
Example ALE Dispatch Failed
Related properties ALE update status property

ALE selective update property

Use this property only if you set the AleUpdateStatus 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. You 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.

Required? No
Default None
Restrictions You can define values for this property only if AleUpdateStatus has been set to true.
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

Related properties ALE update status property

ALE status message code property

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.

For list of available codes, refer to the SAP table TEDS1.

Required? No
Default None
Property type String
Restrictions
  • You can set a value for this property only if AleUpdateStatus has been set to true.
  • You must configure this message code in the receiving partner profile on SAP.
Example TBD
Related properties ALE update status property

ALE success code property

Use this property only if you set the AleUpdateStatus 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. You 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).

Required? Yes if AleUpdateStatus is set to true; no otherwise
Default None
Property type String
Possible values
  • 52
  • 53
Related properties ALE update status property

ALE success text property

Use this property only if you set the AleUpdateStatus 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. You use the ALE success text property to specify the descriptive text used to signify Application Document Posted.

Specifying a value for this property is optional, even when you set AleUpdateStatus to true.

Required? Yes if AleUpdateStatus is set to true; no otherwise
Default None
Property type String
Restrictions  
Example ALE Dispatch OK
Related properties ALE update status property

ALE update status property

This property 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 ALE module has retrieved an IDoc object for event processing.

If you set this value to true, you must also set following properties: AleFailureCode, AleSuccessCode, AleFailureText, and AleSuccessText.

Required? Yes
Default False
Possible values True or False
Related properties

Application server host property

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.

Required? Yes (when load balancing is not used)
Default None
Property type String
Restrictions  
Example sapServer

Assured once only delivery property

If this property is set to True, the adapter attempts to store XID information in the event recovery table. 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 because there is no transaction involved.

This property is used only if the message driven bean is transactional. If it is not, no transaction can be used, regardless of the configuration.

Required? Yes
Default False
Possible values True or False

Auto create event table property

This property indicates whether the adapter should create the event recovery table automatically if it does not already exist.
Note: 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 EP_TableName is used to create the table.

Required? Yes
Default True
Possible values True or False
Related properties Event recovery table name property

Client property

This property is the client number of the SAP system to which the adapter makes a connection.

Required? Yes
Default 100
Property type String
Range of values 000 - 999

Code page number property

This property establishes a connection to the appropriate language. It must correspond to the value specified in the Language property.

Required? No
Default Based on the value of the Language property
Property type Integer
Example

If Language is set to JA (Japanese), Codepage number is set to 8000.

Related properties Language property

Database schema name property

This property is the schema used for automatically creating the event recovery table.
Note: In the administrative console, this property is listed as "EP_SchemaName".
Required? No
Default None
Property type String
Restrictions  
Example ALE_SCHEMA

EIS connection retry interval property

This property specifies the time delay before trying to restart the ALE event listeners.
Note: In the administrative console, this property is listed as "retryInterval".
Required? Yes
Default 3600000
Property type Integer
Unit of measure Milliseconds
Restrictions TBD

EIS connection retry limit property

If this value of this property is greater than 0, it specifies the number of times the adapter tries to restart the ALE event listeners. A value of 0 indicates no limit on the number of retries, in which case the adapter keeps trying to restart the event listeners.
Note: In the administrative console, this property is listed as "retryLimit".
Required? Yes
Default 0
Property type Integer
Restrictions  

Event recovery data source (JNDI) name property

This property is the JNDI name of the data source configured for event recovery.
Note: In the administrative console, this property is listed as "EP_DataSource_JNDIName".
Required? Yes
Default None
Property type String
Restrictions  
Example jdbc/DB2

Event recovery table name property

This property is the name of the event recovery table.
Note: In the administrative console, this property is listed as "EP_TableName".
Required? Yes
Default None
Property type String
Restrictions  
Example EVENT_TABLE

Gateway host property

This property is the name of the SAP system that will be used as the gateway for the resource adapter. The gateway enables communication between work processes on the SAP system and external programs. An IP address or the name of the Gateway host can be used.

Required? Yes
Default None
Property type String
Restrictions Maximum length of 20 characters. If the computer name is longer than 20 characters, define a symbolic name in the THOSTS table.
Example  

Gateway service property

This property is the identifier of the gateway on the gateway host that carries out the RFC services. 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 system number.

Required? Yes
Default sapgw00
Property type String
Restrictions Maximum of 20 characters.
Example TBD

Ignore IDOC packet errors property

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.

Required? No
Default False
Possible values True or False

Language property

This property specifies the language in which the adapter logs on.

Required? Yes
Default Based on the system locale
Property type String
Possible values  
Related properties: Code page number property

Logon group property

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.

Required? Yes (if load balancing is used)
Default None
Property type String
Restrictions Maximum of 20 characters. On most SAP systems, the SPACE logon group is reserved by SAP.
Example TBD

Message server host property

When the adapter is configured for load balancing, this property specifies the name of the host on which the message server is running. Its task is to inform all the servers (instances) belonging to this SAP system of the existence of the other servers. It contains the information about load balancing for RFC clients so that an RFC client can be directed to an appropriate application server.

Only one message server can run on each SAP system.

Required? Yes (if load balancing is used)
Default None
Property type String
Example SAPERP05

Number of listeners property

This property specifies the number of event listeners that are to be started. For event sequencing, this property should be set to 1.

Required? No
Default 1
Property type Integer
Restrictions  

Partner charset property

This property specifies PartnerCharset encoding. When an encoding is specified, it is used; otherwise the default encoding is used.

Required? No
Default None
Property type String
Possible values TBD
Example TBD

Password property

This property is the password for the user account of the adapter on the SAP system.

The password is not globalized.

Required? Yes
Default None
Property type String
Restrictions The restrictions on the password depend on the version of WebSphere® Application Server.
  • For WebSphere Application Server version 6.40 or earlier, the password:
    • Must be uppercase
    • Must be 8 characters in length
  • For versions of WebSphere Application Server later than 6.40, the password:
    • Is not case-sensitive
    • Can be up to 40 characters in length
Example  

Password to connect to event data source property

This property is the user password for connecting to the database.
Note: In the administrative console, this property is listed as "EP_Password".
Required? Yes ?
Default None
Property type String
Restrictions  
Example TBD

RFC program ID property

This property is the program identifier under which the adapter registers in the SAP gateway. 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. Use the SAP transaction SM59 to see a list of available RFC program IDs.

Required? Yes
Default None
Property type String
Restrictions The maximum length is 64 characters.
Example TBD

RFC trace on property

This property specifies whether to generate a text file detailing the RFC activity for each event listener. A value of true activates tracing, which generates a text file.

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.

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.

Required? No
Default False
Possible values True or False

SAP system ID property

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

Required? Yes (when load balancing is used)
Default None
Property type String
Restrictions Value must be three characters
Example DYL

System number property

This property is the system number of the application server. The value is a two-digit number, often 00.

Required? Yes
Default 00
Property type String
Range of values 00-99

User name property

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

Required? Yes
Default None
Property type String
Restrictions Maximum length of 12 characters. The user name is not case-sensitive.
Example SapUser

User name to connect to event data source property

This property is the user name for connecting to the database.
Note: In the administrative console, this property is listed as "EP_UserName".
Required? Yes ?
Default None
Property type String
Restrictions  
Example TBD
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:40:37

rbp_sap_activationspec_props This topic's URL is: