Naming conventions for business objects representing Siebel business services

When the Adapter Connection wizard generates a business object, it provides a name for the business object based on the name of the object in the Siebel application that it uses to build the business object.

Naming conventions for business objects that represent Siebel business services and integration components

The naming conventions for business objects that represent Siebel business services are the same for both inbound and outbound processing. The names comprise the concatenation of several words, including prefix, business service name, integration object, and method name.

The following table describes the naming conventions that the Adapter Connection wizard uses to name business objects that represent Siebel business services and integration components.

Table 1. Business object naming conventions for Siebel business services and integration components
Element Naming convention
Name of the top-level business object <Prefix><Business Service Name><Method Name><Names of all the integration objects selected for the Input and InputOutput complex type arguments>
  • If no Input or InputOutput arguments exist, the names of all the output arguments are: <Prefix><Business Service Name><Method Name><Names of all the integration objects selected for the output complex type arguments>
  • If the method contains no complex arguments in the method, the naming convention is: <Prefix><Business Service Name><Method Name>
Name of the inbound object that is generated against integration components 'IO' + <Name of Integration Object> + 'IC' + <Name of integration component>
For example:
IOAccountInterfaceICAccount
Name of the outbound object that is generated against integration components 'IO' + <Name of Integration Object> + 'IC' + <Name of integration component>
The name of an account interface integration object with the integration component account, as shown in the following example:
IOAccountInterfaceICAccount

Optional: Shorter naming conventions for business objects that are generated against Siebel business services and integration components

The naming conventions for business objects that are generated against Siebel business services and integration components are valid if the optional 'Generate business objects with shorter names' property is specified on the configuration objects pane in the Adapter Connection wizard.

If this optional property is used, you should set the 'Folder' property with a unique value to avoid overwriting existing xsds that were previously generated. For example, if you select 'EAI Siebel Adapter', and click Query in two different Adapter Connection wizard runs for the integration objects, 'Account (PRM ANI)' and 'ATP Check Interface', the top-level object is named EAISiebelAdapter.xsd.

The name comprises the concatenation of several words, including prefix, business service name, and integration component name.

The following table describes the naming conventions that the Adapter Connection wizard uses to name business objects that are generated against Siebel business services and integration components.

Table 2. Shorter business object naming conventions for business objects that are generated against Siebel business services and integration components
Element Naming convention
Name of the inbound and outbound child business objects that are generated against integration components <Prefix>+<Name of the Siebel Integration Component>

The Siebel business object and integration component names are stripped of all non-alphanumeric characters before being added to the business object name. If the resulting names are not unique, a counter is added to the end of the names.

Name of the inbound top-level business object that is generated against business services and integration components <Prefix>+<Name of the Siebel Integration Component>

The Siebel business object and integration component names are stripped of all non-alphanumeric characters before being added to the business object name. If the resulting names are not unique, a counter is added to the end of the names.

Name of the outbound top-level business object that is generated against business services and integration components <Prefix>+<Name of the Siebel Business Service>

The Siebel business object and integration component names are stripped of all non-alphanumeric characters before being added to the business object name. If the resulting names are not unique, a counter is added to the end of the names.

Naming conventions for business objects that represent Siebel business objects

The naming conventions for business objects that represent Siebel business objects are the same for both inbound and outbound processing. The name comprises the concatenation of several words, including prefix, business object name, and business component name.

The following table describes the naming conventions that are used by the Adapter Connection wizard to name business objects that represent Siebel business objects.

Table 3. Business object naming conventions for Siebel business objects
Element Naming convention
Name of the business object <Prefix>+<BO>+<Business Object Name>+<BC>+<Business Component Name>.
The Siebel business object and component names are stripped of all non-alphanumeric characters before being added to the business object name. If the resulting names are not unique, a counter is added to the end of the names. For example, if two business objects have the name, SiebelBOAccountBCBusinessAddress, a counter is added as a suffix to make them unique, as shown in this example:
SiebelBOAccountBCAddress1 and SiebelBOAccountBCAddress2
Name of the container business object that is generated for the Exists operation <SiebelExistsResult>
Name of the container business object that is generated for the Retrieve All operation <Prefix>+BO+<Business Object Name>+<BC>+<Business Component Name>+Container
Name of the top-level business object <Prefix>+<BO>+<Business Object Name>+<BC>+<Business Component Name>

Optional: Shorter naming conventions for business objects that are generated against Siebel business components

The naming conventions for business objects that are generated against Siebel business components are valid if the optional 'Generate business objects with shorter names' property is specified on the configuration objects pane of the Adapter Connection wizard.

If this optional property is used, set the 'Folder' property with a unique value to avoid overwriting existing xsds that were previously generated. For example, Siebel business object > Siebel business component combination of Account-ESP > Account and Account (as the top-level object) is named Account.xsd.

The name comprises the concatenation of several words, including prefix and business component name.

The following table describes the naming conventions that the Adapter Connection wizard uses to name business objects that are generated against Siebel business components.

Table 4. Shorter business object naming conventions for business objects that are generated against Siebel business components
Element Naming convention
Name of the top-level business object that is generated against business components <Prefix>+<Name of the Siebel Business Component>

The Siebel business object and integration component names are stripped of all non-alphanumeric characters before being added to the business object name. If the resulting names are not unique, a counter is added to the end of the names.