Anfang des Inhaltsbereichs

Hintergrunddokumentation Struktur der Funktionsbaustein-Dokumentation Dokument im Navigationsbaum lokalisieren

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.:

  • Berechtigungen, die als Voraussetzung für ein BAPI gelten
  • Wenn das BAPI ein COMMIT WORK-Kommando absetzt, dann müssen Sie dies hier explizit erwähnen, denn das ist die Ausnahme. Sie sollten den Entwickler danach fragen.
  • Wenn es sich um ein schreibendes BAPI mit Pufferung handelt, fügen Sie folgenden Satz hinzu: "Diese Methode arbeitet mit Pufferung. Dies bedeutet, daß in der gleichen LUW weitere, ändernde Methoden auf der(den) von dieser Methode erstellten/geänderten Instanz(en) ausgeführt werden können, ohne daß eine vorherige Verbuchung nötig ist." (Anmerkung an Dokuentwickler: bitte nicht zutreffendes löschen.)
  • Wenn es sich um ein lesendes BAPI handelt, das schreibende BAPIs mit Pufferung (s.o) berücksichtigt, fügen Sie folgenden Satz hinzu: "Diese Methode berücksichtigt Änderungen, die von erstellenden/verändernden BAPIs des gleichen Business-Objekttyps im Puffer durchgeführt wurden, jedoch noch nicht verbucht sind."
  • Customizing-Abhängigkeiten

Erstellen Sie Links zum IMG (siehe Hyperlinks zum IMG).

  • Abhängigkeiten zwischen den Parametern der Methode, z.B. zwischen welchen Parametern eine entweder/oder-Beziehung besteht
  • Situationen, in denen verwandte Methoden benutzt werden können
  • Abhängigkeiten zwischen diesem BAPI und anderen BAPIs
  • Konstellationen, die sich günstig oder ungünstig auf die Performance auswirken

Kundenerweiterungen:

Wenn Sie an der Schnittstelle Extension-Parameter für Kundenerweiterungen angelegt haben, fügen Sie folgende Standardsätze mit einem INCLUDE-Kommando ein:

  • Wenn nur ein ExtensionIn-Parameter angelegt wurde, fügen Sie folgenden Standardtext ein:
    "Das BAPI-Kundenerweiterungskozept ermöglicht es Kunden, zusätzliche Daten zu berücksichtigen, die an der Schnittstelle nicht vorgedacht wurden.
    Der Parameter ExtensionIn dient als Daten-Container, in dem die zusätzlichen Werte beim Import übergeben werden.
    Zusätzlich zu den Extension-Parametern an der Schnittstelle sind im BAPI-Funktionsbaustein BadIs (Business Add-Ins) bzw. Customer Exits vorgesehen, um die vom Kunden an die Methode übergebenen Daten zu prüfen, sowie weitere Verarbeitungen durchzuführen."
    Hierzu includieren Sie nacheinander die Standardsätze BAPI_CUST1, BAPI_CUST_IN und BAPI_CUST2, indem Sie links in der Formatspalte jeweils das Zeichen /: und in der entsprechenden Zeile im SAPscript-Editor das Kommando INCLUDE BAPI_CUST1, etc. einfügen.
  • Wenn ExtensionIn und ExtensionOut-Parameter an der Schnittstelle vorhanden sind, geben Sie folgenden Standardtext ein:
    "Das BAPI-Kundenerweiterungskozept ermöglicht es Kunden, zusätzliche Daten zu berücksichtigen, die an der Schnittstelle nicht vorgedacht wurden.
    Die Parameter ExtensionIn und ExtensionOut dienen als Daten-Container, in denen die zusätzlichen Werte beim Import bzw. Export übergeben werden.
    Zusätzlich zu den Extension-Parametern an der Schnittstelle sind im BAPI-Funktionsbaustein BadIs (Business Add-Ins) bzw. Customer Exits vorgesehen, um die vom Kunden an die Methode übergebenen Daten zu prüfen, sowie weitere Verarbeitungen durchzuführen."
    Hierzu stehen die drei INCLUDES BAPI_CUST1, BAPI_CUST_INOUT und BAPI_CUST2 zur Verfügung, die Sie wie im oben beschriebenen Fall einfügen.
  • Wenn Sie an der Schnittstelle BAPI Table Extensions vorgedacht haben, zählen Sie diese hier auf.

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>."

Hinweis

Beschreiben Sie in der Funktionsbaustein-Dokumentation keine Parameter. Die Dokumentation zu den einzelnen Parametern erstellen Sie in einem zweiten Schritt, der unter Parameterdokumentation anlegen beschrieben ist. Diese Parameter-Dokumentation wird dann automatisch per Hyperlink in die Funktionsbaustein-Dokumentation eingefügt.

Diese Grafik wird im zugehörigen Text erklärt

Ein Beispiel finden Sie unter Dokumentation zu einem BAPI-Funktionsbaustein.

Ende des Inhaltsbereichs