Przegląd narzędzia

CTT (Configuration Transport Tool) to narzędzie dla administratorów Efecte Service Management (ESM) umożliwiające wizualizację zmian wprowadzonych w konfiguracji aplikacji.

CTT umożliwia przenoszenie zmian między środowiskami. W CTT możliwe jest wybranie zmian i utworzenie pliku konfiguracyjnego, który następnie można zaimportować do ESM, aby automatycznie wprowadzić zmiany w tej konfiguracji.

CTT porównuje i pokazuje różnice między dwoma plikami konfiguracyjnymi. Zazwyczaj jeden plik pochodzi ze środowiska testowego, a drugi ze środowiska produkcyjnego.

Wymagania i dostępność

Aby móc korzystać z tego narzędzia, konieczna jest możliwość eksportowania konfiguracji zarówno ze środowiska źródłowego, jak i docelowego ESM, za pośrednictwem opcji Konserwacja → Ustawienia systemowe → Eksportuj konfiguracje.

Transport konfiguracji między środowiskami (import pliku konfiguracyjnego utworzonego za pomocą CTT) jest obsługiwany od wersji ESM 2023.3 . Nie wszystkie elementy są obsługiwane. Więcej informacji poniżej.

Obecnie CTT jest oferowane za pośrednictwem jednej współdzielonej instancji dostępnej w Efecte Cloud . Dostęp do środowiska CTT można uzyskać tutaj: Środowisko CTT

Przypadek użycia

Administrator może przeglądać zmiany wprowadzone w środowisku testowym, które nie zostały jeszcze przeniesione do środowiska produkcyjnego. Innym przykładem zastosowania jest okresowe porównywanie zmian w tym samym środowisku. Na przykład, jeśli konfiguracja jest zapisywana ze środowiska produkcyjnego raz w miesiącu, można użyć CTT, aby zobaczyć zmiany konfiguracji wprowadzone w środowisku w danym miesiącu.

Obecnie CTT potrafi wykrywać zmiany w konfiguracjach szablonów, na przykład dodane klasy i atrybuty lub zmiany w konfiguracji atrybutów. CTT może również wskazywać różnice w strukturze folderów i rolach. Różnice w konfiguracji są podświetlane w CTT.

Przykładowe przypadki użycia CTT

Zapewnienie prawidłowego przeniesienia zmian ze środowiska testowego do Pro

Upewnienie się, że wszystkie zmiany zostaną poprawnie przeniesione ze środowiska testowego do produkcyjnego, gdy zmiana zostanie po raz pierwszy wprowadzona i przetestowana w środowisku testowym.

Konfiguracja jest zazwyczaj tworzona w środowisku testowym przed wdrożeniem tej samej konfiguracji w środowisku produkcyjnym. Pierwszym zastosowaniem CTT jest porównanie konfiguracji między dwoma środowiskami i upewnienie się, że wszystkie zmiany wprowadzone w środowisku testowym zostaną ponownie zaimplementowane w środowisku produkcyjnym.

Odświeżanie środowiska testowego w celu dopasowania konfiguracji do środowiska Pro

Czasami przed rozpoczęciem nowego etapu rozwoju środowiska testowe wymagają odświeżenia, aby były zgodne ze środowiskiem produkcyjnym. Może to wynikać ze zmiany planów i braku wdrożenia niektórych zaplanowanych elementów rozwoju. W takich przypadkach można skorzystać z CTT, aby sprawdzić, czy czegoś brakuje lub nie zmieniono w testach, i pomóc w doprowadzeniu środowisk do tego samego poziomu przed rozpoczęciem kolejnego etapu rozwoju.

Wersjonowanie konfiguracji podczas jej tworzenia

Dobrą praktyką jest eksportowanie konfiguracji przed rozpoczęciem opracowywania nowej funkcji, a także okazjonalnie w trakcie jej trwania. CTT można wykorzystać do porównania tych wersji tego samego środowiska, aby zwizualizować postępy lub pomóc zrozumieć, co zostało zrobione/co należy zrobić w ramach rozwoju. CTT ułatwia również debugowanie zmian w przypadku wystąpienia bardziej złożonych problemów.

Aktualnie obsługiwane elementy konfiguracji

W obecnej wersji CTT zapewnia obsługę porównywania/transportowania następujących elementów konfiguracji:

Nieobsługiwane elementy

