Der Begriff API stammt aus dem englischen Sprachraum und ist die Kurzform von „Application Programming Interface“. Frei ins Deutsche übersetzt bedeutet dies so viel wie „Schnittstelle zur Anwendungsprogrammierung“.
Diese Schnittstelle besteht seit Version 6.20 des SAP® FrontEnd und wird mit diesem standardmäßig ausgeliefert. Über sie ist es möglich, auf alle Elemente der SAP® GUI zuzugreifen. Diese Elemente – im Programmierjargon „Objekte“ genannt – sind in einer entsprechenden API dokumentiert, welche in der Regel im Installationspfad von SAP® unter C:\Program Files (x86)\SAP\FrontEnd\SAPgui\SAPguihelp zu finden ist. Da dieses Dokument leider meist nur spärliche Beschreibungen und kaum Anwendungsbeispiele bietet, konzentriert sich die folgende Arbeit detailliert auf die wichtigsten Teile dieser API.
Inhaltsverzeichnis
- Einleitung
- Die Objekthierarchie in der SAP® GUI
- Die wichtigsten GUI Objekte, ihre Eigenschaften, Methoden und Events
- GuiApplication
- GuiConnection
- GuiSession
- GuiSessionInfo
- GuiMainWindow & GuiModal Window
- GuiButton
- GuiComponent
- GuiComponentCollection
- GuiGridView
- GuiTableControl
- Schluss
Zielsetzung und Themenschwerpunkte
Diese Arbeit zielt darauf ab, einen detaillierten Einblick in die SAP® GUI Scripting API zu geben. Sie konzentriert sich auf die wichtigsten Objekte, deren Eigenschaften, Methoden und Events, und erklärt deren hierarchische Struktur. Der Fokus liegt auf der praktischen Anwendung, da die vorhandene Dokumentation als spärlich beschrieben wird.
- Die hierarchische Struktur der SAP® GUI Objekte
- Die wichtigsten GUI Objekte (GuiApplication, GuiConnection, GuiSession, etc.)
- Eigenschaften, Methoden und Events der Schlüssel-Objekte
- Praktische Anwendung der API
- Zugriff auf Elemente der SAP® GUI
Zusammenfassung der Kapitel
Einleitung: Die Einleitung führt den Begriff der API (Application Programming Interface) ein und erklärt dessen Bedeutung als Schnittstelle zur Anwendungsprogrammierung im Kontext der SAP® GUI. Sie betont den Mangel an detaillierten Beschreibungen und Anwendungsbeispielen in der Standarddokumentation und kündigt eine detaillierte Auseinandersetzung mit den wichtigsten Teilen der API an, wobei auf die vorhandene, jedoch unzureichende, SAP-Dokumentation verwiesen wird.
Die Objekthierarchie in der SAP® GUI: Dieses Kapitel beschreibt die streng hierarchische Struktur der Top-Level-Objekte in der SAP® GUI, beginnend mit der GuiApplication als Einstiegspunkt zu den einzelnen SAP®-Systemen (GuiConnections). Es erläutert den Aufbau der Verbindungen (manuell oder über die GuiApplication-Methoden) und die Erstellung von GuiSessions. Die Kapitel erklärt die Rolle der GuiSessionInfo, GuiMainWindow und GuiModal Window und visualisiert die Hierarchie mit Abbildungen. Es wird herausgestellt, dass jede GuiSession ein GuiMainWindow enthält, welches die Interaktion mit der Instanz ermöglicht. Die visuellen Abgrenzungen der Top-Interface-Objekte eines GuiMain Windows werden ebenfalls beschrieben.
Schlüsselwörter
SAP® GUI Scripting API, Objekthierarchie, GuiApplication, GuiConnection, GuiSession, GuiSessionInfo, GuiMainWindow, GuiModal Window, Methoden, Events, Eigenschaften, Anwendungsprogrammierung, Schnittstelle.
SAP® GUI Scripting API: Häufig gestellte Fragen (FAQ)
Was ist der Inhalt dieses Dokuments?
Dieses Dokument bietet eine umfassende Übersicht über die SAP® GUI Scripting API. Es beinhaltet ein Inhaltsverzeichnis, die Zielsetzung und Themenschwerpunkte, Zusammenfassungen der Kapitel und Schlüsselwörter. Der Fokus liegt auf der detaillierten Erklärung der wichtigsten Objekte, ihrer Eigenschaften, Methoden und Events, sowie deren hierarchischen Struktur. Es wird die unzureichende Dokumentation der Standard-SAP-Dokumentation adressiert und eine praxisorientierte Anwendung der API vermittelt.
Welche Objekte werden in der SAP® GUI Scripting API behandelt?
Das Dokument behandelt die wichtigsten Objekte der SAP® GUI Scripting API, darunter: GuiApplication, GuiConnection, GuiSession, GuiSessionInfo, GuiMainWindow, GuiModal Window, GuiButton, GuiComponent, GuiComponentCollection, GuiGridView und GuiTableControl. Die hierarchischen Beziehungen zwischen diesen Objekten werden ausführlich erklärt.
Wie ist die Objekthierarchie in der SAP® GUI aufgebaut?
Die SAP® GUI Objekte sind streng hierarchisch aufgebaut. Die GuiApplication bildet den Ausgangspunkt, von dem aus Verbindungen zu SAP®-Systemen (GuiConnections) hergestellt werden. Jede Verbindung führt zu einer oder mehreren GuiSessions. Innerhalb einer GuiSession befindet sich ein GuiMainWindow, welches die Interaktion mit der SAP® GUI Instanz ermöglicht. Weitere Objekte wie GuiModal Window und andere Komponenten sind untergeordneten Objekten zugeordnet.
Welche Eigenschaften, Methoden und Events werden beschrieben?
Das Dokument beschreibt die Eigenschaften, Methoden und Events der wichtigsten GUI-Objekte. Die genaue Beschreibung der einzelnen Eigenschaften, Methoden und Events ist im Detail innerhalb der jeweiligen Kapitel zu finden. Der Fokus liegt auf der praktischen Anwendung dieser Elemente.
Woran orientiert sich die Erklärung der API?
Die Erklärung der API orientiert sich an der Praxisanwendung, da die vorhandene SAP-Dokumentation als unzureichend beschrieben wird. Das Dokument zielt darauf ab, die Lücken in der Standarddokumentation zu schließen und ein besseres Verständnis der API zu ermöglichen.
Welche Kapitel umfasst das Dokument?
Das Dokument umfasst die Kapitel "Einleitung", "Die Objekthierarchie in der SAP® GUI", und "Schluss". Das Kapitel "Die Objekthierarchie in der SAP® GUI" beschreibt detailliert die wichtigsten Objekte und deren hierarchische Beziehungen. Die Einleitung führt in die Thematik ein und der Schluss fasst die gewonnen Erkenntnisse zusammen. Jedes Kapitel enthält prägnante Zusammenfassungen.
Welche Schlüsselwörter sind relevant für die SAP® GUI Scripting API?
Die wichtigsten Schlüsselwörter sind: SAP® GUI Scripting API, Objekthierarchie, GuiApplication, GuiConnection, GuiSession, GuiSessionInfo, GuiMainWindow, GuiModal Window, Methoden, Events, Eigenschaften, Anwendungsprogrammierung, Schnittstelle.
Für wen ist dieses Dokument gedacht?
Dieses Dokument richtet sich an Entwickler und Anwender, die die SAP® GUI Scripting API verwenden möchten. Es ist besonders hilfreich für diejenigen, die Schwierigkeiten haben, die offizielle Dokumentation zu verstehen oder nach praktischen Anwendungsbeispielen suchen.
- Citation du texte
- Maximilian Selmair (Auteur), 2014, Einführung in die SAP® GUI Scripting API. GUI Objekte, Methoden und Events, Munich, GRIN Verlag, https://www.grin.com/document/294619
