OData ist das Akronym für Open Data Protocol. Dabei handelt es sich um ein HTTP-basiertes Protokoll für den Datenzugriff zwischen kompatiblen Softwaresystemen.
Bei OData wird der Aufbau, die Kommunikation und der Datenaustausch vollständig definiert. Es basiert auf den Vorteilen und Regeln von REST. Auch wenn die strikten Regeln nicht allen Entwicklern gefallen, so haben sie dennoch ihre Vorteile. Denn dadurch, dass die OData Schnittstellen immer gleich aufgebaut sind, hat man die Möglichkeit sie immer auf die gleiche Art anzusprechen und zu verwenden.
Filter
Mit der Abfrageoption $filter können Clients eine Sammlung von Ressourcen filtern, welche durch die URL an die Datenbank übergeben werden. Diese werden wohl den meisten bereits bekannt aus der SQL oder .NET Welt sein, nämlich: orderby, top, select, skip, format und filter. Auch unterstützt werden folgende Vergleiche: Contains, StartsWith, EndsWith. Ebenfalls Operationen wie Floor, Ceiling oder Round.
URL Aufbau
Über die URL lassen sich mit OData komplexe Datenbankabfragen ausführen. Für jede URL wird dabei eine der folgenden fixen Methoden verwendet: Get, GetAll, Add, Update oder Delete.
Beispiele:
Alle Anwender: http://host/service/User
Alle Anwender, sortiert nach Namen: http://host/service/User?$orderBy=Name
ID, Name und Geburtsdatum aller Anwender: http://host/service/User?$select=ID,Name,DateOfBirth
Alle Anwender, die Anna heißen: http://host/service/User?$filter=contains(Name,‘Anna‘)
Anwender mit der ID 27: http://host/service/User(27)?$select=Name
Der OData-Konnektor im Simplifier
Um einen OData Konnektor im Simplifier anzulegen, folgen Sie den folgenden drei Schritten:
Schritt 1
Wechseln Sie vom Simplifier Dashboard in die Kachel „Konnektoren“. Klicken Sie auf das Plus Symbol, um einen neuen Konnektor hinzuzufügen.
Es öffnet sich ein neues Fenster, in dem Sie den Konnektor Typ definieren müssen. Geben Sie hierfür einen einmaligen Namen an, und wählen Sie den Konnektor Typ, in diesem Fall „Connector OData“. Der Konnektor ist standardmäßig auf „Active“ gesetzt.
Geben Sie die Zeit, solange die Konnektor-Anfrage ausgeführt werden soll, in Sekunden an. Nach Ablauf dieser Zeit wird die Anfrage abgebrochen.
Zuletzt müssen Sie noch den Typ des Ergebnisses der Konnektor-Anfrage definieren. Dabei kann es sich entweder um ein „Einzelnes Ergebnis“ oder „Multi-Ergebnis“ handeln.
Schritt 2
Im zweiten Schritt können Sie entweder eine neue Anmeldemethode erstellen, oder eine bereits vorhandene auswählen. Um eine bereits existierende auszuwählen, klicken Sie auf das dazugehörige leere Feld auf der linken Seite. Wenn Sie eine neue Anmeldemethode erstellen, können Sie zwischen User Credentials und der Single-Sign-On Methode wählen.
Schritt 2 kann übersprungen werden, wenn keine Authentifizierung an der Backend-Schnittstelle erforderlich ist.
Schritt 3
Im dritten Schritt fügen Sie Daten zu Ihrem Konnektor hinzu. Dem OData Konnektor werden spezifische Daten via JSON hinzugefügt.
Mit Klick auf Überprüfen und speichern ist Ihr Konnektor erstellt und Sie können ihn über das Daten Objekt im Process Designer in Ihrer Applikation ansprechen. Wie Sie ein Daten Objekt im Process Designer generell ansprechen, können Sie hier nachsehen.