WebSphere Message Brokers
File: rbp_wa_activationspec_props
Writer: Kate Hostler

Reference topic

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

Activation specification properties

Activation specification properties are properties that hold the inbound event processing configuration information for a message endpoint. You 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 (a message driven bean).

The following table lists the activation specification properties. A complete description of each property is provided in the sections that follow the table.
Table 1. Activation specification properties
Descriptive name Property name Purpose
Assured once delivery

AssuredOnceDelivery

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.

Delivery type

DeliveryType

This property determines the order that polled events are published by the adapter to the endpoint.

Event type filter

EventTypeFilter

This property is a delimited list of event types that indicates to the adapter which events it should deliver. If set, the adapter will deliver only those events that are on the list.

Filter future events

FilterFutureEvents

This property determines whether the timestamp on each event will be compared to the system time.

Maximum connections

MaximumConnections

This property specifies the maximum number of connections that the adapter can use for inbound event delivery.

Minimum connections

Minimum connections

This property specifies the minimum number of connections that the adapter can use for inbound event delivery.

Poll period

PollPeriod

This property specifies the length of time that the adapter waits between polling periods. The poll period is established at a fixed rate.

Poll quantity

PollQuantity

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

Retry interval

RetryInterval

When the adapter encounters an error related to the inbound connection, this property specifies the length of time the adapter waits before trying to establish a new connection.

Retry limit

RetryLimit

When the adapter encounters an error related to the inbound connection, this property specifies the number of times the adapter tries to restart the connection. A value of 0 indicates an infinite number of retries.

Stop polling on error

StopPollingOnError

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

Use native object name

UseNativeObjectName

This property specifies whether the adapter will use the native object name or the business graph name.

Event component interface name EventCIName

This property specifies the name of the PeopleSoft Enterprise event component interface that the adapter uses during inbound operations.

Ping component interface name PingCompInterface This property specifies the name of the PeopleSoft component interface the adapter uses to validate a connection to the PeopleSot Enterprise server.
Event key delimiter EventKeyDelimiter This property specifies the delimiter for the object key name-value pair in the event table.

Assured once delivery property (AssuredOnceDelivery)

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.

A value of 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.

This property is used only if the export component is transactional. If it is not, no transaction can be used, regardless of the value of this property.

Table 2. Assured once delivery property characteristics
Required Yes
Default True
Property type Boolean
Possible values True or False

Delivery type property (DeliveryType)

This property determines the order that polled events are published by the adapter to the endpoint.

If this property is set to ORDERED, the adapter publishes events to the endpoint one at a time.

If this property is set to UNORDERED, the adapter publishes all events to the endpoint at once.

If this property is set to ORDEREDBYKEY, the adapter publishes events to the endpoint simultaneously (except when matching event keys occur).

Table 3. Delivery type property characteristics
Required No
Default ORDERED
Property type String
Possible values ORDERED, UNORDERED, ORDEREDBYKEY

Event type filter property (EventTypeFilter)

This property is a delimited list of event types that indicates to the adapter which events it should deliver. If set, the adapter will deliver only those events that are on the list.

A value of null indicates that no filter will be applied and that all events will be delivered to the endpoint.

Table 4. Event type filter property characteristics
Required No
Default Null
Property type String
Possible values Delimited list of event types

Filter future events property (FilterFutureEvents)

This property determines whether the timestamp on each event will be compared to the system time.

If set to true, the adapter inspects the time of each event and compares it to the system time. If the event time is later than the system time, the event is not be delivered.

If set to false, the adapter will not compare the time of each event to the system time.

Table 5. Filter future events property characteristics
Required Yes
Default False
Property type Boolean
Possible values True, False

Maximum connections property (MaximumConnections)

This property specifies the maximum number of connections that the adapter can use for inbound event delivery.

Any value less than 1 is treated as 1 by the adapter.

Table 6. Maximum connections property characteristics
Required No
Default 1
Property type Integer
Restrictions Only positive values are valid. The adapter considers any positive entry less than 1 to be equal to 1.

Minimum connections property (MinimumConnections)

This property specifies the minimum number of connections that the adapter can use for inbound event delivery.

Any value less than 1 is treated as 1 by the adapter.

Table 7. Minimum connections property characteristics
Required No
Default 1
Property type Integer
Restrictions Only positive values are valid. The adapter considers any positive entry less than 1 to be equal to 1.

Poll period property (PollPeriod)

This property specifies the length of time that the adapter waits between polling periods. The poll period is established at a fixed rate.

If a polling cycle is delayed for any reason, the next cycle will immediately begin.

If set to 0, the adapter does not wait between polling cycles.

Table 8. Poll period property characteristics
Required Yes
Default 2000
Property type Integer
Unit of measure Milliseconds
Restrictions The value must be greater or equal to 0

Poll quantity property (PollQuantity)

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

Table 9. Poll quantity property characteristics
Required Yes
Default 10
Property type Integer
Restrictions The value must be greater than 0

Retry interval property (RetryInterval)

When the adapter encounters an error related to the inbound connection, this property specifies the length of time the adapter waits before trying to establish a new connection.

Table 10. Retry interval property characteristics
Required Yes
Default 6000
Property type Integer
Unit of measure Milliseconds
Restrictions Only positive values are valid.

Retry limit property (RetryLimit)

When the adapter encounters an error related to the inbound connection, this property specifies the number of times the adapter tries to restart the connection. A value of 0 indicates an infinite number of retries.

Table 11. Retry limit property characteristics
Required No
Default 0
Property type Integer
Restrictions Only positive values are valid.

Stop polling on error property (StopPollingOnError)

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

If set to True, the adapter stops polling when it encounters an error.

If set to False, the adapter logs an exception when it encounters an error during polling and continues polling.

Table 12. Stop polling on error property characteristics
Required No
Default False
Property type Boolean
Possible values True, False

Use native object name property (UseNativeObjectName)

This property specifies whether the adapter will use the native object name or the business graph name.

Table 13. Use native object name property characteristics
Required No
Default False
Property type Boolean
Possible values True, False

Event component interface name property

This property specifies the name of the PeopleSoft Enterprise event component interface that the adapter uses during inbound operations.

Required? Yes
Default IBM_EVENT_CI
Property type String

Ping component interface property

This property specifies the name of the PeopleSoft Enterprise component interface that the adapter uses to validate a connection to PeopleSoft Enterprise.

Required? Yes
   
Property type String

Event key delimiter property

This property specifies the delimiter for the object key name-value pair in the event table.

Required? Yes
   
Property type String
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:34

rbp_wa_activationspec_props This topic's URL is: