Aufbau der Dokumentation und Konventionen
Konventionen im Überblick
Beachten Sie folgendes bei der Erstellung der BAPI-Dokumentation:
Kurztexte
Beachten Sie folgende Konventionen, wenn Sie Kurztexte im Function Builder anlegen:
Änderungsparameter enden meistens mit New, z.B. RequisitionItemsNew.
Änderungsparameter könnten Sie folgendermaßen dokumentieren:
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:
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:
Hyperlinks zum IMG
Um von der BAPI-Dokumentation auf einen Eintrag im IMG zu linken: