Siebel connection properties for the Adapter Connection wizard

Set Adapter Connection wizard properties to establish a connection between the wizard, a tool that is used to create business objects, and the Siebel server. The properties that you configure in the Adapter Connection wizard specify such things as connection configuration, and logging and tracing options.

After you have established a connection between the Adapter Connection wizard and the Siebel server, the Adapter Connection wizard is able to access the metadata that it needs from the Siebel server to create business objects.

Some of the properties that you set in the Adapter Connection wizard are used as the initial value for resource adapter, managed connection factory, and activation specification properties that you can specify at a later time in the wizard.

The following table describes the Adapter Connection wizard properties and their purpose. A complete description of each property is provided in the sections that follow the table.

If you set any of these connection properties using bidirectional script, you must set values that identify the format of the bidirectional script that is entered for that property.

Table 1. Adapter Connection wizard properties
Property name in the wizard Description
Adapter style The service type that is associated with the adapter module
Business object namespace The namespace value has been added as a prefix to the business object name to keep the business object schemas separated
Code page The code page that the adapter uses to connect to the Siebel application
Connection URL The connection URL that you need to connect to the Siebel application
Delimiter for keys in the event store Specifies that the delimiter that is used between two name value pairs contains the object key name and value
Folder The location of the generated business object
Generate business objects with shorter names Ensures that the adapter generates shorter business object names, which are based on the Siebel integration components, business services, and business components rather than the concatenation of several words (which is the default)
Language code The language code that is used to log on to the Siebel server
Method name The name of the business service method to be implemented
Password The password for the corresponding user name
Prefix for business object names The prefix for the business object name
Siebel business object name for event store The name of the business object in the event store where events are stored for inbound processing.
Siebel repository name The name of the Siebel repository from which the objects are to be discovered
Siebel server view mode Specifies the Siebel server mode and controls the kind of data to be retrieved and what actions can be performed
Type of Siebel objects to discover The type of Siebel objects (business objects or business services) that need to be discovered and listed
Use resonate support for load balancing on Siebel server 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
User name The user name that is used to log into the Siebel application

Adapter style (AdapterStyle)

This property specifies the service type that is associated with the adapter module.

Table 2. Service type details
Required Yes
Default Outbound
Property type List of values
Possible values
Outbound
Inbound
Usage Specifies the service type associated with the adapter module
Globalized No
Bidi supported No

Business object namespace (BusinessObjectNameSpace)

This property specifies that the namespace value has been added as a prefix to the business object name to keep the business object schemas separated.

Table 3. Business object namespace details
Required Yes
Default http://www.ibm.com/xmlns/prod/wbi/j2ca/siebel
Property type String
Usage The namespace value is added as a prefix to the business object name to keep the business object schemas separated.
Example http://www.ibm.com/xmlns/prod/wbi/j2ca/siebel/IBMSiebelAccountInsertAccount
Globalized No
Bidi supported No

Code page (CodePage)

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

Table 4. 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 for metadata discovery.

The Siebel Java™ Data Bean supports a limited list of code page settings. If the current code page setting of your tooling is not supported, the adapter might not be able to connect to the Siebel server.

Globalized No
Bidi supported No

Connection URL (ConnectionURL)

This property specifies the connection URL that is needed to connect to the Siebel application.
Table 5. Connection URL details
Required Yes
Default No default value
Property type String
Usage The connection URLs for all versions of Siebel follow this format: Protocol://machinename:port/enterprisename/object manager/server name

The default port number is 2320. For Siebel version 7.5x and earlier versions, the port number (2320) and server name are specified. For Siebel version 7.8, the port and server name are not specified. If you do not select the default port, you can specify another port number (for example, 2321).

Examples The following sample connection URLs are for different versions of Siebel:
  • For Siebel 7.5: siebel://<IP_address>:2320/siebel/SSEObjMgr_ENU/sebldevl.
  • For Siebel 7.8: siebel://<IP_address>/Sieb78/SSEObjMgr_enu.
  • For Siebel 8: siebel://<IP_address>:2321/SBA_80/SSEObjMgr_enu.
Globalized Yes
Bidi supported Yes

Delimiter for keys in the event store (DelimiterForKeysInTheEventStore)

Table 6. Delimiter for keys in the event store details
Required Yes
Default ;
Property type String
Usage This is the delimiter that is used between two name value pairs that contain the object key name and value.
Examples You can change the default value for this property. However, if you remove the default value and do not set it again, the default value (;) is used. If the event table key field has values, such as AccountId=1-314:Id=1-325, the event delimiter is the colon (:) . The object key names are AccountId and Id. The values are 1-314 and 1-325.
Globalized Yes
Bidi supported Yes

Folder (Folder)

This property specifies the location of the generated business objects.