Obecnie CTT nie obsługuje wizualizacji ani przenoszenia usuniętych obiektów , takich jak szablony, klasy czy atrybuty. W związku z tym zaimportowanie pliku konfiguracyjnego wygenerowanego przez CTT do ESM nie spowoduje usunięcia żadnego szablonu, klasy ani atrybutu z konfiguracji docelowej.

Ponieważ porównanie zmian w CTT opiera się na kodach obiektu (takich jak kody atrybutów), CTT nie jest w stanie wykryć zmian w takich kodach . Na przykład atrybut ze zmienionym kodem jest wyświetlany jako nowy atrybut w CTT.

Obecnie CTT nie ma możliwości wykrywania atrybutów współdzielonych w klasach niewspółdzielonych . Oznacza to, że jeśli takie atrybuty zostaną przeniesione, zostaną one utworzone jako nowe atrybuty w systemie docelowym.

W przypadku atrybutów obsługiwane jest transportowanie większości konfiguracji obsługi. Konfiguracja obsługi, która nie jest częścią metadanych atrybutu, nie jest obsługiwana . Dotyczy to na przykład szablonów poczty EntityStateMail .

Przewodnik krok po uid

1. Eksportowanie konfiguracji
   Eksportuj konfiguracje ze środowisk źródłowych i docelowych ESM (zwykle testowych i produkcyjnych) poprzez Konserwacja → Ustawienia systemu → Eksportuj konfiguracje . Wybierz wszystkie odpowiednie typy elementów konfiguracji (w sekcji Konfiguracje efektów ).

2. Korzystanie z CTT
   1. Otwórz aplikację CTT.
   2. Prześlij wyeksportowane konfiguracje do CTT, wybierz opcję Wyświetl zmiany .
      1. Ekran przesyłania powinien wyświetlić się natychmiast po otwarciu aplikacji. Jeśli ekran przesyłania nie jest otwarty, kliknij „Prześlij pliki” w nagłówku, aby go otworzyć.

Źródłem powinien być plik konfiguracyjny zawierający zmiany. Zazwyczaj jest to plik konfiguracyjny ze środowiska testowego. Docelowo zazwyczaj jest to konfiguracja z bieżącej produkcji. Konfigurację można przesłać w formacie XML lub ZIP .
Uwaga: w przypadku dużych plików konfiguracyjnych preferowany jest format ZIP, ponieważ skraca on czas przesyłania plików. Łączny rozmiar pliku musi być mniejszy niż 150 MB .

3. Co możesz zobaczyć w CTT
   1. Różnice w szablonach
      Wszystkie szablony ze zmianami są wyświetlane w menu po lewej stronie. Każdy szablon, klasa i atrybut, który jest nowy (zielony) lub zmieniony (żółty), są wyświetlane w menu. Jeśli w szablonie, klasie lub atrybucie nic nie zmieniono, nie są one wyświetlane. ( Uwaga : aktualnie usunięte elementy nie są wyświetlane/obsługiwane).
      
      Wybranie atrybutu (kliknięcie nazwy atrybutu) spowoduje wyświetlenie zmian tego atrybutu w widoku porównania:

b. Różnice między słuchaczami
Wszystkie szablony z nowymi lub zmienionymi słuchaczami są wyświetlane w menu po lewej stronie. Wybierz słuchacza, aby wyświetlić szczegóły zmiany.

c. Różnice w folderach
Nowe foldery (zielone) i zmienione foldery (żółte).

d. Różnice w rolach
Nowe role (zielone) i zmienione role (żółte). Uwaga: zmiana szablonu roli, uprawnień do folderów lub atrybutów nie jest jeszcze obsługiwana jako zmiana.

4. Wybieranie zmian i tworzenie pliku konfiguracyjnego
   1. Wybierz zmiany, zaznaczając pole wyboru ( Uwaga : obecnie można wybierać tylko szablony/klasy/atrybuty).
   2. Kliknij Zastosuj zmiany.
   3. Otworzy się okno dialogowe, w którym możesz sprawdzić, czy występują jakieś problemy lub ostrzeżenia dotyczące wygenerowanego pliku konfiguracyjnego. Kliknij „Pobierz plik konfiguracyjny” , aby pobrać wygenerowany plik konfiguracyjny.
      

5. Importowanie wygenerowanej konfiguracji do ESM
   Uwaga : Importowanie pliku konfiguracyjnego utworzonego przez CTT do ESM jest obsługiwane od wersji ESM 2023.3. Wymagania znajdują się również w poniższych Praktykach administracyjnych .
   

Filtry i wyszukiwanie

Po lewej stronie, nad drzewem zmian, znajdują się funkcje filtrowania i wyszukiwania danych. Należy pamiętać, że filtry i wyszukiwanie dotyczą tylko tego, co jest wyświetlane po lewej stronie (drzewo zmian). Jeśli zaznaczono zmiany ukryte z powodu filtra lub wyszukiwania, nadal pozostaną zaznaczone.

Filtry stanu

Filtry stanu są dostępne dla wszystkich typów elementów konfiguracji – szablonów, folderów i ról. Odznaczenie filtra spowoduje ukrycie tego typu zmian w widoku. Należy pamiętać, że w przypadku zmienionych elementów, takie jak szablony czy klasy, nie ukryją one zmienionych elementów, jeśli pod nimi znajdują się nowe elementy.

Filtry Pro

Specjalne filtry właściwości można stosować z szablonami. Odznaczenie filtra spowoduje ukrycie zmian, które zawierają tylko tego typu zmiany. Na przykład, w przypadku lokalizacji, jeśli w atrybucie występuje tylko zmiana lokalizacji (dodano/zmieniono tłumaczenia), atrybut zostanie ukryty po użyciu filtra. Jeśli atrybut zawiera zmiany lokalizacji i inne zmiany, nie zostanie ukryty.

Zamówienie

„Kolejność” odnosi się do numerów porządkowych klas lub atrybutów w szablonie. Odznaczenie tego filtra spowoduje ukrycie zmian w widoku, w którym jedyną zmianą jest numer porządkowy.

Lokalizacja

Lokalizacja odnosi się do dodanych/zmienionych tłumaczeń szablonów, klas i atrybutów. Odznaczenie tego filtra powoduje, że zmiany te są ukrywane w widoku, w którym jedyną zmianą jest lokalizacja.

Szukaj

Wyszukiwania można używać z szablonami, filtrując widok. Do wyszukiwania szablonów, klas i atrybutów można używać nazw lub kodów. Wyszukiwania można używać w połączeniu z filtrami. Dla wyjaśnienia, wyszukiwanie wyświetla tylko wyniki zmian, które nie zostały ukryte przez filtry.

Dokument wybranych zmian

Możesz pobrać dokument PDF zawierający wszystkie wybrane zmiany dotyczące szablonów, klas i atrybutów. Po wybraniu odpowiednich zmian kliknij Zastosuj zmiany . Następnie wybierz Pobierz plik dokumentacji :

Praktyki administracyjne podczas korzystania z CTT

• CTT został zaprojektowany z myślą o obsłudze przypadków użycia, w których zmiany są wprowadzane za pośrednictwem środowiska źródłowego. Modyfikacja środowiska docelowego bez importu CTT może spowodować utratę niektórych funkcji podczas importowania.
• Aby umożliwić aktualizację konfiguracji w imporcie konfiguracji przy użyciu pliku konfiguracyjnego wygenerowanego przez CTT, ESM musi mieć ustawienie platformy configuration.import.update ustawione na true
  • CTT generuje również znacznik w generowanym pliku konfiguracyjnym, który musi być obecny w celu importu.
  • Bez ustawień platformy i znacznika pliku import konfiguracji działa tak jak dotychczas — tworzy tylko nowe obiekty i niczego nie aktualizuje (przydatne w przypadku importowania całej konfiguracji do pustej bazy danych).
• Wszystkie obiekty w konfiguracji muszą mieć zdefiniowane kody : szablony, klasy, atrybuty, wartości statyczne, foldery, role itd. CTT używa kodów do dopasowywania obiektów i znajdowania różnic w konfiguracji.
  • Funkcjonalność ESM w Konserwacja → Ustawienia systemu → Uruchom sprawdzanie systemu może być używana do znajdowania i dodawania kodów dla atrybutów.
  • Aby móc dodawać kody dla ról, ustawienie platformy adminrole.code.editable musi być ustawione na true .
• Chociaż obecnie najlepszą praktyką jest aktualizacja nazwy obiektu nasłuchującego poprzez dodanie daty i numeru wersji, w danej chwili różnice między zmienionymi obiektami nasłuchu można zobaczyć tylko wtedy, gdy nazwa obiektu nasłuchującego pozostanie taka sama .
  • To samo dotyczy innych obiektów , które są identyfikowane tylko po nazwie (wydarzenia szablonowe, pulpity nawigacyjne, widoki, zadania zaplanowane)
    • Uwaga: CTT obecnie nie obsługuje wyżej wymienionych obiektów. Obsługa może zostać dodana w przyszłych wersjach.
• Wartości statyczne muszą mieć kody, aby działały z CTT.