Anfang des Inhaltsbereichs

Vorgehensweisen Funktionsbausteine dokumentieren und freigeben  Dokument im Navigationsbaum lokalisieren

Funktionsbausteine werden im Function Builder dokumentiert. Dabei wird zwischen der Parameterdokumentation und einer ausführlichen Funktionsbausteindokumentation unterschieden.

Schnittstellendokumentation

Die Parameterdokumentation sollte Informationen zu den einzelnen Parametern und Ausnahmen enthalten.

  1. Verzweigen Sie in den Function Builder und geben Sie den Namen des zu dokumentierenden Funktionsbausteins an.
  2. Wählen Sie Auswahlknopf Schnittstelle.
  3. Führen Sie die Funktion Ändern aus.
  4. Lassen Sie sich die Teilsicht Dokumentation anzeigen.
    Sie erhalten eine Liste aller verwendeten Parameter und Ausnahmen.
  5. Geben Sie einen Kurztext für jeden Eintrag an.
  6. Sichern Sie Ihre Angaben.

Hinweis

Wenn Sie weitere Dokumentation zu einem Parameter oder einer Ausnahme hinterlegen wollen, dann führen Sie einen Doppelklick auf der entsprechenden Zeile in der Teilsicht Dokumentation aus.
Sie gelangen in die Pflege des Langtexts. Geben Sie den Langtext ein und sichern Sie ihn. Kehren Sie dann wieder zur Pflege des Funktionsbausteins zurück.

 

Funktionsbausteindokumentation

Die Funktionsbausteindokumentation enthält weitere Informationen zur Funktionalität, die der Funktionsbaustein zur Verfügung stellt.
Dieser Dokumentation kommt eine wesentliche Bedeutung zu. Da Funktionsbausteine für einen anwendungsübergreifenden Einsatz zur Verfügung gestellt werden, sollte die die in der Dokumentation enthaltene Information zur Funktionalität ausreichend sein, um so der Analyse des Quelltextes völlig zu entgehen.

So erstellen Sie diese Dokumentation:

  1. Verzweigen Sie in den Function Builder und geben Sie den zu dokumentierenden Funktionsbaustein an.
  2. Wählen Sie Auswahlknopf Schnittstelle.
  3. Führen Sie die Funktion Ändern aus.
  4. Wählen Sie die Funktion Fbausteindoku.
    Damit verzweigen Sie zu einem Editor, in dem eine ausführliche Dokumentation des Funktionsbausteins erfaßt werden kann.
    Es wird ein spezieller Editor, der SAP- Script- Editor aufgerufen, in dem zum einen Funktionalität erläutert wird, zum anderen aber auch Beispielaufrufe, Hinweise zur Verwendung und zu weiteren Informationsquellen eingegeben werden:

Diese Grafik wird im zugehörigen Text erklärt


Hinweis

Die Bedienung des SAP-Script-Editors unterscheidet sich beträchtlich von der des Programmeditors. Zum einen fällt die Belegung der Tasten und Menüs unterschiedlich aus, zum anderen kann das SAP-Script-Dokument mit einer speziellen Formatierung versehen werden. Weitere Informationen zur Bedienung des SAP-Script-Editors erhalten Sie unter Textverarbeitung mit dem SAPScript-Editor

5. Speichern Sie das Dokument ab.

Freigabeverfahren

Die Freigabe eines Funktionsbausteins ist eine rein verwaltungstechnische Angelegenheit, die sich in keiner Weise auf den Baustein oder seine Verwendbarkeit auswirkt. Wenn Sie davon überzeugt sind, daß ein Funktionsbaustein zur allgemeinen Benutzung geeignet ist, können Sie ihn im System freigeben. Die Freigabe einer Funktion bedeutet, daß der Entwickler den Baustein getestet hat.

Achtung

Bedenken Sie ferner, daß nach der Freigabe die Dokumentation des Funktionsbausteins im Arbeitsvorrat der Übersetzung erscheint. Die Freigabe sollte daher sorgfältig überlegt werden. Es empiehlt sich, den zuständigen Übersetzer rechtzeitig zu informieren.

In der Regel ist eine einzige Person für eine Funktionsgruppe verantwortlich und nur dieser Benutzer kann den Funktionsbaustein freigeben. Wer für eine Funktionsgruppe verantwortlich ist, erfahren Sie, indem Sie die Attribute einer Funktionsgruppe anzeigen. Teilen Sie daraufhin dieser Person mit, daß Ihr Funktionsbaustein freigegeben werden kann. Wenn Sie der Verantwortliche für die Funktionsgruppe sind, wählen Sie Funktionbaustein ® Freigabe ® Freigeben, um einen Funktionsbaustein freizugeben.

Die Freigabe von Funktionsbausteinen war ursprünglich nur für die SAP-Entwickler gedacht. Indem ein SAP-Entwickler eine Funktion freigibt, teilt er den anderen SAP-Entwicklern mit, daß sie diese Funktion ohne Bedenken verwenden können. SAP-Entwickler können Ihre Funktionen auch für Kunden freigeben. Wenn Sie eine freigegebene SAP-Funktion aufrufen, können Sie davon ausgehen, daß SAP die Funktionsschnittstelle in zukünftigen Software-Releases nur rückwärts-kompatibel ändern wird.