Managed (J2C) connection factory 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 > 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 CMIS server.

You set the managed connection factory properties using the external service wizard and can change them using the IBM Integration Designer Assembly Editor, or after deployment through the IBM 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.
Maximum Number of retries in case of system connection failure connectionRetryLimit The adapter will try connecting to the Enterprise Information System (EIS) for a specified number of tries. Select only if you want to reduce the number of connection exceptions in the outbound operation. If selected, adapter validates the connection for each outbound request.
Endpoint Address of the CMIS server contextRootEndpointAddress Specifies the name or address of the server that hosts the CMIS server.
Navigation Service URL of the CMIS server navigationServiceEndpoint Specifies the URL to locate the Navigation Service of the CMIS server.
Object Service URL of the CMIS server objectServiceEndpoint Specifies the URL to locate the Object Service of the CMIS server.
Password password Specifies the password of the user account of the adapter in the CMIS server.
User name userName Specifies the name of the user account of the adapter in the CMIS server.
Versioning Service URL of the CMIS server versioningServiceEndpoint Specifies the URL to locate the Versioning Service of the CMIS 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 the adapters. The adapter ID is used with an adapter-specific identifier, ECMRA, 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 ECMRA001.
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 Enterprise Content Management to 001 and 002. The component IDs for those instances, ECMRA001 and ECMRA002, 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 the log and the 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

Maximum Number of retries in case of system connection failure

This property specifies the number of times the adapter attempts to create a connection to the Enterprise Information System (EIS). The adapter tries to connect to the EIS for the specified number of times. Select only if you want to reduce the number of connection exceptions in the outbound operation. If you select this option, the adapter will validate the connection for each outbound request.

Reset Client details
Required No
Possible values Integers
Default 0
Property type Integer
Usage
Only positive values are valid.
When the adapter encounters an error related to the outbound connection, it retries to establish a physical connection (when physical connection is not established) for the number of times specified for this property with a time delay specified in the property Time between retries in case of system connection failure (milliseconds).
If the value is 0, the adapter does not perform any EIS connection validation and executes the outbound operation.
if the value is > 0, then during each request the adapter validates if the EIS connection is active.

If the connection is valid the operation is completed.
if connection is invalid, the adapter invalidates the current managed connection and a new managed connection is created (new physical connection)

Globalized No
Bidi supported No

Time between retries in case of system connection failure (milliseconds)

This property specifies the time interval between attempts to connect to the Enterprise Information System (EIS).

Time between retries in case of system connection failure details
Required No
Possible Values Positive Integers
Default 60000
Unit of measure Milliseconds
Property type Integer
Usage When the adapter encounters an error related to the outbound connection, this property specifies the time interval that the adapter waits in between attempts to reestablish an outbound connection. It is disabled by default and is only enabled when the value of Maximum Number of retries in case of system connection failure is greater than 0.
Globalized No
Bidi supported No

Endpoint Address of the CMIS server

This property specifies the URL of the CMIS server end point.

Endpoint address details
Required Yes
Default No default value
Property type String
Usage Must be a valid URL
Example http://cmisserver.com/p8apis
Globalized No
Bidi supported No

Navigation Service URL of the CMIS server

This property specifies the 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
Globalized No
Bidi supported No

Object Service URL of the CMIS server

This property specifies the 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
Globalized No
Bidi supported No

Password

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

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.
Globalized No
Bidi supported No

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.
Globalized No
Bidi supported No

Versioning Service URL of the CMIS server

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

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

Outbound configuration properties

Related concepts:

Outbound processing

Related tasks:

Setting deployment properties for a runtime environment
Setting location properties for artifacts

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.
Maximum Number of retries in case of system connection failure	connectionRetryLimit	The adapter will try connecting to the Enterprise Information System (EIS) for a specified number of tries. Select only if you want to reduce the number of connection exceptions in the outbound operation. If selected, adapter validates the connection for each outbound request.
Endpoint Address of the CMIS server	contextRootEndpointAddress	Specifies the name or address of the server that hosts the CMIS server.
Navigation Service URL of the CMIS server	navigationServiceEndpoint	Specifies the URL to locate the Navigation Service of the CMIS server.
Object Service URL of the CMIS server	objectServiceEndpoint	Specifies the URL to locate the Object Service of the CMIS server.
Password	password	Specifies the password of the user account of the adapter in the CMIS server.
User name	userName	Specifies the name of the user account of the adapter in the CMIS server.
Versioning Service URL of the CMIS server	versioningServiceEndpoint	Specifies the URL to locate the Versioning Service of the CMIS 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 the adapters. The adapter ID is used with an adapter-specific identifier, ECMRA, 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 ECMRA001. 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 Enterprise Content Management to 001 and 002. The component IDs for those instances, ECMRA001 and ECMRA002, 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	No
Possible values	Integers
Default	0
Property type	Integer
Usage	Only positive values are valid. When the adapter encounters an error related to the outbound connection, it retries to establish a physical connection (when physical connection is not established) for the number of times specified for this property with a time delay specified in the property Time between retries in case of system connection failure (milliseconds). If the value is 0, the adapter does not perform any EIS connection validation and executes the outbound operation. if the value is > 0, then during each request the adapter validates if the EIS connection is active. If the connection is valid the operation is completed. if connection is invalid, the adapter invalidates the current managed connection and a new managed connection is created (new physical connection)
Globalized	No
Bidi supported	No

Required	No
Possible Values	Positive Integers
Default	60000
Unit of measure	Milliseconds
Property type	Integer
Usage	When the adapter encounters an error related to the outbound connection, this property specifies the time interval that the adapter waits in between attempts to reestablish an outbound connection. It is disabled by default and is only enabled when the value of Maximum Number of retries in case of system connection failure is greater than 0.
Globalized	No
Bidi supported	No

Required	Yes
Default	No default value
Property type	String
Usage	Must be a valid URL
Example	http://cmisserver.com/p8apis
Globalized	No
Bidi supported	No

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
Globalized	No
Bidi supported	No

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
Globalized	No
Bidi supported	No

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