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 > IBM i > Reference > Configuration properties > Inbound configuration properties
Activation specification properties
Activation specification properties hold the inbound event processing configuration information for an export.
You set activation specification properties using the external service wizard during adapter configuration and change them before deployment through the Integration Designer assembly editor or after deployment through the IBM BPM or WebSphere Enterprise Service Bus administrative console.
The following table summarizes 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 Adapter for IBM i Property name Description In the wizard In the administrative console Business object namespace BusinessObjectNameSpace The namespace for the business object definitions 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.
Interval between polling periods PollPeriod
The length of time that the adapter waits between polling periods.
Failed event archiving control language program path FailedEventArchivingControl LanguageProgramPath The path to the control language program on the IBM i system that will be used to move failed events at run time Failed events queue path FailedEventsQueuePath Path to the data queue on the IBM i system where failed events will be archived 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 IBM i system
Poll quantity PollQuantity
The number of events the adapter delivers to the export during each poll period.
Retry EIS connection on startup RetryConnectionOnStartup Controls whether the adapter retries the connection to the IBM i system 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.
Event types to process EventTypeFilter This property is not applicable for WebSphere Adapter for IBM i. Retry limit for failed events FailedEventRetryLimit The number of times the adapter attempts to redeliver an event before marking the event as failed. 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.
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 Polling queue PollingQueue The absolute path to the queue in the IBM i server Host name HostName The fully qualified host name or IP address of the host where the server is running Object type ObjectType Determines the object type that the adapter will poll Key for keyed data queue KeyForKeyedDataQueue Fetches message from the keyed data queue (polling queue) Payload staging queue path (PayloadStagingQueuePath) PayloadStagingQueuePath Specifies the absolute path of the queue used to store the message fetched from the poll queue for persistence Polling control language program path (PollingControlLanguageProgramPath) PollingControlLanguageProgramPath Specifies an absolute path of the control language program that is used by the adapter to move the messages from the poll queue to the staging queue Database schema name EP_SchemaName The schema name for the database used by the adapter's event persistence feature Event recovery data source (JNDI) name EP_DataSource_JNDIName EP_DataSource_JNDIName Event recovery table name EP_TableName The name of the event store used by the adapter User name used to connect to event data source EP_UserName The user name used by the adapter's assured-once delivery feature. Password used to connect to event data source EP_Password The password used by the adapter's event persistence feature. It is used to acquire the JDBC database connection from the data source configured in the server.
Business object namespace (BusinessObjectNameSpace)
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/ibmi 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/ibmi/Schema1Customer
Bidi supported No
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 user name and password properties are also set, they override the user name and password in the data source.
The properties for connecting to the database are used in the following order:
- If the DataSourceJNDIName property is set, the adapter uses it to establish the connection to the database.
If the UserName and Password properties are also set, they override the user name and password set on the data source.
- If the DataSourceJNDIName property is not set, the adapter uses the XADataSourceName and XADatabaseName properties, if set, to establish the connection.
The DataSourceJNDIName property represents an XA or connection pool data source. If you define a JNDI data source on the server that supports XA transactions and then specify that data source when you configure the adapter, you can connect to any type of database that supports XA transactions. If you use an XA data source and database, the adapter supports XA transaction only for DB2 and Oracle databases.
- If the DataSourceJNDIName, XADataSourceName, and XADatabaseName properties are not set, then the adapter uses the DatabaseURL, JDBCDriverClass, UserName and Password properties to establish the connection.
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
- Used instead of saving user name and password in adapter properties
- 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
- Used instead of specifying the value of each managed connection factory or activation specification property in the wizard
- Saved as the connection target in the import file
Globalized Yes 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.
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
FalseDefault 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.
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
FalseDefault 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 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 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
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
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 IBM i system user name.
Password details Required Yes Default No default value Property type String Usage The password for the IBM i system user name. Typing an incorrect password will prevent the adapter from accessing the IBM i system. 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
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 IBM i system 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 IBM i system 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 IBM i system if it cannot connect at startup.
Retry EIS connection on startup details Required No Possible values True
FalseDefault False Property type Boolean Usage This property indicates whether the adapter should retry the connection to the IBM i system 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 IBM i system, 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
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
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
FalseDefault 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
User name (UserName)
This property specifies the user name for connecting to the IBM i system.
User name details Required Yes Default No default value Property type String Usage The user name for connecting to the IBM i system. Typing an incorrect user name will prevent the adapter from accessing the IBM i system. Globalized No Bidi supported No
Polling queue
This property specifies the absolute path to the queue in the IBM i system.
Polling queue details Required Yes Default No default value Property type String Usage Must be a valid string value Globalized No Bidi supported No
Host name (HostName)
This property specifies the IP address or fully qualified name of the host where the IBM i system is running.
Host name details Required Yes Default No default value Property type String Usage Must be a valid server name Example user.us.ibm.com Globalized No Bidi supported No
Object type (ObjectType)
This property determines the object type that the adapter polls.
Object type details Required No Default No default value Property type String Usage Must be either a simple last-in first-out (LIFO) or first-in first-out (FIFO) data queue or a keyed data queue Globalized No Bidi supported No
Key value (KeyValue)
This property fetches message from the keyed data queue (polling queue).
Key value details Required No Default No default value Property type String Usage Must be a valid string value
Globalized No Bidi supported Yes
Payload staging queue path (PayloadStagingQueuePath)
This property specifies the absolute path of the queue used to store the message fetched from the poll queue for persistence.
Payload staging queue path details Required Yes Default NoneNo default value Property type String Usage Must be a valid string value. The payload staging queue is a keyed data queue that stores messages read from the polled queue. Globalized No Bidi supported No
Event recovery data source (JNDI) name property (EP_DataSource_JNDIName)
This property specifies the JNDI name of the data source that will be used by the event persistence class to acquire the JDBC database connection.
Event recovery data source (JNDI) name details Required Yes, if the AssuredOnceDelivery property is set to True Default No default value Property type String Usage This value is case-sensitive. The external service wizard does not create the data source on IBM BPM or WebSphere Enterprise Service Bus. Verify that the data source is defined on the server before deploying the adapter.
Globalized Yes Bidi supported Yes
Event recovery table name property (EP_TableName)
This property specifies the name of the event store that will be used by the adapter for event persistence.
Event recovery table name details Required Yes, if the AssuredOnceDelivery property is set to True Default Property type String Usage The value specified for this property must be unique for each adapter instance and cannot be used by another instance. This value is not case-sensitive. Globalized Yes Bidi supported Yes
Database schema name (EP_SchemaName)
This property specifies the schema name for the database used by the adapter's assured-once delivery feature.
Database schema name details Required No Default No default value Property type String Usage Specifies the schema name for the database used by the adapter's assured-once delivery feature. This value is not case-sensitive. Globalized Yes Bidi supported Yes
Auto create event table property (EP_CreateTable)
This property specifies whether the adapter should create an event store if it detects one does not exist.
Automatically create event table details Required No Possible values True
FalseDefault True Property type Boolean Usage If set to True, the adapter creates an event store if it detects that one does not exist.
If set to False, the adapter does not create an event store even if one does not exist. Verify that an event store exists if you want to ensure the delivery of events.
Globalized No Bidi supported No
Password used to connect to event data source property (EP_Password)
This property specifies the password used by the adapter's assured-once delivery feature.
Password used to connect to event data source details Required Yes, if the AssuredOnceDelivery property is set to True Default No default value Property type String Usage Specify the password that the adapter uses to connect to the event store. This value is case-sensitive. Globalized Yes Bidi supported Yes
User name used to connect to event data source property (EP_UserName)
This property specifies the user name used by the adapter's event assured-once delivery feature.
User name used to connect to event data source details Required Yes, if you want assured-once delivery Default No default value Property type String Usage Specify the user name that the adapter uses to connect to the event store. Globalized Yes Bidi supported Yes
Failed events queue path (FailedEventsQueuePath)
This property specifies the path to the data queue on the IBM i system where failed events will be archived. Ensure that the failed events data queue is available on the IBM i system at run time.
Failed events queue path details Required Yes Default NoneNo default value Property type String Usage Must be a valid string value Globalized No Bidi supported No
Failed event archiving control language program path (FailedEventArchivingControlLanguageProgramPath)
This property specifies the path to the control language program on the IBM i system that will be used to move failed events at run time. Ensure that the control language program is available on the IBM i system at run time.
Failed event archiving control language program path details Required Yes Default NoneNo default value Property type String Usage Must be a valid string value Globalized No Bidi supported No
Polling control language program path (PollingControlLanguageProgramPath)
This property specifies an absolute path of the control language program that the adapter uses to move the messages from the poll quantity to the staging queue.
Polling control language program path details Required Yes Default NoneNo default value Property type String Usage The adapter moves poll quantity events at a time. As the staging queue is a keyed queue, the control language program also generates the unique key to write to the keyed data queue. In this way, the adapter assigns a unique identification number to each message it polled. Globalized No Bidi supported No