Bereitstellung von Schnittstellenbeschreibungen

Verwendung

Für die Benutzung der BAPI-Schnittstellen sind die beschreibenden Texte, z.B. Kurztexte und Texte für die Bereitstellung von Hilfefunktionen, von großem Nutzen.

Einem Benutzer des R/3-Systems stehen verschiedene Funktionen zur Verfügung, mit denen dieser Unterstützung in seiner Aufgabenstellung erhält. So werden ihm beispielsweise durch die F1-Eingabehilfe Informationen zu einem bestimmten Eingabefeld ausgegeben.

Eine derartige Hilfestellung sollte auch zur Verfügung stehen, wenn mit externen Programmen über den Aufruf von BAPIs mit dem R/3-System gearbeitet wird.

Funktionsumfang

Hierzu stehen folgende Service-BAPIs zur Verfügung, mit denen ein externes Programm die Dokumentation und Beschreibungen einer BAPI-Schnittstelle abrufen kann:

Diese Methode liest die Dokumentation (F1-Hilfe) zu den Feldern eines BAPI-Parameters. Mit Hilfe dieser Methode können Anwendungsentwickler ihren Endanwendern Beschreibungen zu den Feldern in einem BAPI-Parameter bereitstellen.

Um zu gewährleisten, daß über die Methode BapiService.FieldHelpGetDocu() F1-Hilfe zu Ihrem BAPI abgerufen werden kann, muß für jedes Parameterfeld in dem BAPI Datenelement-Dokumentation angelegt sein.

Diese Methode liest die gesamte Schnittstellendokumentation zu einem BAPI. Mit dieser Methode kann auf die Dokumentation zum Business-Objekttyp, zur Methode, zu den Parametern und den Parameterfeldern zugegriffen werden.

Um den Anwendungsentwickler bei seiner Aufgabe zu unterstützen, muß die BAPI-Schnittstelle vollständig dokumentiert sein. SAP-intern stehen für das Erstellen der BAPI-Dokumentation detaillierte Richtlinien zur Verfügung, die Sie von Ihrem Ansprechpartner in der BAPI-Entwicklung erhalten.

Allgemeine Dokumentationsrichtlinien finden Sie unter Dokumentationsrichtlinien.

Diese Methode gibt die Kurz- und Langtexte zu den Fehlermeldungen eines BAPIs zurück.

Um dem Anwendungsentwickler zu ermöglichen, angemessen auf Fehlermeldungen eines BAPIs zu reagieren, müssen Sie die entsprechenden Fehlerlangtexte und Fehlerkurztexte pflegen. Hier gelten die üblichen Regeln der ABAP-Programmierung.

Detaillierte Informationen zu diesen BAPIs finden Sie in der entsprechenden BAPI-Dokumentation.