Aufbau der Dokumentation und Konventionen 

Konventionen im Überblick

Beachten Sie folgendes bei der Erstellung der BAPI-Dokumentation:

·        Verwenden Sie den Begriff “Methode” anstelle von “BAPI” oder “Funktionsbaustein”.

·        Verwenden Sie die Groß-/Kleinschreibung des Business-Objektes, des Methodennamens und der Parameternamen aus dem BAPI Explorer (z.B. "FlightBooking",  "CreateFromData", "BookingData").

·        Für einige Standardformulierungen sind allgemeine Texte angelegt, die Sie über ein INCLUDE-Kommando in Ihre Dokumentation einfügen können. Wie das funktioniert, ist in den jeweiligen Abschnitten beschrieben.

Kurztexte

Beachten Sie folgende Konventionen, wenn Sie Kurztexte im Function Builder anlegen:

·        Kurztexte für das BAPI

·        Diese sollten im Format "<Objekt> <Funktion/Verb>" sein, z.B. "Bestellanforderung anlegen".

·        Der Kurztext für Return-Parameter lautet "Rückmeldungen".

·        Kurztext für Änderungs-Parameter

Änderungsparameter enden meistens mit New, z.B. RequisitionItemsNew.

Änderungsparameter könnten Sie folgendermaßen dokumentieren:

¡        RequisitionItemsNew  ->  "Bestellanforderungsposition - Neuer Stand"

¡        RequisitionItemsNew ->  "Änderungen zu …" bzw. "Änderungen in …"

Formatierungshinweise

Vermeiden Sie komplexe Formatierungen in SAPscript. Diese werden zwar in SAPscript richtig angezeigt, oftmals können diese jedoch in der HTML-Anzeige nicht korrekt umgesetzt werden. Aus diesem Grund sollten Sie Ihre Dokumentation nach Fertigstellung auch immer im BAPI Explorer ansehen.

Wenn Sie Textzeilen tabellenartig ausrichten möchten, verwenden Sie die Formatzeichen PE.

Hierarchische Beziehungen in der BAPI-Dokumentation

Die Schnittstelle eines BAPIs besteht aus mehreren Parametern. Die Parameter wiederum können aus einem oder mehreren Feldern bestehen oder sich auf eine ganze Tabelle beziehen. Entsprechend dieser hierarchischen Beziehung besteht die BAPI-Dokumentation aus:

·        Dokumentation zur Methode

·        Dokumentation zu den Methoden-Parametern

·        Datenelement-Dokumentation zu den Datenelementen, die in Zusammenhang mit den Parametern stehen

Vervollständigt wird diese Dokumentation durch die Dokumentation zum Business-Objekt und zu seinen Schlüsselfeldern.

Es muß sichergestellt sein, daß Dokumentation zu allen obengenannten Bereichen vorliegt. Gleichzeitig darf diese Information nicht redundant vorliegen, d.h. es soll nicht in einer Dokumentation beschrieben werden, was an einer anderen Stelle schon beschrieben ist.

Um dieser Redundanz vorzubeugen und um dem Leser direkten Zugriff auf die Dokumentation der einzelnen Parameter zu geben, werden in die Funktionsbaustein-Dokumentation automatisch Hyperlinks zu der Dokumentation zu den Parametern erstellt. Von der Parameter-Dokumentation wiederum können Sie bei Bedarf auf die Datenelement-Dokumentation linken.

Die genauen Inhalte und die Struktur der einzelnen Dokumentationen werden unter Struktur der Funktionsbaustein-Dokumentation und unter Struktur der Parameter-Dokumentation beschrieben.

Hyperlinks auf andere Dokumentation

Um einen Hyperlink auf andere Dokumentation einzufügen, z.B. um auf ein anderes BAPI oder einen anderen Parameter zu verweisen:

...

       1.      Zeigen Sie den Funktionsbaustein des BAPIs, auf das sie verweisen möchten, in der Transaktion SE37 an.

2.       Um auf die Funktionsbaustein-Dokumentation zu verweisen, wählen Sie die Taste Fbausteindokumentation und kopieren Sie die oberste Zeile der Bildschirmanzeige, z.B: FU. FLBOOKING_CREATEFROMDATA.

3.       Um auf Parameter-Dokumentation zu verweisen, wählen Sie das Register Dokumentation und öffnen Sie mit Doppelklick auf den Kurztext die Parameterdokumentation. Kopieren Sie die oberste Zeile der Bildschirmanzeige (Leerzeichen mitkopieren!), z.B.: FU.BAPI_FLBOOKING_CREATEFROMDATA  BOOKING_DATA.

4.       Linken Sie auf die Dokumentation wie folgt:

¡        Parameter:
<DS:FU.BAPI_FLBOOKING_CREATEFROMDATA  BOOKING_DATA>Text</>

¡        BAPI:
<DS:FU.BAPI_FLBOOKING_CREATEFROMDATA>Flugbuchung anlegen</>

Hyperlinks zum IMG

Um von der BAPI-Dokumentation auf einen Eintrag im IMG zu linken:

...

       1.      Öffnen Sie den gewünschten IMG-Eintrag in einem anderen Modus.

2.       Wählen Sie hier Information -> Titel und Schlüssel.

3.       Kopieren Sie den Schlüssel für den Eintrag, z.B. SIMGSIMG_OLMA_OMJI.

4.       Wählen Sie im Function Builder-Modus in der BAPI-Dokumentation Einbinden -> Verweis und wählen Sie als Dokumentenklasse Kapitel des Einführungsleitfadens (SIMG).

5.       Geben Sie im ersten Eingabefeld den Schlüssel und im Feld darunter die Bezeichnung des Hyperlinks im BAPI-Dokument ein.