Managed (J2C) connection factory properties, WebSphere Adapter for Lotus Domino

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 > Outbound configuration properties
Managed (J2C) connection factory properties

Managed connection factory properties are used by the adapter at run time to create an outbound connection instance with the Lotus Domino server.

You set the managed connection factory properties using the external service wizard and can change them using IBM Integration Designer Assembly Editor, or after deployment through theIBM BPM administrative console.
The following table lists the managed connection factory 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.
The external service wizard refers to these properties as managed connection factory properties and the IBM BPM administrative console refers to them as (J2C) connection factory properties.

Managed connection factory properties
Property name Description
In the wizard In the administrative console
Adapter ID adapterID
Identifies the adapter instance for PMI events and for logging and tracing.
Disguise user data as "XXX" in log and trace files hideConfidentialTrace Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Host name hostName Specifies the name or address of the server that hosts Domino.
Maximum retries on connection failure connectionRetryLimit Specifies the number of times the adapter tries to connect to the Lotus Domino server to reestablish the connection.
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, the adapter uses to access the Lotus Domino server.
Retry interval if connection fails (in milliseconds) entities connectionRetryInterval Specifies the time interval between the attempts to reconnect to the Lotus Domino server if the connection fails.
Set business faults behavior during run time handleAllFaultExceptions Specifies the fault handling behavior during run time.
User name userName Specifies the name of the user account of the adapter in the Lotus Domino server.

Adapter ID

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

Adapter ID details
Required Yes
Default 001
Property type String
Usage This property identifies the adapter instance in log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, DMNORA, 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 DMNORA001.
If you run multiple instances of the same adapter, ensure that the first 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 Lotus Domino to 001 and 002. The component IDs for those instances, DMNORA001 and DMNORA002, 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 cannot examine the log and trace information for each adapter instance because the component ID for both instances is truncated.
For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized Yes
Bidi supported No

Disguise user data as "XXX" in log and trace files

This property specifies whether to replace user data in log and trace files with a string of X's to prevent unauthorized disclosure of potentially sensitive data.

Disguise user data as "XXX" in log and trace files details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files.
For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
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

Maximum retries on connection failure

This property specifies the number of times the adapter attempts to reestablish a connection to the Lotus Domino server, when the adapter encounters an error related to the outbound connection.

Maximum retries on connection failure property characteristics
Required No
Possible values Integers equal to and greater than zero
Default 0
Property type Integer
Usage
When this property is set to:

0

The adapter does not attempt to reconnect to the Lotus Domino server, if an error occurs while establishing a connection.
The adapter does not verify if the connection to the Lotus Domino server is valid when there is an outbound request during run time.

>0

The adapter attempts to reconnect to the Lotus Domino server for the specified number of times, if an error occurs while establishing a connection.
The adapter verifies if the connection to the Lotus Domino server is valid when there is an outbound request during run time. If the connection is not valid, it is terminated and a new connection is created to process the request.

If the adapter fails to establish a connection after trying for the specified number of times, a connection error is generated.
If the adapter is successful in reestablishing the connection, the outbound operation is completed.

Globalized No
Bidi supported No

Password

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

Password details
Required No
Default No default value
Property type String
Usage The restrictions (case, length, and character) are determined by 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

Retry interval if connection fails (in milliseconds) entities

This property specifies the time interval between attempts to reconnect to the Lotus Domino server if the connection fails.

Retry interval if connection fails (milliseconds) property characteristics
Required No
Possible values Integers equal to and greater than 0
Default 60000
Unit of measure Milliseconds
Property type Integer
Usage
This property is applicable only if the value of the property Maximum retries on connection failure is set to greater than 0.
When the adapter encounters an error while establishing a connection to the Lotus Domino server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized No
Bidi supported No

Set business faults behavior during run time

This property is used to configure the fault handling behavior during run time.

Set business faults behavior during run time
Required Yes
Default Only business faults supported
Property type String
Usage Sets the business fault behavior during run time. You can configure the fault behavior during run time by using one of the following settings:

Set to FAULTS_SUPPORTED_INCLUDING_NOTES_ERROR or 2 to handle both the business faults and the Lotus Domino errors as faults.
Set to FAULTS_SUPPORTED or 1 to handle only the business faults.
Set to FAULTS_NOT_SUPPORTED or 0 to disable fault handling support and log the errors as exceptions.

Globalized No
Bidi supported No

User name

This property specifies the name of the user account, the adapter uses on 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 by the Domino version.
Example DV1
Globalized No
Bidi supported Yes

Outbound configuration properties

Related concepts:

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

Activation specification properties

Property name	Description
In the wizard	In the administrative console
Adapter ID	adapterID	Identifies the adapter instance for PMI events and for logging and tracing.
Disguise user data as "XXX" in log and trace files	hideConfidentialTrace	Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Host name	hostName	Specifies the name or address of the server that hosts Domino.
Maximum retries on connection failure	connectionRetryLimit	Specifies the number of times the adapter tries to connect to the Lotus Domino server to reestablish the connection.
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, the adapter uses to access the Lotus Domino server.
Retry interval if connection fails (in milliseconds) entities	connectionRetryInterval	Specifies the time interval between the attempts to reconnect to the Lotus Domino server if the connection fails.
Set business faults behavior during run time	handleAllFaultExceptions	Specifies the fault handling behavior during run time.
User name	userName	Specifies the name of the user account of the adapter in the Lotus Domino server.

Required	Yes
Default	001
Property type	String
Usage	This property identifies the adapter instance in log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, DMNORA, 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 DMNORA001. If you run multiple instances of the same adapter, ensure that the first 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 Lotus Domino to 001 and 002. The component IDs for those instances, DMNORA001 and DMNORA002, 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 cannot examine the log and trace information for each adapter instance because the component ID for both instances is truncated. For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized	Yes
Bidi supported	No

Required	No
Possible values	True False
Default	False
Property type	Boolean
Usage	If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files. For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized	No
Bidi supported	No

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

Required	No
Possible values	Integers equal to and greater than zero
Default	0
Property type	Integer
Usage	When this property is set to: 0 The adapter does not attempt to reconnect to the Lotus Domino server, if an error occurs while establishing a connection. The adapter does not verify if the connection to the Lotus Domino server is valid when there is an outbound request during run time. >0 The adapter attempts to reconnect to the Lotus Domino server for the specified number of times, if an error occurs while establishing a connection. The adapter verifies if the connection to the Lotus Domino server is valid when there is an outbound request during run time. If the connection is not valid, it is terminated and a new connection is created to process the request. If the adapter fails to establish a connection after trying for the specified number of times, a connection error is generated. If the adapter is successful in reestablishing the connection, the outbound operation is completed.
Globalized	No
Bidi supported	No

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

Required	No
Possible values	Integers equal to and greater than 0
Default	60000
Unit of measure	Milliseconds
Property type	Integer
Usage	This property is applicable only if the value of the property Maximum retries on connection failure is set to greater than 0. When the adapter encounters an error while establishing a connection to the Lotus Domino server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized	No
Bidi supported	No

Required	Yes
Default	Only business faults supported
Property type	String
Usage	Sets the business fault behavior during run time. You can configure the fault behavior during run time by using one of the following settings: Set to FAULTS_SUPPORTED_INCLUDING_NOTES_ERROR or 2 to handle both the business faults and the Lotus Domino errors as faults. Set to FAULTS_SUPPORTED or 1 to handle only the business faults. Set to FAULTS_NOT_SUPPORTED or 0 to disable fault handling support and log the errors as exceptions.
Globalized	No
Bidi supported	No