XML exportieren/importieren

In SKOOR Engine ist eine XML-Schnittstelle integriert, die den Export und Import beliebiger Objektstrukturen mit einer einzigen XML-Datei von einem SKOOR Engine-System in ein anderes ermöglicht. Auf diese Weise können Sie eine bestimmte Struktur in einer SKOOR Engine-Testumgebung erstellen, diese exportieren und anschließend in Ihre SKOOR Engine-Produktionsumgebung importieren, sobald die Struktur erfolgreich eingerichtet wurde. Über die XML-Schnittstelle können Sie SKOOR Engine auch mit beliebigen Tools von Drittanbietern (z. B. CMDB, andere vorhandene Überwachungstools) synchronisieren.

Allgemeine Informationen

  • Beim Import/Export von XML hat jedes Objekt eine eindeutige ID, die sogenannte TID (Third Party ID).

  • Eine TID identifiziert ein SKOOR Engine-Objekt global (über alle SKOOR Engine-Instanzen hinweg).

  • Wenn eine TID aufgrund einer Identitätssperre gespeichert werden muss, wird die TID als Eigenschaft namens „tid” gespeichert (siehe Importmodi im folgenden Abschnitt „XML – Import”).

Unterstützte Objekte für XML-Importe/-Exporte

  • ACLs (nur Import)

  • Alarmgeräte

  • Alarmgruppen

  • Alarmvorlagen

  • Geräte

  • Ordner (in Vorlagen)

  • Gruppen

  • Aufträge

  • Filterkarten

  • OPM

  • Prozessobjekte

  • Eigenschaften

  • Berichte (nur PDF)

  • Berichts-Scheduler

  • Zeitpläne

  • SLCs

  • SLOs

  • Vorlagen (Informationen zur XML-Export-/Importfunktion für Vorlagen finden Sie im Abschnitt „Vorlagen”.)

  • Benutzer (nur Import)

  • Benutzergruppen (nur Import)

Grafiken wie Statusverlauf, Wertverlauf oder Wertverlauf Plus können nicht mit der XML-Import-/Exportfunktion verarbeitet werden und können zu Warnungen im Export-/Importprozess führen

Schnittstellendefinition:

  • Der XML-Import/Export entspricht dem XML 1.0-Standard

  • Unterstützt alle W3C-XML-Nachbearbeitungsstandards 

XML – Export

Es gibt zwei Möglichkeiten, Objekte im XML-Format zu exportieren.

Einmaliger Export

Die erste und schnellste Möglichkeit besteht darin, das Funktionsmenü einer Gruppe zu öffnen und auf „XML-Export” zu klicken:

Dadurch werden sofort die Objekte unterhalb dieser Gruppe exportiert:

Konfiguration exportieren

Die zweite Möglichkeit besteht darin, ein Objekt vom Typ XML-Export unter /root/Configurations zu erstellen:

XML-Exportkonfiguration:

Eigenschaft

Beschreibung

Name

Name der Exportkonfiguration

Export

Der Pfad, unter dem Objekte exportiert werden sollen

Postprozessor

Diese Funktion wird derzeit nicht verwendet

Das Objekt wird unter dem Knoten /root/Configurations/Import / Export erstellt. Um den Export tatsächlich zu starten und die XML-Datei zu erstellen, navigieren Sie zu /root/Configurations/Import / Export und klicken Sie auf „Generieren“ für das zuvor erstellte Objekt:

Klicken Sie auf die Schaltfläche „Generieren“:

 Die XML-Exportdatei wird angezeigt und kann über den Browser heruntergeladen werden:

Meldungen mit ungelösten Links, wie im folgenden Abschnitt „Ergebnisinfo“ gezeigt, können durch Objekte wie Grafiken verursacht werden, die von der XML-Exportfunktion nicht unterstützt werden. Andere Objekte sollten davon nicht betroffen sein:

Eigenschaftsreferenzen in Objekten wie <$PID18$>, die in Textfeldern verwendet werden können, werden ignoriert.

XML – Import

Es stehen mehrere Importmodi zur Verfügung:

Importmodus

Beschreibung

Hinzufügen

  • Die in der XML-Datei definierten Objekte werden unterhalb der ausgewählten Gruppe hinzugefügt

  • Die Identität aller hinzugefügten Objekte geht verloren (dasselbe Objekt kann mehrmals hinzugefügt werden).

  • Es wird keine TID gespeichert

Aktualisieren

Die Objekte unterhalb der Importgruppe werden mit den in der XML-Datei definierten Objekten aktualisiert

  • Die Identität wird beibehalten und für alle in der XML-Datei definierten Objekte berücksichtigt

  • Neu hinzugefügte Objekte erhalten die in der XML-Datei definierte TID

  • Es sind beliebig viele Aktualisierungen für jedes Objekt möglich

  • Objekte unterhalb der Importgruppe, die nicht in der XML-Datei enthalten sind, werden gelöscht

XML-Top-Objekte hinzufügen/aktualisieren

  • Funktioniert wie „Aktualisieren”, aber es werden nur die in der XML-Datei definierten Top-Objekte berücksichtigt.

  • Vorhandene Objekte in der Importgruppe werden nicht entfernt, wie dies bei einem normalen Import der Fall wäre

