Entering content frame

Process documentationDetermining Details of BAPIs Locate the document in its SAP Library structure

Purpose

To use a BAPI, you have to determine the information you have to forward to call the BAPI or function in your application program.

Prerequisites

You can find this information in the BAPI Explorer or in the BAPI Browser.

The BAPI Explorer is available as of Release 4.6A and replaces the BAPI Browser used in earlier releases. The BAPI Explorer uses the latest HTML control technology. For this reason to work with the BAPI Explorer, you must be using a SAPgui of version 4.6A.

If you are using a SAPgui from an earlier release, the BAPI Browser is displayed instead of the BAPI Explorer.

Details of BAPIs of Business Object Types

The following information is required to use BAPIs of SAP business object types:

Note

Standardized parameters supply the same or equivalent data and can therefore be used in different BAPIs. These parameters have the same name in all BAPIs and are implemented using the same guidelines. For more information about these parameters see Standardized Parameters.

The key fields of SAP business object types specify the identification structure with which client programs can uniquely access a specific instance of the object type. The key fields are required if the BAPI is using specific instances of an object type. BAPIs are divided into these categories:

Instance-dependent BAPIs use specific instances of an object type, which the client application must specify in the key fields of the business object. An example of an instance-dependent BAPI is CompanyCode.GetDetail() and when used the client application must specify the company code ID, for example, GetSAPObject("CompanyCode","0001").

Instance-independent BAPIs do not use specific instances of an object type. They usually return a list of object type instances in tables to the calling program. Instance-independent BAPIs are also called class methods. The BAPI CompanyCode.GetList(), which returns a list of company codes, is an example of an instance-independent BAPI.

Some instance-independent BAPIs generate object instances and report back information on the generated object instance to the calling application. An example of this type of BAPI is SalesOrder.CreateFromData(), which creates a customer order and reports back information to the calling program.

Once you have retrieved all the required information, you can use the BAPI in your application program.

Details of BAPIs of Interface Types

The following information is required to use BAPIs of SAP business object types:

Once you have retrieved all the necessary information, you can implement the interface and use the BAPI in your application program.

Process Flow

Log on to an SAP System and choose Tools ® Business Framework ® BAPI Explorer, or call transaction BAPI (enter BAPI in the SAPgui command field).

If you are using a SAPgui of Release 4.6A or later, the BAPI Explorer will be displayed. For more information about using the BAPI Explorer see BAPI Explorer.

If you are using a SAPgui in a release earlier than 4.6A, the BAPI Browser appears instead of the BAPI Explorer. For further information see BAPI Browser.

Leaving content frame