IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > JDBC > Reference > Configuration properties > Inbound configuration properties

Activation specification properties

Activation specification properties are properties that hold the inbound event processing configuration information for an export.

You set activation specification properties using the external service wizard during adapter configuration and can change them using the IBM Integration Designer assembly editor or, after deployment, the IBM BPM or WebSphere Enterprise Service Bus administrative console.

The following table lists and describes the activation specification properties. A complete description of each property is provided in the sections that follow the table. For information about how to read the property detail tables in the sections that follow, see Guide to information about properties.

Activation specification properties for IBM WebSphere Adapter for JDBC
Property name Description
In the wizard In the administrative console
Adapter Instance for event filtering AdapterInstanceEvent
Filter
Identifier that determines whether this adapter instance processes specific events in the event store.
Additional JDBC driver connection properties JDBCDriverConnectionProperties

Additional properties for connecting to the database using the JDBC driver, which are used in addition to the UserName and Password properties.

Business object namespace BONameSpace The namespace for the business object definitions.
User-defined delete query CustomDeleteQuery The name of the query, stored procedure, or stored function that is run after each event is processed to delete records that can be deleted after the event is delivered.
User-defined event query CustomEventQuery The name of the query, stored procedure, or stored function that performs the polling for events.
User-defined update query CustomUpdateQuery The name of the query, stored procedure, or stored function that is run after each event is processed to prevent the event from being picked up for processing in a subsequent event cycle.
User-defined update query for failed event delivery CustomUpdateQueryForFailedEvent The name of the query, stored procedure, or stored function that is run when an event is not delivered successfully.
Database connection information ConnectionType Specifies how the adapter establishes connection to the database.
Data source JNDI name DataSourceJNDIName

The name of the JNDI data source used to establish a connection to the database.

Database URL DatabaseURL

The database URL used to connect to the database.

Database vendor DatabaseVendor

The type of database that the adapter uses for special processing.

Do not process events that have a timestamp in the future

FilterFutureEvents

Specifies whether the adapter filters out future events by comparing the timestamp on each event with the system time.

Ensure once-only event delivery

AssuredOnceDelivery

Specifies whether the adapter provides assured once delivery of events.

Event order by EventOrderBy The order in which events are retrieved and processed.
Event query type EventQueryType Determines whether to use the standard event store or custom query.
Event table name EventTableName Name of the database table that contains events generated by the database for inbound processing.
Event types to process

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.
Interval between polling periods

PollPeriod

The length of time that the adapter waits between polling periods.

JDBC driver class JDBCDriverClass

The class name of the JDBC driver used to connect to the database.

Maximum connections

MaximumConnections

The maximum number of connections that the adapter can use for inbound event delivery.

Minimum connections

MinimumConnections

The minimum number of connections that the adapter can use for inbound event delivery.

Maximum number of retries in case of system connection failure

RetryLimit

The number of times the adapter tries to reestablish an inbound connection after an error.

Password Password

Password for authorizing the user to retrieve events from the database.

Poll quantity

PollQuantity

The number of events the adapter delivers to the export during each poll period.

Query time out QueryTimeOut

The maximum number of seconds a query can take for all SQL statements.

Retry EIS connection on startup RetryConnectionOnStartup

Controls whether the adapter retries the connection to the database if it cannot connect at startup.

Time between retries in case of system connection failure (milliseconds)

RetryInterval

The length of time that the adapter waits between attempts to reestablish connection after an error during inbound operations.

Return dummy business object for RetrieveSP ReturnDummyBOForSP

Specifies whether to return output parameters when the result set is empty.

SQL query to verify the connection PingQuery The SQL query used to test the reliability of the connection to the database.
Stop the adapter when an error is encountered while polling

StopPollingOnError

Specifies whether the adapter stops polling for events when it encounters an error during polling.

Stored procedure to run after polling SPAfterPoll The name of the stored procedure that you want to be run after each poll cycle.
Stored procedure to run before polling SPBeforePoll The name of the stored procedure that you want to be run before the actual poll query is called.
Type of delivery

DeliveryType

Determines the order in which events are delivered by the adapter to the export.

User name UserName The database user name to use for inbound events.
(Not available) performTrimOnObjectKeyValue

Specifies whether to trim spaces for key-value pairs.

(Not available) nameValuePairDelimiter

Specifies the delimiter to separate key-value pair.

(Not available) valueDelimeter

Specifies the delimiter to separate the key and value in a key-value pair.

(Not available) unsetValueKeyWord Specifies the unset value in the object_key field.
(Not available) nullValueKeyWord Specifies the null value in the object_key field.
Timeout period for HA Active-Active event processing (seconds)

eventTimeout

Specifies the timeout period by which the polled events must be processed in High Availability Active-Active support. At the end of the timeout interval, unprocessed events will be processed as new events.

Ensure that this value is large enough, or the adapter may generate an unexpected exception in the event handling phase.


Adapter Instance for event filtering (AdapterInstanceEvent
Filter)

This property controls whether the adapter instance processes specific events in the event store.

Adapter Instance for event filtering details
Required No
Default null
Property type String
Usage This property helps you migrate from WebSphere Business Integration Adapter for JDBC to WebSphere Adapter for JDBC. WebSphere Business Integration Adapter for JDBC 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 JDBC 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 AdapterInstanceEvent
Filter property corresponds to the ConnectorID property of the WebSphere Business Integration Adapter for JDBC.

To use this feature, the database triggers or other mechanisms that create events in the event store must assign the appropriate value to the connector_ID column.

Table 3.shows the interaction between the AdapterInstanceEvent
Filter property and the value in the connector_ID column in the event store.

This property applies only to standard event processing. For custom event processing, the custom event query must perform necessary filtering.

If the EventTypeFilter and AdapterInstanceEvent
Filter 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 connector_ID column matches the AdapterInstanceEvent
Filter property.

When you are using custom event processing, this property is not supported.

Example See Table 3.
Globalized Yes
Bidi supported Yes

Interaction of the AdapterInstanceEvent
Filter property with the connector_ID column in the event store
AdapterInstanceEvent
Filter property
connector_ID column of an event Result
null null The adapter processes the event.
null Instance1 The adapter processes the event, because the connector_ID 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.


Additional JDBC driver connection properties [name:value;name:value] (JDBCDriverConnectionProperties)

This property contains additional information for connecting to the database using the JDBC driver.

Additional JDBC driver connection properties details
Row Explanation
Required No
Possible values Database connection properties are database-specific.
Default No default value
Property type String
Usage These connection properties are used in addition to the UserName and Password properties to customize the database connection used by the adapter.

Specify the connection properties as one or more name: value pairs separated by the semicolon character (;).

Example

The following value of this property specifies a login timeout interval, makes a read-only database connection, and sets the security mechanism:

loginTimeout:20;readOnly:true;
securityMechanism:USER_ONLY_SECURITY 

In a high availability environment, to get the properties that DB2 driver requires (retryIntervalForClientReroute, maxRetriesForClientReroute, clientRerouteAlternateServerName, clientRerouteAlternatePortNumber) for a reliable connection to the High Availability and Disaster Recovery (HADR) database, configure this property to generate the correct property string as shown in the example below:

retryIntervalForClientReroute:15;
maxRetriesForClientReroute:5;
clientRerouteAlternateServerName:WLOXS01B.svl.ibm.com;
clientRerouteAlternatePortNumber:50000
For more information about using WebSphere Adapter in WebSphere High Availability
Globalized Yes
Bidi supported No


Business object namespace (BONameSpace)

This property specifies the namespace for the business object definitions.

Business object namespace property characteristics
Required No
Default
http://www.ibm.com/xmlns/prod/websphere/j2ca/jdbc
Property type String
Usage

This value is added as a prefix to the business object name to keep business object names logically separated.

Example

The following example shows the Schema1Customer business object with the default namespace:

http://www.ibm.com/xmlns/prod/websphere/j2ca/jdbc
/Schema1Customer
Bidi supported No


User-defined delete query (CustomDeleteQuery)

Use this property to specify the SQL statement, stored procedure, or stored function to run after each event is processed to delete records that can be deleted after the event is delivered.

Custom delete query details
Required No
Default No default value
Property type String
Usage Use this property to specify the SQL statement, stored procedure, or stored function to run when the EventQueryType property is set to Dynamic.

During Bidi transformation, only the string within the quotes after the WHERE clause are converted for query with conditions.

