Verbindungen zwischen Businesskomponenten Import / Export

Einleitung

CIO Cockpit bietet Ihnen verschiedene Möglichkeiten, Ihre Verbindungen zwischen Businesskomponenten innerhalb des Systems zu verwalten:

In dieser Anleitung wird die Funktionsweise des interaktiven CSV-Imports erläutert.

CSV-Import und CSV-Export

Die Import- und Export-Schnittstellen für Verbindungen zwischen Businesskomponenten im CIO Cockpit basieren auf dem CSV-Format. Ein Importvorgang, wie nachfolgend beschrieben, basiert immer auf genau einer CSV-Import-Datei.

Die Datei, die importiert werden soll, muss dabei wie folgt aufgebaut sein:

  • Einzelne Einträge (Verbindungen zwischen Businesskomponente) sind voneinander durch einen Zeilenumbruch (im Linux- oder Windows-Format) getrennt.
  • Einzelne Spalten innerhalb eines Eintrags sind voneinander durch ein Semikolon (;) getrennt.
  • Die erste Zeile in der CSV-Datei enthält die Spaltennamen und dient der Zuordnung, wie im Abschnitt CSV-Datei mappen beschrieben.
  • Alle Zeilen müssen die gleiche Anzahl an Spalten aufweisen.
  • Leere Spalten einzelner Einträge (Verbindung zwischen Businesskomponenten) können realisiert werden, indem kein Text zwischen den beiden umgebenden Trennern (;) eingefügt wird. Dies führt nicht dazu, dass bei einer Aktualisierung eines vorhandenen Verbindung zwischen Businesskomponenten die Information gelöscht wird, sondern dazu, dass die Information ignoriert wird.
  • Soll eine bestimmte Information eines Eintrags gelöscht werden, so muss folgender Text als Eintrag in der CSV-Spalte gesetzt werden: #NULL#


Im letzten Abschnitt dieser Anleitung Importierbare Verbindungen zwischen Businesskomponenten-Felder finden Sie eine vollständige Liste der Verbindungen-Felder, für welche Sie Informationen in Ihrer CSV-Eingabe-Datei bereitstellen können.

Bitte beachten Sie: Es ist nicht zwingend notwendig, dass Sie die Benamung der Spalten Ihrer CSV-Datei an die unten angegebenen Bezeichner anpassen. Wir empfehlen Ihnen jedoch trotzdem, sofern es aus technischer Sicht möglich ist, dies zu tun, da sich dadurch der weitere Import-Vorgang für Sie komfortabler und schneller durchführbar gestaltet.

Verbindungen ins CIO Cockpit importieren

Der interaktive Verbindungen-Import-Vorgang kann aus dem Konfigurationsbereich - Abschnitt "Main Unit" - heraus gestartet werden. Klicken Sie dazu auf den Button "CSV-Import". Die folgenden Abschnitte erläutern Schritt für Schritt die Bedienung der Import-Funktion, ausgehend von der Ansicht, die nach dem Klick geöffnet wird.


Schritt 1: CSV-Upload

