Skip to main content

Konfigurationstransfer

KIX Pro ermöglicht den Transfer vollständiger Objekt-Konfigurationen von einer KIX-Umgebung in eine andere. Dies erfolgt im Menü System > Konfigurationstransfer.

Der Konfigurationstransfer ermöglicht z. B.:

  • das Übertragen der Konfigurationen von Test- auf Produktivsysteme oder von On- Premises-Installationen in die KIX Cloud. Möglich sind sowohl der Export aus KIX als auch der Import nach KIX.

  • das Ausrollen vorkonfigurierter Systemeinstellungen durch Support oder Kundenberatung

  • den Transfer von Konfigurationen zur Einrichtung, Verwendung und Anzeige von Dynamischen Feldern

  • u.a.m.

Hinweis

Der Im- und Export von Konfigurationen erfolgt aktuell nur im JSON-Format.

Export von Konfigurationen

Der Export von Konfigurationen erfolgt im Menü System > Konfigurationstransfer > Export.

Legen Sie im Dialog fest, in welches Ausgabeformat der Export erfolgen soll und welche Datensätze exportiert werden sollen. Die zu exportierenden Datensätze können Sie durch Auswahl des Objekts (z. B. Report Definition) und durch Setzen von Filtern festlegen.

Der Export startet nach einen Klick auf die Export-Schaltfläche. Das Exportieren kann je nach Anzahl der gewählten Objekte und der darin hinterlegten Datensätze einige Zeit in Anspruch nehmen. Im Anschluss wird eine Datei im gewählten Ausgabeformat erzeugt und über die Funktionen des verwendeten Browsers zum Download bereitgestellt.

Konfig-Export.png

Abb.: Objektauswahl für den Export

Wichtig

In den Konfigurationen hinterlegte Berechtigungszuordnungen werden aktuell nicht exportiert und müssen manuell gesetzt werden.

Parameter

Beschreibung

Format

Wählen Sie aus, in welches Ausgabeformat die Konfiguration exportiert werden soll (aktuell nur JSON).

Objekt

Wählen Sie aus, welchen Objekttyp Sie exportieren möchten.

  • Sie können nacheinander mehrere Objekte wählen. Klicken Sie dazu auf die Plus-Schaltfläche.

  • Ist kein Objekt gewählt, werden alle verfügbaren Konfigurationen exportiert. Die Plus-Schaltfläche darf dazu noch nicht angeklickt sein.

  • Es werden sowohl gültige als auch (temporär) ungültige Objekte exportiert.

Hinweis: Der Export von Rulesets erfolgt ohne Macros

Filter

Durch Angabe von Filterkriterien können Sie die zu exportierenden Datensätze konkretisieren.

  • Es werden alle Datensätze des Objekts exportiert, die den gewählten Filterkriterien entsprechen.

  • Die zur Verfügung stehenden Filterkriterien sind vom jeweiligen Objekttyp abhängig.

  • Wird kein Filter gesetzt, werden alle erlaubten Datensätze des gewählten Objekts exportiert.

button_plus.png button_minus.png

Hinzufügen bzw. Entfernen von Objekten und Filtern

Import von Konfigurationen

Der Import von Konfigurationen erfolgt im Menü System > Konfigurationstransfer > Import mittels Datei- Upload.

Die Datei muss die Datensätze für den Import enthalten und in einem unterstützten Format vorliegen.

Der Import kann je nach Dateigröße einen Moment dauern.

Beachten Sie auch die Hinweise für den Im- und Export

Wichtig

  • Der Import legt keine neuen Objekte an. Achten Sie daher darauf, dass alle zu importierenden Objekte in KIX existieren, z. B. der im Filter von ObjectActions angegebene Statustyp. Legen Sie ggf. die Objekte zuvor in KIX an.

  • Für eine korrekte und vollständige Anzeige bitte nach dem Import mittels Konsolen- Kommando Console::Command::Maint::Cache::Delete den Cache löschen und eine Ab- und Anmeldung durchführen.

Parameter

Beschreibung

Modus

Der gewählte Modus bestimmt, wie die zu importierenden Datensätze behandelt werden.

Beispielsweise, ob bei identischem Identifikator ein neuer Datensatz angelegt wird oder ob ein bestehender Datensatz aktualisiert wird.

Standard

Aktualisierung oder Hinzufügen von Datensätzen, sofern diese vorhanden sind oder nicht (Standard).

OnlyUpdate

Führt nur ein Update bestehender Datensätze aus.

OnlyAdd

Ein Datensatz wird nur hinzugefügt, wenn er nicht existiert.

ForceAdd

Erzwungene Neuanlage:

  • Ein Datensatz wird kopiert, wenn dieser schon existiert. Der Datensatzname erhält ein vorangestelltes "Copy" (außer bei ObjectIcons).

  • Nicht vorhandene Datensätze werden hinzugefügt.

Datei

Wählen Sie die hochzuladende Datei aus.