For example, in the query select * from customer where customerid='john', only the string 'john' is converted.

Example
<customEventQuery>select event_id, object_key, object_name, object_function, connector_id from wbia_jdbc_eventstore_dynamic where event_status = 0</customEventQuery>
<customUpdateQuery>update wbia_jdbc_eventstore_dynamic set event_status= 1 where event_id = ?</customUpdateQuery>
<customUpdateQueryForFailedEvent>update wbia_jdbc_eventstore_dynamic set event_status=-1 where event_id = ?</customUpdateQueryForFailedEvent>
<customDeleteQuery>delete from wbia_jdbc_eventstore_dynamic  where event_id= ?</customDeleteQuery>
Globalized Yes
Bidi supported Yes


User-defined event query (CustomEventQuery)

Use this property to specify the SQL statement, stored procedure, or stored function to run to poll for events in custom event processing.

Custom event query details
Required No
Default No default value
Property type String
Usage Use this property to specify the SQL statement, stored procedure, or stored function to run during each poll cycle when the EventQueryType property is set to Dynamic.
Examples In the following example, the custom event query runs a SQL statement that returns the event ID, object key, and object name of every record in the MY_EVENT_TABLE event store whose status column has the value 0:
select event_id, object_key, object_name 
from MY_EVENT_TABLE where status = 0

The following example, for Oracle databases only, limits the returned event records to the value of the PollQuantity property:

select event_id, object_key, object_name 
from MY_EVENT_TABLE 
where status = 0 and rownum < POLL QUANTITY

The following example runs a stored procedure with two parameters:

CALL MY_EVENT_STORED_PROC (?,?)

The following example runs a stored function with one parameter and one return value:

? = CALL MY_EVENT_FUNCTION(?)
During Bidi transformation, only the string within the quotes after the WHERE clause are converted for query with conditions.

For example, in the query select * from customer where customerid='john', only the string 'john' is converted.For more examples, see the examples under User-defined delete query (CustomDeleteQuery).

Globalized Yes
Bidi supported Yes


User-defined update query (CustomUpdateQuery)

Use this property to specify the SQL statement, stored procedure, or stored function to run after each event is processed so that the same event does not get picked up for processing in the subsequent event cycle.

Custom update query details
Required No
Default No default value
Property type String
Usage Use this property to specify the SQL statement, stored procedure, or stored function to run when the EventQueryType property is set to Dynamic.

During Bidi transformation, only the string within the quotes after the WHERE clause are converted for query with conditions.

For example, in the query select * from customer where customerid='john', only the string 'john' is converted.

Examples See the examples listed in User-defined delete query (CustomDeleteQuery).
Globalized Yes
Bidi supported Yes


User-defined update query for failed event delivery (CustomUpdateQueryForFailedEvent)

Use this property to specify the SQL statement, stored procedure, or stored function to run to update event status when an event is not delivered successfully.

Custom update query for failed event details
Required No
Default No default value
Property type String
Usage Use this property to specify the SQL statement, stored procedure, or stored function to run when the EventQueryType property is set to Dynamic.

If an event is delivered successfully, the property User-defined update query (CustomUpdateQuery) is used to update event status. If an event is not delivered successfully, the property User-defined update query for failed event delivery (CustomUpdateQueryForFailedEvent) is used to update event status.

Examples See the examples listed in User-defined delete query (CustomDeleteQuery).
Globalized Yes
Bidi supported Yes


Data source JNDI name (DataSourceJNDIName)

This property specifies the name of the JNDI data source to use to establish a connection to the database.

Data source JNDI name details
Required No
Default No default value
Property type String
Usage Use this property to specify the JNDI name of a data source in IBM BPM or WebSphere Enterprise Service Bus that specifies connection information for the target database.

To improve the performance of inbound or outbound operations, specify the name of a data source that is enabled for prepared statement caching.

If the UserName and Password properties are also set, they override the user name and password in the data source.

Do not confuse the data source JNDI name property with the JNDI name of a managed connection factory or activation specification on the server. The following list highlights important differences between the types of JNDI names:

  • Data source JNDI name

    • Specifies a connection to a database
    • Is used instead of saving user name and password in adapter properties
    • Is saved as an adapter property

  • JNDI name of the managed connection factory or activation specification

    • Specifies a connection to a managed connection factory or activation specification on the server
    • Is used instead of specifying the value of each managed connection factory or activation specification property in the wizard
    • Is saved as the connection target in the import file

Globalized Yes
Bidi supported No


Database URL (DatabaseURL)

This property specifies the JDBC driver-specific URL for creating a connection to the database.

Database URL details
Required Yes, when the connection is of the type LocalConnectionProps or ConnectionProps.
Default No default value
Property type String
Usage In the external service wizard, compose the database URL by entering in database-specific fields.

For example, the database URL for a DB2 database is composed of the database name, the server host name, and the database port number. In the administrative console, type the complete database URL value.

If your database server supports IPv6, you can specify the host name portion of the database URL in IPv6 format.

If you specify the host name as an IP address in IPv6 format, enclose the IP address in square brackets ( []).

Examples

The following are typical values for common database servers:

DB2 universal (type 4) JDBC driver

jdbc:db2://www.example.com:50000/DB

DB2 universal JDBC driver with an IPv6 address

jdbc:db2://[fe80::20c:29ff:feea:1361%4]:50000/DB

DB2 Universal Database™ type 2 driver for local connection

jdbc:db2:TEST

DB2 Universal Database type 2 driver for remote connection

jdbc:db2://www.example.com:50000/TEST

Oracle V10

jdbc:oracle:thin:@9.26.248.148:1521:dev
Globalized Yes
Bidi supported Yes


Database vendor (DatabaseVendor)

This property specifies the type of database that is used. The type is determined by the database vendor name.

Database vendor details
Required Yes
Possible values

DB2
Informix
MSSQLServer
Oracle
Others

Default No default value
Property type String
Usage

Some SQL statements require special processing, which varies by database type.

For example, the Struct and Array data types in Oracle require special processing. This property specifies the RDBMS that is used, which determines the database type.

For other databases, the adapter does not perform any special processing. Verify that the correct driver is specified in the JDBCDriverClass property.

Globalized No
Bidi supported No


Delivery type (DeliveryType)

This property specifies the order in which events are delivered by the adapter to the export.

Delivery type details
Required No
Possible values

ORDERED
UNORDERED

Default ORDERED
Property type String
Usage The following values are supported:

  • ORDERED: The adapter delivers events to the export one at a time.
  • UNORDERED: The adapter delivers all events to the export at once. If you set to UNORDERED, you must specify multiple connections for the event delivery to allow the adapter to deliver events to the end-point correctly. To specify multiple connections, edit the export file and specify appropriate values for the Minimum connections (MinimumConnections) and Maximum connections (MaximumConnections) properties.

Globalized No
Bidi supported No


Do not process events that have a timestamp in the future (FilterFutureEvents)

This property specifies whether the adapter filters out future events by comparing the timestamp on each event with the system time.

Do not process events that have a timestamp in the future details
Required Yes
Possible values

True
False

Default False
Property type Boolean
Usage

If set to True, the adapter compares the time of each event to the system time. If the event time is later than the system time, the event is not delivered.

If set to False, the adapter delivers all events.

When you are using custom event processing, this property is not supported.

Globalized No
Bidi supported No


Ensure once-only event delivery (AssuredOnceDelivery)

This property specifies whether to provide ensure once-only event delivery for inbound events.

Ensure once-only event delivery details
Required Yes
Possible values

True
False

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 is 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 it is not, no transaction can be used, regardless of the value of this property.

Globalized No
Bidi supported No


Event order by (EventOrderBy)

The order in which events are retrieved and processed.

Event order by details
Required No
Possible values A comma-separated (,) list of column names in the event store, and the order attributes asc and desc
Default event_time, event_priority
Property type String
Usage Specify a comma-separated list of column names from the event store, with the optional attributes for ascending or descending order.
Examples To present events ordered first by time and then by priority, specify:
event_time, event_priority

To present events ordered first by object name in ascending order and then by event time in descending order, specify:

object_name asc, event_time desc
Globalized Yes
Bidi supported Yes


Event query type for processing events (EventQueryType)

This property specifies whether to use standard or custom query processing.

Event query type details
Required Yes
Possible values

Standard
User-Defined(Dynamic)

Default Standard
Property type String
Usage

The valid values are Standard, for standard event processing, and Dynamic, for custom event processing.

