Übersicht über das Tool

CTT (Configuration Transport Tool) ist ein Tool für Efecte Service Management (ESM)-Administratoren zur Visualisierung von Änderungen an der Konfiguration der Anwendung.

CTT bietet eine Möglichkeit, Änderungen zwischen Umgebungen zu übertragen. In CTT ist es möglich, Änderungen auszuwählen und eine Konfigurationsdatei zu erstellen, die dann in ESM importiert werden kann, um automatisch Änderungen an dieser Konfiguration vorzunehmen.

CTT vergleicht und zeigt die Unterschiede zwischen zwei Konfigurationsdateien. Normalerweise stammt eine Datei aus der Testumgebung und eine andere aus der Produktionsumgebung.

Anforderungen und Verfügbarkeit

Die Verwendung des Tools erfordert die Möglichkeit, Konfigurationen sowohl aus der Quell- als auch aus der Ziel-ESM-Umgebung über Wartung → Systemeinstellungen → Konfigurationen exportieren zu exportieren.

Der Konfigurationstransport zwischen Umgebungen (Import der mit CTT erstellten Konfigurationsdatei) wird ab ESM-Version 2023.3 unterstützt. Nicht alle Elemente werden unterstützt. Weitere Informationen finden Sie unten.

Derzeit wird CTT über eine gemeinsam genutzte Instanz von Efecte Cloud angeboten. Sie können hier auf die CTT-Umgebung zugreifen: CTT-Umgebung

Anwendungsfall

Der Administrator kann sehen, welche Änderungen in der Testumgebung implementiert wurden, die noch nicht in die Produktion übernommen wurden. Ein weiterer Anwendungsfall ist der regelmäßige Vergleich der Änderungen derselben Umgebung. Wenn beispielsweise die Konfiguration einmal im Monat aus der Produktionsumgebung gespeichert wird, können Sie mit CTT die Konfigurationsänderungen anzeigen, die jeden Monat an der Umgebung vorgenommen wurden.

Aktuell kann CTT Änderungen in der Vorlagenkonfiguration erkennen, beispielsweise hinzugefügte Klassen und Attribute oder Änderungen in der Attributkonfiguration. CTT kann auch Unterschiede in der Ordnerstruktur und den Rollen anzeigen. Unterschiede in der Konfiguration werden in CTT hervorgehoben.

Beispiel-Anwendungsfälle für CTT

Sicherstellen, dass Änderungen korrekt von einer Test- in eine Pro übertragen werden

Sicherstellen, dass alle Änderungen korrekt von einer Testumgebung in eine Produktionsumgebung übertragen werden, wenn eine Änderung erstmals in einer Testumgebung erstellt und getestet wird.

Die Konfiguration wird üblicherweise in einer Testumgebung erstellt, bevor sie in einer Produktionsumgebung implementiert wird. Der erste Anwendungsfall für CTT besteht darin, die Konfiguration zwischen den beiden Umgebungen zu vergleichen und sicherzustellen, dass alle in der Testumgebung vorgenommenen Änderungen in der Produktionsumgebung erneut implementiert werden.

Aktualisieren einer Testumgebung, um sie an die Konfiguration in Pro anzupassen

Testumgebungen müssen manchmal aktualisiert werden, um sie an die Produktion anzupassen, bevor eine neue Entwicklung gestartet wird. Dies kann auf Planänderungen und die Nichtinbetriebnahme geplanter Entwicklungselemente zurückzuführen sein. CTT kann in diesen Fällen verwendet werden, um zu prüfen, ob im Test etwas fehlt oder geändert wurde, und um die Umgebungen auf den gleichen Stand zu bringen, bevor mit dem nächsten Entwicklungselement begonnen wird.

Versionierung der Konfiguration während der Entwicklung

Es empfiehlt sich, vor Beginn der Entwicklung neuer Funktionen und gelegentlich auch während der Entwicklung einen Export einer Konfiguration durchzuführen. CTT kann verwendet werden, um diese Versionen derselben Umgebung zu vergleichen, den Fortschritt zu visualisieren oder zu verstehen, was für die Entwicklung getan wurde/werden muss. Auch das Debuggen von Änderungen bei komplexeren Problemen ist mit CTT einfacher.

Derzeit unterstützte Konfigurationselemente

Ab der aktuellen Version bietet CTT Unterstützung für den Vergleich/Transport der folgenden Konfigurationselemente:

Nicht unterstützte Elemente

Derzeit unterstützt CTT weder die Visualisierung noch den Transport gelöschter Objekte wie Vorlagen, Klassen oder Attribute. Daher werden beim Importieren einer von CTT generierten Konfigurationsdatei in ESM keine Vorlagen, Klassen oder Attribute aus der Zielkonfiguration entfernt .

