Business object naming, 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 > Business object information
Naming conventions

When the external service 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 external service wizard uses to name business objects that represent Siebel business services and integration components.

Business object naming conventions for Siebel business services and integration components
Element Naming convention
Name of the business graph <Top Level business object Name> +"BG"
A "Prefix" is used only for top-level business objects generated against business service methods.
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 there are no Input or Input/Output arguments, 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 generated against integration components 'IO' + <Name of Integration Object> + 'IC' + <Name of integration component> +"BG"
The top-level business graph has the suffix BG added to the business object name, as shown in this example: IOAccountInterfaceICAccountBG
Name of the outbound object 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 looks like this: IOAccountInterfaceICAccount

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

The naming conventions for business objects generated against Siebel business services and integration components are valid if the optional property, 'Generate business objects with shorter names' is specified in the configuration objects window in the external service wizard.
If this optional property is used, you must set the 'Folder' property with a unique value. This avoids overwriting the existing XSDs that were previously generated.
For example, if you select 'EAI Siebel Adapter', and click Query in two different external service wizard runs for the integration objects, 'Account (PRM ANI)' and 'ATP Check Interface', the top-level object will be named as '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 external service wizard uses to name business objects that are generated against Siebel business services and integration components.

Shorter business object naming conventions for business objects generated against Siebel business services and integration components
Element Naming convention
Name of the inbound and outbound child business objects 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 generated against business services and integration components <Prefix>+<Name of the Siebel Integration Component> +"BG" (with business graph specified) and <Prefix>+<Name of the Siebel Integration Component> (without business graph specified)
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 generated against business services and integration components <Prefix>+<Name of the Siebel Business Service> +"BG" (with business graph specified) and <Prefix>+<Name of the Siebel Business Service> (without business graph specified)
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 representing 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 used by the external service wizard to name business objects that represent Siebel business objects.

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 generated for the Exists operation <SiebelExistsResult>
A business graph will not be generated for the "SiebelExistsResult" business object.
Name of the container business object 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>+"BG"
The top-level business object will have a business graph generated.

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

The naming conventions for business objects generated against Siebel business components are valid if the optional property, 'Generate business objects with shorter names' is specified in the configuration objects window in the external service wizard.
If this optional property is used, you must set the 'Folder' property with a unique value. This will avoid overwriting the 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) will be named as, '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 external service wizard uses to name business objects that are generated against Siebel business components.

Shorter business object naming conventions for business objects generated against Siebel business components
Element Naming convention
Name of the top-level business object generated against business components <Prefix>+<Name of the Siebel Business Component> +"BG" (with business graph specified) and <Prefix>+<Name of the Siebel Business Component> (without business graph specified)
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.

Business object information

Related reference:

Application-specific information
Supported operations

Element	Naming convention
Name of the business graph	<Top Level business object Name> +"BG" A "Prefix" is used only for top-level business objects generated against business service methods.
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 there are no Input or Input/Output arguments, 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 generated against integration components	'IO' + <Name of Integration Object> + 'IC' + <Name of integration component> +"BG" The top-level business graph has the suffix BG added to the business object name, as shown in this example: IOAccountInterfaceICAccountBG
Name of the outbound object 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 looks like this: IOAccountInterfaceICAccount

Element	Naming convention
Name of the inbound and outbound child business objects 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 generated against business services and integration components	<Prefix>+<Name of the Siebel Integration Component> +"BG" (with business graph specified) and <Prefix>+<Name of the Siebel Integration Component> (without business graph specified) 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 generated against business services and integration components	<Prefix>+<Name of the Siebel Business Service> +"BG" (with business graph specified) and <Prefix>+<Name of the Siebel Business Service> (without business graph specified) 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.

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 generated for the Exists operation	<SiebelExistsResult> A business graph will not be generated for the "SiebelExistsResult" business object.
Name of the container business object 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>+"BG" The top-level business object will have a business graph generated.