Grundlagen (SAP-Bibliothek - Referenz zum BAPI-Programmierleitfaden (CA-BFA))

Grundlagen

Wo wird BAPI-Dokumentation angelegt?

Die BAPI-Dokumentation wird größtenteils im Function Builder an dem Funktionsbaustein angelegt, der dem BAPI zugrundeliegt. Die BAPI-Dokumentation muß jedoch - obwohl sie Funktionsbausteindokumentation ist - die Methode im BOR beschreiben. Dies liegt daran, daß der Anwendungsprogrammierer über den BAPI Explorer auf die Definition und Dokumentation des BAPIs im BOR zugreift.

Teile der BAPI-Dokumentation werden auch im BOR und im ABAP Dictionary angelegt.

Um dem Anwendungsentwickler die Informationen so bereitzustellen, wie er sie im BOR sucht und erwartet, müssen Sie bei der Dokumentationserstellung zu einem BAPI genau auf die hier beschriebenen Richtlinien achten.

Woraus besteht die BAPI-Dokumentation?

Die BAPI-Dokumentation setzt sich aus folgenden Bestandteilen zusammen. Diese können über das Register Dokumentation im BAPI Explorer angezeigt werden:

Dokumentation zur Methode selbst
Dies ist Dokumentation des Funktionsbausteins, der dem BAPI zugrundeliegt. Ziel dieser Dokumentation ist, daß der Benutzer weiß, was die Methode leistet und wie die Kommunikation mit einem externen Programm erfolgt.

Dokumentation zu den einzelnen Methoden-Parametern
Die Import-, Export- und Tabellenparameter definieren die BAPI-Schnittstelle, d.h. die R/3-Daten, die über die BAPI-Schnittstelle ausgetauscht werden. Ein Parameter kann sich auf eine Tabelle, eine Struktur oder ein einzelnes Feld beziehen.

Datenelement-Dokumentation zu jedem Feld, das in einem BAPI-Parameter verwendet wird
Teil der Datenelement-Dokumentation ist auch der englische Default-Feldname.

Zusätzlich hierzu muß weitere Dokumentation zur Verfügung stehen, um den vollständigen Kontext zu einem BAPI zu liefern (auch diese Dokumentation wird im BAPI Explorer angezeigt):

Dokumentation zu dem Business-Objekt, an dem das BAPI implementiert ist

Dokumentation zu den Schlüsselfeldern dieses Business-Objektes
Ein Schlüsselfeld identifiziert ein bestimmtes Vorkommen (z.B. "Material XYZ") eines Business-Objekts (z.B. "Material"). Viele BAPIs verwenden die Schlüsselfelder ihres Business-Objektes als Parameter in ihrer Schnittstelle.

Nur wenn all diese Dokumentationseinheiten existieren, erhält ein Anwendungsentwickler ein geschlossenes Bild über die Funktionalität des BAPIs.

Funktionsgruppen-Dokumentation ist für BAPIs nicht nötig.

Wo wird BAPI-Dokumentation angezeigt?

BAPI-Dokumentation steht im BAPI Explorer (Transaktion BAPI) unter dem Register Dokumentation, bzw. im Business Object Builder (Transaktion SWO1) zur Verfügung.

Beachten Sie, daß die Dokumentation im BAPI Explorer in HTML-Format angezeigt wird und die Formatierungskommandos aus SAPscript nicht notwendigerweise umgesetzt werden.

Wann wird BAPI-Dokumentation angelegt?

Bis auf folgende Empfehlung gibt es keine besonderen Richtlinien, wann Sie die BAPI-Dokumentation anlegen müssen:

Wenn Ihr Entwickler ein BAPI als Methode im BOR anlegt (mit dem BOR/BAPI Wizard), werden die beschreibenden Kurztexte für die Methode und die Parameter aus dem Function Builder/ABAP Dictionary gezogen und im BOR hart festgeschrieben. Dies bedeutet daß Sie, wenn Sie diese Texte anlegen bevor das BAPI mit dem BOR/BAPI Wizard als Methode im BOR definiert wird, die Kurztexte für die Methode und deren Parameter nur im Function Builder pflegen müssen.

Wenn Sie die Dokumentation jedoch anlegen/pflegen, nachdem der Entwickler die Methode im BOR mit dem BOR/BAPI Wizard angelegt hat, müssen Sie die Änderungen an den Kurztexten im Function Builder manuell im BOR nachziehen. In Zukunft soll ein dynamischer Abgleich der Kurztexte zwischen BOR und Function Builder möglich werden.

Bevor Sie beginnen, BAPI-Dokumentation zu schreiben

Bevor Sie beginnen, ein BAPI zu dokumentieren:

1.	Erfragen Sie die nötigen Informationen vom BAPI-Entwickler:
	Den Namen des Funktionsbausteins, auf dem das BAPI beruht, z.B. BAPI_REQUISITION_CREATE Den Namen und den technischen Namen des Business-Objekts, an dem das BAPI im BOR hängt (z.B. PurchaseRequisition, BUS2103)), und/oder den Pfad in der Anwendungshierarchie, in dem sich das Business-Objekt befindet (z.B. Materialwirtschaft -> Einkauf -> PurchaseRequisition) Den Namen des BAPIs im BOR, z.B. CreateFromData() Finden Sie heraus, ob der Entwickler eine neue Entwicklungsklasse für BAPIs angelegt hat. In diesem Fall ordnen Sie sich der neuen Entwicklungsklasse zu, damit Arbeitsvorräte erzeugt werden können. Die Übersetzung erfolgt im aktuellen Übersetzungssystem. Nicht übersetzte oder geänderte BAPI-Dokumentationen erscheinen in den Arbeitsvorräten der Übersetzer. Die Transportwege entsprechen dabei denjenigen der Oberflächendokumentation.
2.	Lesen Sie diesen Leitfaden und die Musterbeispiele.

Dokumentationssprache anders als Entwicklungssprache

Es ist möglich, daß Ihr BAPI in einer Sprache angelegt wurde, die nicht mit der Sprache übereinstimmt, in der Sie dokumentieren. Momentan ist es nicht möglich, Entwicklungs- und Dokumentationssprache voneinander zu entkoppeln, d.h. Sie müssen die Dokumentation in der Originalsprache des BAPIs anlegen. (Wenn Sie die Originalsprache für das BAPI ändern, müssen Sie die Sprache für die gesamte Funktionsgruppe ändern!)

In dieser Situation sollten Sie die BAPI-Dokumentation in einem beliebigen Editor anlegen. Geben Sie diesen Text zur Übersetzung in die Entwicklungssprache des BAPIs und tragen Sie die Übersetzung als eigentliche BAPI-Dokumentation ein.

Dies ist nur als Workaround zu sehen, an einer permanenten Lösung zu diesem Problem wird gearbeitet.

Siehe auch:

Funktionsbaustein-Dokumentation anlegen

Parameterdokumentation anlegen

Datenelement-Dokumentation überprüfen oder anlegen

Dokumentation zum Business-Objekt überprüfen oder anlegen