Työkalun yleiskatsaus

CTT (Configuration Transport Tool) on työkalu, jonka avulla Efecte Service Managementin (ESM) ylläpitäjät voivat visualisoida sovelluksen konfiguraatioon tehtyjä muutoksia.

CTT tarjoaa tavan siirtää muutoksia ympäristöjen välillä. CTT:ssä voi valita muutoksia ja luoda konfiguraatiotiedoston, joka voidaan sitten tuoda ESM:ään tekemään muutokset kyseiseen konfiguraatioon automaattisesti.

CTT vertailee ja näyttää erot kahden konfiguraatiotiedoston välillä. Tyypillisesti toinen tiedosto on testiympäristöstä ja toinen tuotantoympäristöstä. 

Vaatimukset ja saatavuus

Työkalun käyttö edellyttää mahdollisuutta viedä konfiguraatioita sekä lähde- että kohde-ESM-ympäristöistä kohdasta Maintenance → System settings → Export configurations.

Konfiguraation siirto ympäristöjen välillä (CTT:llä luodun konfiguraatiotiedoston tuonti) tuetaan alkaen ESM-versiosta 2023.3. Kaikkia kohteita ei tueta, katso lisätietoja alta.

Tällä hetkellä CTT tarjotaan yhden jaetun instanssin kautta Efecte Cloudissa. Pääset CTT-ympäristöön täällä: CTT-ympäristö

Käyttötapaus

Ylläpitäjä voi tarkastella, mitä muutoksia testiympäristöön on toteutettu mutta joita ei ole vielä siirretty tuotantoon. Toinen käyttötapaus on saman ympäristön muutosten vertailu säännöllisin väliajoin. Jos esimerkiksi konfiguraatio tallennetaan tuotantoympäristöstä kerran kuukaudessa, CTT:llä voi nähdä ympäristöön kunkin kuukauden aikana tehdyt konfiguraatiomuutokset.

Tällä hetkellä CTT pystyy havaitsemaan muutokset mallien konfiguraatioissa, esimerkiksi lisätyt luokat ja attribuutit tai muutokset attribuuttien määrityksissä. CTT voi myös näyttää erot kansiorakenteessa ja rooleissa. Konfiguraation erot korostetaan CTT:ssä.

Esimerkkikäyttötapauksia CTT:lle

Muutosten oikean siirtymisen varmistaminen testiympäristöstä tuotantoympäristöön

Varmistetaan, että kaikki muutokset siirtyvät oikein testiympäristöstä tuotantoympäristöön, kun muutos ensin rakennetaan ja testataan testiympäristössä.

Konfiguraatio rakennetaan yleensä testiympäristössä ennen saman konfiguraation toteuttamista tuotantoympäristössä. CTT:n ensimmäinen käyttötapaus on verrata kahden ympäristön konfiguraatiota ja varmistaa, että kaikki testiympäristössä rakennetut muutokset toteutetaan myös tuotantoympäristössä.

Testiympäristön päivittäminen vastaamaan tuotantoympäristön konfiguraatiota

Testiympäristöjä on toisinaan tarpeen päivittää vastaamaan tuotantoa ennen uuden kehitystyön aloittamista. Tämä voi johtua suunnitelmien muutoksesta, jolloin joitakin suunniteltuja kehityskohteita ei julkaista. CTT:tä voidaan käyttää näissä tapauksissa tarkistamaan, puuttuuko testistä jotain tai onko siihen tehty muutoksia, ja auttamaan ympäristöjen saattamisessa samalle tasolle ennen seuraavan kehityskohteen aloittamista.

Konfiguraation versiointi kehityksen aikana

On hyvä käytäntö ottaa vienti konfiguraatiosta ennen uuden ominaisuuden kehityksen aloittamista ja myös ajoittain kehityksen aikana. CTT:llä voidaan vertailla saman ympäristön näitä eri versioita edistymisen visualisoimiseksi tai kehitystyön tilan ymmärtämisen helpottamiseksi. CTT helpottaa myös muutosten virheenjäljitystä, jos ilmenee monimutkaisempia ongelmia.

Tällä hetkellä tuetut konfiguraatiokohteet

Nykyisessä versiossa CTT tukee seuraavien konfiguraatiokohteiden vertailua/siirtoa:

Ei-tuetut kohteet

Tällä hetkellä CTT ei tue poistettujen objektien, kuten mallien, luokkien tai attribuuttien, visualisointia tai siirtoa. Näin ollen CTT:n luoman konfiguraatiotiedoston tuonti ESM:ään ei poista mitään mallia, luokkaa tai attribuuttia kohdekonfiguraatiosta.

Koska CTT:n muutosvertailu perustuu objektien koodeihin (kuten attribuuttikoodeihin), CTT ei pysty havaitsemaan näiden koodien muutoksia. Esimerkiksi attribuutti, jonka koodi on muuttunut, näkyy CTT:ssä uutena attribuuttina.

Tällä hetkellä CTT:llä ei ole kykyä havaita jaettuja attribuutteja ei-jaetuissa luokissa. Tämä tarkoittaa, että jos tällaisia attribuutteja siirretään, ne luodaan kohdejärjestelmään uusina attribuutteina.

Attribuuttien osalta useimpien käsittelijäkonfiguraatioiden siirto on tuettu. Käsittelijäkonfiguraatiota, joka ei ole osa attribuutin metatietoja, ei tueta. Tämä koskee esimerkiksi EntityStateMail-sähköpostimalleja.

Vaiheittainen opas

1. Konfiguraatioiden vienti
   Vie konfiguraatiot lähde- ja kohde-ESM-ympäristöistä (yleensä testi ja tuotanto) kohdasta Maintenance → System settings → Export configurations. Valitse kaikki soveltuvat konfiguraatiokohdetyypit (kohdassa Efecte configurations).

2. CTT:n käyttäminen
   1. Avaa CTT-sovellus.
   2. Lataa viedyt konfiguraatiot CTT:hen ja valitse view changes.
      1. Latausnäkymän tulisi tulla näkyviin heti sovelluksen avaamisen jälkeen. Jos latausnäkymä ei ole auki, avaa se napsauttamalla otsikkopalkin Upload Files -painiketta.

Source-kentän tulee olla muutoksia sisältävä konfiguraatiotiedosto. Yleensä tämä on testiympäristön konfiguraatiotiedosto. Target on yleensä nykyisen tuotannon konfiguraatio. Konfiguraation voi ladata XML- tai ZIP-muodossa.
Huomautus: suurille konfiguraatiotiedostoille ZIP-muoto on suositeltavampi, koska se lyhentää tiedostojen latausaikaa. Tiedostojen yhteiskoon on oltava alle 150 Mt.

3. Mitä CTT:ssä näkyy
   1. Erot malleissa
      Kaikki muutoksia sisältävät mallit näkyvät vasemman reunan valikossa. Jokainen malli, luokka ja attribuutti, joka on joko uusi (vihreä) tai muutettu (keltainen) , näkyy valikossa. Jos malliin, luokkaan tai attribuuttiin ei ole tehty muutoksia, sitä ei näytetä. (Huomautus: tällä hetkellä poistettuja kohteita ei näytetä/tueta.)
      
      Attribuutin valitseminen (napsauttamalla attribuutin nimeä) näyttää kyseisen attribuutin muutokset vertailunäkymässä:

b. Erot kuuntelijoissa
Kaikki mallit, joissa on uusia tai muutettuja kuuntelijoita, näkyvät vasemman reunan valikossa. Valitse kuuntelija nähdäksesi muutosten yksityiskohdat.

c. Erot kansioissa
Uudet kansiot (vihreä) ja muutetut kansiot (keltainen).

d. Erot rooleissa
Uudet roolit (vihreä) ja muutetut roolit (keltainen). Huomautus: roolin malli-, kansio- tai attribuuttikohtaisten käyttöoikeuksien muutosta ei vielä tueta muutoksena.

4. Muutosten valitseminen ja konfiguraatiotiedoston luominen
   1. Valitse muutokset rastittamalla valintaruutu (Huomautus: tällä hetkellä voi valita vain malleja/luokkia/attribuutteja).
   2. Napsauta Apply changes.
   3. Avautuu valintaikkuna, jossa näet, onko luodussa konfiguraatiotiedostossa ongelmia tai varoituksia. Lataa luotu konfiguraatiotiedosto napsauttamalla Download configuration file.
       

5. Luodun konfiguraation tuonti ESM:ään
   Huomautus: CTT:llä luodun konfiguraatiotiedoston tuonti ESM:ään on tuettu ESM 2023.3:sta alkaen. Katso vaatimukset myös alla olevasta kohdasta Admin Practices.
    

Suodattimet ja haku