Im ersten Schritt des Import-Vorgangs müssen Sie eine Eingabe zur Verarbeitung in Form einer kompatiblen CSV-Datei bereitstellen (siehe CSV-Import und CSV-Export).
Dazu stehen Ihnen verschiedene Möglichkeiten zur Verfügung:

  1. Über die Schaltfläche "Muster-CSV-Datei downloaden" haben Sie die Möglichkeit, sich ein auf Ihre CIO Cockpit Umgebung zugeschnittenes Beispiel herunterzuladen, indem veranschaulicht wird, welche Informationen in welchem Format benötigt werden, um Verbindungen zwischen Businesskomponenten ins CIO Cockpit zu importieren.
    Die Beispiel-CSV-Datei enthält sämtliche Verbindungen-Felder, die zum Import zur Verfügung stehen und kann als Vorlage für eine eigene Import-Datei verwendet werden:
    Die erste Zeile der Muster-Datei enthält die Standard-Spaltenbezeichner.
    Die zweite Zeile erläutert den Inhalt der Spalte und das jeweils zu verwendende Format.
    Die dritte Zeile enthält Beispielwerte für die jeweiligen Spalten.

    Alternativ können Sie die Muster-CSV-Datei hier herunterladen.

  2. Über die Schaltfläche "Businesskomponenten-Usages-CSV-Datei downloaden" haben Sie die Möglichkeit, einen kompletten Export Ihrer im CIO Cockpit hinterlegten Verbindungen zwischen Businesskomponenten zu generieren und als CSV-Datei herunterzuladen. Diese Datei erfüllt die Anforderungen an eine Eingabe für die Import-Funktion.
    Sie können die erzeugte Export-Datei modifizieren und im Anschluss zum Import verwenden. Dies dient insbesondere der Aktualisierung bestehender Verbindungen zwischen Businesskomponenten. Sie können aber auch zusätzliche Verbindungen zwischen Businesskomponenten in dieselbe Datei einpflegen, die dann über die Import-Funktion neu erzeugt werden können.

  3. Über den Drag and Drop-Bereich ganz rechts können Sie eine vorbereitete CSV-Import Datei als Eingabe für den Import hochladen und zur Verarbeitung zur Verfügung stellen. Diese Aktion startet die Vorbereitungen zum Import, während die ersten beiden Optionen der Vorbereitung der Eingabe dienen. Ziehen Sie eine CSV-Datei in den Drag and Drop-Bereich oder klicken Sie alternativ auf die dunkelblaue Schaltfläche, um einen Dateiauswahl-Dialog zu öffnen. Nachdem Sie eine Datei ausgewählt haben, klicken Sie auf den Button "Businesskomponenten-Usages-CSV-Datei importieren", um zum nächsten Schritt zu gelangen.


Schritt 2: CSV-Datei mappen

Im zweiten Schritt wird eine Verknüpfung zwischen den Spalten, die in Ihrer CSV-Datei definiert sind und den zum Import verfügbaren Verbindungen-Feldern vorgenommen. Die Software versucht zunächst automatisch passende Mappings zu finden und trägt diese als Vorschlag ein. Wenn Sie die Namen Ihrer CSV-Spalten aus der Muster-Datei oder einem Verbindungen-Export übernehmen, können alle Spalten automatisch ausgewählt werden. Sie haben die Möglichkeit jede Ihrer CSV-Spalten auf beliebig viele Verbindungen-Felder zu mappen. Dadurch werden die Werte einer einzelnen CSV-Spalte in mehrere Verbindungen-Felder kopiert. Jedes Verbindungen-Feld kann hingegen nur von maximal einer CSV-Spalte belegt werden.
In der oberen, grauen Zeile der Tabelle sehen Sie sämtliche Spalten der CSV Datei. In der darunterliegenden, blauen Zeile sehen Sie für jede CSV-Spalte ein Auswahlmenü mit den noch verfügbaren (d.h. noch nicht belegten) Verbindungen-Feldern. Wählen Sie einen Eintrag aus dem Auswahlmenü aus, so wird im nachfolgenden Import das zugehörige Verbindungen-Feld mit den Informationen aus der CSV-Spalte befüllt. Die Einträge der Tabelle entsprechen den Daten in der hochgeladenen CSV-Datei.
Es ist nicht notwendig, sämtliche Verbindungen-Felder durch Spalten Ihrer CSV-Datei zu belegen. Prinzipiell werden pro zu importierendem Verbindungen zwischen Businesskomponenten zwei Fälle unterschieden:

  1. Die Verbindung zwischen Businesskomponente existiert bereits: Diejenigen Felder, für die Sie ein Mapping einstellen, werden durch den Import-Vorgang aktualisiert. Die restlichen bleiben unberührt. Diese Menge umfasst die Felder:
    • parentCockpitId oder parentCustomId
    • childCockpitId oder childCustomId
  2. Die Verbindung zwischen Businesskomponente muss neu angelegt werden: In diesem Fall gibt es eine Menge an Pflichtfeldern, für die ein Mapping vorhanden sein muss. Diese Menge umfasst die Felder:
    • parentCockpitId oder parentCustomId
    • childCockpitId oder childCustomId

Innerhalb eines Vorgangs können sowohl neue Verbindungen zwischen Businesskomponenten angelegt, als auch bestehende Verbindungen zwischen Businesskomponenten aktualisiert werden. In einem solchen Fall ist es trotzdem notwendig, ein Mapping für die Pflichtfelder anzugeben.


