Activation specification properties, WebSphere Adapter for Enterprise Content Management

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 > Enterprise Content Management > Reference > Configuration properties > Inbound configuration properties
Activation specification properties

Activation specification properties are properties that hold the inbound event processing configuration information for an export.

The following table lists the activation specification properties for inbound communication. You set the activation specification properties using the external service wizard and can change them before deployment using the IBM Integration Designer Assembly Editor. After deployment, you can change these values using the IBM BPM or WebSphere Enterprise Service Bus 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
In the wizard In the Process Administrative Console Description
Base events folder (baseEventFolder) baseEventFolder The folder where all the events are stored
Connection connection The protocol used for connection
JAAS Stanza fnJaazStanza The JAAS stanza for the FileNet Content Engine connection
Endpoint URI fnUri The URI to connect to FileNet Content Engine
Navigation Service URL navigationServiceEndpoint URL used to traverse the folder hierarchy in the Content Management Repository
Object Service URL of the CMIS server objectServiceEndpoint URL to perform ID-based create, retrieve, update, and delete operations on Objects
Failed events folder FailedEventsFolder The absolute path to the file folder on the local system where unsuccessfully processed email events are archived in file format.
Host name HostName The IP address of the host where the mail server is running.
Password (Password) Password The password associated with the CMIS server user name.
Path path The context root
Port Number portNumber Port number
Subscription subscriptions The subscription details that are captured during discovery
User name userName The user name for an CMIS server.
FileNet P8 User Name fnUserName The FileNet P8 user name to connect to FileNet P8, and setup a subscription.
FileNet P8 Password fnPassword The FileNet P8 password to connect to FileNet P8, and setup a subscription.
Type of delivery
DeliveryType

Determines the order in which events are delivered by the adapter to the export.
Ensure once-only event delivery
AssuredOnceDelivery

Specifies whether the adapter provides assured once delivery of events.
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.
Retry limit for failed events FailedEventRetryLimit The number of times the adapter attempts to redeliver an event before marking the event as failed.
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.
Interval between polling periods
PollPeriod

The length of time that the adapter waits between polling periods.
Maximum events in polling period
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 CMIS server 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.
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.
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.
Auto create event table EP_CreateTable Specifies whether the adapter should create a database table for the event store if one does not exist
Event recovery table name EP_TableName The name of the event store used by the adapter
Event recovery data source (JNDI) name EP_DataSource_JNDIName The JNDI name of the data source used by the event persistence class to acquire the JDBC database connection
Database schema name EP_SchemaName The schema name for the database used by the adapter's event persistence feature

Bidi format string (BIDIContextEIS)

This property indicates the bidi format for string type business data exchanged between the mail server and the adapter.

Bidi format string details
Required No
Possible values IBM BPM and WebSphere Enterprise Service Bus use ILYNN (implicit, left-to-right, on, off, nominal). These five attributes comprise the format used by Windows.
Default No default value
Property type String
Usage A five-character string that identifies the bidirectional format used by the CMIS server.
If the CMIS server that sends or receives data from the server uses a different format than ILYNN, the adapter converts the format before introducing the data to the server. For the conversion to occur, you use the external service wizard to set attribute values that represent the bidirectional format used by the CMIS server. This is done when you configure the module for the first time.
Example
ILYNN
VRYNN
VLYNN
Globalized No
Bidi supported No

Base events folder (baseEventFolder)

This property specifies the file folder on the local system where all the events are stored.

Base events folder details
Required No
Default /ECMAdapterEvents
Property type String
Usage This property is populated and is not editable

Connection

This property specifies protocol used for connection

Connection
Required Yes
Default No default value
Property type String
Usage http or https

JAAS Stanza

This property specifies the JAAS Stanza for the FileNet Content Engine connection.

JAAS Stanza
Required Yes
Default No default value
Property type String
Usage Specify the Jaas Stanza for FileNet connection
Example FileNetP8WSI

Endpoint URI

The URI to connect to FileNet Content Engine.

Endpoint URI
Required Yes
Default No default value
Property type String
Usage Must be a valid URI

Navigation Service URL of the CMIS server

This property specifies URL of the Navigation Service of the CMIS server.

URL of the Repository Service of the CMIS server
Required Yes
Default Endpoint Address of the CMIS Server + /NavigationService
Property type String
Usage Must be a valid URL
Example http://cmisserver.com/p8apis/NavigationService

Object Service URL of the CMIS server

This property specifies URL of the Object Service of the CMIS server.

URL of the Repository Service of the CMIS server
Required Yes
Default Endpoint Address of the CMIS Server + /ObjectService
Property type String
Usage Must be a valid URL
Example http://cmisserver.com/p8apis/ObjectService

Failed events folder (FailedEventsFolder)

This property specifies the file folder on the local system where unsuccessfully processed email events are archived in file format.

Failed events folder details
Required No
Default No default value
Property type String
Usage This folder must be manually created on the same system as the adapter before the adapter is run. If you do not specify a failed events folder, the adapter does not archive any unsuccessful email event.
You can use a WebSphere Application Server environment variable to represent the failed events folder. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${FAILEDEVENTS_FOLDER}. See the topic on creating an environment variable in this documentation.

Host name (HostName)

This property specifies the IP address of the host where the mail server is running.

Host name details
Required No
Default localhost
Property type String
Usage Specifies the IP address of the host where the mail server is running

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 CMIS server user name.

Password details
Required Yes
Default No default value
Property type String
Usage The password for the CMIS server user name. Typing an incorrect password prevents the adapter from accessing the CMIS server.

Path

This property specifies the context root

Path
Required Yes
Default No default value
Property type String
Usage Specify the context root

Port Number

This property specifies the Port number

Port number
Required Yes
Default 9080 - WebSphere default
Property type String
Usage Select from the list or key in the Port number

Subscription

This property specifies subscription details that are captured during discovery

Subscription
Required Yes
Default No default value
Property type String
Usage Specify the subscription details that are captured during discovery in the following format: subscriptionName:;ObjectClass:;ObjectType:;Events:;RepoId: subscriptionName:<:yoursub-name>;ObjectClass:<my object class>;ObjectType:<Folder or Document>;Events:<your subscribed events>;RepoId:<Repository ID>.

User name

This property specifies the user name to connect to the CMIS server.

User name details
Required Yes
Default No default value
Property type String
Usage The user name for connecting to the CMIS server. Typing an incorrect user name prevents the adapter from accessing the CMIS server.

FileNet P8 User Name

This property specifies the user name to connect to the FileNet8 system.

FileNet8 User name
Required Yes
Default No default value
Property type String
Usage The FileNet P8 user name for connecting to the FileNet8 system. Typing an incorrect user name prevents the adapter from accessing the FileNet8 system.
Bidi supported Yes

FileNet P8 Password

This property specifies the password to connect to the FileNet8 system.

FileNet8Password
Required Yes
Default No default value
Property type String
Usage The FileNet P8 password for connecting to the FileNet 8 system. Typing an incorrect password prevents the adapter from accessing the FileNet8 system.
Bidi supported Yes

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

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

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

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

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

Retry EIS connection on startup (RetryConnectionOnStartup)

This property controls whether the adapter attempts to connect again to the CMIS 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 CMIS 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 CMIS 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

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
Unit of measure Milliseconds
Property type Integer
Usage
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 CMIS 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 CMIS server when it is first started, use the RetryConnectionOnStartup property.
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

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
False
Default 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

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

Inbound configuration properties

Related reference:

Connection properties for the wizard

In the wizard	In the Process Administrative Console	Description
Base events folder (baseEventFolder)	baseEventFolder	The folder where all the events are stored
Connection	connection	The protocol used for connection
JAAS Stanza	fnJaazStanza	The JAAS stanza for the FileNet Content Engine connection
Endpoint URI	fnUri	The URI to connect to FileNet Content Engine
Navigation Service URL	navigationServiceEndpoint	URL used to traverse the folder hierarchy in the Content Management Repository
Object Service URL of the CMIS server	objectServiceEndpoint	URL to perform ID-based create, retrieve, update, and delete operations on Objects
Failed events folder	FailedEventsFolder	The absolute path to the file folder on the local system where unsuccessfully processed email events are archived in file format.
Host name	HostName	The IP address of the host where the mail server is running.
Password (Password)	Password	The password associated with the CMIS server user name.
Path	path	The context root
Port Number	portNumber	Port number
Subscription	subscriptions	The subscription details that are captured during discovery
User name	userName	The user name for an CMIS server.
FileNet P8 User Name	fnUserName	The FileNet P8 user name to connect to FileNet P8, and setup a subscription.
FileNet P8 Password	fnPassword	The FileNet P8 password to connect to FileNet P8, and setup a subscription.
Type of delivery	DeliveryType	Determines the order in which events are delivered by the adapter to the export.
Ensure once-only event delivery	AssuredOnceDelivery	Specifies whether the adapter provides assured once delivery of events.
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.
Retry limit for failed events	FailedEventRetryLimit	The number of times the adapter attempts to redeliver an event before marking the event as failed.
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.
Interval between polling periods	PollPeriod	The length of time that the adapter waits between polling periods.
Maximum events in polling period	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 CMIS server 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.
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.
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.
Auto create event table	EP_CreateTable	Specifies whether the adapter should create a database table for the event store if one does not exist
Event recovery table name	EP_TableName	The name of the event store used by the adapter
Event recovery data source (JNDI) name	EP_DataSource_JNDIName	The JNDI name of the data source used by the event persistence class to acquire the JDBC database connection
Database schema name	EP_SchemaName	The schema name for the database used by the adapter's event persistence feature

Required	No
Possible values	IBM BPM and WebSphere Enterprise Service Bus use ILYNN (implicit, left-to-right, on, off, nominal). These five attributes comprise the format used by Windows.
Default	No default value
Property type	String
Usage	A five-character string that identifies the bidirectional format used by the CMIS server. If the CMIS server that sends or receives data from the server uses a different format than ILYNN, the adapter converts the format before introducing the data to the server. For the conversion to occur, you use the external service wizard to set attribute values that represent the bidirectional format used by the CMIS server. This is done when you configure the module for the first time.
Example	ILYNN VRYNN VLYNN
Globalized	No
Bidi supported	No

Required	No
Default	/ECMAdapterEvents
Property type	String
Usage	This property is populated and is not editable

Required	Yes
Default	Endpoint Address of the CMIS Server + /NavigationService
Property type	String
Usage	Must be a valid URL
Example	http://cmisserver.com/p8apis/NavigationService

Required	Yes
Default	Endpoint Address of the CMIS Server + /ObjectService
Property type	String
Usage	Must be a valid URL
Example	http://cmisserver.com/p8apis/ObjectService

Required	No
Default	localhost
Property type	String
Usage	Specifies the IP address of the host where the mail server is running

Required	Yes
Default	9080 - WebSphere default
Property type	String
Usage	Select from the list or key in the Port number

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

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

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

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

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 CMIS 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 CMIS server when it is first started, use the RetryConnectionOnStartup property.
Globalized	No
Bidi supported	No

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