Bereichsfrei

  • Der Umfang wird durch die XML-Datei definiert (kein Stammobjekt erforderlich)

  • Objekte können über die gesamte SKOOR Engine-Datenbank verteilt sein. Ihre Abhängigkeiten werden gemäß der Definition in der XML-Datei aktualisiert

    • Die Identität bleibt erhalten und wird berücksichtigt

    • Es sind beliebig viele Aktualisierungen desselben Objekts möglich.

 

Wenn Objekte auf dasselbe System importiert werden, von dem sie zuvor exportiert wurden, kann der Modus „Hinzufügen” zu doppelten Objekten führen, z. B. Alarmgeräten, die mit exportierten Objekten verknüpft sind

Diese Importmodi sind in der entsprechenden Dropdown-Liste mit dem Titel „Instanz” aufgeführt, um sie von den Importmodi zu unterscheiden, die nur für Vorlagen verwendet werden und unter dem Titel „Vorlage” aufgeführt sind

Einmaliger Import

Wie beim XML-Export können Importe direkt auf jedem Gruppenobjekt durchgeführt werden. Klicken Sie im Funktionsmenü der Gruppe, die die Objekte nach dem Import enthalten soll, auf „XML-Import“:

Laden Sie eine Datei hoch, wählen Sie sie zum Importieren aus und wählen Sie den gewünschten Modus aus dem Dropdown-Menü:

Klicken Sie auf „Prüfen“, um die Importdatei zu überprüfen und gegebenenfalls Fehler zu korrigieren. Bitte konsultieren Sie die bereitgestellte Protokolldatei, um Fehler zu analysieren. Wenn die Überprüfung erfolgreich war, klicken Sie auf „Importieren“:

Importkonfiguration

Wenn eine dauerhafte Importkonfiguration erforderlich ist, kann diese unter „/root/Configurations/Import / Export“ erstellt werden:

XML-Importkonfiguration:

 

Eigenschaft

Beschreibung

Name

Name der XML-Importkonfiguration

Importmodus

Importmodus (siehe Beschreibung oben)

Unten

Einstiegspunkt des Objektbaums, um Objekte darunter hinzuzufügen

Datei

Zu importierende XML-Datei (muss zuerst hochgeladen werden)

Präprozessor

Derzeit nicht in Verwendung

Datei hochladen

Ziehen Sie eine XML-Datei per Drag & Drop, um sie in die SKOOR Engine hochzuladen, und wählen Sie sie aus dem Dropdown-Menü „Datei“ aus.


Der Importvorgang ist derselbe wie oben beschrieben. Bei einem erfolgreichen Import wird als Ergebniscode „Import erfolgreich“ angezeigt. Eine Zusammenfassung wird angezeigt und in die Protokolldatei geschrieben. Durch Klicken auf die Protokolldatei wird ein neues Fenster mit detaillierten Informationen zum Import angezeigt.

Das Überprüfen und endgültige Importieren einer XML-Datei kann je nach Anzahl der beteiligten Objekte und dem gewählten Importmodus eine Stunde oder sogar länger dauern. Durch Klicken auf die Schaltfläche „Importieren“ wird der Import endgültig ausgelöst. Führen Sie diesen Schritt nur aus, wenn die Überprüfung erfolgreich war, wie neben dem Ergebniscode angegeben

Der Import überprüft zunächst, ob Lizenzbeschränkungen verletzt werden. In diesem Fall erhält der Benutzer eine Fehlermeldung und der Import schlägt fehl.

Wenn während des Imports ein Fehler auftritt, werden alle neu erstellten Objekte vollständig entfernt – es bleiben keine dangling objects im System zurück.

Bearbeiten Sie die XML-Datei vor dem Import

In der Regel ist es nicht erforderlich, die exportierte Datei vor dem erneuten Import zu ändern. Manchmal können Konfigurationsänderungen jedoch schneller durchgeführt werden, wenn sie vor dem Import in der XML-Datei vorgenommen werden.

Beispiel: Ändern Sie den Kollektor importierter Jobs

Wenn mehrere Kollektoren konfiguriert sind, kann es erforderlich sein, diese beim Importieren von Jobs aus einem anderen SKOOR-System zu ändern.

Suchen Sie zunächst nach dem Tag „Agents” in der XML-Datei (es können mehrere Agent-Tags darin enthalten sein):

<Agents>
  <Agent id="xxxx">
    <Name>collector-local</Name>
  </Agent>
</Agents>

Fügen Sie dann einen neuen Agent-Tag mit den folgenden Konventionen hinzu:

  • Geben Sie eine Agent-ID ein, die mit einem Buchstaben beginnt. Diese ID steht in keinem Zusammenhang mit einem Objekt in der SKOOR Engine, sie wird nur innerhalb der XML-Datei selbst verwendet.

  • Fügen Sie im Tag „Name“ den Namen eines vorhandenen Kollektors im Zielsystem hinzu.

<Agents>
  <Agent id="xxxx">
    <Name>collector-local</Name>
  </Agent>
  <Agent id="myNewCollectorId">
    <Name>external-collector-1</Name>
  </Agent>
</Agents>

Nun kann die Agent-ID verwendet werden, um den neuen Kollektor für alle Jobs im Tag „Jobs“ zu konfigurieren. Legen Sie das Tag „Agent“ der Jobs entsprechend fest:

<Jobs>
  ...
    <Name>My Job</Name>
    <Agent>myNewCollectorId</Agent>
  ...
</Jobs>