Standard naming conventions

The ALE Module requires its business objects to follow the naming conventions described in Table 23. SAPODA, which generates all but the control record business object, derives the business object and attribute names from the IDoc definition in accordance with these conventions.

Table 23. IBM WebSphere SAP business object naming conventions

IBM WebSphere business object or attribute Name Type
Parent wrapper business object BOprefix_BasicIDocType
Note:
The illustrations in this chapter use SAP_ or sap_ as the business object prefix. You can specify your own meaningful prefix when you create your business object definitions.
n/a
Control Record business object Control_record sap_idoccontrol
Data Record business object Data_record BOprefix_BasicIDocType_cwdata
Data Record child business object BOprefix_BasicIDocType_ IDocSegmentName BOprefix_BasicIDocType_ IDocSegmentName
Data Record attribute IDocFieldName or IDoc Field Description

When generating the BOs, the user has the choice to either choose IDoc segment field names or field descriptions as the BO attribute names.

Component names in the WebSphere business integration system support only alphanumeric characters and the underscore character (_). Therefore, when naming components in a generated business object definition, SAPODA replaces special characters in the IDoc segment field descriptions or field names with underscore characters. For example, SAPODA changes the spaces, parentheses, and periods in the following SAP description to underscores in the corresponding attribute name:

Partner function (e.g. sold-to party, ship-to party)
 

SAPODA represents the above description in the generated business object definition as:

Partner_function__e_g__sold_to_party__ship_to_party__ 
 

SAPODA guarantees that all attribute names in the business object definition are unique. If an IDoc has multiple fields with the same field descriptions, then SAPODA adds a counter suffix to the generated attribute name.

When naming an attribute, SAPODA prepends a string to the attribute name when the changed attribute name:

Important:
You can modify attribute names at any time after you generate the business object. However, when you modify an attribute name, do not modify its application-specific information. The connector uses this text to identify the IDoc field to which the business object attribute corresponds. For more information, see Application-specific information: Data record business object.

Copyright IBM Corp. 1997, 2003