Formularschnittstelle definieren 

Verwendung

Sie definieren die Formularschnittstelle, um Daten aus Ihrer Anwendung an das Formular zu übergeben.

Integration

Die Formularschnittstelle ist ein Teil des Formularobjektes Schnittstelle und wird im Form Builder definiert. Die Formularschnittstelle eines Formulars ist gleich aufgebaut wie die Schnittstelle eines Funktionsbausteines im System. Jedoch unterstützt die Formularschnittstelle keine Changing-Parameter.

Voraussetzungen

·        Sie haben ein Formularobjekt Schnittstelle angelegt.

·        Im Anwendungsprogramm werden die Daten bereitgestellt, die Sie im Formular einbinden wollen. Die Typen der zugehörigen Variablen sind Ihnen also bekannt.

Die Semantik der zugelassenen Parameterarten stimmt mit der eines Funktionsbausteins überein.

Siehe dazu:

Informationen über Schnittstellenparameter anzeigen

Übersicht über Funktionsbausteine (aus ABAP Workbench: Werkzeuge)

Funktionsbausteine anlegen (aus ABAP Programmierung (BC-ABA)).

Vorgehensweise

...

       1.      Öffnen Sie die gewünschte Schnittstelle im Repository Browser der ABAP Workbench.

       2.      Sie befinden sich auf der Registerkarte Schnittstelle. Doppelklicken Sie auf den Knoten Formularschnittstelle → Import.

       3.      Sie erhalten das Bild zur Eingabe der Importparameter, welches auch den Standardparameter /1BCDWB/DOCPARAMS anzeigt. Dieser kann nicht geändert werden.

Sie verwenden diesen Parameter in Ihrem Anwendungsprogramm, um z. B. den Wert für die Spracheinstellung zu übergeben. Durch Doppelklicken auf den Typ SFPDOCPARAMS wird Ihnen diese Struktur im ABAP Dictionary angezeigt.

       4.      XML-Schema-basierte Schnittstelle:

¡        Der Standardparameter /1BCDWB/DOCXML vom Typ XSTRING ist für die Übergabe der Daten aus dem Anwendungsprogramm vorgesehen.

ABAP-basierte oder Smart-Forms-kompatible Schnittstelle:

¡        Wählen Sie Zeile einfügen (), um eine neue Zeile einzufügen. Tragen Sie die Parameternamen für die zu übergebenden Daten ein. Die Namen sind im ganzen Formular gültig und müssen nicht den Variablennamen im Datenbeschaffungsprogramm entsprechen. Es sind beliebige Datentypen zugelassen. Unter Typisierung ist als Auswahl TYPE zugelassen.

       5.      Wenn Sie auf Export doppelklicken, wird Ihnen der Standardparameter /1BCDWB/FORMOUTPUT des generierten Funktionsbausteines angezeigt. Dieser kann nicht geändert werden.

Sie verwenden diesen Parameter in Ihrem Anwendungsprogramm, um z.B. das generierte Formular als PDF zur weiteren Verarbeitung zu erhalten.

       6.      Doppelklicken Sie auf Ausnahmen, um die vom generierten Funktionsbaustein verwendeten Ausnahmen anzuzeigen.

       7.      Aktivieren Sie die Schnittstelle.

Die Parameter müssen zur Laufzeit vom Anwendungsprogramm bereitgestellt werden. Die Formularausgabe endet mit einem Programmabbruch (Hex-Dump), wenn ein Parameter im Formular definiert wurde, nicht aber beim Aufruf im Anwendungsprogramm.

Umgekehrt ist es jedoch möglich, dass im Anwendungsprogramm Parameter bereitgestellt werden, die im Formular nicht gebraucht werden. Sie müssen diese im Formular nicht erwähnen, auch die Reihenfolge der Nennung kann eine andere als im Code des Anwendungsprogramms sein. Der Vorteil dabei ist, dass ein Anwendungsprogramm mehrere Formulare bedienen kann.

Migrierte Smart-Forms-Schnittstelle oder neue zu Smart Forms kompatible Schnittstelle

Wenn Sie die Schnittstelle eines migrierten Smart Forms oder eine neue zu Smart Forms kompatible Schnittstelle bearbeiten, erhalten Sie mit Tabellen einen weiteren Parameter. Das System stellt Ihnen außerdem für Import, Export und Ausnahmen die aus Smart Forms bekannten Standardparameter zur Verfügung.

Bei einer Smart-Forms-kompatiblen Schnittstelle können Sie das vorhandene Anwendungsprogramm des entsprechenden Smart Forms ohne Änderung wieder verwenden. (Siehe auch Abschnitt „Laufzeit umschalten“ unter Migration von Smart-Forms-Formularen)

Ergebnis

Sie haben die Formularschnittstelle definiert und können die angegebenen Parameternamen im Formularkontext verwenden.