Da der Vergleich der Änderungen in CTT auf den Codes des Objekts (z. B. Attributcodes) basiert, kann CTT Änderungen in solchen Codes nicht erkennen . Beispielsweise wird ein Attribut mit einem geänderten Code in CTT als neues Attribut angezeigt.

Derzeit verfügt CTT nicht über die Fähigkeit , gemeinsame Attribute in nicht gemeinsam genutzten Klassen zu erkennen. Das bedeutet, dass beim Transport solcher Attribute diese im Zielsystem als neue Attribute erstellt werden.

Für Attribute wird der Transport der meisten Handler-Konfigurationen unterstützt. Handler-Konfigurationen, die nicht Teil der Attribut-Metadaten sind, werden nicht unterstützt . Dazu gehören beispielsweise EntityStateMail- Mail-Vorlagen.

Schritt-für-Schritt- uid

1. Konfigurationen exportieren
   Exportieren Sie Konfigurationen aus Quell- und Ziel-ESM-Umgebungen (normalerweise Test- und Produktionsumgebungen) über Wartung → Systemeinstellungen → Konfigurationen exportieren . Wählen Sie alle zutreffenden Konfigurationselementtypen aus (unter „Efekte Konfigurationen“ ).

2. CTT verwenden
   1. Öffnen Sie die CTT-Anwendung.
   2. Laden Sie exportierte Konfigurationen in CTT hoch und wählen Sie „Änderungen anzeigen“ aus.
      1. Der Upload-Bildschirm sollte unmittelbar nach dem Öffnen der Anwendung angezeigt werden. Falls der Upload-Bildschirm nicht geöffnet ist, klicken Sie in der Kopfzeile auf „Dateien hochladen“, um ihn zu öffnen.

Die Quelle sollte die Konfigurationsdatei mit den Änderungen sein. Normalerweise ist dies die Konfigurationsdatei aus einer Testumgebung. Das Ziel ist normalerweise die Konfiguration aus der aktuellen Produktion. Sie können die Konfiguration im XML- oder ZIP -Format hochladen.
Hinweis: Für große Konfigurationsdateien ist das ZIP-Format vorzuziehen, da es die Zeit zum Hochladen der Dateien verkürzt. Die Gesamtdateigröße muss unter 150 MB liegen .

3. Was Sie in CTT sehen können
   1. Unterschiede in den Vorlagen
      Alle geänderten Vorlagen werden im linken Menü angezeigt. Jede Vorlage, Klasse und jedes Attribut, das entweder neu (grün) oder geändert (gelb) ist, wird im Menü angezeigt. Wenn an der Vorlage, Klasse oder dem Attribut nichts geändert wurde, wird es nicht angezeigt. ( Hinweis : Derzeit entfernte Elemente werden nicht angezeigt/unterstützt.)
      
      Wenn Sie ein Attribut auswählen (klicken Sie auf den Attributnamen), werden die Änderungen an diesem Attribut in der Vergleichsansicht angezeigt:

b. Unterschiede bei den Zuhörern
Alle Vorlagen mit neuen oder geänderten Listenern werden im linken Menü angezeigt. Wählen Sie einen Listener aus, um die Änderungsdetails anzuzeigen.

c. Unterschiede in Ordnern
Neue Ordner (grün) und geänderte Ordner (gelb).

d. Rollenunterschiede
Neue Rollen (grün) und geänderte Rollen (gelb). Hinweis: Das Ändern der Vorlagen-, Ordner- oder Attributberechtigungen einer Rolle wird derzeit nicht als Änderung unterstützt.

4. Änderungen auswählen und Konfigurationsdatei erstellen
   1. Wählen Sie Änderungen durch Ankreuzen des Kontrollkästchens aus ( Hinweis : Derzeit können nur Vorlagen/Klassen/Attribute ausgewählt werden).
   2. Klicken Sie auf Änderungen übernehmen.
   3. Es öffnet sich ein Dialog, in dem Sie sehen können, ob Probleme oder Warnungen mit der generierten Konfigurationsdatei vorliegen. Klicken Sie auf Konfigurationsdatei herunterladen, um die generierte Konfigurationsdatei herunterzuladen.
      

5. Importieren der generierten Konfiguration in ESM
   Hinweis : Der Import der von CTT erstellten Konfigurationsdatei in ESM wird ab ESM 2023.3 unterstützt. Die Anforderungen finden Sie auch in den unten stehenden Administratorpraktiken .
   

Filter und Suche

Links über dem Änderungsbaum finden Sie Funktionen zum Filtern und Suchen von Daten. Beachten Sie, dass Filter und Suche nur die links angezeigten Änderungen betreffen. Wenn Sie Änderungen ausgewählt haben, die durch einen Filter oder eine Suche ausgeblendet sind, bleiben diese weiterhin ausgewählt.

