Inbound adapter properties for Siebel

Inbound adapter properties hold the configuration information for inbound event processing of a message endpoint. These properties also control the general operation of the adapter. Use the Adapter Connection wizard to set these properties.

These properties are used during endpoint activation to notify the adapter of eligible event listeners. During inbound processing, the adapter uses these event listeners to receive events before it forwards them to the endpoint.

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	Description
Adapter ID property	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.
Code page (codePage)	The code page that the adapter uses to connect to the Siebel server
Connection URL	The connection URL that is needed to connect to the Siebel application
Delivery type	Determines the order in which events are delivered by the adapter to the export component.
Do not process events that have a timestamp in the future	Specifies whether the adapter filters out future events by comparing the timestamp on each event with the system time
Ensure once-only event delivery	Specifies whether the adapter provides assured once-only delivery of events.
Event component name	The name of the Siebel component for the event table
Event delimiter	Specifies whether the delimiter that is used between two name value pairs contains the object key name and value
Event types to process	A delimited list of event types that indicates to the adapter which events it should deliver
Include empty elements in the output	Specifies if the empty elements are included in the response business object
Interval between polling periods	The length of time that the adapter waits between polling periods.
Language code	The language code that is used to log on to the Siebel server
Maximum connections	The maximum number of connections that the adapter can use for inbound event delivery.
Maximum events in polling period	The number of events that the adapter delivers to the export component during each poll period.
Minimum connections	The minimum number of connections that the adapter can use for inbound event delivery.
Password	The password for the corresponding user name
Resonate support	Specifies that if resonate support is installed on the Siebel server, and the value is set to `True`, the adapter takes advantage of the load balancing feature to connect to the Siebel server more efficiently
Retry EIS connection on startup	Controls whether the adapter retries the connection to the Siebel server if it cannot connect at startup.
Retry limit for failed events	The number of times the adapter attempts to redeliver an event before marking the event as failed.
Siebel server view mode	Specifies the Siebel view mode and controls the kind of data to be retrieved and what actions can be performed
Stop the adapter when an error is encountered while polling	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.
User name	The user name that is used to log on to the Siebel application

Adapter ID to use for logging and tracing (AdapterID)

This property identifies a specific deployment, or instance, of the adapter.

Table 2. Adapter ID to use for logging and tracing details
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, SEBLRA, 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 SEBLRA001. 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 JD Edwards EnterpriseOne to 001 and 002. The component IDs for those instances, SEBLRA001 and SEBLRA002, 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 SEBLRAInstance. 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)

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

Table 3. 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 Business Applications to WebSphere Adapter for Siebel Business Applications . You can use the WebSphere Business Integration Adapter for Siebel Business Applications to manage 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 WebSphere Business Integration Adatper customers to JCA for customers who are currently taking advantage of the connector ID filtering. WebSphere Business Integration 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 AdapterInstanceEventFilter property corresponds to the Connector ID property of the WebSphere Business Integration Adapter for Siebel Business 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 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. This property applies only to standard event processing. For custom event processing, the custom event query must perform necessary filtering. 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. Note: When you are using custom event processing, this property is not supported.
Example	See the example in the following table.
Globalized	Yes
Bidi supported	Yes

Table 4. Interaction of the AdapterInstanceEventFilter property with the Connector ID column in the event store
AdapterInstanceEventFilter property	Connector ID	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.

Code page (codePage)

Specifies the code page that the adapters uses to connect to the Siebel server.

Table 5. Connection URL details
Required	No
Default	No default value
Property type	String
Usage	Use this property to specify the code page details that the adapter uses to connect to the Siebel server. The Siebel Java™(tm) 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 might not be able to connect to the Siebel server. The adapter uses the code page property to change the `file.encoding` property of the current Java(tm) Virtual Machine (JVM), when it establishes its first connection to the Siebel server. This change can affect other applications that run on the same JVM. Ensure that the code page has a valid value for all applications.
Globalized	No
Bidi supported	No

Connection URL (ConnectionURL)

This property specifies the connection URL that is needed to connect to the Siebel application.

Table 6. 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 above (for Siebel versions 7.8 and 8), another port (2321) has been specified.
Globalized	Yes
Bidi supported	Yes

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

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 8. 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

Ensure once-only event delivery (AssuredOnceDelivery)

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

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

Event component name (EventComponentName)

This property specifies the name of the event store where events are stored for inbound processing.

Table 10. Event component name details
Required	Yes
Default	`IBM2` (for Siebel version 7.x) and `IBM Event` (for Siebel version 8)
Property type	String
Usage	The default value is `IBM2` for Siebel version 7.x, and `IBM Event` for Siebel version 8. If you select one of these default values to configure the event business component on the Siebel 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. You can edit the list of values. 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 delimiter (EventDelimiter)

This property indicates that the delimiter that is used between two name value pairs contains the object key name and value.

Table 11. Event delimiter details
Required	Yes
Default	;
Property type	String
Usage	If multiple value pairs are set against the object key in the event component, they are used for the delimiter.
Globalized	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 12. 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 component. 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` Note: Only operations chosen for the business objects and services in the Adapter Connection wizard can be used in this property. Otherwise, the events of those operations are not delivered properly at run time. 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

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.

Table 13. Include empty elements in the output details
Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	Use this property to include 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

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

Language code (LanguageCode)

This property specifies the language code that is used to log on to the Siebel server.

Table 15. 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), which is used to log on to the Siebel 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 16. 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

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

Minimum connections (MinimumConnections)

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

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

Password (Password)

This property specifies the password for the corresponding user name.

Table 19. Password details
Required	Yes
Default	No default value
Property type	String
Usage	This property displays after you click Advanced on the connection properties pane of the Adapter Connection wizard. The password is saved in .import and .export files so that the adapter can connect to the Siebel application after it has been deployed. If a J2C Authentication Alias is used, a password is not required.
Example	`sadmin`
Globalized	Yes
Bidi supported	Yes

Resonate support (ResonateSupport)

This property indicates whether the Siebel server uses resonate support.

Table 20. Resonate support details
Required	No
Possible values	`True` `False`
Default	`True`
Property type	Boolean
Usage	If you set this property to `True`, the adapter takes advantage of the load balancing feature to connect to the Siebel server more efficiently.
Globalized	No

Retry EIS connection on startup (RetryConnectionOnStartup)

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

Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	This property indicates whether the adapter should retry the connection to the Siebel server 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 server; 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. 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, then attempts to reconnect by using the RetryInterval property to determine how frequently to retry, and the RetryLimit property to retry multiple times until that value is reached.
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.

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

Siebel server view mode (SiebelServerViewMode)

This property specifies the Siebel view mode and controls the data that can be retrieved and what actions can be performed on it.

Table 21. View mode details
Required	Yes
Default	`3`
Property type	Integer
Usage	The View mode property applies only to Siebel business objects and not to Siebel business services.
Globalized	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 22. 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 23. 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

User name (UserName)

This property specifies the user name that is used to log into the Siebel application.

Table 24. User name details
Required	Yes
Default	No default value
Property type	String
Usage	This property displays after you click Advanced on the connection properties pane of the Adapter Connection wizard. The user name is saved in .import and .export files so that the adapter can connect to the Siebel application after it has been deployed. If a J2C Authentication Alias is used, a password is not required.
Globalized	Yes
Bidi supported	Yes