If this property is set to User-Defined(Dynamic), the CustomEventQuery, CustomUpdateQuery, CustomUpdateQueryForFailedEvent, and CustomDeleteQuery properties are used. If this property is set to Standard, these properties are ignored.

Globalized No
Bidi supported No


Event table name (EventTableName)

This property specifies the name of the table in the target database that contains the event store, which is used for inbound processing.

Event table name details
Required Yes
Default WBIA_JDBC_EventStore
Property type String
Usage Create the event store before starting to configure the adapter.

For standard event processing, the event is generated by the database through a trigger or other mechanism. For custom query processing, the adapter saves events in the event store as it receives the result of the custom queries.

Globalized Yes
Bidi supported Yes


Event types to process (EventTypeFilter)

This property contains a delimited list of event types that indicates to the adapter which events it should deliver.

Event types to process details
Required No
Possible values

  • ',' - is used to separate different filters, which are compatible with earlier versions.
  • ':' - is used to separate the business object name and the operation name.
  • '|' - is used to separate the different supported values.

Default null
Property type String
Usage Events are filtered by business object names or function/operation filter type. .

If the property is set, the adapter delivers only those events that match the patterns in the list. A value of null indicates that no filter will be applied and that all events will be delivered to the export.

When you are using custom event processing, this property is not supported.

The polling filter does not support iterative mode. If you change operations in the iterative mode, the value must be updated manually and you must maintain consistency between the operations in the filter value and the operations in the operations list of the EMD wizard.

The * sign represents all values and indicates that no filters will be applied.

For example, since , represents the logic operator OR, the value of *:*,BOName1:Create indicates that no filter is applied.

Example

The business name in this filter is the same as the object_name column in the event table, and the operations are Create, Update, and Delete.

For example:

  • To receive events related to the Customer and Order business objects only, specify this value: SchemaNameCustomerBG,SchemaNameOrderBG

  • To receive events related to the Customer business object with only the Create operation, and Order business object with the Create or Delete operation, specify this value: SchemaNameCustomerBG:Create,SchemaNameOrderBG:Create|Delete

Use the real schema name to replace SchemaName.

This property applies only to standard event processing. For custom event processing, the custom event query must perform necessary filtering.

If the EventTypeFilter and AdapterInstanceEvent
Filter 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 connector_ID column matches the AdapterInstanceEvent
Filter property.

Globalized No
Bidi supported No


Retry limit for failed events (FailedEventRetryLimit)

This property specifies the number of times that the adapter attempts to redeliver an event before marking the event as failed.

Retry limit for failed events details
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:

Default

If this property is not set, the adapter tries five additional times before marking the event as failed.

0

The adapter tries to deliver the event an infinite number of times. When the property is set to 0, the event remains in the event store and the event is never marked as failed.

> 0

For integers greater than zero, the adapter retries the specified number of times before marking the event as failed.

< 0

For negative integers, the adapter does not retry failed events.
Globalized No
Bidi supported No


JDBC driver class (JDBCDriverClass)

This property specifies the class name of the JDBC driver used to connect to the database.

JDBC driver class details
Row Explanation
Required Yes, when the connection is of the type LocalConnectionProps or ConnectionProps.
Possible values

Values are database-specific.

Default No default value
Property type String
Usage In the external service wizard, the JDBC driver class is displayed if you select a common database software and driver combination, such as type 4 drivers for recent versions of IBM DB2, Oracle, and Microsoft SQL. For most type 2 drivers for most database software, you must type the database class name.

For example, for the DB2 Universal Database type 2 driver, the class name is COM.ibm.db2.jdbc.app.DB2Driver

In the administrative console, type the database-specific name of the driver.

Examples

Values for the JDBC driver class is displayed in both the external service wizard and the administrative console. The following examples depict the JDBC driver class properties in both the external service wizard and the administrative console. In the external service wizard:

  • To connect to a DB2 database using the universal, or type 4, JDBC driver, select IBM DB2 Universal.

  • To connect to a DB2 database using the DB2 universal type 2 driver, select Other.

  • To connect to an Oracle 10 database using the type 4 driver, select Oracle Thin Driver.


In the administrative console:

DB2 Universal Database type 2 driver

COM.ibm.db2.jdbc.app.DB2Driver

