Översikt över verktyget

CTT (Configuration Transport Tool) är ett verktyg för Efecte Service Management (ESM)-administratörer för att visualisera ändringar som gjorts i applikationens konfiguration.

CTT erbjuder ett sätt att transportera ändringar mellan miljöer. I CTT är det möjligt att välja ändringar och skapa en konfigurationsfil, som sedan kan importeras till ESM för att automatiskt göra ändringar i den konfigurationen.

CTT jämför och visar skillnaderna mellan två konfigurationsfiler. Vanligtvis kommer en fil från testmiljön och en annan från produktionsmiljön.

Krav och tillgänglighet

Användning av verktyget kräver möjligheten att exportera konfigurationer från både käll- och mål-ESM-miljöerna, via Underhåll → Systeminställningar → Exportera konfigurationer.

Konfigurationstransport mellan miljöer (import av konfigurationsfil skapad med CTT) stöds från och med ESM version 2023.3 . Alla objekt stöds inte, se nedan för mer information.

För närvarande erbjuds CTT via en delad instans tillgänglig från Efecte Cloud . Du kan komma åt CTT-miljön här: CTT-miljö

Användningsfall

Administratören kan se vilka ändringar som har implementerats i testmiljön som ännu inte har flyttats till produktion. Ett annat användningsfall är att jämföra ändringar i samma miljö regelbundet. Om till exempel konfigurationen sparas från produktionsmiljön en gång i månaden kan du använda CTT för att se konfigurationsändringar som gjorts i miljön under varje månad.

För närvarande kan CTT upptäcka ändringar i mallkonfigurationer, till exempel tillagda klasser och attribut eller ändringar i attributkonfigurationen. CTT kan också visa skillnader i mappstruktur och roller. Skillnader i konfigurationen markeras i CTT.

Exempel på användningsfall för CTT

Säkerställa att ändringar överförs korrekt från en testmiljö till en Pro

Säkerställa att alla ändringar överförs korrekt från en testmiljö till en produktionsmiljö när en ändring först skapas och testas med en testmiljö.

Konfiguration byggs vanligtvis i en testmiljö innan samma konfiguration implementeras i en produktionsmiljö. Det första användningsfallet för CTT är att jämföra konfigurationen mellan de två miljöerna och se till att alla ändringar som byggts i testmiljön implementeras igen i produktionsmiljön.

Uppdatera en testmiljö så att den matchar konfigurationen i Pro

Testmiljöer behöver ibland uppdateras för att matcha produktionen innan en ny utveckling påbörjas. Detta kan bero på ändrade planer och att vissa planerade utvecklingsobjekt inte går live. CTT kan användas i dessa fall för att kontrollera om något saknas eller ändras i testet och hjälpa till att få miljöerna till samma nivå innan nästa utvecklingsobjekt påbörjas.

Versionshantering av konfigurationen under utveckling

Det är en bra vana att exportera en konfiguration innan man påbörjar ny funktionsutveckling och även ibland under utvecklingen. CTT kan användas för att jämföra dessa versioner av samma miljö för att visualisera framstegen eller för att förstå vad som görs/behöver göras för utvecklingen. Det är också enklare att felsöka ändringar med CTT om mer komplexa problem uppstår.

Konfigurationsobjekt som för närvarande stöds

Från och med den nuvarande versionen tillhandahåller CTT stöd för att jämföra/transportera följande konfigurationsobjekt:

Objekt som inte stöds

För närvarande stöder inte CTT visualisering eller transport av borttagna objekt som mallar, klasser eller attribut. Därför kommer import av en CTT-genererad konfigurationsfil till ESM inte att ta bort någon mall, klass eller attribut från målkonfigurationen.

Eftersom jämförelsen av ändringarna i CTT är beroende av objektets koder (såsom attributkoder), kan CTT inte upptäcka ändringar i sådana koder . Till exempel visas ett attribut med en ändrad kod som ett nytt attribut i CTT.

För närvarande har CTT ingen kapacitet att upptäcka delade attribut i icke-delade klasser . Det betyder att om sådana attribut transporteras kommer de att skapas som nya attribut i målsystemet.

För attribut stöds transport av de flesta hanterarkonfigurationer. Hanterarkonfigurationer som inte ingår i attributmetadata stöds inte . Detta inkluderar till exempel e-postmallar för EntityStateMail .

Steg-för-steg- uid

1. Exportera konfigurationer
   Exportera konfigurationer från käll- och mål-ESM-miljöer (vanligtvis test och produktion) via Underhåll → Systeminställningar → Exportera konfigurationer . Välj alla tillämpliga konfigurationsobjekttyper (under Efecte-konfigurationer ).

2. Använda CTT
   1. Öppna CTT-applikationen.
   2. Ladda upp exporterade konfigurationer till CTT, välj visa ändringar .
      1. Uppladdningsskärmen bör visas omedelbart efter att programmet öppnats. Om uppladdningsskärmen inte är öppen klickar du på Ladda upp filer i sidhuvudet för att öppna den.

Källa ska vara konfigurationsfilen som innehåller ändringarna. Vanligtvis är detta konfigurationsfilen från en testmiljö. Målfilen är vanligtvis konfigurationen från aktuell produktion. Du kan ladda upp konfigurationen i XML- eller ZIP -format.
Obs: För stora konfigurationsfiler är ZIP-format att föredra eftersom det minskar tiden det tar att ladda upp filerna. Den sammanlagda filstorleken måste vara under 150 MB .

