The external service wizard provides
names for the business objects for BAPIs, BAPI work unit, and BAPI
result sets. At its core, the business object name reflects the structure
of the business function on the SAP server.
BAPIs
When naming business objects for BAPIs, the external service wizard adds
a prefix of Sap then converts the name of the business
function to mixed case, removing any separators such as spaces or
underscores, capitalizes the first letter of each word and may add
an element-specific suffix (for example, BG for
business graph or Wrapper for top-level business
object).
The following table describes the
convention applied by the external service wizard when
naming BAPI business objects.
Table 1. Naming conventions
for BAPI business objectsElement |
Naming convention |
Name of the business graph |
Sap + Name of the wrapper object
you specify in the external service wizard +
BG
For example: SapSalesOrderBG
|
Name of the top-level business object |
Sap + Name of the wrapper object
you specify in the external service wizard +
Wrapper
For example: SapSalesOrderWrapper
|
Name of the BAPI business object |
Sap + Name of the BAPI interface
For
example: SapBapiSalesOrderCreateFromDat1
Note: The top-level object can contain more than one BAPI object.
|
Name of the child object |
Sap + Name of the Structure/Table
For
example: SapReturn
|
Note that business graph generation
is optional and is supported for IBM® Business Process Manager or WebSphere® Enterprise Service Bus only.
When
you select the Generate business
objects according to SAP naming conventions option in
the Specify the Discovery Properties window, the
adapter generates all the Business Object names same as that of the
SAP with original casing. This enables the elements (at child and
grand-child levels) which are complex type to appear in the SAP original
casing.
If
the module contains structures that have the same name, for example,
the
RETURN structure, the adapter handles Business
Object name duplication depending on the value specified for the
Enforce
the same naming convention for business objects EMD property.
The behaviour differs based on the selection in the following manner:
- If the Enforce the same naming convention for business
objects checkbox is checked, the adapter generates all
the Business Object name without appending any hashcode. The hashcode
is appended to the namespace of each Business Object instead of the
name.
Example: If the repeating structure
is RETURN, the adapter generates the corresponding
Business Object name SapReturn. If there are three
occurrences of the RETURN structure in the same module,
then all three Business Objects will have the name SapReturn.
- If the Enforce the same naming convention for business
objects checkbox is unchecked, the adapter appends the
hashcode to the subsequent Business Object that has the same name.
This is done to avoid duplication.
Example:
If the repeating structure is
RETURN, the adapter
generates the corresponding Business Object name
SapReturn.
If there are three occurrences of the
RETURN structure
in the same module,
- The first occurrence of the SapReturn Business
Object has the name SapReturn.
- The second occurrence of the SapReturn Business
Object has the name SapReturn203510914 where 203510914
is the hashcode of the String SapReturn.
- The third occurrence of the SapReturn Business
Object has name SapReturn619647890 where 619647890
is the hashcode of the String SapReturn203510914.
BAPI work unit
The following table describes
the convention applied by the external service wizard when
naming a BAPI work unit business object.
Table 2. Naming conventions
for BAPI work unit business objectsElement |
Naming convention |
Name of the business graph |
Sap + Name of the wrapper object
you specify in the external service wizard +
Txn + BG
For example: SapCustomerTxnBG
|
Name of the top-level business object
|
Sap + Name of the wrapper object
you specify in the external service wizard +
Txn
For example: SapCustomerTxn
|
Name of the BAPI business object |
Sap + Name of the BAPI interface
For
example: SapCustomer
|
Name of the child object |
Sap + Name of the Structure/Table
For
example: SapReturn
|
Note that business graph generation
is optional and is supported for IBM Business Process Manager or WebSphere Enterprise Service Bus only.
If
the module contains structures that have the same name, for example,
the
RETURN structure, the adapter handles Business
Object name duplication depending on the value specified for the
Enforce
the same naming convention for business objects EMD property.
The behaviour differs based on the selection in the following manner:
- If the Enforce the same naming convention for business
objects checkbox is checked, the adapter generates all
the Business Object name without appending any hashcode. The hashcode
is appended to the namespace of each Business Object instead of the
name.
Example: If the repeating structure
is RETURN, the adapter generates the corresponding
Business Object name SapReturn. If there are three
occurrences of the RETURN structure in the same module,
then all three Business Objects will have the name SapReturn.
- If the Enforce the same naming convention for business
objects checkbox is unchecked, the adapter appends the
hashcode to the subsequent Business Object that has the same name.
This is done to avoid duplication.
Example:
If the repeating structure is
RETURN, the adapter
generates the corresponding Business Object name
SapReturn.
If there are three occurrences of the
RETURN structure
in the same module,
- The first occurrence of the SapReturn Business
Object has the name SapReturn.
- The second occurrence of the SapReturn Business
Object has the name SapReturn203510914 where 203510914
is the hashcode of the String SapReturn.
- The third occurrence of the SapReturn Business
Object has name SapReturn619647890 where 619647890
is the hashcode of the String SapReturn203510914.
BAPI result sets
The following table describes
the convention applied by the external service wizard when
naming a BAPI result sets business object.
Table 3. Naming
conventions for BAPI result setsElement |
Naming convention |
Name of the top-level business object |
Sap + Name of the object you specify
in the external service wizard +
Resultset
For example: SapCustomerGetDetailResultset
|
Name of the result set BAPI business object |
Sap + Name of the BAPI interface
For
example: SapBapiCustomerGetDetail
|
Name of the child object |
Sap + Name of the Structure/Table
For
example: SapReturn
|
Name of the query business object |
Sap + Formatted name of the query
BAPI interface
For example: SapBapiCustomerGetList
|
If
the module contains structures that have the same name, for example,
the
RETURN structure, the adapter handles Business
Object name duplication depending on the value specified for the
Enforce
the same naming convention for business objects EMD property.
The behaviour differs based on the selection in the following manner:
- If the Enforce the same naming convention for business
objects checkbox is checked, the adapter generates all
the Business Object name without appending any hashcode. The hashcode
is appended to the namespace of each Business Object instead of the
name.
Example: If the repeating structure
is RETURN, the adapter generates the corresponding
Business Object name SapReturn. If there are three
occurrences of the RETURN structure in the same module,
then all three Business Objects will have the name SapReturn.
- If the Enforce the same naming convention for business
objects checkbox is unchecked, the adapter appends the
hashcode to the subsequent Business Object that has the same name.
This is done to avoid duplication.
Example:
If the repeating structure is
RETURN, the adapter
generates the corresponding Business Object name
SapReturn.
If there are three occurrences of the
RETURN structure
in the same module,
- The first occurrence of the SapReturn Business
Object has the name SapReturn.
- The second occurrence of the SapReturn Business
Object has the name SapReturn203510914 where 203510914
is the hashcode of the String SapReturn.
- The third occurrence of the SapReturn Business
Object has name SapReturn619647890 where 619647890
is the hashcode of the String SapReturn203510914.