IBM Integration Bus, Version 10.0.0.2 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Inbound adapter properties for PeopleSoft

Inbound adapter properties hold the configuration information for inbound event processing of an export component. These properties also control the general operation of the adapter, such as specifying the namespace for business objects. Use the Adapter Connection wizard to set these properties.

The following table lists the properties for inbound processing that you set by using the Adapter Connection wizard. A more detailed description of each property is provided in the sections that follow the table.
Table 1. Inbound adapter properties
Property name Purpose
Adapter ID to use for logging and tracing (AdapterID) The name of the adapter instance in the log and trace files.
Adapter instance for event filtering (AdapterInstanceEventFilter) Identifier that determines whether this adapter instance processes specific events in the event store.

Ensure once-only event delivery (AssuredOnceDelivery)

Specifies whether the adapter provides assured once-only delivery of events.

Component interface for testing failed connections (PingCompIntfc) The component interface that the adapter uses to validate a connection to the PeopleSoft Enterprise server
Component interface name for event notification (EventCIName) The component interface that the adapter uses for event notification

Delivery type (DeliveryType)

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

Delimiter for keys in the event store (EventKeyDelimiter) The name and value for an object key in the event table
Do not process events that have a timestamp in the future (FilterFutreEvents)

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

Event types to process (EventTypeFilter)

A delimited list of event types that indicates to the adapter which events it should deliver

Java™ date format for event timestamp (DateFormat) The format that is used to create the event timestamp

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.

Time between polling for events (PollPeriod)

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

Maximum number of events collected during each poll (PollQuantity)

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

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.

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

The length of time that the adapter waits between attempts to establish a new connection after an error occurs during inbound operations.

Adapter ID to use for logging and tracing (AdapterID)

Required Yes
Default 001
Property type String
Usage This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, PSOFTRA, to form the component name used by the Log and Trace Analyzer tool. For example, if the adapter ID property is set to 001, the component ID is PSOFTRA001.

If you run multiple instances of the same adapter, ensure that the first eight characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter.

For example, when you set the adapter ID property of two instances of WebSphere® Adapter for PeopleSoft Enterprise to 001 and 002. The component IDs for those instances, PSOFTRA001 and PSOFTRA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to PSOFTRAInstance.

For inbound processing, this property is retrieved from the resource adapter properties. For outbound processing, it is retrieved from the managed connection factory properties.

Globalized Yes
Bidi supported No

Adapter Instance for event filtering (AdapterInstanceEventFilter) (AdapterInstanceEventFilter)

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

Table 2. Adapter Instance for event filtering (AdapterInstanceEventFilter) details
Required No
Default null
Property type String
Usage This property helps you migrate from WebSphere Business Integration Adapter for PeopleSoft to WebSphere Adapter for PeopleSoft Enterprise. WebSphere Business Integration Adapter for PeopleSoft 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 PeopleSoft Enterprise 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 PeopleSoft.

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.

To use this feature, the PeopleCode that create events in the event store must assign the appropriate value to the Connector ID column.

The example in the following table shows the interaction between the AdapterInstanceEventFilter property and the value in the Connector ID 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 Connector ID column matches the AdapterInstanceEventFilter property.

Example See the example in the following table.
Globalized Yes
Bidi supported Yes
Table 3. Interaction of the AdapterInstanceEventFilter property with the Connector ID column in the event store
AdapterInstanceEventFilter 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.

Ensure once-only event delivery (AssuredOnceDelivery)

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

Table 4. 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-only event delivery so that each event is delivered 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

Component interface for testing failed connection (PingCompInterface)

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

Table 5. Component interface for testing failed connection details
Row Explanation
Required Yes
Default The name of the first component interface in the list
Property type String
Usage The name of the component interface that the adapter uses to test connectivity to the PeopleSoft Enterprise server. Specify a component interface name that already exists in your PeopleSoft Enterprise applications.
Globalized No
Bidi supported No