Nachdem Sie alle gewünschten Mappings eingetragen haben, klicken Sie auf den Button "Fortfahren". Ein Dialog öffnet sich und Sie haben die Möglichkeit zu entscheiden, ob Sie für Ihre Verbindungen zwischen Businesskomponenten Schlüssel hinterlegen wollen. Das Hinterlegen von Schlüsseln ist essentiell, um Verbindungen zwischen Businesskomponenten zu erstellen und zu aktualisieren.

Achtung: Wenn Sie in Ihrer CSV-Datei keine Schlüssel haben oder diese Schlüssel nicht zuweisen, können Sie über die Import-Funktion keine bestehenden Verbindung zwischen Businesskomponenten aktualisieren, oder anlegen.


Schritt 3: Schlüssel zuweisen

Das Zuweisen von Schlüsseln funktioniert analog zur Erstellung der Mappings im vorherigen Schritt. Zusätzlich zu den CSV-Spalten und den bereits zuvor gewählten Verbindung-Feldern, sehen Sie nun eine neue Auswahlmöglichkeit für die zur Auswahl stehenden Schlüssel. Je CSV-Spalte haben Sie die Möglichkeit festzulegen, dass die Spalte als Quelle für einen der Schlüssel "Eltern ID" / "Kind ID" oder "Fremdschlüssel Elternelement" / "Fremdschlüssel Kindelement" dient. Wie im letzten Schritt entsprechen die ausgewählten Einträge erneut jeweils einem Verbindung-Feld. Jeder Eintrag, den Sie vornehmen, führt dazu, dass der Inhalt der entsprechenden CSV-Spalte als Inhalt des gewählten Verbindung-Schlüssel-Feldes übernommen wird.

Die Schlüssel "Fremdschlüssel Elternelement" / "Fremdschlüssel Kindelement" sind frei verwendbare, Text-basierte Schlüsselfelder, der Businesskomponenten. Die Cockpit ID ist eine innerhalb des CIO Cockpit eindeutige Kennnummer, die für jede Businesskomponente automatisch vergeben wird. Wenn Sie eine Schlüsselzuweisung für die Cockpit ID vornehmen, müssen Sie sicherstellen, dass alle verwendeten Cockpit IDs in Ihrer CSV-Import-Datei bereits existieren. Sie können dies z.B. sicherstellen, indem Sie als Ausgangspunkt für den Import einen Verbindungs-Export verwenden, da in diesem immer die korrekte Cockpit ID enthalten ist.

Wählen Sie nun mindestens eine Kombination aus CSV-Spalte und Schlüssel aus und klicken Sie danach auf die Schaltfläche "Fortfahren".


Schritt 4: Schlüssel auswählen

Im vorherigen Schritt haben Sie mindestens zwei Schlüssel (einen für das Elternelement und einen für das Kindelement) ausgewählt, der Ihre Businesskomponenten für die Verbindungen identifiziert. In diesem Schritt wird nun derjenige Schlüssel ausgewählt, über den bestehende Businesskomponenten im System mit den von Ihnen über die CSV-Datei gelieferten Verbindungen identifiziert werden. Wird eine Zeile Ihrer CSV-Datei beim Import mit einer bestehenden Verbindung identifiziert, wird keine neue Verbindung angelegt, sondern die bestehende Verbindung aktualisiert.
Im oberen Bereich stehen alle Schlüssel, die Sie im letzten Schritt zugewiesen haben, zur Auswahl. Um fortzufahren, wählen Sie den Schlüssel aus, über welchen bestehende Verbindungen identifiziert werden sollen und klicken Sie auf den Button "Fortfahren".
Ihre Eingaben werden jetzt zum CIO Cockpit übertragen und vom System auf Korrektheit und Konsistenz überprüft. Dieser Vorgang kann einige Sekunden dauern. Falls die Validierung erfolgreich ohne Fehler durchlaufen werden konnte, werden Sie direkt zu Schritt 7 weitergeleitet. Andernfalls leitet Sie die Software automatisch zu Schritt 5 weiter und Sie müssen vor dem Import Ihrer Daten eine Korrektur vornehmen.


Schritt 5 & 6: Verbindungen Informationen prüfen / bearbeiten

Im Schritt "Daten prüfen" erhalten Sie Informationen zu den Fehlern in Ihrer Eingabe, die verhindern, dass Ihre Daten korrekt importiert werden können.



