WebSphere Adapter for JDBC

Activation specification properties

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

When you configure the adapter, specify the activation specification properties listed the tables below. A separate table describes the bidirectional activation specification properties that need to be configured only if bidirectional text transformation is being used.

Table 1. Activation specification properties for the Adapter for JDBC
Property Type Description Globalized Default value
AssuredOnceDelivery Boolean If this property is set to true, an xid value is set for each event in the event store. Each event is then delivered to its corresponding endpoint and subsequently deleted from the event table. No true
CustomDeleteQuery String The custom delete query that is run after each event is processed. This is enabled for use with bidirectional languages. Yes None
CustomEventQuery String The SQL query, stored procedure, or stored function for custom event processing. This query is run during each poll cycle when the EventQueryType is set to Dynamic. This is enabled for use with bidirectional languages. Yes None
CustomUpdateQuery String The custom update query that is run after each event is processed so that the same event does not get picked up for processing in the subsequent event cycle. This is enabled for use with bidirectional languages. Yes None
DatabaseURL String The driver-specific URL for creating a connection to the enterprise information system (EIS). This is enabled for use with bidirectional languages. Yes None
DataSource
JNDIName
String Name used by the adapter to establish the connection to the database. If UserName and Password are also set, they are also used when establishing the connection. If not, just the DataSourceJNDIName property is used. Yes None
Delivery Type String This property determines the order in which the events are published. The value is either ORDERED or UNORDERED.Ordered means events are published one at a time, while unordered means events are published all at once. Yes ORDERED
EventFilterType String The adapter can filter the events to be processed by business object type. EventFilterType has a comma delimited list of business object types, and only the types specified in the property are picked up for processing. If no value is specified for the property, no filter is applied, and all the events are picked up for processing. Yes null
EventOrderBy String The order in which events are retrieved and processed. Expected values are comma-separated column names of the event table. This property is enabled for use with bidirectional languages. No None
EventQueryType String Determines whether to use the standard event store or custom query. The valid values are Standard, for standard event store, and Dynamic, for custom event processing. No None
EventTableName String Table in the EIS that contains events generated by the EIS for inbound processing. This is enabled for use with bidirectional languages. Yes None
FilterFutureEvents Boolean If this property is set to true, the adapter filters events based on timestamp. The adapter compares the system time in each poll cycle to the timestamp on each event. If an event is set to occur in the future, it is not picked up for processing until that time. No false
JDBCDriverClass String JDBC driver class used to connect to the EIS. No None
Password String Password for authorizing the user to retrieve events from the EIS. This property is enabled for use with bidirectional languages. Yes None
PollPeriod Integer that is equal to or greater than 0 The rate in milliseconds at which to poll the EIS event store for new inbound events. If 0, the adapter will not wait between cycles. The poll cycle is established at a fixed rate, meaning that if an execution of the poll cycle is delayed (for example, the prior poll cycle takes longer than expected to complete) the next cycle will occur immediately to catch up. This is a required property. Yes 500
PollQuantity Integer that is greater than 0. This property is used to determine the number of events to deliver to each endpoint per poll cycle. It is a required property. Yes None
RetryLimit Integer The number of times the adapter attempts to retry the connection to the EIS. A value of 0 (zero) causes the adapter to use an unlimited number of attempts. No 0
RetryInterval Integer If this value is non-negative and the adapter encounters an error related to the inbound connection to the EIS, the adapter continues to re-attempt a connection after the specified interval until a connection is re-established. Values are in milliseconds. No 60000 (1 minute)
SPAfterPoll String Any stored procedure that you want to be run after each poll cycle. It takes one input parameter for PollQuantity. This is enabled for use with bidirectional languages. Yes None
SPBeforePoll String Any stored procedure that you want to be run before the actual poll query is called. It takes one input parameter for PollQuantity. This is enabled for use with bidirectional languages. Yes None
StopPollingOnError Boolean If true, the adapter stops polling when it encounters an error during polling. If false, the adapter logs an exception when it encounters an error, and continues polling. No false
UserName String User name for logging into the EIS for inbound events. This is enabled for use with bidirectional languages. Yes None

Bidirectional activation specification properties for the Adapter for JDBC

Property Type Description
BiDiContextEIS String Defines bidirectional format for content data in all of the business object runtime instances supported by the adapter for specific connection to the EIS.
BiDiContextMetadata String Defines the bidirectional format for metadata or configuration properties for a specific connection to the EIS.
BiDiContextSkip Boolean Flag that controls the invocation of bidirectional support at the resource adapter level. If it equals true, the support will not be invoked. If it equals false, then the support will be invoked.
BiDiContextSpecialFormat String Specifies the category of properties subject to special treatment for all of the connector properties of a specific connection to the EIS.
CustomDeleteQuery BiDi properties   *CustomDeleteQueryEIS
CustomDeleteQuerySkip
CustomEventQuery BiDi properties   *CustomEventQueryEIS
CustomEventQuerySkip
CustomUpdateQuery BiDi properties   *CustomUpdateQueryEIS
CustomUpdateQuerySkip
DatabaseURL BiDi properties   *DatabaseURLEIS, DatabaseURLSpecialFormat (default value is JDBC_URL_SQL), DatabaseURLSkip
EventTableName BiDi properties  

*EventTableNameEIS,
EventTableNameSkip

EventOrderBy BiDi properties   *EventOrderByEIS, EventOrderBySkip
Password BiDi properties   *PasswordEIS, PasswordSkip
SPAfterPoll BiDi properties   *SPAfterPollEIS, SPAfterPollSkip
SPBeforePoll BiDi properties   *SPBeforePollEIS, SPBeforePollSkip
UserName BiDi properties   *UserNameEIS, UserNameSkip
*The three bidirectional (BiDi) properties associated with each BiDi-supported property. These properties are described in the following table.
BiDi property Type Description

BiDiContextCP<property_
Name>EIS

String Defines bidirectional format for a specific connector configuration property for a specific connection to the EIS.

BiDiContectCP<property_
Name>SpecialFormat

String Flag that controls the invocation of bidirectional support at the connector configuration property level. If it equals true, the support will not be invoked. If it equals false, then the support will be invoked.

BiDiContextCP<property_
Name>Skip

Boolean Defines special format for a specific connector property for a specific connection to the EIS.
Important: Custom queries for CustomEventQuery, CustomUpdateQuery, and CustomDeleteQuery properties are supported for bidirectional transformation when they are in the form of stored procedures or stored functions. But, for standard SQL only the string constants in the SQL statement are supported.
Related reference
Resource adapter properties
Managed (J2C) connection factory properties

Terms of use |

Last updated: Tue 12 Dec 2006 03:32:39

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