Table 7. Folder details
Required No
Default No default value
Property type String
Usage The generated business objects are copied into this folder.
Example inboundartifacts and outboundartifacts
Globalized No
Bidi supported No

Generate business objects with shorter names (GenerateBusinessObjectsWithShorterNames)

This property ensures that the adapter generates shorter business object names, which are based on the Siebel integration components, business services, and business components rather than the concatenation of several words (which is the default).

Table 8. Generate business objects with shorter names details
Required No
Default No default value
Property type Boolean
Usage This property ensures that the adapter generates shorter business object names. The shorter business object names are based on the Siebel integration components, business services, and business components. The prefix is also attached to the shorter names.

The adapter removes special characters from the shorter business object names. Alphanumeric characters (a-z, A-Z, and 1-9) are supported, and a counter (1-9) is added to the end of business object names to avoid duplication of names.

Example If 'Account' is the name of the Siebel business component, and 'Siebel' is the prefix, the shorter name is 'Siebel_Account'.
Globalized No
Bidi supported No

Language code (LanguageCode)

This property specifies the language code that is used to log on to the Siebel server.
Table 9. Language code details
Required Yes
Default ENU
Property type String
Usage If the system locale is English, the value for this property is ENU (English). This is used to log on to the Siebel server.
Globalized No
Bidi supported No

Method name (MethodName)

This property specifies the name of the business service method to be implemented.

Table 10. Method name details
Required Yes
Default Query
Property type String
Usage The default is Query.
Example Query, QueryByExample, QueryById, and so on.
Globalized Yes
Bidi supported Yes

Password (Password)

This property specifies the password for the corresponding user name.
Table 11. Password details
Required Yes
Default No default value
Property type String
Usage If a J2C Authentication Alias is used, a password is not required.
Example 1-XYZ
Globalized Yes
Bidi supported Yes

Prefix for business object names (PrefixForBusinessObjectNames)

This property specifies the prefix for the business object name.
Table 12. 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 that was generated.
Example For example, you use the prefix, IBM, and generate a business object for the EAI Siebel Adapter and the Insert method. Then you choose the Account Interface and Business Address Interface integration object against an Input and InputOutput method argument. The corresponding business object that is generated is:
IBMEAISiebelAdapterInsertAccountInterfacBusinessAddressInterface
Globalized Yes
Bidi supported Yes

Siebel business object name for event store (SiebelBusinessObjectNameForEventStore)

This property specifies the name of the business object in the event store where events are stored for inbound processing.

Table 13. Siebel business object name for event store details
Required Yes
Default IBM_EVENT
Property type String
Usage To set this property, click Advanced on the connection properties pane on the Adapter Connection wizard, then go to the Event configuration tab. The two values listed are IBM_EVENT and IBM2. If you create a custom event component name, you can specify the value for it in the list box.
Globalized Yes
Bidi supported No

Siebel repository name (SiebelRepositoryName)

This property specifies the name of the Siebel repository from which the objects are discovered.
Table 14. Siebel repository name details
Required Yes
Default Siebel repository
Property type String
Usage This default value is Siebel Repository. Although this is a required field, it is optional on the Adapter Connection wizard. You can edit this value to point to other repositories if needed.
Globalized No
Bidi supported No

Siebel server view mode (SiebelServerViewMode)

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

Table 15. Siebel server view mode details
Required Yes
Default 3
Property type Integer
Usage This property displays when you click Advanced on the connection properties pane of the Adapter Connection wizard. This mode, when set to "Type of Siebel objects to discover" applies only to Siebel business objects, not to Siebel business services. The values that are supported by Siebel are 1 to 9.
Globalized No

Type of Siebel objects to discover (TypeOfSiebelObjectsToDiscover)

This property specifies the type of Siebel object that needs to be discovered and listed.
Table 16. Type of Siebel objects to discover details
Required Yes
Possible values Siebel business objects and Siebel business services
Default Siebel business objects
Property type String
Usage Although the default is Siebel business objects, you can select Siebel business services. Based on your selection, the Adapter Connection wizard retrieves either the business objects or the business services.
Globalized No
Bidi supported No

Use resonate support for load balancing on Siebel server (UseResonateSupportForLoadBalancingOnSiebelServer)

This property indicates whether the Siebel server uses resonate support.

Table 17. Use resonate support for load balancing on Siebel server details
Required No
Possible values
True
False
Default True
Property type Boolean
Usage This property displays after you click Advanced on the connection properties pane of the Adapter Connection wizard. 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

User name (UserName)

This property specifies the user name that is used to log into the Siebel application.
Table 18. User name details
Required Yes
Default No default value
Property type String
Usage If a J2C Authentication Alias is used, a user name is not required.
Globalized Yes
Bidi supported Yes