Vasemmalla puolella, Changes-puun yläpuolella, on toimintoja tietojen suodattamiseen ja hakemiseen. Huomaa, että suodattimet ja haku vaikuttavat vain siihen, mitä vasemmalla puolella (muutospuussa) näytetään. Jos olet valinnut muutoksia, jotka piiloutuvat suodattimen tai haun vuoksi, ne pysyvät silti valittuina.

Tilasuodattimet

Tilasuodattimet ovat käytettävissä kaikentyyppisille konfiguraatiokohteille - malleille, kansioille ja rooleille. Suodattimen valinnan poistaminen piilottaa kyseisen tyyppiset muutokset näkymästä. Huomaa, että muutettujen kohteiden osalta se ei piilota muutettuja kohteita, kuten malleja tai luokkia, jos niiden alla on uusia kohteita.

Ominaisuussuodattimet

Malleille voidaan käyttää erityisiä ominaisuussuodattimia. Suodattimen valinnan poistaminen piilottaa muutokset, jotka sisältävät vain kyseisen tyyppisen muutoksen. Esimerkiksi lokalisointien osalta, jos attribuutissa on muutos vain lokalisoinnissa (lisätyt/muutetut käännökset), attribuutti piilotetaan suodattimen ollessa käytössä. Jos attribuutissa on lokalisointimuutosten lisäksi myös muita muutoksia, sitä ei piiloteta.

Järjestys

Järjestys viittaa luokan tai attribuutin järjestysnumeroihin mallissa. Tämän suodattimen valinnan poistaminen piilottaa näkymästä muutokset, joissa ainoa muutos koskee järjestysnumeroa.

Lokalisointi

Lokalisointi viittaa mallien, luokkien ja attribuuttien lisättyihin/muutettuihin käännöksiin. Tämän suodattimen valinnan poistaminen piilottaa näkymästä muutokset, joissa ainoa muutos koskee lokalisointia.

Haku

Hakua voidaan käyttää mallien kanssa näkymän suodattamiseen. Voit hakea malleja, luokkia ja attribuutteja nimillä tai koodeilla. Hakua voidaan käyttää yhdessä suodattimien kanssa. Selvyyden vuoksi: haku näyttää tuloksia vain muutoksista, joita suodattimet eivät piilota.

Valittujen muutosten dokumentti

Voit ladata PDF-dokumentin, joka sisältää kaikki valitut muutokset malleille, luokille ja attribuuteille. Kun olet valinnut haluamasi muutokset, valitse Apply changes. Valitse sitten Download documentation file:

Ylläpitokäytännöt CTT:tä käytettäessä

• CTT on suunniteltu tukemaan käyttötapauksia, joissa muutokset tehdään lähdeympäristön kautta. Kohdeympäristön muokkaaminen ilman CTT-tuontia saattaa rikkoa joitakin toimintoja tuonnin yhteydessä.
• ESM:ssä alustan asetuksen configuration.import.update tulee olla true, jotta CTT:n luoman konfiguraatiotiedoston tuonti voi päivittää konfiguraatiota
  • CTT lisää luotuun konfiguraatiotiedostoon myös merkinnän, jonka on oltava läsnä tuontia varten.
  • Ilman alustan asetusta ja tiedostomerkintää konfiguraation tuonti toimii kuten ennenkin - se vain luo uusia objekteja eikä päivitä mitään (hyödyllistä koko konfiguraation tuonnissa tyhjään tietokantaan)
• Kaikilla konfiguraation objekteilla tulee olla koodit määriteltynä: malleilla, luokilla, attribuuteilla, staattisilla arvoilla, kansioilla, rooleilla jne. CTT käyttää koodeja objektien täsmäyttämiseen ja erojen löytämiseen konfiguraatiosta.
  • ESM:n toimintoa kohdassa Maintenance → System settings → Run system check voidaan käyttää attribuuttien koodien löytämiseen ja lisäämiseen.
  • Jotta rooleille voidaan lisätä koodeja, alustan asetuksen adminrole.code.editable tulee olla true.
• Vaikka kuuntelijan nimen päivittäminen sisältämään päivämäärä tai versionumero on nykyinen paras käytäntö, tällä hetkellä muutetun kuuntelijan erot näkyvät vain, jos nimi pysyy samana.
  • Sama pätee muihin objekteihin, jotka tunnistetaan vain nimen perusteella (template events, dashboards, views, scheduled tasks)
    • Huomautus: CTT ei tällä hetkellä tue edellä mainittuja objekteja. Tuki saatetaan lisätä tulevissa versioissa.
• Staattisilla arvoilla täytyy olla koodit, jotta ne toimivat CTT:n kanssa.