Um ein BAPI in einem Anwendungsprogramm zu verwenden, muß ein Anwendungsentwickler wissen:

• Welches BAPI die gewünschten Daten bereitstellt, d.h. Informationen zum Funktionsumfang des BAPIs.
• Wie das BAPI aufgerufen werden muß, d.h. aus welchen Parametern und Feldern die BAPI-Schnittstelle besteht.

Im Business Object Repository kann der Anwendungsentwickler auf die technischen Metadaten zu einem BAPI und auf dessen Dokumentation zugreifen.

Dieser Abschnitt enthält allgemeine Richtlinien für die Dokumentation von BAPIs. SAP-intern stehen detaillierte Dokumentationsrichtlinien zur Verfügung, die Sie von Ihrem Ansprechpartner in der BAPI-Entwicklung erhalten.

BAPIs sind betriebswirtschaftliche Schnittstellen zum R/3-System, für deren Verwendung keine tiefgreifende Kenntnis des R/3-Systems und der R/3-Entwicklungsumgebung vorausgesetzt wird.

Bei den Lesern von BAPI-Dokumentation handelt es sich oftmals nicht um R/3-Experten oder Anwendungsexperten.

Um Anwendungsentwicklern ein geschlossenes Bild über die Funktionalität eines BAPIs zu liefern, muß folgende Dokumentation bereitgestellt werden:

Legen Sie diese Dokumentation im Function Builder an dem Funktionsbaustein an, der dem BAPI zugrundeliegt. Ziel dieser Dokumentation ist darzulegen, was die Methode leistet und wie die Kommunikation mit einem externen Programm erfolgt. Sie soll als Entscheidungshilfe dienen, ob diese Methode zur Durchführung der Aufgabenstellung geeignet ist und sollte folgende Fragen beantworten:

• Was ist die betriebswirtschaftliche Funktionalität des BAPIs und dessen Einsatzmöglichkeiten?
• Was leisten die Funktionen des BAPIs im einzelnen?
• Liegen wichtige Einschränkungen vor, d.h. Funktionen, die man mit diesem BAPI nicht durchführen kann?
• Was ist bei der Verwendung dieser Methode besonders zu beachten, z.B. Berechtigungen, die als Voraussetzung für ein BAPI gelten?
• Welche Customizing-Abhängigkeiten existieren?
• Welche Abhängigkeiten existieren zwischen diesem BAPI und anderen BAPIs, und zwischen den einzelnen Methodenparametern?

Wenn das BAPI ein "COMMIT WORK"-Kommando absetzt oder mit Pufferung arbeitet, müssen Sie dies explizit dokumentieren.

Die Dokumentation zu den einzelnen Methoden-Parametern wird ebenfalls im Function Builder an dem entsprechenden Funktionsbaustein angelegt. Parameterdokumentation sollte folgende Fragen beantworten:

• Was ist die Bedeutung des Parameters?
• Welches Feld muß gefüllt sein, damit der Parameter als gefüllt gilt, d.h. welches sind die obligatorischen Felder?
• Welche Abhängigkeiten existieren zwischen den Feldern?
• Gibt es mögliche feste Werte und was ist deren Wirkung?
• Wie ist der Parameter vorbelegt? Alle Felder, die eventuell über das Customizing mit Default-Werten vorbelegt und daher schreibgeschützt sind, müssen entsprechend dokumentiert werden.
• Welche Rückgabewerte können direkt oder indirekt über den Parameter Return an die aufrufende Anwendung gelangen?

Um den vollständigen Kontext zu einem BAPI zu liefern, muß zusätzlich folgende Information zur Verfügung stehen:

• Dokumentation zu dem Business-Objekttyp, an dem das BAPI implementiert ist.
• Dokumentation zu den Schlüsselfeldern dieses Business-Objekttyps.