Webservice Datenquellen anlegen


Die Datenquellen-Eingabe-Maske öffnen sich, in der Sie als ersten Schritt die Webservice Datenquelle als „Typ“ auswählen können.

Vergeben Sie für die Datenquelle jedoch erst einen Namen, und enthält dieser das Wort „webservice“, so wird „Webservice“ schon als

Datenquellen-Typ vorgewählt. (Dies funktioniert mit allen Datenquellen-Typen)



Nachdem dies geschehen ist, passen sich die Datenquellen-spezifischen Einstellungen, der Webservice Datenquelle automatisch an.



Webservice Spezifisch:


Die Webservice Datenquelle dient zum Austausch von Informationen mit einem Webservice.

Daten müssen dabei im „JSON“, „XML“ oder „URLEncoded“-Format übertragen werden.



Lesen:



  • Anfrage Methode

Einige Webservices erwarten bestimmte Anfrage-Methoden zum Lesen von Daten.

Hier bestimmen Sie die Anfrage-Methode für das Lesen der Datenquelle.

Zur Verfügung stehen hier die Anfrage-Methoden „GET“ und „POST“.


  • URL

Die URL, die aufgerufen wird, um Daten vom Webservice zu lesen. 

Die Verwendung von Platzhaltern (siehe unten) ist zulässig.


  • Parameter

Zusätzliche Parameter, die zusammen mit der Leseanfrage an den Webservice übertragen werden sollen.

Unterstütze Format sind hier ebenfalls „JSON“, „XML“ und „URLEncoded“. Die Verwendung von Platzhaltern (siehe unten) ist zulässig.


Um das Eingabefeld zu vergrößern und somit besser schreiben zu können, verwenden Sie das Lupen-Icon neben dem Textfeld.




Schreiben:



  • Anfrage Methode

Einige Webservices erwarten bestimmte Anfrage-Methoden zum Schreiben von Daten. Hier bestimmen Sie die Anfrage-Methode für

das Schreiben der Datenquelle. Zur Verfügung stehen hier die Anfrage-Methoden „GET“, „POST“ und „PUT“.


  • URL

Die URL, die aufgerufen wird, um Daten an den Webservice zu senden (Schreiben von Variablen). Wird keine abweichende Schreib-URL angegeben,

wird die Lese-URL auch zum Schreiben aufgerufen. Die Verwendung von Platzhaltern (siehe unten) ist         zulässig.


Sollte es beim Verarbeiten der Daten im Webservice zu Problemen kommen, kann dies dem QuickHMI-System mitgeteilt werden,

sodass dieses eine entsprechende Fehlermeldung anzeigen kann. Dafür wird die Antwort des Servers in einem bestimmten Format erwartet.

Antwort-Beispiele in den 3 unterstützen Formaten finden Sie unten. Sobald die übertragene Quality von „GOOD“ abweicht,

wird in QuickHMI eine Fehlermeldung mit entsprechender Nachricht angezeigt.



  • Parameter

Parameter, die zusammen mit einer Schreibanfrage an den Webservice gesendet werden.

Durch die Verwendung von Platzhaltern (siehe unten) kann die zu schreibende Variable sowie der zu schreibende Wert übergeben werden.


Beispiele möglicher Parameter für die einzelnen Formate finden Sie unten.


Um das Eingabefeld zu vergrößern und somit besser schreiben zu können, verwenden Sie das Lupen-Icon neben dem Textfeld.






  • Headers

In diesem Bereich lassen sich http-Header definieren.




Mit dem Plus-Button lassen sich neue Headers anlegen. Dazu vergeben Sie einen Header-Namen und einen Header-Wert.

Sie können sowohl eigene Header anlegen als auch aus einer Vielzahl vorgegebener Standards auswählen.

Mehrere Header können mit „Hinzufügen“ angelegt und ebenso wieder gelöscht werden mit dem „X“.






Der Authorization Header:


Manche URLs erwarten beim Aufruf eine Authentifizierung via Benutzername und Passwort. Dazu dient der Authorization Header.

Wählt man diesen aus, erscheint ein Schlüssel Icon, welches ein neues Fenster öffnet. Hier lassen sich die Login Daten eingeben, die vom Server erwartet werden.

Nach der anschließenden Bestätigung mit „OK“, wird das Werte-Feld für den Header automatisch ausgefüllt. Der Inhalt für den Authorization Header kann also durch

die Eingabe von Benutzername und Passwort automatsch generiert werden. Dies ist jedoch optional und kann auch manuell ausgefüllt werden.





Platzhalter:



In den URL´s und Parametern können Platzhalter verwendet werden, um variablen-spezifische URL´s aufzurufen bzw. variablen-spezifische Parameter zu senden.


Zur Verfügung stehen folgende Platzhalter:


  • @var_name

Enthält den Namen der Variable im QuickHMI System.


  • @var_path

Enthält den Pfad innerhalb der „JSON“- oder „XML“-Struktur. Im Falle von „URLEncoded“-Daten ist lediglich der Key enthalten.


  • @var_value (Nur für Lese-Anfragen)

Enthält den zu schreibenden Wert.



Durch die Verwendung von Platzhaltern in der Lese-URL oder den Lese-Parametern, wird für jede Variable ein eigener Request an den Webserver gesendet.

Bei vielen Variablen kann die Verwendung von solchen Platzhaltern zu Performance-Einbüßen führen. Beim Schreiben gibt es diese Einschränkung nicht,

da hier sowieso für jede Variable ein einzelner Request gesendet wird, unabhängig von der Verwendung von Platzhaltern.



Nach Eingabe der für die Verbindung relevanten Informationen, klicken Sie auf „Hinzufügen“ bzw. auf „Speichern“,

nach der Bearbeitung einer bereits angelegten Datenquelle.




Die Webservice Datenquelle wird angelegt und nachfolgend in der Datenquellen - Übersicht angezeigt.



Angelegte Datenquellen, können bearbeitet oder auch wieder gelöscht werden. Dies tun Sie über die entsprechenden Buttons.

Zudem haben Sie die Möglichkeit, sich allen internen Datenquellen anzeigen zu lassen.

Dies funktioniert über die Aktivierung der Checkbox „Zeige interne Datenquellen“.


Nachfolgend können Sie Variablen für die Webservice Datenquelle anlegen.


Wie Sie für die Webservice Datenquelle Variablen hinzufügen, erfahren Sie im Kapitel „Webservice Variablen hinzufügen“.


>> Webservice Variablen hinzufügen