Writing Parameter Documentation 

Procedure

Parameter documentation is also written in the Function Builder:

  1. Logon to the appropriate development system, and create two sessions.

In one session, enter transaction SE37 to display the Function Builder. This is where you write the parameter documentation.

In the second session, enter the transaction BAPI to invoke the BAPI Explorer, and to display the BAPI in the BOR for reference. In the tree view, open the relevant business object and BAPI to display its parameters.

If you cannot find your BAPI in this view, display all BAPIs using the filter "Filter BAPIs according to release status", or start transaction SWO1 and enter the technical name of the business object.

The next steps are carried out in the Function Builder.
  1. In the Function Builder, enter the name of the function module the BAPI is based on. The names of function modules for BAPIs always begin with BAPI_ .
  1. Choose Change.
  1. A table containing all the parameters of the BAPI function module is displayed.

If you now compare the parameters in the Function Builder with the parameters in the BAPI Explorer, you may see that there are less parameters displayed in the BAPI Explorer than in the Function Builder.

This is because some BAPIs use the key fields of their business object. Although theses are defined as key fields of the business object in the BOR, they are actually implemented as parameters in the BAPI function module.

In the tree view of the BAPI Explorer, the key fields of a business object are displayed directly above the object’s BAPIs. This is where you will find the "missing" parameters.
  1. In the Function Builder, select the Documentation tab.
  1. Enter a description for the BAPI parameters in the Short text field, or check the existing description is correct. This short texts are used as the titles of the parameter documentation. Follow the naming conventions described in Documentation Structure and Writing Conventions.

You must then copy these short texts in the BOR (transaction SWO1) using the appropriate function Goto -> Documentation. They are then displayed in the BAPI Explorer (Detail tab) and the BOR as the short descriptions of the parameters.

  1. Double-click on the parameter name to open the editor and to document the parameter. Follow the guidelines in Structure of Parameter Documentation.
  1. When you have completed the final version, save the document as the active version. This ensures that the text will be added to the translator’s worklist.
  1. After you have saved the document as an active version, display it in the BAPI Explorer to check the formatting of the HTML display. Change the formatting if required, and when you are happy with the changes, again save the document as an active version.

Refer to Examples of BAPI Documentation.