Activation specification properties are properties that 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 Business Process Manager or WebSphere® Enterprise Service Bus administrative console.
The following table lists the activation specification properties for Advanced event inbound processing. A complete description of each property is provided in the sections that follow the table. For information on how to read the property detail tables in the sections that follow, see http://publib.boulder.ibm.com/infocenter/dmndhelp/v7r5mx/topic/com.ibm.wsadapters.jca.sap.doc/shared/rsha_in_interpret_prop_details.html.
| Property name | Purpose | |
|---|---|---|
| In enterprise service wizard | In administrative console | |
| Adapter Instance for event filtering (AdapterInstanceEventFilter) | AdapterInstanceEventFilter | Identifier that determines whether this adapter instance processes specific events in the event store. |
| Assured once-only delivery | AssuredOnceDelivery |
Specifies whether to provide assured-once delivery for inbound events. |
| 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. |
| Delivery type (DeliveryType) | DeliveryType |
Determines the order in which events are delivered by the adapter to the export. |
| Event types to process (EventTypeFilter) | EventTypeFilter | A delimited list of event types that indicates to the adapter which events it should deliver. |
| 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. |
| 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. |
| 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 events collected during each poll | PollQuantity |
The number of events that the adapter delivers to the export during each poll period |
| Maximum number of retries in case of system connection failure | RetryLimit |
The number of times SAP JCo tries to restart its server after an error. |
| Message server host | MessageServerHost |
Specifies the name of the host on which the message server is running. |
| Partner character set | PartnerCharset |
Specifies PartnerCharset encoding. |
| Password | Password |
The password of the user account of the adapter on the SAP application server. |
| Retry EIS connection on startup | RetryConnectionOnStartup |
Controls whether the adapter retries the connection to the EIS if it cannot connect at startup |
| 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. |
| Stop the adapter when an error is encountered while polling (StopPollingOnError) | StopPollingOnError |
Specifies whether the adapter stops polling for events when it encounters an error during polling. |
| System number | SystemNumber |
The system number of the SAP application server. |
| Time between polling for events (milliseconds) | PollPeriod |
The length of time that the adapter waits between polling periods |
| Time between retries in case of system connection failure (milliseconds) | RetryInterval |
This property is used by the SAP JCo server for the number of retry attempts made. |
| 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. |
This property controls whether the adapter instance processes specific events in the event store.
| Required | No |
|---|---|
| Default | null |
| Property type | String |
| Usage | This property helps you migrate from WebSphere Business Integration Adapter for SAP to WebSphere Adapter for SAP Software. WebSphere Business Integration Adapter for SAP allows
you to perform load balancing on high-volume event types by allowing
multiple adapter instances to process events of the same type. When
load balancing is not required, a single adapter instance processes
all events of a given type. This property is to enable seamless migration
for WBIA customers to JCA for customers who are currently taking advantage
of the connectorID filtering. WebSphere Adapter for SAP Software typically does not require load balancing in this way, but supports it so that you can migrate without modifying the database triggers or other mechanisms that write events to the event store. The AdapterInstanceEventFilter property corresponds to the ConnectorID property of the WebSphere Business Integration Adapter for SAP. To use this feature, the database triggers or other mechanisms that create events in the event store must assign the appropriate value to the ConnectorId column. Table 3 shows the interaction between the AdapterInstanceEventFilter property and the value in the ConnectorId column in the event store. If the EventTypeFilter and AdapterInstanceEventFilter properties are both set, the adapter processes only events that meet both criteria. That is, it processes only those events whose type is specified in the EventTypeFilter property and whose ConnectorId column matches the AdapterInstanceEventFilter property. |
| Example | See Table 3. |
| Globalized | Yes |
| Bidi supported | Yes |
| AdapterInstanceEventFilter property | ConnectorId column of an event | Result |
|---|---|---|
| null | null | The adapter processes the event. |
| null | Instance1 | The adapter processes the event, because the ConnectorId column is not checked. |
| Instance1 | Instance1 | The adapter processes the event. |
| Instance1 | Instance2 | The adapter does not process the event, because the instance IDs do not match. |
| Instance1 | null | The adapter does not process the event, because the instance IDs do not match. |
This property specifies whether to provide assured once-only delivery for inbound events.
| Required | Yes |
|---|---|
| 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 |
This property is the client number of the SAP system to which the adapter connects.
| 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 |
This property is the client number of the SAP system to which the adapter connects.
| 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 |
The numeric identifier of the code page.
| 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 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 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 |
This property specifies the order in which events are delivered by the adapter to the export.
| Required | No |
|---|---|
| Possible values | ORDERED |
| Default | ORDERED |
| Property type | String |
| Usage | The following values are supported:
|
| Globalized | No |
| Bidi supported | No |
This property indicates whether secure network connection mode is enabled.
| Required | No |
|---|---|
| Possible values | 0 (off) |
| 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:
|
| Globalized | No |
| Bidi supported | No |
This property contains a delimited list of event types that indicates to the adapter which events it should deliver.
| Required | No |
|---|---|
| Possible values | A comma-delimited (,) list of business object types |
| Default | null |
| Property type | String |
| Usage | Events are filtered by business object type . If the property is set, the adapter delivers only those events that are in the list. A value of null indicates that no filter will be applied and that all events will be delivered to the export. |
| Example | To receive events related to the Customer and Order business objects only, specify this value: Customer,Order If the EventTypeFilter and AdapterInstanceEventFilter properties are both set, the adapter processes only events that meet both criteria. That is, it processes only those events whose type is specified in the EventTypeFilter property and whose ConnectorId column matches the AdapterInstanceEventFilter property. |
| Globalized | No |
| Bidi supported | No |
This property specifies the number of times that the adapter attempts to redeliver an event before marking the event as failed.
| 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:
|
| Globalized | No |
| Bidi supported | No |
This property sets the fully qualified local path to the folder in which to write RFC trace files.
| 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 |
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.
| 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 |
This property is the identifier of the gateway on the gateway host that carries out the RFC services.
| 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 |
Specifies the IP address or the name of the application server host that the adapter logs on to.
| 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 |
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.
| Required | No |
|---|---|
| Possible Values | BEFORE_AND_AFTER ONLY_POPULATED_FIELDS |
| Default | ONLY_POPULATED_FIELDS |
| Property type | String |
| Usage | Use this property to select the following IDoc empty tag options:
|
| Globalized | No |
| Bidi supported | No |
This property specifies the Language code in which the adapter logs on.
| Required | Yes |
|---|---|
| Possible values | For a full listing of languages and associated codepage numbers supported by SAP, access 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 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 |
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.
| 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 |
This property specifies if your SAP configuration uses load balancing
| Required | Yes |
|---|---|
| Possible values | TrueFalse |
| 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 |
This property specifies the number of events that the adapter delivers to the export during each poll period.
| Required | Yes |
|---|---|
| Default | 10 |
| Property type | Integer |
| Usage | The value must be greater than 0 |
| Globalized | No |
| Bidi supported | No |
This property specifies the number of times the SAP JCo tries to restart the server. 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 inbound connection to the EIS if it cannot connect at startup.
| 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 SAP JCo tries to restart the server. |
| Globalized | No |
| Bidi supported | No |
This property specifies the name of the host on which the message server is running.
| 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 |
This property specifies the partner character set encoding.
| 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 |
This property is the password of the user account of the adapter on the SAP application server.
| Required | Yes |
|---|---|
| Default | No default value |
| Property type | String |
| Usage | The restrictions on the password depend on the version of SAP Web Application Server.
|
| Globalized | No |
| Bidi supported | Yes |
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).
| 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:
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 |
This property specifies the global trace level.
| Required | No |
|---|---|
| Possible values | 0 - No error |
| 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 |
This property specifies whether to generate a text file detailing the RFC activity for each event listener.
| Required | No |
|---|---|
| Possible values | True |
| 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 |
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 | No default value |
| Property type | String |
| Usage | Value must be three characters |
| Example | DYL |
| Globalized | No |
| Bidi supported | No |
This property specifies the path to the library that provides the secure network connection service.
| 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 |
This property specifies the path to the library that provides the secure network connection service.
| 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 |
This property specifies the name of the secure network connection.
| 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 |
This property specifies the name of the secure network connection partner.
| 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 |
This property specifies the level of security for the secure network connection.
| Required | Yes, if SncMode is set to 1; no otherwise. |
|---|---|
| Possible values |
|
| 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 |
This property specifies the level of security for the secure network connection.
| Required | Yes, if SncMode is set to 1; no otherwise. |
|---|---|
| Possible values |
|
| 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 |
This property specifies whether the adapter will stop polling for events when it encounters an error during polling.
| Required | No |
|---|---|
| Possible values | True |
| 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 |
This property is the system number of the SAP application server.
| 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 |
This property specifies the length of time that the adapter waits between polling periods.
| 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 will occur immediately to make up for the lost time caused by the delay. |
| Globalized | No |
| Bidi supported | No |
This property is used by the SAP JCo server for the number of retry attempts made. 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.
| 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 is used by SAP JCo server. |
| Globalized | No |
| Bidi supported | No |
This property is the user account for the adapter on the SAP server.
| 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 |
This property is the user account for the adapter on the SAP server.
| 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 |
This property specifies the X509 certificate to be used as the logon ticket.
| 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 |