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 > Lotus Domino > Reference > Configuration properties > Inbound configuration properties

Activation specification properties

Activation specification properties are properties that hold the inbound event processing configuration information for a message endpoint.

Activation specification 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 forwarding them to the endpoint (a message driven bean).

You set the activation specification properties using the external service wizard and can change them using the IBM Integration Designer Assembly Editor, or after deployment through the Process Administrative Console.

The following table lists 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 details tables in the sections that follow, see Guide to understanding property details.

Activation specification properties
Property name Description
In the wizard In the administrative console
Event groups to filter (AdapterInstanceEventFilter) adapterInstanceEventFilter Controls whether this adapter instance processes specific event groups in the event store.
Ensure once-only event delivery (AssuredOnceDelivery) assuredOnceDelivery

Specifies whether the adapter provides assured once delivery of events.

Delivery type deliveryType

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

Event type filter 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.
Host name hostName Specifies the name or address of the server that hosts Domino.
Interval between polling periods

PollPeriod

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

Maximum events in polling period (PollQuantity)

PollQuantity

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

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 Specifies the password of the user account of the adapter in the Lotus Domino server.
DIIOP port number portNumber Specifies the port number that the adapter uses to access the Lotus Domino server.
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.

Retry EIS connection on startup RetryConnectionOnStartup

Controls whether the adapter retries the connection to the Lotus Domino server if it cannot connect at startup.

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 Specifies the name of the user account of the adapter in the Lotus Domino server.


Event groups to filter (AdapterInstanceEventFilter)

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

AdapterInstanceEventFilter
Required No
Default No default value
Property type String
Usage You can use this property to filter the events during event processing by the adapter. Using this property, you can set the event filtering only to the event groups that you have subscribed. This property helps 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.

The AdapterInstanceEvent
Filter property corresponds to the ConnectorId column of the event table. Therefore, when you specify this property, the adapter filters the event groups based on your subscription.

  • All events are filtered when there is no value in the AdapterInstanceEvent
    Filter property even when the value is set in the ConnectorId column of the event table.
  • 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 Domino001
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


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
ORDEREDBYKEY

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.
  • ORDEREDBYKEY: The adapter delivers all events simultaneously except for the matching event keys. The events with matching keys are delivered to the export one at a time.

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 must deliver.

Event types to process details
Required No
Possible values

A comma-delimited (,) list of business object types that can accept any one of the following values.

  • EventTypeFilter=dbpath
  • EventTypeFilter=dbpath:form
  • EventTypeFilter=dbpath1:form1,dbpath2:form2
  • EventTypeFilter=dbpath1:form1:Operation1|Operation2,dbpath2:form2:Operation2|Operation3

Default All selected objects
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 is applied and that all events are delivered to the endpoint.

The adapter delivers all the events automatically only when running the external service wizard. When modifying the artifacts through iterative development, ensure that you manually add the new events in the Event type filter field. The default value with no operations shown means that all supported operations are filtered by the adapter.

The following parameters show the usage format for the Event type filter field.

DBName:FormName:Operation1|Operation2, DBName:FormName:Operation1|Operation2|Operation3

  • The comma (,) is used for separating the business objects. The adapter ignores objects that are excluded from this list.

  • The colon (:) is used for separating the database, business object, and the operation names.

  • The vertical bar (|) is used for separating the supported operations (such as Create, Delete, and Update).

Example mail1/report.nsf:newReport:Create|Delete,mail/sample.nsf:newSample:Update
Globalized No
Bidi supported Yes


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


Host name

This property specifies the name or address of the server that hosts Domino.

Host name details
Required Yes
Default No default value
Property type String
Usage Identifies the server, either by name or IP address, that hosts Domino.
Example 9.26.159.264
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 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


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 Lotus Domino server 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 Lotus Domino server when it is first started, use the RetryConnectionOnStartup property.

Globalized No
Bidi supported No


Password

This property specifies the password of the user account of the adapter in the Lotus Domino server.

Password details
Required No
Default No default value
Property type String
Usage The restrictions (case, length, and character) are determined based on the version of Domino.
Globalized No
Bidi supported Yes


DIIOP port number

This property specifies the port number the adapter uses to access the Lotus Domino server.

Port number details
Required Yes
Default 63148
Property type Integer
Usage The port number is required when you use the external service wizard to discover objects and services.
Example 9000
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


Retry EIS connection on startup (RetryConnectionOnStartup)

This property controls whether the adapter attempts to connect again to the Lotus Domino server 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 Lotus Domino 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 Lotus Domino 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. 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


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


User name

This property specifies the name of the user account, the adapter uses in the Lotus Domino server.

User name details
Required No
Default No default value
Property type String
Usage The restrictions (case, length, and character) are determined based on the Lotus Domino server version.
Example DV1
Globalized No
Bidi supported Yes

Inbound configuration properties


Related concepts:

Inbound processing

WebSphere Application Server environment variables


Related tasks:

Setting deployment properties for a runtime environment

Setting location properties for artifacts

Defining WebSphere Application Server environment variables


Related reference:

Connection properties for the wizard

Resource adapter properties

Managed (J2C) connection factory properties