Start of Content Area

Background documentation Conventions  Locate the document in its SAP Library structure

The following conventions apply to BAPI methods.

This graphic is explained in the accompanying text

If the BAPI to be implemented is a standardized BAPI, use the generic names, for example, GetList, GetDetail.
You should particularly note the difference between reading and writing methods and between simple and multiple methods.

This graphic is explained in the accompanying text

The method name must be in English (maximum 30 characters).

This graphic is explained in the accompanying text

The individual components of a BAPI name are separated by the use of upper and lower case.

Example: GetList.

This graphic is explained in the accompanying text

Underscores ("_") are not allowed in BAPI names.

This graphic is explained in the accompanying text

Each BAPI has a return parameter that is either an export parameter or an export table.

This graphic is explained in the accompanying text

So that customers can enhance BAPIs, each BAPI must have an ExtensionIn and an ExtensionOut parameter. See also: Customer Enhancement of BAPIs.

See also: Standardized BAPI.

 

The following conventions apply to parameters:

This graphic is explained in the accompanying text

Obligatory parameters should be checked to see if they can become optional in the future. This is important to avoid possible incompatible changes to the interface and to guarantee the stability of the interface.

This graphic is explained in the accompanying text

If standardized parameters are used, you have to use the names specified for standardized parameters.

This graphic is explained in the accompanying text

BAPI parameter names should be as meaningful as possible.
Poorly chosen names include abbreviations and technical names (e.g. "flag", table names, etc.).

This graphic is explained in the accompanying text

The parameter and field names must be in English with a maximum of 30 characters.

This graphic is explained in the accompanying text

The components of a parameter name in the BOR are separated by upper and lower case letters to make them easier to read.

Example : FlightList.

This graphic is explained in the accompanying text

Values that belong to each other semantically should be grouped together in one structured parameter, instead of using several scalar parameters.

This graphic is explained in the accompanying text

For ISO-relevant fields (country, language, unit of measure, currency), additional fields for ISO codes are provided.

Example

The CustomerData parameter of the FlightCustomer.CreateFromData method contains, in addition to the LANGU field (language key in SAP code), the LANGU_ISO field (language key in ISO code).

Note

For more information, see Actions in the ABAP Dictionary.

This graphic is explained in the accompanying text

Unit of measure fields must accompany all quantity fields and currency identifiers must accompany currency amount fields.

Example

See the FlightList parameter of the Flight.GetList method: In addition to the PRICE currency field (standard list price of the flight), there is also the CURR currency field (local currency of the airline).

See also: Standardized Parameters.