Connector für OData - Daten anbieten - Dienst erstellen

Hier erfahren Sie, wie ein eigener OData-Service erstellt und konfiguriert werden kann.

Dazu wird eine einfache Kalenderapplikation verwendet, deren Termine per OData-Service angeboten werden. Die entsprechende Applikationsvorlage Sie in den Vorlagen & Lösungen, wenn Sie eine neue Applikation erstellen.

Um einen OData-Dienst zu erstellen, markieren Sie im Modul "Integration" unter dem Knoten "Daten anbieten" den Eintrag "Connector für OData". Wählen Sie dann das Hauptmenü "OData / Neuer Dienst" oder das entsprechende Kontextmenü.

Allgemeine Angaben

Tragen Sie hier den eindeutigen Name des Services ein. Für unser Beispiel verwenden wir hier den Namen "Kalender1".

Da der Name Teil des Service Endpoint-URLs ist, dürfen keine Sonderzeichen oder Leerzeichen verwendet werden.

Die Endpunkt-URL wird automatisch gebildet.

"Namespace" gibt den zu verwendenden Namensraum an, dem die OData-Collections und -Typen im Metadaten-Dokument zugeordnet werden sollen. Hier dürfen ebenfalls keine Leerzeichen oder Sonderzeichen verwendet werden. Für unser Beispiel verwenden wir auch hier den Namen "Kalender1".

Wenn gewünscht, kann eine Beschreibung des Dienstes erfasst werden. Sie haben auch die Möglichkeit, mit der Einstellung "Anonyme Anmeldungen" Daten ohne Login zur Verfügung zu stellen. Aktivieren Sie den Dienst mit Klick auf "Dienst ist aktiv".

Klicken Sie "Weiter".

Datengruppen

Hier werden die Entity-Types und Collections des OData-Services und deren Beziehungen definiert. Dazu werden Datengruppen aus der gewünschten Intrexx-Applikationen - in unserem Beispiel der Applikation "Kalender1" - ausgewählt. Jede Datengruppe stellt einen Entity-Type dar und steht automatisch als OData-Entity-Collection im Dienst zur Verfügung. Beziehungen zwischen Entity-Types werden in OData über sogenannte Association-Sets und Navigation-Properties abgebildet. Dabei können Eltern-Kind-Beziehungen und Referenzen ausgewählt werden, um diese als Navigation-Propertys in den jeweiligen Entity-Types zu definieren.

Klicken Sie auf "Datengruppe hinzufügen".

Auswahl der Datengruppe

Hier kann die gewünschte Applikation mit Datengruppe ausgewählt werden. Eine Datengruppe darf pro Service nur einmal hinzugefügt werden.

Klicken Sie "Weiter".

Eigenschaften der Datengruppe

"Typname" gibt den Namen des Entity-Types an, der die Beschreibung der Datengruppe abbildet. Der Name muss eindeutig sein und darf keine Sonder- oder Leerzeichen enthalten.

"Setname" gibt den Namen des Entity-Sets an, das für die Adressierung von Datensätzen aus der Datengruppe verwendet werden soll. Der Name muss eindeutig sein und darf keine Sonder- oder Leerzeichen enthalten.

"Maximale Anzahl Datensätze pro Abfrage" definiert eine maximale Anzahl von Datensätzen, die der Service bei einer Anfrage zurückliefert.

Mit den Einstellungen unter "Zugelassene Aktionen" können die erlaubten Aktionen definiert werden, die über einen OData-Service auf der Datengruppe ausgeführt werden dürfen.

Klicken Sie "Weiter".

Datenfelder auswählen

Alle Datenfelder, die Sie von der Liste "Verfügbar" in die Liste "Ausgewählt" verschieben, stehen später im Dienst zur Verfügung. Wählen Sie für unser Beispiel einfach alle Datenfelder aus.

"Datenfeld bearbeiten" öffnet einen Dialog, in dem die Feld-Eigenschaften bei Bedarf bearbeitet werden können.

Eigenschaften des Datenfeldes

Unter "Name" finden Sie den Namen des Datenfeldes im Entity-Type. Als Default wird der Intrexx-Datenfeldname verwendet. Der Name muss eindeutig sein und darf keine Sonder- oder Leerzeichen enthalten. Der Titel hingegen ist frei wählbar.

