Providing Interface Descriptions

Use

Descriptive text, for example, short texts and texts on how to write help functions are very useful for using BAPI interfaces.

Various functions are provided that support SAP System users in carrying out the tasks required of them. For example, F1 help provides information on specific input fields.

F1 help should also be available to users who are working with data in an SAP System from an external program, via BAPI calls.

Features

Service BAPIs are provided that are used by external programs to call documentation and descriptions of BAPI interfaces.

·        BapiService.FieldHelpGetDocu()

This method reads the documentation (F1 help) for the fields in a BAPI parameter. Application developers can use this method to provide end-users with descriptions of fields in a BAPI parameter.

To ensure that F1 help for your BAPI can be called via the method BapiService.FieldHelpGetDocu(), data element documentation must be written for each parameter field in the BAPI. 

·        BapiService.InterfaceGetDocu()

This method reads the whole interface documentation for a BAPI. You can use this method to access the documentation on the business object type, method, parameters and parameter fields.

To support application developers with their work, the documentation on BAPI interfaces must be complete. For internal use SAP provides detailed guidelines on writing BAPI documentation. You can get a copy of the guidelines from your contact person in the BAPI Development group.

See the general Documentation Guidelines.

·        BapiService.MessageGetDetail()

This method returns the short and long texts of BAPI error messages.

To enable application developers to process BAPI error messages, you have to maintain the short and long error texts for the BAPI. You should follow the standard ABAP programming rules.

For information about these BAPIs see the relevant BAPI documentation.