Artikel-ID: 050619279

REST API-Methoden mithilfe von Excel & Swagger verwenden

Schlagwörter:  Administration  Webanwendung  Bedienung  Workflow

Problembeschreibung

Eine REST API zu verwenden erfordert in der Regel Kenntnisse in der Programmierung und ein Verständnis dafür wie eine REST API funktioniert. In diesem Dokument wird eine einfache Variante beschrieben, wie mit Hilfe von REST API-Methoden in Excel eine Administrationsübersicht (Dashboard) für den GBS Workflow Manager erstellt werden kann.

In diesem Anwendungsfall erzeugt der Administrator eine Übersicht über die Prozessinstanzen im GBS Workflow Manager.

Lösung

Die Excel-Datei, die hier zur beispielhaften Lösung erstellt wurde, nennt sich „Workflow Manager Administrator Dashboard“ und verwendet die REST API-Methoden mithilfe von Swagger direkt in Excel. Die Excel-Datei setzt sich aus drei Reitern zusammen die miteinander arbeiten. Der erste Reiter „Dashboard“ besitzt eine Übersicht die bestimmte Aussagen anhand der Pivot-Tabellen, aus dem zweiten Reiter visualisiert.

Workflow Manager Administrator Dashboard
Der zweite Reiter

Der zweite Reiter „Pivot Tabellen“, bezieht seine Informationen aus dem dritten Reiter „Daten“. Dieser dritte Reiter ist auch der wichtigste Reiter, da von hier aus auch der REST API-Aufruf gestartet wird. Es werden jedoch bestimmte Daten gefordert, um erfolgreich den REST API-Aufruf durchzuführen. Die benötigten Daten können z.B. die „URL des GBS Workflow Manager Server, Domänenname, Applikations- ID, Formularname & Benutzername“ sein. Dem Bild kann beispielhaft eine mögliche Abbildung des dritten Reiters entnommen werden.

Der zweite Reiter Pivot Tabellen

Im Konfigurationsbereich befinden sich zwei relevante Abschnitte, die auf der Abbildung mit einer roten und einer violetten Umrandung markiert wurden. Unter dem Konfigurationsbereich befindet sich der Datenbereich. Dieser definiert welche Daten geholt und welche Überschrift diese bekommen sollen. In der Abbildung ist dieser Bereich grün umrandet.

In der roten Umrandung befinden sich die Kerndaten damit jeder REST API-Aufruf weiß, welche Daten zu nutzen sind. Das Passwort des Benutzers wird nach dem Ausführen des „Importiere Daten“ Buttons abgefragt.

Die Daten werden anschließend geholt und unter dem Datenbereich in einer Tabelle gespeichert.

Die grüne Umrandung besitzt in Zeile 11 die Parameter, die aus der Applikation geholt werden sollen.  Bei diesen Parametern sollte darauf geachtet werden, dass diese auch korrekt geschrieben sind und die Groß- und Kleinschreibung beachtet wurde. Die darauffolgende Zeile ist der Titel und beschreibt wie die Daten anschließend in den Pivot-Diagrammen und Tabellen benannt werden.

Die Daten aus Zeile 11 sind nur beispielhaft und können je nach eigenem Bedarf angepasst werden. Es können Prinzipiell auch Workflow-spezifische Objekte geholt werden, diese müssen dann aber mit einem Backslash „\“ getrennt werden, damit die Daten auch richtig interpretiert werden können. Dies kann wie folgt aussehen: „bos\subject\value“. Dabei sollte jedoch beachtet werden, dass die Daten nach dem Begriff „bos\“ variieren können. Dies hängt davon ab, wie die Namen der Felder im GBS Workflow Manager und der übergebenen Form und Applikation gewählt wurden. In dem Beispiel gibt es also ein Feld das „subject“ heißt. Der Wert dieses Feldes wird aber mit dem Namen „value“ angesprochen, deswegen muss also nach dem Begriff „bos\“ noch zusätzlich „subject\value“ eingegeben werden.

Generell lassen sich auch andere Funktionen in diese Excel-Datei einpflegen. Jedoch sollten dann die entsprechenden URLs aus Swagger geholt und der beispielhafte Aufbau der vorhandenen Methoden beachten werden.

Sollte beim Aufruf der Swagger-URL ein Fehler „401“ auftreten, so sollte die „System.properties“-Datei vom GBS Workflow Manager Server auf fehlerhafte Werte kontrolliert werden. Es kann sein, dass die Parameter „security.allowSwaggerUI“ und „security.crossSiteRequestForgerySolution“ auf dem Wert „false“ stehen. Dies sollte dann auf den Wert „true“ geändert werden, damit es wieder funktioniert.

Die „System.properties“-Datei befindet sich standardmäßig im Pfad „wildfly-9.0.1.final\standalone\configuration\GBSWorkflowManager“. Der Pfad kann jedoch von Anwender zu Anwender variieren.

Standard Ansicht: So kann Swagger beim Anwender aussehen, wenn eine korrekte Konfiguration durchgeführt wurde.

Standard Ansicht

Zuletzt aktualisiert am 05.06.2019


« vorheriger Artikel

Wie bewerten Sie diesen Artikel?

0/5 Sterne (0 Stimmen)
REST API-Methoden mithilfe von Excel & Swagger verwenden 0 5 0

Ihr Kommentar

Zurück

Cookies erleichtern die Bereitstellung dieser Webseite. Mit der Nutzung dieser Webseite erklären Sie sich mit dem Einsatz von Cookies einverstanden. Mehr >>