Datenimporte in die imx.Platform

Datum: 10. November 2017
Autor: Tobias Pfannkuche


Aufgrund der kontinuierlich steigenden Anzahl externer Datenlieferanten bzw. der Anbindung von Schnittstellen im Rahmen von Datenimporten und damit verbundenen wiederkehrenden Fragen, hier eine Zusammenfassung der Kern-Anforderungen, um Daten von Drittanbietern in die imx.Platform zu übernehmen, sowie Grundfunktionalitäten für Datenimporte.

Anforderungen

Grundsätzlich sind folgende technischen Anforderungen einer Schnittstelle, die wir zwecks Datenübernahme/-import nutzen wollen, zu erfüllen:

  • Strukturiertes Datenformat (XML, JSON, CSV), idealerweise in UTF-8 Codierung
  • einheitliche Datentypen pro Feld
  • Pro Entität (s.u.) eine eindeutige, unveränderliche Fremd-ID
  • Anbindung mittels HTTP/REST-API (inkl. BasicAuth oder OAuth) oder FTP (Push oder Pull)

Daten-Entitäten

Die folgenden Daten-Entitäten können in die imx.Platform importiert werden. Für jeden Entitäts-Typ müssen von einem Datenlieferanten die beschriebenen Informationen bereitgestellt werden.

Stammdaten (Hotel, Unterkunft o.ä.) / Point Of Interest (POI)

  • Titel
  • Adressinformationen (PLZ, Ort)
  • optional: Beschreibungstext
  • optional: Geo-Informationen
  • optional für Stammdaten: Modul-Daten und Medien
  • optional: Typisierung (Spielstätte, Veranstalter)

Angebot

  • Titel
  • Preisinformationen (u.a. Preise von/bis/absolut; Preiseinheiten; kostenlos)
  • Verfügbarkeit (Datum von/bis)
  • optional: Beschreibungstext
  • optional: Modul-Daten und Medien

Veranstaltung

  • Titel
  • optional: Beschreibungstext
  • POI-Zuweisung (Spielstätte/Veranstalter); hier kann auch auf festgelegte, bereits existierende POIs zurückgegriffen werden („Fallback-POIs“)
  • Termin-Informationen
  • optional: Buchungsinformationen (global oder auf Termin-Basis)
  • optional: Mapping-Definitionen (Kategorien, Merkmale)
  • optional: Medien

Darüber hinaus gibt es noch weitere Datenfelder, die hier nicht aufgeführt sind und im Einzelfall analysiert und abgestimmt werden. Außerdem lassen sich auch einmalige Datenübernahmen von sogenannten „Basis-Entitäten“ umsetzen, wie Veranstaltungs-Kategorien, Betriebsarten, etc.

Im Idealfall wird vom Kunden in Zusammenarbeit mit dem Projektmanager bereits ein Feld-Mapping erstellt, welches als Arbeitsgrundlage für die technische Umsetzung der Datenübernahme dient.

Modul-Erweiterungen

Sowohl die Stammdaten als auch Veranstaltungen bieten die Möglichkeit von kundenspezifischen Erweiterungen (Module). Hier können je nach Anforderung und Datenlieferant spezialisierte Lösungen umgesetzt werden.

Mehrsprachigkeit

Werden über eine Datenquelle mehrsprachige Informationen geliefert (bspw. für Titel, Beschreibungstexte, o.ä.) so können diese je nach Setup der imx.Platform problemlos übernommen werden.

Import-Strategien

Es werden die folgenden Strategien für Datenimporte unterstützt:

  • nur neue Datensätze werden hinzugefügt, bestehende Datensätze bleiben unverändert
  • neue Datensätze werden hinzugefügt, bestehende Datensätze werden aktualisiert
  • neue Datensätze werden hinzugefügt, bestehende Datensätze werden aktualisiert, fehlende Datensätze einer Datenquelle werden deaktiviert. Hinweis: diese Import-Strategie ist nur dann sinnvoll, wenn eine Datenquelle immer ein vollständiges Set an Daten liefert!

Für die Aktualisierung von Datensätzen wird pro Daten-Importer definiert, welche Felder der zu aktualisierenden Entität vom Import überschrieben werden sollen und welche Felder unverändert bleiben. Es lassen sich bei Bedarf kundenspezifische Logiken umsetzen oder es kann Standard-Funktionalität genutzt werden. Die Definition von ausgewählten Feldern, deren Inhalte vom Import überschrieben werden, ist insbesondere dann sinnvoll, wenn von Kundenseite bei importierten Datensätzen Änderungen und/oder Anreicherungen stattfinden sollen.

Vollimport vs. Deltaimport

Um die Menge von Aktualisierungsoperationen zu minimieren und damit unnötige Datenbank-Updates zu vermeiden, gibt es die Möglichkeit, auf Basis eines Zeitstempels der letzten Änderungen eines Datensatzes an der Datenquelle (ChangeDate / lastModifiedDate) nur diejenigen Datensätze in der imx.Platform zu aktualisieren, die sich seit dem letzten Datenimport für einen gegebenen Datensatz geändert haben. Die Steuerung dieser Logik lässt sich mittels Konfigurations-Einstellungen umgehen, etwa wenn aus bestimmten Gründen nochmals ein Vollimport notwendig ist.

Standard-Datenimport

Sollte ein Datenlieferant keine verfügbare Schnittstelle vorliegen haben bzw. eine Neuentwicklung angestrebt werden, gibt es für den Import von Veranstaltungs- und POI-Daten (Spielstätte, Veranstalter) ein standardisiertes XML-Format, um Daten in die imx.Platform zu importieren. Mittels einer speziellen Administrations-Funktionalität in der imx.Platform können die sogenannten „Standard-Importer“ konfiguriert werden, für die Aktivierung muss lediglich für das jeweilige Kundenprojekt ein Cronjob eingerichtet werden.

Kommentare

Selber kommentieren:






Weitere Beiträge zum Thema Technologie


XML in JSON oder Arrays umwandeln in PHP

Autor: Stefan Oswald


Technologie


Ich bin heute über die mir bisher in diesem Ausmaß noch gar nicht bekannte Mächtigkeit der JSON-Funktionen von PHP gestolpert: Wie sich bei einer imx.Mapwork Anpassung herausgestellt hat, kann json_encode() so ziemlich alles als Parameter erhalten – einschließlich SimpleXMLElement. Der einzige Typ, der nicht verarbeitet werden kann, ist „resource“. Auf diese Art ist es sehr …


Beitrag lesen
08.
April
2014

OOP 2015 – Tag 2

Autor: Marc Kurzmann


Technologie // Über den Tellerrand


Heute mach ich’s ein wenig kürzer: Die erste Session war sehr technisch: „Bring Your Technology“; 5 „Gurus“ haben nacheinander jeweils ihre aktuell spannendste Technologie vorgestellt, mit der sie sich entweder intensiv beschäftigen, oder die sie zukünftig für sehr interessant halten. Folgende Technologien wurden dabei vorgestellt: Arduino (eine Art Mikrocontroller mit Open-Source-Layout, ideal im Zusammenhang mit …


Beitrag lesen
28.
Januar
2015

Integrationskomponente imxTools Tag 2.2.0 released

Autor: Bastian Schwarz


Technologie


Heute wurden von mir, mit Vorarbeit von Bastian die Services zur Abfrage des Schneeforums bereitgestellt. Es wird als Erweiterung dazu bald noch Object-Wrapper geben, die im Portal dann verwendet werden. Diese Wrapperobjekte erfüllen zwei Ziele. Zum einen bieten sie einige Shortcuts (auf z.B. i18N-Objekte) und schon Funktionalitäten um konstante Stringwerte auf portalspezifische Resource-Keys zu mappen …


Beitrag lesen
25.
Nov.
2011

bLazy.js

Autor: Benjamin Hofmann


Technologie // User Experience & Design


Und schon wieder eine kleine Standalone-Vanilla-JS-Library, die ich am Wochenende entdeckt habe: bLazy.js (GitHub, Demo) In dem ca. 1,5 KB Skript befindet sich die komplette Logik, um Bilder erst dann zu laden wenn sie im Viewport angezeigt werden. Und nicht nur Bilder, sondern auch I-Frames und andere Embeds können dynamisch nachgeladen werden. Und es funktioniert …


Beitrag lesen
26.
Sep.
2016