Funktionsbaustein-Dokumentation anlegen 

Vorgehensweise

Um die Dokumentation zu einem BAPI anzulegen:

  1. Melden Sie sich am entsprechenden Entwicklungssystem an und erzeugen Sie zwei Modi.

Geben Sie in einem Modus die Transaktion SE37 ein, um in den Function Builder zu gelangen. Hier erstellen Sie die Dokumentation.

Wählen Sie im zweiten Modus die Transaktion BAPI, um als Referenz im BAPI Explorer die Sicht auf das BAPI im BOR anzuzeigen. Öffnen Sie in der Baumanzeige das betreffende Business-Objekt, um dessen BAPIs anzuzeigen. Im Register Detail können Sie Detailinformationen zu jedem BAPI aufrufen.

Sollten Sie Ihr BAPI in dieser Sicht nicht finden, zeigen Sie über die Filter-Ikone "BAPIs nach Freigabestatus filtern" alle BAPIs an, oder verwenden Sie die Transaktion SWO1 und geben Sie den technischen Namen des Business-Objekts ein.

Die weiteren Schritte finden im Function Builder statt.
  1. Im Function Builder geben Sie den Namen des Funktionsbausteins ein, der dem BAPI zugrundeliegt. Funktionsbausteine von BAPIs fangen immer mit BAPI_ an.
  1. Wählen Sie Ändern.

Eine Tabelle mit den Schnittstellen-Parametern des BAPI-Funktionsbausteins wird angezeigt.

  1. Wählen Sie das Register Dokumentation.
  1. Legen Sie im ersten Feld Kurztext eine Beschreibung zu dem BAPI an, bzw. überprüfen Sie die existierende Beschreibung.

Der Kurztext soll eine stichwortartige Beschreibung der Methode sein und der Konvention <Objekt> <Funktion/Verb> entsprechen, zum Beispiel "Bestellanforderung anlegen". Dieser Text wird automatisch als Titel für die Funktionsbaustein-Dokumentation verwendet.

Diesen Text müssen Sie im BOR (Transaktion SWO1) über die entsprechende Funktion Springen -> Dokumentation nachziehen. Er wird dann im BAPI Explorer (Register Detail) und im BOR als Kurztext zu dem BAPI angezeigt.

  1. Wählen Sie anschließend die Taste Fbausteindokumentation, um die Dokumentation zum BAPI anzulegen. Verwenden Sie hierzu die unter Struktur der Funktionsbaustein-Dokumentation.angegebenen Richtlinien.
  1. Um das Dokument zu sichern, wählen Sie im Editor Dokument -> Sichern. Je nach Vollständigkeitsgrad des Dokuments können Sie eine Rohfassung oder eine aktive Fassung sichern. Damit das Dokument in die Übersetzungsschiene gelangt, müssen Sie das endgültige Dokument in aktiver Fassung sichern.
  1. Zeigen Sie nach dem aktiven Sichern die Dokumentation im BAPI Explorer an, um die Darstellung der Dokumentation im HTML-Format zu überprüfen. Machen Sie gegebenenfalls Formatierungsänderungen und sichern Sie die Dokumentation erneut in aktiver Fassung.

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