Managed connection factory properties, WebSphere Adapter for PeopleSoft Enterprise

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 > PeopleSoft Enterprise > 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 with the PeopleSoft Enterprise server.

The following table lists and describes the managed connection factory properties for outbound communication. You set the managed connection factory properties using either the external service wizard or the administrative console (after deployment).
A more detailed 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 information about properties.
The external service wizard refers to these properties as managed connection factory properties and the Process Administrative Console refers to them as (J2C) connection factory properties.

Managed connection factory properties
In the wizard In the administrative console Description
Adapter ID (adapterID) adapterID
Identifies the adapter instance for PMI events and for logging and tracing.
Component interface for testing failed connection PingCompInterface Specifies the component interface the adapter uses to validate a connection to the PeopleSoft Enterprise server.
Disguise user data as "XXX" in log and trace files hideConfidential
Trace Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Show error on empty result set (showErrorOnEmptyResultSet) showErrorOnEmpty
ResultSet Specifies whether to generate a fault or return an empty business object when no records are found.
Host name hostName Specifies the name or address of the server that hosts PeopleSoft Enterprise.
Language (language) language Specifies the language code the adapter uses to log on to the PeopleSoft Enterprise server.
Maximum retries in case of system connection failure (connectionRetryLimit) connectionRetry
Limit Specifies the maximum number of times the adapter attempts to reestablish an outbound connection to the EIS.
Password (Password) password Specifies the password of the user account of the adapter on the PeopleSoft Enterprise server.
Port number (Port) port The port number the adapter uses to access the PeopleSoft Enterprise server.
Retry interval if connection drops(in milliseconds) (connectionRetryInterval) connectionRetry
Interval Specifies the time interval between attempts to reconnect to the PeopleSoft Enterprise server if the connection fails.
User name (UserName) userName The name of the user account the adapter uses on the PeopleSoft Enterprise server.
Use Invalid Request Fault (useInvalidRequestFault) useInvalidRequest
Fault Specifies whether to generate the invalid request fault business object

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, 001, 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 PSFTRA001.
If you run multiple instances of the same adapter, ensure that the first seven 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 PeopleSoft Enterprise to 001 and 002. The component IDs for those instances, PSFTRA001 and PSFTRA002, 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 PSFTRAInstanc.
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

Component interface for testing failed connection (PingCompInterface)

This property specifies the name of the PeopleSoft Enterprise component interface that the adapter uses to validate a connection to the PeopleSoft Enterprise server.

Component interface for testing failed connection details
Required Yes
Default The name of the first component interface in the list.
Property type String
Usage Specify a component interface name that exists within your PeopleSoft Enterprise applications.
Example WBI_CUSTOMER_CI
Globalized No
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

Host name (hostName)

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

Host name details
Required Yes
Default No default value
Property type String
Usage Identifies, either by name or IP address, the server that hosts PeopleSoft Enterprise.
Example 9.26.248.202
Globalized No
Bidi supported No

Language (language)

This property specifies the language code the adapter uses to log on to the PeopleSoft Enterprise server.

Language details
Required Yes
Default The default value for the Language property is based on the system locale.
Property type String
Usage Each of the supported languages is preceded by a three character language code. The language itself is presented in parentheses.
Example If the system locale is English, the value for this property is ENG (English).
Globalized No
Bidi supported No

Show error on empty result set (showErrorOnEmptyResultSet)

This property specifies whether to return an empty business object when no records are found.

Show error on empty result set details
Required No
Possible values
True
False
Default True
Property type Boolean
Usage If you set this property to False, the RetrieveAll operation returns an empty business object when no records are found.
If you set this property to True, the RetrieveAll operation generates a RecordNotFoundFault or InvalidRequestFault depending on the value of useInvalidRequestFault.
Globalized No
Bidi supported No

Maximum retries in case of system connection failure (connectionRetryLimit)

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

Maximum retries in case of system connection failure details
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 PeopleSoft Enterprise server, if an error occurs during startup or while establishing a connection.
The adapter does not verify if the connection to the PeopleSoft Enterprise server is valid when there is an outbound request during run time.

>0

The adapter attempts to reconnect to the PeopleSoft Enterprise 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 PeopleSoft Enterprise 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 (Password)

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

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

Port number (Port)