Component interface name for event notification (EventCIName)

This property specifies the name of the PeopleSoft Enterprise component interface that the adapter uses to for inbound processing.

Table 6. Component interface name for event notification details
Row Explanation
Required Yes
Default IBM_EVENT_CI
Property type String
Usage The name of the component interface that the adapter uses for inbound processing. To use inbound processing, create a component interface specifically for event notification in PeopleSoft Enterprise.
Globalized No
Bidi supported No

Delivery type (DeliveryType)

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

Table 7. 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 component one at a time.
  • UNORDERED: The adapter delivers all events to the export component at once.

If you set this property to UNORDERED, the properties Minimum connections and Maximum connections must be greater than 1.

Globalized No
Bidi supported No

Delimiter for keys in the event store (EventKeyDelimiter)

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

Table 8. Delimiter for keys in the event store details
Row Explanation
Required No
Default =:
Property type String
Usage Use this property to specify an object name and value to be used as an object key in the event store.
Example CustomerID=2001
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.

Table 9. 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.

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.

Table 10. Event types to process details
Required No
Possible values A comma-delimited (,) list of business object types and operations
Default null
Property type String
Usage Events are filtered by business object type and operations. If the property is set, the adapter delivers only those events that are in the list. A value of null or * indicates that no filter will be applied and that all events will be delivered to the export component.

When the default operation set (Create/Update/Delete) is not preferred, the adapter provides an operation-based event polling capability.

For example, if you select Create|Update operation, the adapter polls only those events with Create or Update operation for all the business objects. The default string generated for eventTypeFilter is *: Create|Update.

Syntax: BOName:Operation1|Operation2, BOName:Operation1|Operation2|Operation3
  • "," is used for separating the business objects. The objects that are not in this list are ignored.
  • ":" is used for separating the business object name and the operation name.
  • "|" is used for separating the supported operations, such as Create, Delete, and Update.
Example
  • To receive events related to the Customer and Order business objects regardless of operations, specify this value: Customer,Order or specify this value for all supported operations: Customer:Create|Update|Delete,Order:Create|Update|Delete.
  • To receive all events of the Customer business object and the Create and Delete events of the Order business object, specify this value: Customer,Order:Create|Delete
  • To receive the Create and Delete events of all the business objects, specify this value: *:Create|Delete.
Note: In this property, you can use only those operations that are chosen while selecting business objects and services.

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 Connector ID column matches the AdapterInstanceEventFilter property.

Globalized No
Bidi supported No

Java date format for event timestamp (DateFormat)

This property specifies the format that is used for the event timestamp.

Table 11. Java date format for event timestamp details
Row Explanation
Required Yes
Default MM/dd/yy
Property type String
Usage This property is used to format the date values from the PeopleSoft Enterprise server.
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.

Table 12. Maximum connections details
Required No
Default 1
Property type Integer
Usage Only positive values are valid. The adapter considers any positive entry less than 1 to be equal to 1. Typing a negative value or 0 for this property might result in runtime errors.
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.

Table 13. 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. Typing a negative value or 0 for this property might result in runtime errors.
Globalized No
Bidi supported No

Interval between polling periods (PollPeriod)

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

Table 14. 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 that was 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 component during each poll period.

Table 15. 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 might 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

Number of times to retry the system connection (RetryLimit)

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

Table 16. Number of times to retry the system connection details
Required No
Possible values Positive integers
Default 0
Property type Integer
Usage Only positive values are valid.

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

Globalized Yes
Bidi supported No

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

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

Table 17. 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

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

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

Table 18. Retry interval details
Required Yes
Default

60000 (1 minute)

Unit of measure Milliseconds
Property type Integer
Usage Only positive values are valid. When the adapter encounters an error that is related to the inbound connection, this property specifies the length of time that the adapter waits before trying to establish a new connection.
Globalized No
Bidi supported No

rbp_peo_inbound_props_wmb.htm | Last updated 2015-09-24 12:54:55