Über die obere Schaltfläche "Fehlerhafte Daten anzeigen" können Sie eine Dialog-Ansicht öffnen, die diejenigen Verbindungen in Ihrer CSV-Datei auflistet, die Fehler enthalten und darum nicht importiert werden können. Zellenbasierte Fehler, die sich auf eine bestimmte Spalte eines Eintrags beziehen, werden direkt in der betreffenden Zelle markiert. Zeilenbasierte Fehler, die sich nicht auf eine bestimmte Spalte beziehen, können über die Sonder-Spalte "Fehler" gefunden werden.



Indem Sie den Button "Fehlerhafte Daten als CSV-Datei exportieren" klicken, erhalten Sie einen Ausschnitt aus der hochgeladenen CSV-Datei zum Download, der nur die Zeilen umfasst, in denen während der Validierung Fehler gefunden wurden.
Sie haben nun drei Optionen, den Import-Vorgang fortzuführen:

  1. Sie können den interaktiven Bearbeitungsmodus verwenden, um die fehlerhaften Einträge direkt in der Software zu korrigieren. Klicken Sie dazu auf die linke Schaltfläche "Daten bearbeiten". Es öffnet sich eine neue Tabellen-Ansicht, die nur die fehlerhaften Zeilen enthält. Sie können die als fehlerhaft identifizierten Zellen direkt in der Tabelle bearbeiten oder über die Schaltfläche in der "Sidebar"-Spalte eine Formular-Ansicht am seitlichen Bildrand öffnen und die Fehler dort korrigieren.
    Klicken Sie auf den Button "Eingabe prüfen" oberhalb der Tabelle, um eine erneute Validierung der von Ihnen korrigierten Einträge vorzunehmen. Falls Sie nur einen Teil der Fehler behoben haben, reduziert sich die Tabelle auf die noch fehlerhaften Zeilen und Sie können mit der Korrektur fortfahren. Nachdem Sie alle Fehler behoben haben, werden Sie automatisch zu Schritt 7 weitergeleitet.
    Alternativ können Sie auch vor der Korrektur aller Fehler über die Schaltfläche "Zurück" zur letzten Ansicht zurückkehren. Ihre bislang eingetragenen und überprüften Korrekturen bleiben dabei erhalten.



  2. Wenn Sie keine interaktive Bearbeitung Ihrer fehlerhaften Daten vornehmen wollen, können Sie alternativ über einen Klick auf die mittlere Schaltfläche "CSV-Datei herunterladen und fortfahren" eine mit Anmerkungen versehene Kopie Ihrer Eingabedaten herunterladen.
    Die heruntergeladene Datei enthält die gleichen Daten wie Ihre ursprüngliche Import-Datei, wurde aber vom System mit Informationen zu den fehlerhaften Zellen ergänzt. Markierte, fehlerhafte Zellen haben dabei in der Datei folgenden Aufbau: ##FEHLER##<Fehlerbeschreibung>
    Sie können diese Datei mit einem Textbearbeitungswerkzeug Ihrer Wahl (Excel, Notepad etc.) korrigieren. Bitte beachten Sie, dass Sie ausschließlich Zelleninhalte modifizieren dürfen, da der Import ansonsten fehlschlägt. Es ist nicht zulässig, die Anzahl oder die Benamung der Spalten zu ändern, Zeilen hinzuzufügen oder zu entfernen.
    Beim Download der CSV-Datei werden Sie automatisch zu einem Auswahlbereich weitergeleitet, über welchen Sie die korrigierte CSV Datei nun wieder bereitstellen können. Das Bereitstellen der korrigierten Datei funktioniert auf die gleiche Art wie zum Start des Import-Vorgangs. Wählen Sie die korrigierte Datei aus und klicken Sie auf den Button "Fortfahren". Eine erneute Validierung wird durchgeführt und abhängig vom Ergebnis werden Sie entweder erneut zu Schritt 5 weitergeleitet um ggf. weitere Fehler zu korrigieren oder, falls alle Fehler korrigiert wurden, zu Schritt 7.
  3. Falls Sie keine Korrektur Ihrer Daten vornehmen wollen, können Sie die rechte Schaltfläche "Daten verwerfen und fortfahren" wählen. Wenn Sie diese Option wählen, werden nur die fehlerfreien Verbindungen importiert / aktualisiert und die restlichen Zeilen der von Ihnen bereitgestellten CSV-Datei werden ignoriert. Mit Klick auf diesen Button werden Sie direkt zu Schritt 7 weitergeleitet.

Schritt 7: Businesskomponenten importieren