This property specifies the port number the adapter uses to access the PeopleSoft Enterprise server.

Port number details
Required Yes
Default The port number entered when you use the external service wizard to discover objects and services.
Property type Integer
Example 9000
Globalized No
Bidi supported No

Retry interval if connection drops(in milliseconds) (connectionRetryInterval)

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

Retry interval if connection failure details
Required No
Possible values Integers equal 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 in case of system connection failure (connectionRetryLimit) is set to greater than 0.
When the adapter encounters an error while establishing a connection to the PeopleSoft Enterprise server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized No
Bidi supported No

User name (UserName)

This property specifies the name of the user account the adapter uses on the PeopleSoft Enterprise server.

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

Use Invalid Request Fault (useInvalidRequestFault)

This property specifies whether to generate the invalid request fault business object.

Use Invalid Request Fault (useInvalidRequestFault)
Required No
Default False
Property type Boolean
Usage If you set this property to True, the adapter returns an InvalidRequestFault business object if any error occurs in PeopleSoft Enterprise system server side during run time outbound processing. The error codes and error messages are contained in this business object.
Globalized No
Bidi supported No

Outbound configuration properties

Related reference:

Globalization

In the wizard	In the administrative console	Description
Adapter ID (adapterID)	adapterID	Identifies the adapter instance for PMI events and for logging and tracing.
Component interface for testing failed connection	PingCompInterface	Specifies the component interface the adapter uses to validate a connection to the PeopleSoft Enterprise server.
Disguise user data as "XXX" in log and trace files	hideConfidential Trace	Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Show error on empty result set (showErrorOnEmptyResultSet)	showErrorOnEmpty ResultSet	Specifies whether to generate a fault or return an empty business object when no records are found.
Host name	hostName	Specifies the name or address of the server that hosts PeopleSoft Enterprise.
Language (language)	language	Specifies the language code the adapter uses to log on to the PeopleSoft Enterprise server.
Maximum retries in case of system connection failure (connectionRetryLimit)	connectionRetry Limit	Specifies the maximum number of times the adapter attempts to reestablish an outbound connection to the EIS.
Password (Password)	password	Specifies the password of the user account of the adapter on the PeopleSoft Enterprise server.
Port number (Port)	port	The port number the adapter uses to access the PeopleSoft Enterprise server.
Retry interval if connection drops(in milliseconds) (connectionRetryInterval)	connectionRetry Interval	Specifies the time interval between attempts to reconnect to the PeopleSoft Enterprise server if the connection fails.
User name (UserName)	userName	The name of the user account the adapter uses on the PeopleSoft Enterprise server.
Use Invalid Request Fault (useInvalidRequestFault)	useInvalidRequest Fault	Specifies whether to generate the invalid request fault business object

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, 001, 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 PSFTRA001. If you run multiple instances of the same adapter, ensure that the first seven 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 PeopleSoft Enterprise to 001 and 002. The component IDs for those instances, PSFTRA001 and PSFTRA002, 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 PSFTRAInstanc. 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	Yes
Default	The name of the first component interface in the list.
Property type	String
Usage	Specify a component interface name that exists within your PeopleSoft Enterprise applications.
Example	WBI_CUSTOMER_CI
Globalized	No
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, either by name or IP address, the server that hosts PeopleSoft Enterprise.
Example	9.26.248.202
Globalized	No
Bidi supported	No

Required	Yes
Default	The default value for the Language property is based on the system locale.
Property type	String
Usage	Each of the supported languages is preceded by a three character language code. The language itself is presented in parentheses.
Example	If the system locale is English, the value for this property is ENG (English).
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 PeopleSoft Enterprise server, if an error occurs during startup or while establishing a connection. The adapter does not verify if the connection to the PeopleSoft Enterprise server is valid when there is an outbound request during run time. >0 The adapter attempts to reconnect to the PeopleSoft Enterprise 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 PeopleSoft Enterprise 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	The port number entered when you use the external service wizard to discover objects and services.
Property type	Integer
Example	9000
Globalized	No
Bidi supported	No

Required	No
Possible values	Integers equal 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 in case of system connection failure (connectionRetryLimit) is set to greater than 0. When the adapter encounters an error while establishing a connection to the PeopleSoft Enterprise server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized	No
Bidi supported	No