DB2 Universal Database type 4 driver

com.ibm.db2.jcc.DB2Driver

Oracle Thin JDBC driver

oracle.jdbc.driver.OracleDriver

IBM Toolkit for Java™ remote driver for IBM i

com.ibm.as400.access.AS400JDBCDriver

IBM WebSphere Connect JDBC driver for Microsoft SQL Server

com.ibm.websphere.jdbc.sqlserver.SQLServerDriver
Globalized No
Bidi supported No


Maximum connections (MaximumConnections)

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

Maximum connections details
Required No
Default 1
Property type Integer
Usage Only positive values are valid. Any value less than 1 is treated as 1 by the adapter.
Globalized No
Bidi supported No


Minimum connections (MinimumConnections)

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

Minimum connections details
Required No
Default 1
Property type Integer
Usage Only positive values are valid. Any value less than 1 is treated as 1 by the adapter.
Globalized No
Bidi supported No


Password (Password)

This property specifies the password for the database user name.

Password details
Required No. For inbound processing, if you set the Authentication alias or the DataSourceJNDIName, the password is not mandatory. However, if you set the DataSourceJNDIName, and the Password field, the value specified for the Password takes precedence.

For outbound processing, if you set the Authentication alias, XADataSourceJNDIName or PoolDataSourceJNDIName property, the password is not mandatory. However, if you set the XADataSourceJNDIName or PoolDataSourceJNDIName property, and the Password field, the value specified for the Password takes precedence.

Default No default value
Property type String
Usage For inbound processing, setting this property overrides the password specified for the data source on the server using the Authentication alias or DataSourceJNDIName property.

For outbound processing, setting this property overrides the password specified for the data source on the server using the Authentication alias, or XADataSourceJNDIName or PoolDataSourceJNDIName property.

If you specify JAAS as the security credential, the authentication alias will override this property.

Globalized Yes
Bidi supported Yes


SQL query to verify the connection (PingQuery)

This property specifies the SQL query used to test the reliability of the connection to the database.

Ping query details
Required No
Property type String
Default No default value
Usage

This property contains the SQL query statement that you want to run to determine whether the adapter can connect to the database.

For inbound event processing, when the ping query indicates an invalid connection, the adapter throws an exception.

Globalized No
Bidi supported No


Interval between polling periods (PollPeriod)

This property specifies the length of time that the adapter waits between polling periods.

Interval between polling periods details
Required Yes
Possible values Integers greater than or equal to 0.
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage The poll period 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 occurs immediately to make up for the lost time caused by the delay.
Globalized No
Bidi supported No


Maximum events in polling period (PollQuantity)

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

Maximum events in polling period details
Required Yes
Default 10
Property type Integer
Usage The value must be greater than 0. If this value is increased, more events are processed per polling period and the adapter may perform less efficiently. If this value is decreased, fewer events are processed per polling period and the adapter's performance might improve slightly.
Globalized No
Bidi supported No


Query timeout (seconds) (QueryTimeOut)

This property specifies the maximum number of seconds a query can take to run all SQL statements.

Query timeout details
Required No
Default No default value
Unit of measure Seconds
Property type Integer
Usage If the query takes longer than the number of seconds specified, the database returns an SQL exception that is captured. The associated message is logged in the log file.

If a value is not specified, no timeout is set on the query.

Globalized No
Bidi supported No