Statusfilter

Statusfilter sind für alle Arten von Konfigurationselementen verfügbar – Vorlagen, Ordner und Rollen. Durch Deaktivieren eines Filters werden diese Änderungen aus der Ansicht ausgeblendet. Beachten Sie, dass geänderte Elemente wie Vorlagen oder Klassen nicht ausgeblendet werden, wenn ihnen neue Elemente untergeordnet sind.

Pro

Mit Vorlagen können spezielle Eigenschaftsfilter verwendet werden. Durch Deaktivieren eines Filters werden Änderungen ausgeblendet, die nur diesen Änderungstyp enthalten. Beispielsweise wird bei Lokalisierungen, wenn sich in einem Attribut nur die Lokalisierung ändert (hinzugefügte/geänderte Übersetzungen), das Attribut bei Verwendung des Filters ausgeblendet. Enthält das Attribut Lokalisierungsänderungen und weitere Änderungen, wird es nicht ausgeblendet.

Befehl

Mit „Reihenfolge“ werden die Klassen- oder Attributreihenfolgenummern in der Vorlage bezeichnet. Durch Deaktivieren dieses Filters werden Änderungen in der Ansicht ausgeblendet, in der lediglich die Reihenfolgenummer geändert wurde.

Lokalisierung

Lokalisierung bezieht sich auf hinzugefügte/geänderte Übersetzungen für Vorlagen, Klassen und Attribute. Durch Deaktivieren dieses Filters werden diese Änderungen aus der Ansicht ausgeblendet, in der sich lediglich die Lokalisierung ändert.

Suchen

Die Suche kann mit Vorlagen verwendet werden, um die Ansicht zu filtern. Sie können Namen oder Codes verwenden, um nach Vorlagen, Klassen und Attributen zu suchen. Die Suche kann in Kombination mit Filtern verwendet werden. Zur Verdeutlichung: Die Suche zeigt nur Ergebnisse von Änderungen an, die nicht durch die Filter ausgeblendet sind.

Dokument der ausgewählten Änderungen

Sie können ein PDF-Dokument mit allen ausgewählten Änderungen für Vorlagen, Klassen und Attribute herunterladen. Wählen Sie nach Auswahl der gewünschten Änderungen Änderungen übernehmen aus. Wählen Sie anschließend Dokumentationsdatei herunterladen aus:

Admin-Praktiken bei der Verwendung von CTT

• CTT wurde für Anwendungsfälle entwickelt, bei denen Änderungen über die Quellumgebung vorgenommen werden. Das Ändern der Zielumgebung ohne CTT-Import kann beim Importieren zu Funktionseinschränkungen führen.
• ESM muss die Plattformeinstellung configuration.import.update auf „true“ setzen, um die Aktualisierung der Konfiguration im Konfigurationsimport mit der von CTT generierten Konfigurationsdatei zu ermöglichen.
  • CTT erzeugt zudem eine Markierung in der generierten Konfigurationsdatei, die für den Import vorhanden sein muss.
  • Ohne die Plattformeinstellung und den Dateimarker funktioniert der Konfigurationsimport wie zuvor – er erstellt nur neue Objekte und aktualisiert nichts (nützlich zum Importieren einer gesamten Konfiguration in eine leere Datenbank).
• Für alle Objekte in der Konfiguration müssen Codes definiert sein : Vorlagen, Klassen, Attribute, statische Werte, Ordner, Rollen usw. CTT verwendet Codes, um Objekte abzugleichen und Unterschiede in der Konfiguration zu finden.
  • Mit der ESM-Funktionalität unter Wartung → Systemeinstellungen → Systemprüfung ausführen können Codes für Attribute gesucht und hinzugefügt werden.
  • Um Codes für Rollen hinzufügen zu können, muss die Plattformeinstellung adminrole.code.editable auf true gesetzt werden.
• Während es derzeit bewährte Vorgehensweise ist, den Namen eines Listeners zu aktualisieren, um ein Datum oder eine Versionsnummer einzuschließen, können Sie derzeit nur dann Unterschiede eines geänderten Listeners sehen , wenn der Name gleich bleibt .
  • Gleiches gilt für andere Objekte , die nur durch den Namen identifiziert werden (Vorlagenereignisse, Dashboards, Ansichten, geplante Aufgaben).
    • Hinweis: CTT unterstützt die oben genannten Objekte derzeit nicht. Die Unterstützung kann in zukünftigen Versionen hinzugefügt werden.
• Statische Werte müssen Codes haben, damit sie mit CTT funktionieren.