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

Connection properties for the wizard

The external service wizard properties are used to establish a connection between the external service wizard of IBM Integration Designer, a tool used to create business objects, and the Siebel Business Applications server. The properties you configure in the external service wizard specify such things as connection configuration, bidirectional (bidi) properties, and logging and tracing options.

After a connection between the external service wizard and the Siebel Business Applications server is established, the external service wizard is able to access the metadata it needs from the Siebel Business Applications server to create business objects.

Some of the properties that you set in the external service 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 external service wizard properties and their purpose are described in the following table. A complete 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 that follow, see Guide to information about properties.

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

external service wizard properties
Property name in the wizard Description
Adapter style Service type 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 Specifies the code page that the adapter uses to connect to the Siebel Business Applications server.
Connection URL The connection URL needed to connect to the Siebel application.
Delimiter for keys in the event store Specifies that the delimiter 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 used to log on to the Siebel Business Applications server.
Method name The name of the business service method to be implemented.
Password The password for the corresponding user 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 Business Applications mode and controls the data type 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 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.
User name The user name used to log in to the Siebel application.


Adapter style (AdapterStyle)

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

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.

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


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 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, as shown in the example below. For Siebel version 7.8, the port and server name are not specified, as shown in the example below. If you do not select the default port, then you can specify another port number (for example, 2321), as shown in the example below for Siebel version 8.
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


Code page (CodePage)

Specifies the code page that the adapter uses to connect to Siebel Business Applications 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 tooling is not supported, the adapter may not be able to connect to the Siebel Business Applications server.

This property allows the users to specify the code page details that the adapter uses to connect to Siebel Business Applications server for metadata discovery.

Globalized No
Bidi supported No


Delimiter for keys in the event store (DelimiterForKeysInTheEventStore)

Delimiter for keys in the event store details
Required Yes
Default ;
Property type String
Usage This is the delimiter used between two name value pairs containing the object key name and value.
Examples The default value for this property can be changed, however, if you remove the default value and do not set it again, the default value (;) will be used. If the event table key field has values, such as AccountId=1-314:Id=1-325, then 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.

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).

Generate business objects with shorter names details
Required No
Default No default value
Property type Boolean
Usage 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 used to log on to the Siebel Business Applications server.

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 Business Applications server.
Globalized No
Bidi supported No


Method name (MethodName)

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

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.

Password details
Required Yes
Default No default value
Property type String
Usage If a J2C Authentication Alias is used, then 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.

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 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/Output method argument. The corresponding business object generated would be: 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.

Siebel business object name for event store details
Required Yes
Default IBM_EVENT
Property type String
Usage After clicking the advanced button on the connection properties window on the external service wizard, this property will display under 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 to be discovered.

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 external service 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 Business Applications server view mode and controls the data that can be retrieved and what actions can be performed on it.

Siebel server view mode details
Required Yes
Default 3
Property type Integer
Usage This property displays after clicking the advanced button on the connection properties window on the external service 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 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.

Type of Siebel objects to discover details
Required Yes
Possible values Siebel business objects or 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 external service 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 Business Applications server uses resonate support.

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 clicking the advanced button on the connection properties window on the external service wizard.

If the check box is selected, it will be set to True, and the adapter takes advantage of the load balancing feature to connect to the Siebel Business Applications server more efficiently. If the check box is not selected, it will be set to false.

Globalized No


User name (UserName)

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

User name details
Required Yes
Default No default value
Property type String
Usage If a J2C Authentication Alias is used, then a user name is not required.
Globalized Yes
Bidi supported Yes

Outbound configuration properties