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 > Siebel Business Applications > Reference > Inbound configuration properties
Activation specification properties
Activation specification properties hold the inbound event processing configuration information for a message endpoint. You can set the activation specification properties either through the external service wizard or the Process Administrative Console.
Activation specification properties are used during the endpoint activation to notify the adapter of eligible event listeners. During inbound processing, the adapter uses these event listeners to receive the events before forwarding them to the endpoint.
The following table lists the activation specification properties for inbound communication. You set the activation specification properties in the external service wizard and can change them in the Integration Designer Assembly Editor, or after deployment through the Process Administrative Console. A more detailed 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 Property name Description In the wizard In the administrative console Connection URL connectString The connection URL to connect to the Siebel application. Code page (codePage) codePage Specifies the code page that the adapter uses to connect to Siebel server. Delivery type DeliveryType
Determines the order in which events are delivered by the adapter to the export.
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 component name eventComponentName The name of the Siebel component for the event table. Event types to process EventTypeFilter
A delimited list of event types that indicates to the adapter which events it should deliver. If the value of the property is blank or set to "*", all event types are included. In addition, the property supports filtering at the operations level.
Include empty elements in the output includeEmptyField Specifies if the empty elements are included in the response business object. Interval between polling periods PollPeriod
The length of time that the adapter waits between polling periods.
Language code languageCode The language code used to log on to the Siebel Business Applications server. Maximum connections MaximumConnections
The maximum number of connections that the adapter can use for inbound event delivery.
Maximum events in polling period PollQuantity
The number of events the adapter delivers to the export during each poll period.
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 the corresponding user name. Retry limit for failed events FailedEventRetryLimit The number of times the adapter attempts to redeliver an event before marking the event as failed. Retry EIS connection on startup RetryConnectionOnStartup Controls whether the adapter retries the connection to the Siebel application 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.
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.
User name userName The user name used to log in to the Siebel application. Adapter Instance for event filtering (AdapterInstanceEventFilter) AdapterInstanceEvent
FilterIdentifier that determines whether this adapter instance processes specific events in the event store.
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 Siebel eBusiness Applications to WebSphere Adapter for Siebel Business Applications. WebSphere Business Integration Adapter for Siebel eBusiness Applications 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 Siebel Business Applications 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 Siebel eBusiness Applications.To use this feature, the database triggers or other mechanisms that create events in the event store must assign the appropriate value to the ConnectorId column.
Table 3.shows the interaction between the AdapterInstanceEvent
Filter property and the value in the ConnectorId column in the event store.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 ConnectorId column matches the AdapterInstanceEvent
Filter property.Example See Table 3. Globalized Yes Bidi supported Yes
Interaction of the AdapterInstanceEvent
Filter property with the ConnectorId column in the event storeAdapterInstanceEvent
Filter propertyConnectorId column of an event Result null null The adapter processes the event. null Instance1 The adapter processes the event, because the ConnectorId 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.
Connection URL (ConnectionURL)
This property specifies the connection URL to connect to the Siebel application.
Connection URL details Required Yes Default No default value Property type String Usage Protocol://machinename:port/enterprisename/object manager/server name.
- For Siebel 7.0.5 to 7.5x: siebel://<IP ADDRESS>/siebel/SSEObjMgr_ENU/sebldev1.
- For Siebel 7.8: siebel://<IP ADDRESS>:2321/Sieb78/SSEObjMgr_enu.
- For Siebel 8: siebel://<IP ADDRESS>:2321/SBA_80/SSEObjMgr_enu. The default port number is 2320.
In the examples provided (for Siebel versions 7.8 and 8), another port (2321) has been specified.
Globalized Yes Bidi supported Yes
Code page (codePage)
Specifies the code page that the adapter uses to connect to Siebel server.
Code page details Required No Default No default value Property type String Usage The Siebel Java™ Data Bean supports a limited list of code page settings. If the current code page setting of your run time is not supported, the adapter may not be able to connect to the Siebel server.
This property allows the users to specify the code page details that the adapter uses to connect to Siebel server.
The adapter uses the code page property to change the “file.encoding” property of the current Java Virtual Machine (JVM), when it establishes its first connection to the Siebel server. This may affect other applications which run on the same JVM. You need to ensure that the code page has a valid value for all applications.
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 the value of DeliveryType is UNORDERED, then Minimum connections (MinimumConnections) and Maximum connections (MaximumConnections) must be greater than 1. Otherwise, event delivery will not work correctly. As an example, you can set Minimum connections as 2 and Maximum connections as 4.
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 component name (EventComponentName)
This property specifies the name of the event store where events are stored for inbound processing.
Event component name details Required Yes Default
- For Siebel version 7.x: IBM2
- for Siebel version 8 : IBM Event
Property type String Usage If you select one of the default values to configure the event business component on the Siebel Business Applications server, it is the name of the Siebel event business component that was created. You can also select a value from the list of values provided by the adapter. The list of values can be edited. If you create your own Siebel event business component, you can edit the list to include the name of that event business component.
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 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 indicates that no filter will be applied and that all events will be delivered to the export.
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 all events of the Customer and Order business objects, specify one of these values: Customer:Create|Update|Delete,Order:Create|Update|Delete or Customer,Order.
- 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.
Only operations chosen for the business objects and services (see Selecting business objects) in the external service wizard can be used in this property. Otherwise, the events of those operations are not delivered properly during run time.
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 ConnectorId 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
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
Include empty elements in the output (includeEmptyField)
Specifies if the adapter returns the elements that have an empty string value in the response business object.
Include empty elements in the output details Required No Possible values True
FalseDefault False Property type Boolean Usage This property enables you to include the empty elements in the output. When this property is selected, the adapter returns the elements that have empty string values in the response business object. Globalized No Bidi supported No
Language code (LanguageCode)
This property specifies the language code used to log on to the Siebel Business Applications server.
Language code details Required Yes Default ENU Property type String Usage If the system locale is English, the value for this property is ENU (English). This value is used to log on to the Siebel Business Applications 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.
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
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
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
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 Siebel application 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 Siebel application when it is first started, use the RetryConnectionOnStartup property.
Globalized No Bidi supported No
Password (Password)
This property specifies the password for the corresponding user name.
Password details Required Yes Default No default value Property type String Usage The restrictions (case, length, and character) are determined by the version of Siebel application. If a J2C Authentication Alias is used, then you need not set the password. Example sadmin Globalized Yes Bidi supported Yes
Retry EIS connection on startup (retryConnectionOn
Startup)This property controls whether the adapter attempts to connect again to the Siebel application 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 Siebel application 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 Siebel application, 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 60000 (1 minute) Unit of measure Milliseconds Property type Integer Usage If this value is non-negative and the adapter encounters an error related to the inbound connection to the Siebel application, the adapter continues to attempt a connection after the specified interval until a connection is established. Globalized No 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.
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 used to log in to the Siebel application.
User name details Required Yes Default No default value Property type String Usage The restrictions (case, length, and character) are determined by the version of Siebel application. If a J2C Authentication Alias is used, then you need not set the user name.
Globalized Yes Bidi supported Yes
Inbound configuration properties
Related reference: