Resource adapter 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 > Inbound configuration properties
Resource adapter properties

The resource adapter properties control the general operation of the adapter. You set the resource adapter properties in the external service wizard when you configure the adapter. After deploying the adapter, use the Process Administrative Console to change these properties.

The following properties for logging and tracing are no longer required in version 7.5.0.2, but are supported for compatibility with previous versions:

LogFileMaxSize
LogFileName
LogNumberOfFiles
TraceFileMaxSize
TraceFileName
TraceNumberOfFiles

The following table lists and describes the resource adapter properties. A more detailed description of each property is provided in the sections that follow the table. For more information about how to read the property detail tables in the sections to follow, see Guide to information about properties.

Resource adapter 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.
(Not available) enableHASupport
Do not change this property.
Event delimiter EventDelimiter Specifies whether the delimiter used between two name value pairs contains the object key name and value.
(Not available) LogFileMaxSize Deprecated
(Not available) LogFilename Deprecated
(Not available) LogNumberOfFiles Deprecated
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.
Siebel server view mode viewMode Specifies the Siebel view mode and controls the type of data to be retrieved and the actions to be performed.
(Not available) TraceFileMaxSize Deprecated
(Not available) TraceFileName Deprecated
(Not available) TraceNumberOfFiles Deprecated

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

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

Enable high availability support (enableHASupport)

Do not change this property. It must be set to true.

Event delimiter (EventDelimiter)

This property indicates that the delimiter used between two name value pairs contains the object key name and value.

Event delimiter details
Required Yes
Default ;
Property type String
Usage If multiple value pairs are set against the object key in the event component, they will be used for the delimiter.
Globalized No

Log file maximum size (LogFileMaxSize)

This property specifies the size of the log files in kilobytes.

Log file maximum size details
Required No
Default 0
Property type Integer
Usage When the log file reaches it maximum size, the adapter start using a new log file. If the file size is specified as 0 or no maximum size is specified, the file does not have a maximum size.
Globalized Yes
Bidi supported No

Log file name (LogFilename)

This property specifies the full path name of the log file.

Log file name details
Required No
Default No default value
Property type String
Usage This property is deprecated.
Globalized Yes
Bidi supported Yes

Log number of files (LogNumberOfFiles)

This property specifies the number of log files.

Log number of files details
Required No
Default 1
Property type Integer
Usage When a log file reaches its maximum size, the adapter starts using another log file. If no value is specified, the adapter creates a single log file.
Globalized Yes
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 value of this property is set to True, the adapter takes advantage of the load balancing feature to connect to the Siebel Business Applications server more efficiently.
Globalized No
Siebel server view mode (SiebelServerViewMode)

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

View mode details
Required Yes
Default 3
Property type Integer
Usage The View mode property applies only to Siebel business objects and not to Siebel business services.
Globalized No

Trace file maximum size (TraceFileMaxSize)

This property specifies the size of the trace files in kilobytes.

Trace file maximum size details
Required No
Default 0
Property type Integer
Usage If no value is specified, then the trace file has no maximum size.
Globalized Yes
Bidi supported No

Trace file name (TraceFilename)

This property specifies the full path of the trace file.

Trace file name details
Required No
Default No default value
Unit of measure Kilobytes
Property type String
Usage This property is deprecated.
Globalized Yes
Bidi supported Yes

Trace number of files (TraceNumberOfFiles)

This property specifies the number of trace files to use. When a trace file reaches its maximum size, the adapter starts using another trace file.

Trace number of files details
Required No
Default 1
Property type Integer
Usage If no value is specified, the adapter uses a single trace file.
Globalized Yes
Bidi supported No

Inbound configuration 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.
(Not available)	enableHASupport	Do not change this property.
Event delimiter	EventDelimiter	Specifies whether the delimiter used between two name value pairs contains the object key name and value.
(Not available)	LogFileMaxSize	Deprecated
(Not available)	LogFilename	Deprecated
(Not available)	LogNumberOfFiles	Deprecated
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.
Siebel server view mode	viewMode	Specifies the Siebel view mode and controls the type of data to be retrieved and the actions to be performed.
(Not available)	TraceFileMaxSize	Deprecated
(Not available)	TraceFileName	Deprecated
(Not available)	TraceNumberOfFiles	Deprecated

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
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
Default	No default value
Property type	String
Usage	This property is deprecated.
Globalized	Yes
Bidi supported	Yes

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