OData-Web-Schnittstellen

Information

• PLANTA project ermöglicht den Austausch von Daten mithilfe von OData.
• Hierfür werden Web-Schnittstellen verwendet.

Hinweise

• Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
  • generic_service = true
  • generic_service_interface und generic_service_port enthalten sinnvolle Daten
• Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.
• Web-Schnittstellen verwenden standardmäßig den Fully Qualified Domain Name (FQDN) als Adresse. Ist dieser nicht verfügbar, wird auf den Hostnamen der Maschine zurückgegriffen. Ist dieser nicht verfügbar, wird auf die IP der Maschine zurückgegriffen. Ein expliziter Hostname kann mit der Globalen Einstellung planta_link_hostname definiert werden.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

OData-Web-Schnittstellen aktivieren

Vorgehensweise

• Das Modul Web-Schnittstellen aufrufen.
• Die gewünschten OData-Schnittstellen öffnen.
• Die Checkbox Aktiv bei den gewünschten OData-Schnittstellen aktivieren.
  • Hierbei muss die Schnittstelle OData Test Service Root zwingend aktiviert werden.
  • Die Aktivierung weiterer Schnittstellen hängt von den gewünschten Datenquellen ab.
• Speichern.

Um alle OData-Schnittstellen einzusehen, kann über die Filterkriterien nach der Bezeichnung "odata*" gefiltert werden.

Hinweise

• Alle Requests werden standardmäßig über die Schnittstelle OData Test Service Root abgewickelt.
  • Ein eigener Root Service kann bei Bedarf eingerichtet werden.
  • Hierbei muss die Implementation ODataServiceImplementation als GET-Implementation hinterlegt werden.
  • Alle weiteren OData-Schnittstellen müssen dieselbe URL verwenden.
• Standardmäßig wird in Web-Schnittstellen ein API-Token zur Authentifizierung verwendet.
  • Hierfür muss zu Beginn im Modul API-Tokens verwalten ein API-Token generiert und der Root Service-Web-Schnittstelle zugeordnet werden.

Details

• Die UUIDs werden im Hintergrund automatisch vergeben und heißen immer <Entitätsbezeichnung>UUID.
• Über die Relation werden auch die Fremdschlüssel automatisch als UUIDs angelegt und heißen <Entitätsbezeichnung der Fremdtabelle>UUID.
• Die Felder, die in der OData-Schnittstelle enthalten sind, werden in der entsprechenden Web-Entität konfiguriert.

OData-Web-Schnittstellen konfigurieren

Details

• Im Modul Web-Entitäten können neue Web-Entitäten für OData-Web-Schnittstellen angelegt und bestehende Web-Entitäten angepasst werden.
• Als Implementation muss customizing.weblink.ODataWebEntity hinterlegt werden.
• Neue Dataitems können der Web-Entität wie gewohnt hinzugefügt werden.

Mehr Informationen zu Web-Entitäten

Beispiel: Daten aus OData in Excel aufrufen

Ziel

• Daten aus den OData-Web-Schnittstellen sollen in MS Excel angezeigt werden.

Vorbereitung

• Das Modul Web-Schnittstellen aufrufen.
• Die Checkbox Aktiv bei den OData-Schnittstellen OData Test Service Root und den gewünschten anderen Schnittstellen aktivieren.
• Speichern.

Vorgehensweise

• In MS Excel die Option Daten → Daten abrufen → Aus anderen Quellen → Aus OData-Datenfeed auswählen.
• Im Feld URL die Komplette URL aus der OData Test Service Root-Web-Schnittstelle einfügen.
  • Hierbei die Variablen innerhalb der URL entsprechend ausfüllen.
• Auf OK klicken.
• Im Navigator die gewünschten Daten auswählen und nach Bedarf weiterverarbeiten.