Time between retries in case of system connection failure (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 reestablish a connection.

Retry interval details
Required Yes
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage Only positive values are valid. 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.
Globalized No
Bidi supported No


Maximum number of retries in case of system connection failure (RetryLimit)

This property specifies the number of times the adapter tries to reestablish an inbound connection.

Maximum number of retries in case of system connection failure
Required No
Possible values 0 and positive integers
Default 0
Property type Integer
Usage

This property controls how many times the adapter retries the connection if the adapter cannot connect to the database to perform inbound processing. A value of 0 indicates an infinite number of retries.

To control whether the adapter retries if it cannot connect to the database when it is first started, use the RetryConnectionOnStartup property.

Globalized No
Bidi supported No


Retry EIS connection on startup (RetryConnectionOnStartup)

This property controls whether the adapter attempts to connect again to the database if it cannot connect at startup.

Retry EIS connection on startup details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage This property indicates whether the adapter should retry the connection to the database if the connection cannot be made when the adapter is started:

  • Set the property to False when you want immediate feedback about whether the adapter can establish a connection to the database, for example, when you are building and testing the application that receives events from the adapter. If the adapter cannot connect, the adapter writes log and trace information and stops. The administrative console.shows the application status as Stopped. After you resolve the connection problem, start the adapter manually.
  • Set the property to True if you do not need immediate feedback about the connection. If the adapter cannot connect during startup, it writes log and trace information, and then attempts to reconnect, using the RetryInterval property to determine how frequently to retry and the value of the RetryLimit property to retry multiple times until that value is reached. The administrative console.shows the application status as Started.

Globalized No
Bidi supported No


Return business object even when the stored procedure result set is empty (ReturnDummyBOForSP)

This property specifies whether to return output parameters when the result set is empty.

Return business object even when the stored procedure result set is empty details
Required No
Possible values

True
False

Default False
Property type Boolean
Usage

The Retrieve Stored Procedure (RetrieveSP) operation returns a result set. If the result set is empty and the ReturnDummyBOForSP property is set to False, no business objects are created, and the output parameters returned by the procedure call cannot be retrieved.

However, if the ReturnDummyBOForSP property is set to True, a dummy business object is created and the returned parameters (including the out and inout parameters) from the stored procedure are populated into the corresponding attributes

Globalized No
Bidi supported No


Stop the adapter when an error is encountered while polling (StopPollingOnError)

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

Stop the adapter when an error is encountered while polling details
Required No
Possible values

True
False

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


Stored procedure to run after polling (SPAfterPoll)

This property specifies the name of the stored procedure or stored function to run after each polling cycle.

Stored procedure to run after poll details
Required No
Default No default value
Property type String
Usage The stored procedure takes one input parameter of type integer for poll quantity, which is set by the adapter at run time. Here is the syntax:
call <spname> (?)

Example: SPAfterPoll>call afterpool(?)</SPAfterPoll>

The stored procedure can also have additional input parameters, and these values must be specified in the call statement itself. Here's the syntax for a stored procedure that has additional input parameters:

call <spname> (25, ?, 'test') 
Globalized Yes
Bidi supported Yes


Stored procedure to run before polling (SPBeforePoll)

This property specifies the name of any stored procedure or stored function to run before the actual poll query is called.

Stored procedure to run before poll details
Required No
Default No default value
Property type String
Usage The stored procedure takes one input parameter of type integer for poll quantity, which is set by the adapter at run time. Here is the syntax:
call <spname> (?)

Example: <SPBeforePoll>call beforepool(?)</SPBeforePoll>

The stored procedure can also have additional input parameters, and these values must be specified in the call statement itself. Here's the syntax for a stored procedure that has additional input parameters:

call <spname> (25, ?, 'test') 
Globalized Yes
Bidi supported Yes


User name (UserName)

This property specifies the database user name used to access the database.

User name details
Required No. For inbound processing, if you set the Authentication alias or the DataSourceJNDIName, the User name property is not mandatory. However, if you set the DataSourceJNDIName, and User name field, the value specified for the User name takes precedence.

For outbound processing, if you set the Authentication alias, XADataSourceJNDIName or PoolDataSourceJNDIName property, the User name is not mandatory. However, if you set the XADataSourceJNDIName or PoolDataSourceJNDIName property, and the User name field, the value specified for the User name takes precedence.

Default No default value
Property type String
Usage For inbound processing setting this property overrides the user name specified for the data source on the server using the DataSourceJNDIName property or the Authentication alias.

For outbound processing, setting this property overrides the user name specified for the data source on the server using the XADataSourceJNDIName property, PoolDataSourceJNDIName property or the Authentication alias.

If you specify JAAS as the security credential, the authentication alias will override this property.

Globalized Yes
Bidi supported Yes


Trim spaces for key-value pair (performTrimOnObjectKeyValue)

This property specifies if the inbound operation has to trim the spaces before and after a key-value pair.

Trim spaces for key-value pair details
Required No.
Possible values

True
False

Default True
Property type Boolean
Usage If you set this property to True, the inbound operation trims the spaces before and after a key-value pair. If you set this property to False, the spaces are not trimmed.
Globalized No
Bidi supported No


Separate key-value pair (nameValuePairDelimiter)

This property specifies the delimiter to separate the key-value pair.

Separate name-value pair details
Required No.
Possible values Any string
Default N/A
Property type String
Usage Delimiter to separate key-value pair.
Example key1=value1;key2=value2;key3=value3 or value1;value2;value3
Globalized No
Bidi supported No


Separate key and value (valueDelimeter)

This property specifies the delimiter to separate the key and value in a key-value pair.

Separate key and value details
Required No.
Possible values Any string
Default =
Property type String
Usage Delimiter to separate the key and value.
Example key1=value1 or value1
Globalized No
Bidi supported No


Unset value (unsetValueKeyWord)

This property represents the unset value in the object_key field.

Unset value key word details
Required No
Possible values JCA_JDBC_UNSET
Default blank
Property type String
Usage If this property is set as not blank, the adapter checks for the value in the object_key field. If a value exists in the object_key field, the adapter treats this field as unset.

For example, if you set this property to “JCA_JDBC_UNSET” and the object_key field value is "1; JCA_JDBC_UNSET;2", during run time, the adapter treats the field corresponding to the value "JCA_JDBC_UNSET" as unset and it does not use that field in the WHERE clause for retrieving the object.

Globalized No
Bidi supported No


Null value (nullValueKeyWord)

This property represents the null value in the object_key field.

Null value key word details
Required No
Possible values JCA_JDBC_NULL
Default blank
Property type String
Usage If this property is set as not blank, the adapter checks for the value in the object_key field. If a value exists in the object_key field , the adapter treats this field as null.

For example, if you set this property to “JCA_JDBC_NULL” and the object_key field value is "1; JCA_JDBC_NULL;2", during run time, the adapter treats the field corresponding to the value "JCA_JDBC_NULL" as null and it sets that field value to ‘is Null' in the WHERE clause when retrieving the object.

Globalized No
Bidi supported No


Database connection information (ConnectionType)

This property specifies how the adapter establishes connection to the database.

Database connection information
Required Yes
Possible values ConnectionProps or DataSourceJNDI
Default ConnectionProps
Property type String
Usage This property specifies how the adapter establishes database connection at run time. This property can have the following values:

  • ConnectionProps - Indicates that the database connection is established using the DatabaseURL and JDBCDriverClass properties.

  • DataSourceJNDI - Indicates that the database connection is established using the DataSourceJNDIName property corresponding to predefined data source.

For a new application, this property is automatically set by external service wizard. For a migrated application, this property is set during the migration process according to the ActivationSpecification properties.

  • If the DataSourceJNDIName property is set, the value of this property is set to DataSourceJNDI.

  • If the DataSourceName is set, the value of this property is set to ConnectionProps.

If this property is not set, adapter uses backward compatibility mode to establish database connection. In backward compatibility mode, the properties for connecting to the database are used in the following order:

  1. If the DataSourceJNDIName property is set, the adapter uses it to establish the connection to the database.

  2. If the DataSourceJNDIName is not set, then the adapter uses the DatabaseURL, JDBCDriverClass, UserName and Password properties to establish the connection.
Globalized No
Bidi supported No


Timeout period for HA Active-Active event processing (seconds)

Specifies the time interval, in seconds, for processing the HA Active-Active events. The unprocessed events at the end of the time interval are reprocessed as new events.

Timeout period for HA Active-Active event processing (in seconds) property characteristics
Required Yes
Default 300
Unit of measure Seconds
Property type Integer
Usage

This property is used for specifying the time interval, in seconds, for the adapter to process the polled events. For some reason, in the cluster environment, if an activated adapter instance fails to process all the polled events during the specified time interval, for example if the node in the cluster crashes, the unprocessed events will be restored as new events by the other activated adapter instance.

You can use this property if the High Availability Active-Active configuration is enabled. To enable inbound High Availability Active-Active mode, set Enable High Availability support (enableHASupport) to false. See WebSphere Adapters in clustered environments.

Globalized No
Bidi supported No

Inbound configuration properties


Related concepts:

High Availability Active-Active support

Event store

WebSphere Adapters in clustered environments


Related tasks:

Setting global properties for operations and creating wrapper business objects

Setting deployment properties and generating the service