Import


Eine XML-Schnittstelle kann sämtliche per Lobster Data Platform / Orchestration verwalteten Entitäten ausgehend von Profilen Erstellen, Ändern oder Löschen.

Unabhängig vom Charakter der auszuführenden Aktion wird der Vorgang als Import bezeichnet. Grundsätzlich stehen zwei unterschiedliche Importmethoden zur Auswahl, die allerdings technisch eng verwandt sind:

  • Der Single-Import ermöglicht den Import genau einer einzelnen Entität.

  • Der Batch-Import ermöglicht den Import mehrerer Entitäten als Serie von eigenständigen "Single-Transaktionen" (ähnlich zur Ausführung eines Single-Import für jede einzelne Entität) oder einer gemeinsamen "Batch-Transaktion", die alle Entitäten beinhaltet.

HINWEIS◄ Da der Batch-Import die Funktionalitäten des Single-Import komplett und in Kombination mit zusätzlichen Funktionalitäten (z. B. zur Fehlerbehandlung) unterstützt, ist es kein Nachteil grundsätzlich immer den Batch-Import einzusetzen, auch wenn nur einzelne Datenobjekte importiert werden sollen.

XSD-Dateien für sämtliche Entitätstypen der Lobster Data Platform stellt das System per Unterseite "./system/schema/all" relativ zur für die Anmeldung verwendeten URL bereit.

Zu den dort definierten XML-Strukturen sind konforme Orchestration-Vorlagen für die betreffenden Datenstrukturen verüfgbar, die zum Aufbau von Quell- und Zielstrukturen in Profilen genutzt werden können.

Auch für die Importstrukturen für Single-Import (core:Import) oder Batch-Import (core:BatchImport) stehen Orchestration-Vorlagen bereit.

Die folgenden Abschnitte beschreiben das allgemeine Zusammenspiel von Lobster Data Platform / Integration und Lobster Data Platform / Orchestration für den Import.

Weiterführende Informationen zum Import:

Konfiguration eines Import-Profils

Die folgende Liste beschreibt die typischen Verarbeitungsschritte für ein Importprofil:

  • Phase 1: Der Eingangsagent ordnet dem Profil die Eingangsdaten zur Verarbeitung zu.


  • Phase 2: Der Parser überträgt das Format der Eingangsdaten in die für das Profil definierte "Quellstruktur".


  • Phase 3: Die geparsten Quelldaten werden per Mapping in eine Zielstruktur übertragen, die dem XML-Importformat von Lobster Data Platform / Orchestration entspricht. Diese Importstruktur beinhaltet neben Kopfdaten für den Importprozess die notwendigen Detaildaten der zu manipulierenden Entitäten.


  • Phase 5: Die Integration Unit (kurz: "IU") formatiert die erzeugten "Zieldaten" für die Ausgabe. Für den Import per XML-Datei kommt dabei in der Regel der IU-Typ XMLNoTemplateUnit zum Einsatz.


  • Phase 6: Für die Übergabe der XML-Daten vom Profil an den Server muss ein Antwortweg eingerichtet sein, der die Ausgabedaten der "IU" per ImportResponder (Responder) weitergibt und dabei auch Authentifizierungsdaten für den Import bereitstellt.

Phase 1 und Phase 2: Standardfunktionalitäten von Lobster Data Platform / Integration

Die Aufbereitung von Eingangsdaten in den Phasen 1 und 2 bis hin zur Definition einer Quellstruktur für das Mapping in Phase 3 ist abhängig von Inhalt und Format der Eingangsdaten ein individueller Prozess. Spezifische Aspekte ergeben sich aus einem anschließenden Import nicht. Die technischen Möglichkeiten und geeignete Vorgehensweisen für Phase 1 und 2 beschreibt die Dokumentation für Lobster Data Platform / Integration.

Phase 3: Mapping

Spezifische Aspekte für die Konfiguration eines Import-Profils werden nachfolgend und ggf. in referenzierten Handbucheinträgen für Lobster Data Platform / Orchestration beschrieben:

ANMERKUNG◄ Die Phase 4 - das Verarbeiten der Zieldaten auf Datenbankebene - ist für einen Import in der Regel nicht relevant und wird deshalb übersprungen.

Phase 5: Integration Unit

