!--a11y-->
Struktur der Funktionsbaustein-Dokumentation 
Bevor Sie ein BAPI dokumentieren, rufen Sie sich noch einmal ins Gedächtnis, daß BAPIs betriebswirtschaftliche (nicht technische!) Schnittstellen eines SAP-Systems sind, für die man keine tiefgreifende Kenntnis des SAP-Systems und der SAP-Entwicklungsumgebung benötigt. Bei vielen Lesern handelt es sich nicht um SAP-Experten oder Anwendungsexperten.
Die Funktionsbaustein-Dokumentation für BAPIs ist wie folgt strukturiert:
Keyblock |
Inhalt |
Funktionalität |
Was leistet die Methode im einzelnen? Geben Sie einen Überblick über die betriebswirtschaftliche Funktionalität des BAPIs und dessen Einsatzmöglichkeiten. Beschreiben Sie die Funktionen im einzelnen und geben Sie dem Anwender damit eine Entscheidungshilfe, ob diese Methode zur Durchführung seiner Arbeitsaufgabe geeignet ist oder nicht. Verwenden Sie hier ggf. Beispiele. Gibt es Funktionen, die man mit diesem BAPI nicht durchführen kann, so erwähnen Sie diese hier. Dieser Abschnitt enthält keine Informationen zur technischen Realisierung. |
Beispiele |
Schreiben Sie keine Dokumentation zu diesem Keyblock. Er ist für Coding-Beispiele gedacht. Diese sind jedoch plattformabhängig und veralten schnell. |
Hinweise |
Was ist bei der Verwendung dieser Methode besonders zu beachten? Beschreiben Sie hier u.a.:
Erstellen Sie Links zum IMG (siehe Hyperlinks zum IMG).
Kundenerweiterungen: Wenn Sie an der Schnittstelle Extension-Parameter für Kundenerweiterungen angelegt haben, fügen Sie folgende Standardsätze mit einem INCLUDE-Kommando ein:
Rückmeldungen Fügen Sie in diesen Abschnitt mit einem INCLUDE-Kommando einen Standardsatz wie folgt ein: "Geben Sie links in der Formatspalte die Zeichen /: und in der entsprechenden Zeile im SAPscript-Editor das Kommando INCLUDE.BAPI_REF ein." Dies fügt automatisch folgenden Standardsatz ein: "Meldungen werden im Parameter Return zurückgegeben. In dieser Parameter-Dokumentation finden Sie die Rückgabewerte und deren Bedeutungen." Für SAP-Interfacetypen fügen Sie folgende Information hinzu: "Dieses BAPI ist eine Methode zu einem Interfacetyp und stellt die Definition der standardisierten Schnittstelle zur Verfügung. Es wird von dem System implementiert, das dieses Interface anbieten möchte. Dem empfangenden System werden die Daten in der vom BAPI vorgegebenen Struktur übergeben. Das empfangende System muß dafür sorgen, daß diese Daten in die entsprechenden Datenbanktabellen eingetragen werden. Dies kann durch die Implementierung der von diesem BAPI definierten Schnittstelle erfolgen. " |
Weiterführende Informationen |
Verweisen Sie hier, wenn möglich, auf die Dokumentation zur Funktion im System. Diese Verweise sind wichtig für diejenigen, die nicht unbedingt mit dem System oder der spezifischen Anwendung vertraut sind. Verwenden Sie hierzu folgenden Standardsatz: "Weitere Informationen finden Sie in der SAP-Bibliothek unter <Titel>." |

Beschreiben Sie in der Funktionsbaustein-Dokumentation keine Parameter. Die Dokumentation zu den einzelnen Parametern erstellen Sie in einem zweiten Schritt, der unter

Ein Beispiel finden Sie unter