In Schritt 7 des Import-Vorgangs sehen Sie eine Übersicht der Verbindungen aus Ihrer (ggf. korrigierten) CSV-Datei inkl. Mappings auf die gewählten Verbindung-Felder. Indem Sie auf den Button "Fortfahren" klicken, starten Sie den Import-Vorgang.


Schritt 8: Zusammenfassung

Der letzte Schritt des Vorgangs dient als Bestätigung des erfolgreich durchgeführten Imports. Sie sehen erneut die Liste der nun erfolgreich importierten Verbindungen und eine Erfolgsmeldung im oberen Bereich. Sollten unerwartete Fehler aufgetreten sein, so werden diese ebenfalls im oberen Bereich aufgelistet. Sie haben nun über die Schaltfläche "CSV-Datei downloaden" die Möglichkeit, die erfolgreich importierte CSV-Datei herunterzuladen und abzuspeichern. Über einen Klick auf den Button "Zur Ursprungsansicht Ansicht wechseln" werden Sie in den Konfigurationsbereich - Abschnitt Businesskomponenten - weitergeleitet, während Sie der Button "Weitere Daten importieren" zum Ausgangspunkt des Import-Vorgangs führt.


Businesskomponenten Verbindungen aus dem CIO Cockpit exportieren

Sie können Ihre Verbindungen aus dem System über die CSV-Export-Schnittstelle exportieren. Im Abschnitt Schritt 1: CSV-Upload wird erläutert, wie Sie innerhalb der Import-Funktion einen vollständigen Export generieren können.
Dies führt zu einem Export sämtlicher im CIO Cockpit eingetragener Verbindungen. Der Vorgang kann, je nach Gesamtanzahl an hinterlegten Verbindungen, einige Sekunden dauern. Nach Abschluss des Exports wird Ihnen das Ergebnis in Form einer CSV-Datei zum Download über den Browser zur Verfügung gestellt.
Die exportierte CSV-Datei ist kompatibel zur Verbindungen-Import-Funktion und kann daher verwendet werden, um die bestehenden Verbindungen zu aktualisieren. Dazu modifizieren Sie einfach die zu den zu aktualisierenden Verbindungen gehörenden Einträge in der Datei und verwenden das Ergebnis im Anschluss als Eingabe in der Verbindungen-Import-Funktion wie oben beschrieben unter Verwendung der Cockpit ID der Eltern- und Kind-Businesskomponenten als Schlüssel.

Importierbare Verbindungen-Felder

Die folgende Tabelle enthält alle aktuell importierbaren Verbindungen-Felder:

Businesskomponenten-Feld Feld-Typ Standard-Spaltenname Beschreibung
Cockpit Id der Eltern Businesskomponente Pflichtfeld, wenn Fremdschlüssel nicht gesetzt parentCockpitId Die Cockpit ID der Eltern Business Komponente. Dieses Feld kann nicht importiert werden, sondern wird dazu genutzt, die bestehende Eltern Business Komponente zu identifizieren.
Fremdschlüssel der Eltern Businesskomponente Pflichtfeld, wenn Cockpit Id nicht gesetzt parentCustomId Benutzerdefinierte Id der Eltern Business Komponente. Dieses Feld kann nicht importiert werden, sondern wird dazu genutzt, die bestehende Eltern Business Komponente zu identifizieren.
Cockpit Id der Kind Businesskomponente Pflichtfeld, wenn Fremdschlüssel nicht gesetzt childCockpitId Die Cockpit ID der Kind Business Komponente. Dieses Feld kann nicht importiert werden, sondern wird dazu genutzt, die bestehende Kind Business Komponente zu identifizieren.
Fremdschlüssel der Kind Businesskomponente Pflichtfeld, wenn Cockpit Id nicht gesetzt childCustomId Benutzerdefinierte Id der Kind Business Komponente. Dieses Feld kann nicht importiert werden, sondern wird dazu genutzt, die bestehende Kind Business Komponente zu identifizieren.
Zähler Pflichtfeld usageFractionNumerator Zähler für die Nutzung der untergeordneten Business Komponente
Nenner Pflichtfeld usageFractionDenominator Nenner für die Nutzung der untergeordneten Business Komponente
       



Bei Fragen und Anregungen freuen wir uns über einen Anruf unter +49 201 959750 oder eine E-Mail an unseren Support an servicedesk@dextradata.com.

Nach oben