Die Aufgabe der Integration Unit ist die Umwandlung der zuvor per Mapping in die Importstruktur übertragenen Eingangsdaten in das für den Import in Lobster Data Platform / Orchestration vordefinierte XML-Format.

  • In der Konfiguration eines Profils in Lobster_data muss zunächst das Register für die Phase 5 aufgerufen werden.


  • Dort wird die Integration Unit definiert. Um aus den auf eine Zielstruktur abgebildeten Daten ein XML zu erzeugen eignet sich in der Regel die "XMLNoTemplateUnit", die im Screenshot bereits ausgewählt wurde, so dass unterhalb die zugehörigen Parameter erscheinen.


  • Details zu diesen Parametern beschreibt die Kontext-Hilfe von Lobster_data, die über das ?-Symbol neben der Auswahl für die Integration Unit abrufbar ist.


  • Der Parameter Root node name ist im Bild hervorgehoben. Dieser muss immer auf den Namen des "Wurzelknotens" der Importstruktur (hier: Import) verweisen.

images/download/attachments/201674898/image2020-7-14_16-22-21-version-1-modificationdate-1747120021603-api-v2.png

Phase 6: Antwortweg

Phase 6 definiert Antwortwege für die Übergabe die durch die vorherigen Phasen generierten Daten an einen oder mehrere Empfänger.

Für ein Import-Profil ist entscheidend, dass dabei ein Antwortweg wie unten beschrieben konfiguriert wird:

  • Ein Rechtsklick in der Liste der Antwortwege öffnet ein Kontextmenü mit dem Eintrag Neuer Antwortweg.


  • Im Untermenü zu diesem Menüpunkt erscheinen zahlreiche Kategorien von Antwortwegen.


  • Der für ein Import-Profil relevante Typ ImportResponder (Responder) gehört der Kategorie Eigene Klasse an.

images/download/attachments/201674898/image2020-7-14_16-55-5-version-1-modificationdate-1747120021600-api-v2.png

Nach dem Auswählen einer Kategorie für einen neuen Antwortweg erscheint sofort eine Maske unterhalb der Liste der Antwortwege, in der Details eingestellt werden können:

  • Der Name kann frei gewählt werden und dient zusammen mit der internen Bezeichnung für die gewählte Kategorie zur Identifikation innerhalb der Liste der Antwortwege.


  • Im Detailreiter Eigene Klasse-Einstellungen muss unter Klasse angegeben werden, welcher Typ von
    Antwortwege (für Orchestration) verwendet werden soll. Hier muss der ImportResponder (Responder) ausgewählt werden.


  • Für die Authentifizierung eines Imports müssen als Zusätzliche Parameter geeignete Anmeldedaten mitgegeben werden. Neben einer Direkteingabe für die XML-Struktur eines LobsterDataLoginRequest-Objekts kann ein entsprechender Inhalt auch über eine Variable bereitgestellt werden. Ein Klick auf das im Bild hervorgehobene %-Symbol öffnet eine Liste, in der eine Referenz auf eine Variable ausgewählt werden kann. Der Inhalt für diese Variable kann im Zuge des Mappings (Phase 3) per Funktion Create Login Request (Integration-Funktion) bequem aufbereitet werden.

images/download/attachments/201674898/image2020-7-14_17-3-53-version-1-modificationdate-1747120021598-api-v2.png

Beispiel für "Zusätzliche Parameter" zur Authentifizierung eines Imports:

Login Beispiel
 <base:LobsterDataLoginRequest xmlns:base='SCM.BASE' userName="admin" selectedRole="1" selectedCompany="1" />

Weitere Details zur Authentifizierung s. Integration Login bzw. Create Login Request (Integration-Funktion).

Ein letzter wichtiger Schritt zum Einrichten des Antwortwegs für ein Import-Profil ist die Zuordnung der Ausgabedaten der Integration Unit als Inhalt für den Antwortweg:

  • Im Detailregister Inhalts-Einstellungen muss für den Pflichtparameter Inhalt die Option Ausgabe von IU gewählt werden, damit die von der Integration Unit bereitgestellte XML-Struktur überhaupt als Antwort ausgegeben wird.


  • Abschließend muss die Konfiguration für einen neuen oder geänderten Antwortweg per Klick auf den Button images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Antwortweg übernehmen (unten rechts) bestätigt werden.

images/download/attachments/201674898/image2020-7-14_17-32-56-version-1-modificationdate-1747120021596-api-v2.png