Checking or Writing Data Element Documentation 

Use

Data element documentation must be written for all the fields of a BAPI parameter. This is because an end user (using a specially-implemented BAPI) can call F1 help for all of the fields of a BAPI. Moreover, field documentation can be viewed from the BAPI Explorer.

Procedure

To determine whether data elements have already been documented for the parameter fields, follow the steps below:

...

       1.      In the Function Builder, enter the name of the function module the BAPI is based on.

2.       Choose Display.

A table containing all the parameters of the BAPI function module is displayed.

3.       Select the appropriate tab "Import", "Export" or "Tables" to display the required parameter. Double-clicking on the field Reference field/Reference structure displays the ABAP Dictionary.

4.       For each field, double-click on the name of the data element in the column Component type.

5.       To display the data element documentation, choose Documentation.

6.       Select the Definition tab, and check under Attributes whether the default field name (in English) has been specified for the field.

If there is no existing documentation, or no English default field name has been specified, you must write it. Discuss the English default field name with your developer and possibly with your translator.

To write data element documentation, proceed as follows:

...

       1.      Choose Display <-> Change. First check the short text for the data element. The developer should have already written this. For key fields, this text is displayed as the description of the key field in the BAPI Explorer (Detail tab) and in the BOR.

2.       Choose Documentation to write the documentation.

3.       Save the documentation as the active version.

4.       Select the Definition tab, and specify the default field name in English.