Anfang des Inhaltsbereichs

Vorgehensweisen Parameterdokumentation anlegen Dokument im Navigationsbaum lokalisieren

Vorgehensweise

Parameterdokumentation wird ebenfalls im Function Builder angelegt:

  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 Parameter-Dokumentation.

Wählen Sie im zweiten Modus die Transaktion BAPI, um als Referenz im BAPI Explorer die Sicht auf das BAPI im BOR anzuzeigen. Navigieren Sie in der Baumanzeige zu dem Business-Objekt, an dem das BAPI hängt, und öffnen Sie das BAPI. Die Parameter des BAPIs werden angezeigt.

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.
  1. Eine Tabelle mit allen Parametern des BAPI-Funktionsbausteins wird angezeigt.

Wenn Sie nun die Parameter-Sicht im Function Builder mit der im BAPI Explorer vergleichen, werden Sie vielleicht feststellen, daß im BAPI Explorer weniger Parameter für das BAPI angezeigt werden als im Function Builder.

Dies liegt daran, daß manche BAPIs die Schlüsselfelder ihres Business-Objekts verwenden. Diese sind im BOR zwar als Schlüsselfelder des Business-Objekts definiert, werden im BAPI-Funktionsbaustein aber als Parameter implementiert.

In der Baumanzeige im BAPI-Explorer werden die Schlüsselfelder eines Business-Objekts direkt vor den BAPIs angezeigt. Hier werden Sie die 'fehlenden' Parameter finden.

  1. Wählen Sie im Function Builder das Register Dokumentation.
  1. Geben Sie im Feld Kurztext Beschreibungen für die BAPI-Parameter ein, oder überprüfen Sie die existierenden Kurztexte. Die Kurztexte werden als Titel für die Parameter-Dokumentation verwendet. Beachten Sie hierzu die Konventionen, die unter Aufbau der Dokumentation und Konventionen aufgeführt sind.

Diese Kurztexte müssen Sie im BOR (Transaktion SWO1) über die entsprechende Funktion Springen -> Dokumentation nachziehen. Diese werden dann im BAPI Explorer (Register Detail) und im BOR als Beschreibungen zu dem Parameter angezeigt.

  1. Doppelklicken Sie anschließend auf den Parameternamen, um den Editor aufzurufen und den Parameter zu dokumentieren. Verwenden Sie hierzu die Richtlinien unter Struktur der Parameter-Dokumentation.
  1. Sichern Sie die Dokumentation abschließend in aktiver Fassung, um sicherzustellen, daß die Dokumentation zur Übersetzung gelangt.
  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.

Diese Grafik wird im zugehörigen Text erklärt

Beispiele finden Sie unter Beispiele für BAPI-Dokumentation.

Ende des Inhaltsbereichs