Es kann nur 1 Datei hochgeladen werden.

Tipp: Sie können die Datei auch via Drag & Drop auf die Schaltfläche ziehen.

Nach dem Import wird eine Ergebnistabelle mit folgenden Informationen angezeigt:

Import-Ergebnis.png

  • Objekt: Das Objekt, dessen Datensätze importiert wurden

  • Einträge: Anzahl der importierten Datensätze

  • Ignoriert: Anzahl der ignorierten Datensätze

    Ignoriert werden Datensätze, wenn sie z. B. bei gewähltem Modus "OnlyAdd" schon existieren oder bei "OnyUpdate" nicht existieren.

  • Aktualisiert: Anzahl der aktualisierten Datensätze

  • Hinzugefügt: Anzahl der hinzugefügten Datensätze

  • Hinzugefügt erzwungen: Anzahl der Datensätze die durch den Modus "ForceAdd" kopiert und mit "Copy" markiert wurden.

    Dies betrifft grundlegend nur die Datensätze, die schon im System existieren.

  • Fehlgeschlagen: Anzahl der Datensätze, die nicht importiert werden konnten.

    Die Gründe dazu finden Sie unter System > Logs.

Hinweise für den Im- und Export

Der Export betrachtet stets die Grundkonfigurationen. Individuelle Parameter (z. B. Icons von Teams) bleiben unberücksichtigt.

Baumstrukturen (z. B. Teams, Status, Vorlagengruppen) werden komplett exportiert, d. h. inkl. aller ihrer Sub- Kategorien. Es wird stets vom Root-Team ausgegangen. Beim Export von Sub-Kategorien werden auch dessen Eltern-Elemente betrachtet, um die Kategorien beim (Re-)Import korrekt im Baum einordnen zu können.

Team-Konfigurationen

  • Der Kalender wird nur als Kalendernummer (Name) erfasst.

  • Icons werden nicht betrachtet.

  • Die Absender E-Mail Adressen (Systemadressen) werden aufbereitet exportiert.

SysConfig-Konfigurationen

  • Ermöglicht den Export von SysConfig-Einstellungen, deren Schlüssel bestimmten Namensmustern (wildcard pattern) entspricht

  • Ermöglicht den Export aller geänderten SysConfig-Einstellungen ("modified")

    KonfigExport_SysConfig.png

    Abb.: Export von Systemkonfigurationen

  • Der Import verarbeitet Konfigurationsdateien (JSON), die zuvor durch den Export erstellt wurden.

    Nach dem Import ist die geänderte Konfiguration aktiv.

  • Bei Verwendung des Modus "ForceAdd" werden existierende Konfigurationen ignoriert, da Konfigurationen nicht kopiert und mit einem vorangestellten "Copy_" versehen werden können.

Wichtig

Beim Import wird die Anwendbarkeit Plug-In-spezifischer Konfigurationen (KIX Connect/ KIX Pro) NICHT überprüft. Die Verantwortung liegt beim ausführenden Administrator.

  • Bei schwerwiegenden Fehlern kann die SysConfig von On-Premises Installationen vollständig auf Standard zurück gesetzt werden. Führen Sie dazu nacheinander die Konsolen-Kommandos: Console::Command::Admin::Config::CleanUp und Console::Command::Maint::Config::Rebuild aus. Für Cloud-Umgebungen ist dies nicht möglich.

  • Nach dem Import muss das Frontend manuell geladen werden.

    Navigieren Sie dazu ins Menü System > SysConfig und klicken Sie in der Übersicht auf Lade Frontendkonfigurationen neu.

Object Icons

  • Dieses Objekt kann kein ForceAdd ausführen bzw. nur teilweise.

    • Ist der Datensatz nicht existent, so wird dieser normal als Add behandelt.

    • Ein Copy ist nicht möglich, da es keinen Namen zum Icon gibt.

  • Die Eindeutigkeit wird über die Parameter Object und ObjectID ermittelt.

    • Object: Objektzuweisung für das Icon, wo es angewendet werden soll

      z. B. TicketState, TicketType, GeneralCatalogItem, MIMEType, usw.

    • ObjectID: Ist die ID des jeweiligen Objekts

    • Das heißt, weder an ObjectID noch an Object kann der Prefix "Copy" ergänzt werden, da sonst das Icon nie angezeigt werden kann, weil die Zuweisung fehlerhaft ist.

E-Mail-Filter

Hinweis

Beachten Sie insbesondere bei der Verwendung von IDs, dass zu importierende E-Mail-Header- Werte auf dem Zielsystem nicht plausibilisiert werden!

  • Es erfolgt eine Prüfung auf den PostMasterHeader X-KIX-TicketTemplate.

    • Haben Match oder Set diesen enthalten, wird der Filter nicht importiert.

    • PostMasterHeader, die das System nicht kennt, werden dem PostmasterX-Header ergänzt, sofern es nicht X-KIX-TicketTemplate ist.

In diesem Abschnitt: