Managed connection factory properties, WebSphere Adapter for Siebel Business Applications

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 > Siebel Business Applications > 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 Siebel application.

You set the managed connection factory properties through either the external service wizard or the administrative console (after deployment).
The following table lists the managed connection factory properties for inbound communication. You set the activation specification properties using the external service wizard and can change them using the Integration Designer Assembly Editor, or after deployment through the 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 understanding property details.
The external service wizard refers to these properties as managed connection factory properties and the IBM BPM or WebSphere Enterprise Service Bus 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.
Connection URL connectString The connection URL needed to connect to the Siebel application.
Code page codePage Specifies the code page that the adapter uses to connect to Siebel server.
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.
Include empty elements in the output includeEmptyField Specifies if the empty elements are included in the response business object.
Language code languageCode The language code used to log on to the Siebel Business Applications server.
Maximum retries in case of system connection failure (connectionRetryLimit) connectionRetryLimit Specifies the maximum number of times the adapter tries to reestablish an outbound connection to the EIS.
Password password The password for the corresponding user name.
Retry interval if connection fails (in milliseconds) (connectionRetryInterval) connectionRetryInterval Specifies the time interval between attempts to reconnect to the Siebel Business Applications server if the connection fails.
Resonate support resonateSupport Specifies that if resonate support is installed on the Siebel Business Applications server, and the value is set to True, the adapter takes advantage of the load balancing feature to connect to the Siebel Business Applications server more efficiently.
Show error on empty result set (errorOnEmptyResultSet) errorOnEmptyResultSet For a business object, the property specifies if the adapter returns an empty business object or RecordNotFoundException when the result of RetreiveAll operation does not return any records. For a business service, the property specifies if the adapter generates an exception when a returned Siebel message is null.
User name userName The user name used to log in to the Siebel application
View mode viewMode Specifies the Siebel view mode and controls the data that can be retrieved and what actions can be performed on it.

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, SEBLRA, 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 SEBLRA001.
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 Siebel Business Applications to 001 and 002. The component IDs for those instances, SEBLRA001 and SEBLRA002, 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 SEBLRAInstanc.
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

Code page (codePage)

Specifies the code page that the adapter uses to connect to Siebel server.

Code page details
Required No
Default No default value
Property type String
Usage
The Siebel Java™ Data Bean supports a limited list of code page settings. If the current code page setting of your run time is not supported, the adapter may not be able to connect to the Siebel server.

This property allows the users to specify the code page details that the adapter uses to connect to Siebel server.

The adapter uses the code page property to change the “file.encoding” property of the current Java Virtual Machine (JVM), when it establishes its first connection to the Siebel server. This may affect other applications which run on the same JVM. You need to ensure that the code page has a valid value for all applications.
Globalized No
Bidi supported No

Connection URL (ConnectionURL)

This property specifies the connection URL needed to connect to the Siebel application.

Connection URL details
Required Yes
Default No default value
Property type String
Usage Protocol://machinename:port/enterprisename/object manager/server name.

For Siebel 7.0.5 to 7.5x: siebel://<IP ADDRESS>/siebel/SSEObjMgr_ENU/sebldev1.
For Siebel 7.8: siebel://<IP ADDRESS>:2321/Sieb78/SSEObjMgr_enu.
For Siebel 8: siebel://<IP ADDRESS>:2321/SBA_80/SSEObjMgr_enu. The default port number is 2320.
In the examples (for Siebel versions 7.8 and 8), another port (2321) has been specified.
Globalized Yes
Bidi supported Yes

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

Include empty elements in the output (includeEmptyField)

Specifies if the adapter returns the elements that have an empty string value in the response business object.

Include empty elements in the output details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage This property enables you to include the empty elements in the output. When this property is selected, the adapter returns the elements that have empty string values in the response business object.
Globalized No
Bidi supported No

Language code (LanguageCode)

This property specifies the language code used to log on to the Siebel Business Applications server.

Language code details
Required Yes
Possible values None
Default ENU
Property type String
Usage If the system locale is English, the value for this property is ENU (English). It is used to log on to the Siebel Business Applications server.
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 Siebel Business Applications 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 Siebel Business Applications server, if an error occurs during startup or while establishing a connection.
The adapter does not verify if the connection to the Siebel Business Applications server is valid when there is an outbound request during run time.

>0

The adapter attempts to reconnect to the Siebel Business Applications 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 Siebel Business Applications 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 for the corresponding user name.

Password details
Required Yes
Default No default value
Property type String
Usage The restrictions (case, length, and character) are determined by the version of Siebel application. If a J2C Authentication Alias is used, then you need not set the password.
Globalized Yes
Bidi supported Yes

Prefix (Prefix)

This property specifies the prefix for the business object name.

Prefix details
Required No
Default No default value
Property type String
Usage The prefix string is attached to the front of the business object name.
Example Use the prefix, IBM and generate a business object for the EAI Siebel Adapter and the Insert method. Then you choose the integration object, Account (PRM ANI). The corresponding business object generated is: IBMEAISiebelAdapterInsertAccountU40PRMANIU41, where U40 and U41 are the unicode value replacements of (and).
Globalized Yes
Bidi supported Yes

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

This property specifies the time interval between attempts to reconnect to the Siebel Business Applications 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 is set to greater than 0.
When the adapter encounters an error while establishing a connection to the Siebel Business Applications server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized No
Bidi supported No

Resonate support (ResonateSupport)

This property indicates whether the Siebel Business Applications server uses resonate support.

Resonate support details
Required No
Possible values
True
False
Default True
Property type Boolean
Usage If the property is selected (value set to True), and the adapter takes advantage of the load balancing feature to connect to the Siebel Business Applications server more efficiently.
Globalized No

Show error on empty result set (errorOnEmptyResultSet)

For a business object, this property specifies if the adapter returns an empty business object or RecordNotFoundException when the result of RetreiveAll operation does not return any records. For a business service, this property specifies if the adapter generates an exception when a returned Siebel message is null.

Show error on empty result set details
Required No
Default
For business object: True
For business service: False
Property type Boolean
Usage
For business object, when this property is set to:

True:
Throws a RecordNotFoundException if no records are found in RetreiveAll operation.
False:
Returns an empty business object if no records are found in RetreieveAll operation.

For business service, when this property is set to:

True:
Throws a RecordNotFoundException if no records are returned.
False:
Returns null Siebel message if no records are returned.

Globalized No
Bidi supported No

User name (UserName)

This property specifies the user name used to log in to the Siebel application.

User name details
Required Yes
Possible values None
Default No default value
Property type String
Usage The restrictions (case, length, and character) are determined by the version of Siebel application.
If a J2C Authentication Alias is used, then you need not set the user name.
Globalized Yes
Bidi supported Yes

View mode (ViewMode)

This property specifies the Siebel view mode and controls the data that can be retrieved and what actions can be performed on it.

View mode details
Required Yes
Possible values 1 - 9
Default 3
Property type Integer
Usage The View mode property applies only to Siebel business objects and not to Siebel business services. When this property is used for Siebel business objects, the default is 3.
Examples The adapter supports values 1 - 9.
For example, 1 is Manager View, 2 is Personal View, and 3 is All View.
Globalized No

Outbound configuration properties

Related tasks:

Setting deployment properties and generating the service

Related reference:

Globalization

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.
Connection URL	connectString	The connection URL needed to connect to the Siebel application.
Code page	codePage	Specifies the code page that the adapter uses to connect to Siebel server.
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.
Include empty elements in the output	includeEmptyField	Specifies if the empty elements are included in the response business object.
Language code	languageCode	The language code used to log on to the Siebel Business Applications server.
Maximum retries in case of system connection failure (connectionRetryLimit)	connectionRetryLimit	Specifies the maximum number of times the adapter tries to reestablish an outbound connection to the EIS.
Password	password	The password for the corresponding user name.
Retry interval if connection fails (in milliseconds) (connectionRetryInterval)	connectionRetryInterval	Specifies the time interval between attempts to reconnect to the Siebel Business Applications server if the connection fails.
Resonate support	resonateSupport	Specifies that if resonate support is installed on the Siebel Business Applications server, and the value is set to True, the adapter takes advantage of the load balancing feature to connect to the Siebel Business Applications server more efficiently.
Show error on empty result set (errorOnEmptyResultSet)	errorOnEmptyResultSet	For a business object, the property specifies if the adapter returns an empty business object or RecordNotFoundException when the result of RetreiveAll operation does not return any records. For a business service, the property specifies if the adapter generates an exception when a returned Siebel message is null.
User name	userName	The user name used to log in to the Siebel application
View mode	viewMode	Specifies the Siebel view mode and controls the data that can be retrieved and what actions can be performed on it.

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, SEBLRA, 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 SEBLRA001. 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 Siebel Business Applications to 001 and 002. The component IDs for those instances, SEBLRA001 and SEBLRA002, 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 SEBLRAInstanc. 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
Default	No default value
Property type	String
Usage	The Siebel Java™ Data Bean supports a limited list of code page settings. If the current code page setting of your run time is not supported, the adapter may not be able to connect to the Siebel server. This property allows the users to specify the code page details that the adapter uses to connect to Siebel server. The adapter uses the code page property to change the “file.encoding” property of the current Java Virtual Machine (JVM), when it establishes its first connection to the Siebel server. This may affect other applications which run on the same JVM. You need to ensure that the code page has a valid value for all applications.
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
Possible values	None
Default	ENU
Property type	String
Usage	If the system locale is English, the value for this property is ENU (English). It is used to log on to the Siebel Business Applications server.
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 Siebel Business Applications server, if an error occurs during startup or while establishing a connection. The adapter does not verify if the connection to the Siebel Business Applications server is valid when there is an outbound request during run time. >0 The adapter attempts to reconnect to the Siebel Business Applications 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 Siebel Business Applications 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	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 is set to greater than 0. When the adapter encounters an error while establishing a connection to the Siebel Business Applications server, this property specifies the time interval the adapter waits between attempts to reestablish a connection.
Globalized	No
Bidi supported	No

Required	No
Default	For business object: True For business service: False
Property type	Boolean
Usage	For business object, when this property is set to: True: Throws a RecordNotFoundException if no records are found in RetreiveAll operation. False: Returns an empty business object if no records are found in RetreieveAll operation. For business service, when this property is set to: True: Throws a RecordNotFoundException if no records are returned. False: Returns null Siebel message if no records are returned.
Globalized	No
Bidi supported	No

Required	Yes
Possible values	1 - 9
Default	3
Property type	Integer
Usage	The View mode property applies only to Siebel business objects and not to Siebel business services. When this property is used for Siebel business objects, the default is 3.
Examples	The adapter supports values 1 - 9. For example, 1 is Manager View, 2 is Personal View, and 3 is All View.
Globalized	No