Naming conventions for BAPI business objects
The Adapter Connection wizard provides
names for the business objects for BAPIs, BAPI work units, and BAPI
result sets. The business object name reflects the structure of the
business function on the SAP server.
BAPIs
When it names business objects for BAPIs, the Adapter Connection wizard adds
the prefix Sap. The wizard also 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 it can add an element-specific suffix (for example, Wrapper for
a top-level business object).
The following
table describes the convention that is applied by the Adapter Connection wizard when
it names BAPI business objects.
Table 1. Naming conventions
for BAPI business objectsElement |
Naming convention |
Name of the top-level business object |
Sap + Name of the wrapper object
that you specify in the Adapter Connection wizard + Wrapper For
example: SapSalesOrderWrapper
|
Name of the BAPI business object |
Sap + Name of the BAPI interface For
example: SapBapiSalesOrderCreateFromDat1
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
|
When
you select Generate business objects according to SAP PI
naming conventions in the Specify the Discovery
Properties pane of the wizard, the adapter generates all
the business object names in the same case in which they appear in
the SAP application. This naming convention enables elements with
a complex type to match the case used by SAP.
If
the module contains structures that have the same name (for example,
the
RETURN structure), the adapter handles business
object name duplication according to the value specified for the
Enforce
the same naming convention for business objects property.
- If Enforce the same naming convention for business
objects is selected, the adapter generates the business
object name without appending a hash code. The hash code is appended
to the namespace of each business object instead of the name.
For
example: If the repeating structure is RETURN, the
adapter generates the corresponding business object name SapReturn.
If three occurrences of the RETURN structure exist
in the same module, all three business objects have the name SapReturn.
- If Enforce the same naming convention for business
objects is cleared, the adapter appends the hash code
to the subsequent business object that has the same name to avoid
duplication.
For example: If the repeating structure is
RETURN,
the adapter generates the corresponding business object name
SapReturn.
If three occurrences of the
RETURN structure exist
in the same module, the following behavior occurs:
- 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 hash code of the string SapReturn.
- The third occurrence of the SapReturn business
object has the name SapReturn619647890, where 619647890
is the hash code of the string SapReturn203510914.
BAPI work units
The following table describes
the convention that is applied by the Adapter Connection wizard when
it names a BAPI work unit business object.
Table 2. Naming
conventions for BAPI unit of work business objectsElement |
Naming convention |
Name of the top-level business object |
Sap + Name of the wrapper object
that you specify in the Adapter Connection 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
|
If
the module contains structures that have the same name (for example,
the
RETURN structure), the adapter handles business
object name duplication according to the value specified for the
Enforce
the same naming convention for business objects property.
- If Enforce the same naming convention for business
objects is selected, the adapter generates the business
object name without appending a hash code. The hash code is appended
to the namespace of each business object instead of the name.
For
example: If the repeating structure is RETURN, the
adapter generates the corresponding business object name SapReturn.
If three occurrences of the RETURN structure exist
in the same module, all three business objects have the name SapReturn.
- If Enforce the same naming convention for business
objects is cleared, the adapter appends the hash code
to the subsequent business object that has the same name to avoid
duplication.
For example: If the repeating structure is
RETURN,
the adapter generates the corresponding business object name
SapReturn.
If three occurrences of the
RETURN structure exist
in the same module, the following behavior occurs:
- 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 hash code of the string SapReturn.
- The third occurrence of the SapReturn business
object has the name SapReturn619647890, where 619647890
is the hash code of the string SapReturn203510914.
BAPI result sets
The following table describes
the convention that is applied by the Adapter Connection wizard when
it names 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 Adapter Connection 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 according to the value specified for the
Enforce
the same naming convention for business objects property.
- If Enforce the same naming convention for business
objects is selected, the adapter generates the business
object name without appending a hash code. The hash code is appended
to the namespace of each business object instead of the name.
For
example: If the repeating structure is RETURN, the
adapter generates the corresponding business object name SapReturn.
If three occurrences of the RETURN structure exist
in the same module, all three business objects have the name SapReturn.
- If Enforce the same naming convention for business
objects is cleared, the adapter appends the hash code
to the subsequent business object that has the same name to avoid
duplication.
For example: If the repeating structure is
RETURN,
the adapter generates the corresponding business object name
SapReturn.
If three occurrences of the
RETURN structure exist
in the same module, the following behavior occurs:
- 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 hash code of the string SapReturn.
- The third occurrence of the SapReturn business
object has the name SapReturn619647890, where 619647890
is the hash code of the string SapReturn203510914.