Outbound adapter properties for Siebel

Outbound adapter properties define how the adapter creates an outbound connection instance with the Siebel application, and how operations are run on the server. Use the Adapter Connection wizard to set these properties.

The following table describes the outbound adapter properties. A more detailed description of each property is provided in the sections that follow the table.
Table 1. Managed connection factory properties
Property name Description
Adapter ID The name of the adapter instance in the log and trace files
Code page Specifies the code page that the adapter uses to connect to Siebel server
Connection URL The connection URL that is needed to connect to the Siebel application
Language code The language code that is used to log on to the Siebel server
Maximum records (maxRecords) Maximum number of records to return during a RetrieveAll operation
Password The password for the corresponding user name
Prefix The prefix for the business object name
Resonate support Specifies that if resonate support is installed on the Siebel server, and the value is set to True, the adapter takes advantage of the load balancing feature to connect to the Siebel server more efficiently
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, the property specifies whether the adapter generates an exception when a returned Siebel message is null.
User name The user name that is used to log into the Siebel application
View mode 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.

Table 2. Connection URL 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.
Globalized Yes
Bidi supported No

Code page (codePage)

Specifies the code page that the adapter uses to connect to Siebel server.
Table 3. Code page details
Required No
Default No default value
Property type String
Usage

Use this property to specify the code page details that the adapter uses to connect to the Siebel server.

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 might not be able to connect to the 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 change might affect other applications that run on the same JVM. 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 that is needed to connect to the Siebel application.
Table 4. 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 above (for Siebel versions 7.8 and 8) another port (2321) has been specified.
Globalized Yes
Bidi supported Yes

Language code (LanguageCode)

This property specifies the language code that is used to log on to the Siebel server.
Table 5. 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). This value is used to log on to the Siebel server.
Globalized No
Bidi supported No

Maximum records (maxRecords)

This property specifies the maximum number of records to return during a RetrieveAll operation.

Table 6. Maximum records details
Required Yes
Default 100
Usage If the number of hits in the database exceeds the value of the MaximumRecords property, the adapter returns the MatchesExceededLimitException error. The adapter uses this property to help avoid out-of-memory issues.
Property type Integer
Globalized No
Bidi supported No

Password (Password)

This property specifies the password for the corresponding user name.
Table 7. Password details
Required Yes
Default No default value
Property type String
Example sadmin
Usage This property displays after you click Advanced on the connection properties pane of the Adapter Connection wizard. The password is saved in .import and .export files so that the adapter can connect to the Siebel application after it has been deployed. If a J2C Authentication Alias is used, a password is not required.
Globalized Yes
Bidi supported Yes

Prefix (Prefix)

This property specifies the prefix for the business object name.
Table 8. 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 If you use the prefix IBM, generate a business object for the EAI Siebel Adapter and the Insert method, and 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

Resonate support (ResonateSupport)

This property indicates whether the Siebel server uses resonate support.
Table 9. Resonate support details
Required No
Possible values
True
False
Default True
Property type Boolean
Usage If you select the check box, the property is set to True, and the adapter takes advantage of the load balancing feature to connect to the Siebel server more efficiently. If you clear the check box, the property is set to False.
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 whether the adapter generates an exception when a returned Siebel message is null.

Table 10. Show error on empty result set details
Required No
Default

For a business object: True

For a business service: False
Property type Boolean
Usage
For a business object:
  • When this property is set to True, a "record not found" exception is issued if no records are found in RetreiveAll operation.
  • When this property is set to False, an empty business object is returned if no records are found in RetreieveAll operation.
For a business service:
  • When this property is set to True, a "record not found" exception is issued if no records are returned.
  • When this property is set to False, a null Siebel message is returned if no records are returned.
Globalized No
Bidi supported No

User name (UserName)

This property specifies the user name that is used to log into the Siebel application.
Table 11. User name details
Required Yes
Possible values None
Default No default value
Property type String
Usage This property displays after you click Advanced on the connection properties pane of the Adapter Connection wizard. The user name is saved in .import and .export files so that the adapter can connect to the Siebel application after it has been deployed. If a J2C Authentication Alias is used, a password is not required.
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.
Table 12. 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 value is 3.
Example The adapter supports values 1 to 9. For example, 1 is Manager View, 2 is Personal View, and 3 is All View.
Globalized No