Start of Content Area

Function documentation Documenting the BAPI  Locate the document in its SAP Library structure

Principles

The quality of your BAPI documentation depends on the following principle:

The documentation must be in sufficient detail so that an external developer familiar with the business background but not with the SAP System, can use the BAPI.

Features

The documentation for the BAPI covers four areas:

1.

The SAP business object type documentation.

2.

The method documentation should answer the following questions:

This graphic is explained in the accompanying text

What is the business function of the BAPI and what is it used for?

This graphic is explained in the accompanying text

What do the BAPI functions actually do?

This graphic is explained in the accompanying text

Are there any important limitations, that is, are there functions that this BAPI cannot perform?

This graphic is explained in the accompanying text

What must you pay particular attention to with this BAPI? (e.g. authorization checks)
What other prerequisites apply to the BAPI?

This graphic is explained in the accompanying text

Are there any Customizing dependencies?

This graphic is explained in the accompanying text

What dependencies are there between this BAPI and other BAPIs, and between individual method parameters?

This graphic is explained in the accompanying text

Is it a BAPI with buffering?

If it is, the BAPI must be explicitly identified as such.

This graphic is explained in the accompanying text

Does the BAPI contain a COMMIT WORK command?

If it does, it must be documented.

3.

The BAPI parameter documentation answers the following questions:

This graphic is explained in the accompanying text

What is the parameter used for?

This graphic is explained in the accompanying text

Which fields of a parameter must be filled, that is, what are the mandatory fields?

This graphic is explained in the accompanying text

What are the dependencies between fields?
Are there parameter dependencies and field dependencies within a structure?

This graphic is explained in the accompanying text

Are there any fixed values and what do they do?

This graphic is explained in the accompanying text

What are the default values of the parameter?
All the fields that are assigned default values by Customizing and are therefore write-protected, must be documented.

This graphic is explained in the accompanying text

Does the documentation of the return parameter comply with the guidelines and does it contain all the relevant error messages?

This graphic is explained in the accompanying text

If there is a termination, is a database rollback executed as an exception within the BAPI?

If it is, you must describe this process in the documentation for the return parameter.

This graphic is explained in the accompanying text

Are all the available BAPI table extensions listed in the documentation on the extension parameters (ExtensionIn, ExtensionOut)?

4.

Data element documentation underlying the fields in the BAPI parameters

Note

Finally, you must also make sure that the documentation about the function modules and parameters has been saved by the documentation developer as an active version so that it appears in the translator's worklist.

Example

Refer to Examples of BAPI Documentation. See also the documentation about the demo business object types Flight, FlightBooking, and FlightCustomer, and the corresponding BAPI methods.