NULL-Wert zulassen

Erlaubt NULL Werte.

Einfügen zulassen

Erlaubt die Verwendung des Datenfeldes in POST (INSERT) Operationen.

Aktualisieren zulassen

Erlaubt die Verwendung des Datenfeldes in PUT (UPDATE) Operationen.

Klicken Sie "Fertig stellen".

Klicken Sie hier "Weiter".

Beziehungen und Referenzen zwischen Intrexx-Datengruppen werden in OData als Associations und Navigation-Propertys abgebildet. Dabei können 1:1 und 1:n Beziehungen definiert werden. Beziehungen mit m:n Kardinalität lassen sich über eine m:n Datengruppe abbilden. Associations definieren in OData die Beziehungen und deren Kardinalität zwischen Entity-Types. Navigation-Properties wiederum fügen den Entity-Types Properties hinzu, mit denen von einem Datensatz zu einem referenzierten Datensatz navigiert werden kann, ohne dass dem Entity-Type explizit die Foreign-Key bzw. Referenzdatenfelder hinzugefügt werden müssen. Hier werden die notwendigen Einstellungen getroffen. Nachdem die dem Service zur Verfügung stehenden Datengruppen ausgewählt wurden, können die Beziehungen zwischen diesen definiert werden.

Für unser Beispiel werden keine Beziehungen benötigt. Es soll im Folgenden dennoch kurz erklärt werden, wie Beziehungen konfiguriert werden können.

"Beziehung hinzufügen" öffnet einen Dialog, in dem Beziehungen ausgewählt werden können.

Auswahl einer Beziehung

Hier werden die Applikation und Datengruppe ausgewählt, deren Beziehungen definiert werden sollen. Das System erkennt automatisch die Beziehungen zu anderen Datengruppen und bietet diese hier zur Auswahl an. Dabei wird zwischen Referenzen und Eltern-Kind-Beziehungen unterschieden.

Klicken Sie "Weiter".

Eigenschaften der Beziehung

Quelle

Definiert die Quell-Applikation und -Datengruppe. "Name der Navigationseigenschaft" definiert die Navigation-Property, die dem Entity-Type für diese Beziehung hinzugefügt werden soll. Der Name darf keine Sonder- und Leerzeichen enthalten. Er sollte so gewählt werden, dass er auf die Ziel-Datengruppe verweist.

Ziel

Definiert die referenzierte Ziel-Applikation, -Datengruppe und -Referenz. "Name der Navigationseigenschaft" definiert den Namen der Navigation-Property, die dem Entity-Type für diese Beziehung hinzugefügt werden soll. Der Name darf keine Sonder- und Leerzeichen enthalten und sollte so gewählt werden, dass er auf die Quell-Datengruppe verweist.

Bidirektionale Beziehung

In der Regel werden Beziehungen immer als bidirektional definiert, so dass von beiden Seiten einer Datengruppe aus zur referenzierten Datengruppe navigiert werden kann. Soll dies nur von der Quell-Datengruppe aus möglich sein, kann eine unidirektionale Beziehung definiert werden. In dem Fall wird der Ziel-Datengruppe kein Navigation-Property hinzugefügt.

Klicken Sie "Fertig stellen", um Änderungen zu speichern und den Dialog wieder zu schließen.

Klicken Sie auch hier auf "Fertig stellen".

Die Datengruppenkonfiguration ist nun abgeschlossen.

Datengruppe entfernen

Entfernt die aktuell markierte Datengruppe.

Datengruppe bearbeiten

Öffnet die Eigenschaften der Datengruppe zur Bearbeitung.

Filter bearbeiten

Öffnet einen Dialog, In dem ein Filter für die aktuell markierte Datengruppe erstellt werden kann. Dieser globale Filter wird bei jeder OData-Abfrage auf die Datengruppe angewendet, unabhängig davon, ob bereits ein Filter in der OData-Abfrage definiert wurde, wobei in diesem Fall der globale Filter mit dem Abfragefilter kombiniert wird. Dadurch kann sichergestellt werden, dass grundsätzlich nur auf bestimmte Datensätze über einen OData-Service zugegriffen werden kann.

Klicken Sie "Weiter".