Managed connection factory properties, WebSphere Adapter for JD Edwards EnterpriseOne

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 > JD Edwards EnterpriseOne > Reference > Outbound configuration properties
Managed connection factory properties

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

You set the managed connection factory properties using either the external service wizard or the administrative console (after deployment).
The following table lists and describes the managed connection factory properties. A more detailed description of each property is provided in the sections that follow the table. For information on how to read the property detail tables in the sections that follow, see Guide to information about properties.
The external service wizard refers to these properties as managed connection factory properties and IBM BPM or WebSphere Enterprise Service Bus administrative console refers to these as (J2C) connection factory properties.

Managed connection factory properties for Adapter for JD Edwards EnterpriseOne
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.
Environment environment Specifies the JD Edwards EnterpriseOne environment name
Password password Password of the adapter user account on the JD Edwards EnterpriseOne environment
Role role Name of the role that is associated with the user name used to access the JD Edwards EnterpriseOne environment.
Timeout timeout This property is the global timeout value, in milliseconds, set on the XML List request execute call.
User name userName Name of the adapter user account on the JD Edwards EnterpriseOne environment
Maximum retries on connection failure (connectionRetryLimit) connectionRetryLimit Specifies the maximum number of times the adapter attempts to connect to the Enterprise Information System (EIS) to reestablish the connection.
Retry interval if connection fails (connectionRetryInterval) connectionRetryInterval Specifies the time interval between the attempts to reconnect to EIS, if the connection fails.

Adapter ID (AdapterID)

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 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, JDERA, 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 JDERA001.
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, JDERA001 and JDERA002, 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 JDERAInstance.
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 (HideConfidentialTrace)

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

Environment

This property specifies the JD Edwards EnterpriseOne environment name.

Environment details
Required Yes
Default No default value
Property type String
Usage A JD Edwards EnterpriseOne environment is a user-defined pointer that indicates the location of data and objects on a JD Edwards EnterpriseOne server. Users can be authorized to use multiple JD Edwards EnterpriseOne environments on a single JD Edwards EnterpriseOne server.
Example
Globalized Yes
Bidi supported Yes

Password

This property specifies the password of the adapter user account on the JD Edwards EnterpriseOne environment.

Password details
Required Yes
Default No default value
Property type String
Usage Passwords are created and named by the JD Edwards EnterpriseOne administrator. There are no restrictions on the type of characters used, the number of characters used, or the case of the characters used in passwords.
Example
Globalized No
Bidi supported Yes

Role

This property specifies the name of the role that is associated with the user name used to access the JD Edwards EnterpriseOne environment.

Role details
Required Yes
Default No default value
Property type String
Usage Roles define what authority users have. Users can have multiple roles. A user's access to applications, forms, table columns, data sources, and so on, is based on one or more roles to which the user is assigned. Roles are created and named by the JD Edwards EnterpriseOne administrator.
Examples

System administrator
Human resources
Accounting

Globalized No
Bidi supported Yes

Timeout

This property specifies the timeout value, in milliseconds, set on the XML List request call.

Timeout details
Required Yes
Default 30,000
Unit of measure Milliseconds
Property type Integer
Usage Use the Timeout property to specify the amount of time the adapter should take to perform a RetrieveAll operation using an XML List. If no value is specified, the adapter will time out after 30 seconds (30,000 milliseconds).
Globalized Yes
Bidi supported No

User name

This property specifies the name of the adapter user account on the JD Edwards EnterpriseOne environment.

User name details
Required Yes
Default No default value
Property type String
Usage User names are created by the JD Edwards EnterpriseOne administrator. There are no restrictions on the type of characters used, the number of characters used, or the case of the characters used in user names.
Example
Globalized Yes
Bidi supported Yes

Maximum retries on connection failure (connectionRetryLimit)

This property specifies the maximum number of times the adapter will attempt to reestablish a connection to the EIS 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 connect to the EIS server, if an error occurs during startup and or while establishing a connection. The adapter does not verify if the connection to the EIS server is valid when there is an outbound request during runtime.
>0

The adapter attempts to connect to the EIS server for the specified number of times, if an error occurs during startup or while establishing a connection.
The adapter verifies if the connection to the EIS server is valid when there is an outbound request during runtime. 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 re-establishing the connection, the outbound operation is completed.
Globalized No
Bidi supported No

Retry interval if connection fails (connectionRetryInterval)

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

Retry interval if connection fails property characteristics
Required No
Possible values Integers equal to and greater than zero
Default 60000
Property type Milliseconds
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 EIS server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized No
Bidi supported No

Outbound configuration properties

Related concepts:

Business objects

Related tasks:

Generate business functions using external service discovery
Generate XML Lists using external service discovery
Installing the EAR file
Setting deployment properties and generating the service
Setting deployment properties and generating the service

Related reference:

Guide to information about properties
Setting connection properties for the external service wizard
Resource adapter properties
Interaction 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.
Environment	environment	Specifies the JD Edwards EnterpriseOne environment name
Password	password	Password of the adapter user account on the JD Edwards EnterpriseOne environment
Role	role	Name of the role that is associated with the user name used to access the JD Edwards EnterpriseOne environment.
Timeout	timeout	This property is the global timeout value, in milliseconds, set on the XML List request execute call.
User name	userName	Name of the adapter user account on the JD Edwards EnterpriseOne environment
Maximum retries on connection failure (connectionRetryLimit)	connectionRetryLimit	Specifies the maximum number of times the adapter attempts to connect to the Enterprise Information System (EIS) to reestablish the connection.
Retry interval if connection fails (connectionRetryInterval)	connectionRetryInterval	Specifies the time interval between the attempts to reconnect to EIS, if the connection fails.

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, JDERA, 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 JDERA001. 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, JDERA001 and JDERA002, 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 JDERAInstance. 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	A JD Edwards EnterpriseOne environment is a user-defined pointer that indicates the location of data and objects on a JD Edwards EnterpriseOne server. Users can be authorized to use multiple JD Edwards EnterpriseOne environments on a single JD Edwards EnterpriseOne server.
Example
Globalized	Yes
Bidi supported	Yes

Required	Yes
Default	30,000
Unit of measure	Milliseconds
Property type	Integer
Usage	Use the Timeout property to specify the amount of time the adapter should take to perform a RetrieveAll operation using an XML List. If no value is specified, the adapter will time out after 30 seconds (30,000 milliseconds).
Globalized	Yes
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 connect to the EIS server, if an error occurs during startup and or while establishing a connection. The adapter does not verify if the connection to the EIS server is valid when there is an outbound request during runtime. >0 The adapter attempts to connect to the EIS server for the specified number of times, if an error occurs during startup or while establishing a connection. The adapter verifies if the connection to the EIS server is valid when there is an outbound request during runtime. 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 re-establishing the connection, the outbound operation is completed.
Globalized	No
Bidi supported	No