3. Vad du kan se i CTT
   1. Skillnader i mallar
      Alla mallar som har ändrats visas i menyn till vänster. Varje mall, klass och attribut som antingen är ny (grön) eller ändrad (gul) visas i menyn. Om ingenting ändras i mallen, klassen eller attributet visas det inte. ( Obs : borttagna objekt visas/stöds inte.)
      
      Om du väljer ett attribut (klicka på attributnamnet) visas ändringarna av det attributet i jämförelsevyn:

b. Skillnader i lyssnare
Alla mallar som har nya eller ändrade lyssnare visas i menyn till vänster. Välj en lyssnare för att se ändringsinformationen.

c. Skillnader i mappar
Nya mappar (gröna) och ändrade mappar (gula).

d. Skillnader i roller
Nya roller (grön) och ändrade roller (gul). Obs: ändring av rollens mall-, mapp- eller attributbehörigheter stöds ännu inte som en ändring.

4. Markera ändringar och skapa konfigurationsfil
   1. Markera ändringar genom att markera kryssrutan ( Obs : för närvarande kan endast mallar/klasser/attribut väljas).
   2. Klicka på Verkställ ändringar.
   3. En dialogruta öppnas där du kan se om det finns några problem eller varningar med den genererade konfigurationsfilen. Klicka på Ladda ner konfigurationsfil för att ladda ner den genererade konfigurationsfilen.
      

5. Importerar genererad konfiguration till ESM
   Obs ! Import av CTT-skapad konfigurationsfil till ESM stöds från och med ESM 2023.3. Se även Administratörspraxis nedan för krav.
   

Filter och sökning

På vänster sida, ovanför ändringsträdet, hittar du funktioner för att filtrera och söka data. Observera att filter och sökning endast påverkar vad som visas på vänster sida (ändringsträdet). Om du har valt några ändringar som är dolda på grund av ett filter eller en sökning, kommer de fortfarande att vara markerade.

Tillståndsfilter

Tillståndsfilter är tillgängliga för alla typer av konfigurationsobjekt – mallar, mappar och roller. Genom att avmarkera ett filter döljs den typen av ändringar från vyn. Observera att för ändrade objekt döljs inte ändrade objekt som mallar eller klasser, om de har nya objekt under sig.

Pro

Speciella egenskapsfilter kan användas med mallar. Genom att avmarkera ett filter döljs de ändringar som endast innehåller den typen av ändring. Till exempel, med lokaliseringar, om det bara finns en ändring i lokaliseringen (tillagda/ändrade översättningar) i ett attribut, kommer attributet att döljas när filter används. Om attributet innehåller lokaliseringsändringar och vissa andra ändringar kommer det inte att döljas.

Beställa

Ordning hänvisar till klass- eller attributordernummer i mallen. Genom att avmarkera det här filtret döljs dessa ändringar från vyn där den enda ändringen är av ordernumret.

Lokalisering

Lokalisering avser tillagda/ändrade översättningar för mallar, klasser och attribut. Genom att avmarkera det här filtret döljs dessa ändringar från vyn där den enda ändringen är av lokaliseringen.

Söka

Sökning kan användas med mallar där du kan använda den för att filtrera vyn. Du kan använda namn eller koder för att söka efter mallar, klasser och attribut. Sökning kan användas i kombination med filter. För att förtydliga visar sökningen endast resultat från ändringar som inte döljs av filtren.

Dokument över de valda ändringarna

Du kan ladda ner ett PDF-dokument som innehåller alla valda ändringar för mallar, klasser och attribut. När du har valt relevanta ändringar väljer du Verkställ ändringar . Välj sedan Ladda ner dokumentationsfil :

Administrativa rutiner vid användning av CTT

• CTT är utformat för att stödja användningsfall där ändringar görs via källmiljön. Att modifiera målmiljön utan CTT-import kan förstöra vissa funktioner vid import.
• ESM måste ha plattformsinställningen configuration.import.update satt till true för att möjliggöra uppdatering av konfigurationen i konfigurationsimporten med konfigurationsfilen som genereras av CTT.
  • CTT producerar också en markör i den genererade konfigurationsfilen, vilken måste finnas för importen.
  • Utan plattformsinställningen och filmarkören fungerar konfigurationsimporten som den har fungerat tidigare - den skapar bara nya objekt och uppdaterar ingenting (användbart för att importera en hel konfiguration till en tom databas)
• Alla objekt i konfigurationen måste ha definierade koder : mallar, klasser, attribut, statiska värden, mappar, roller etc. CTT använder koder för att matcha objekt och hitta skillnader i konfigurationen.
  • ESM-funktionaliteten i Underhåll → Systeminställningar → Kör systemkontroll kan användas för att hitta och lägga till koder för attribut.
  • För att kunna lägga till koder för roller måste plattformsinställningen adminrole.code.editable vara inställd på true .
• Även om det är bästa praxis att uppdatera namnet på en lyssnare för att inkludera ett datum eller versionsnummer, kan du för närvarande bara se skillnader för en ändrad lyssnare om namnet behålls detsamma .
  • Detsamma gäller för andra objekt som endast identifieras med namn (mallhändelser, instrumentpaneler, vyer, schemalagda uppgifter)
    • Obs: CTT har för närvarande inte stöd för ovannämnda objekt. Stöd kan läggas till i framtida versioner.
• Statiska värden måste ha kod för att de ska fungera med CTT.