Présentation de l'outil

CTT (Configuration Transport Tool) est un outil permettant aux administrateurs d'Efecte Service Management (ESM) de visualiser les modifications apportées à la configuration de l'application.

CTT permet de transférer les modifications entre les environnements. Il permet de sélectionner les modifications et de créer un fichier de configuration, qui peut ensuite être importé dans ESM pour y apporter automatiquement des modifications.

CTT compare et met en évidence les différences entre deux fichiers de configuration. Généralement, un fichier provient de l'environnement de test et l'autre de l'environnement de production.

Exigences et disponibilité

L'utilisation de l'outil nécessite la possibilité d' exporter des configurations à partir des environnements ESM source et cible, via Maintenance → Paramètres système → Exporter les configurations.

Le transport de configuration entre environnements (importation du fichier de configuration créé avec CTT) est pris en charge à partir de la version 2023.3 d'ESM . Tous les éléments ne sont pas pris en charge ; voir ci-dessous pour plus d'informations.

Actuellement, CTT est proposé via une instance partagée disponible sur Efecte Cloud . Vous pouvez accéder à l'environnement CTT ici : Environnement CTT

Cas d'utilisation

L'administrateur peut visualiser les modifications implémentées dans l'environnement de test et non encore déployées en production. Un autre cas d'utilisation consiste à comparer périodiquement les modifications d'un même environnement. Par exemple, si la configuration est enregistrée depuis l'environnement de production une fois par mois, vous pouvez utiliser CTT pour visualiser les modifications de configuration apportées à l'environnement chaque mois.

Actuellement, CTT est capable de détecter les modifications dans les configurations de modèles, par exemple l'ajout de classes et d'attributs, ou la modification de la configuration des attributs. CTT peut également afficher les différences de structure de dossiers et de rôles. Les différences de configuration sont mises en évidence dans CTT.

Exemples de cas d'utilisation pour CTT

S'assurer que les modifications sont correctement transférées d'un environnement de test à un environnement de Pro

S'assurer que toutes les modifications sont correctement transférées d'un environnement de test vers un environnement de production lorsqu'une modification est créée et testée pour la première fois avec un environnement de test.

La configuration est généralement construite dans un environnement de test avant d'être implémentée en production. Le premier cas d'utilisation de CTT consiste à comparer la configuration des deux environnements et à s'assurer que toutes les modifications apportées dans l'environnement de test sont réimplémentées dans l'environnement de production.

Actualisation d'un environnement de test pour correspondre à la configuration de l'environnement de Pro

Il est parfois nécessaire de mettre à jour les environnements de test pour les adapter à la production avant le lancement d'un nouveau développement. Cela peut être dû à des modifications de planning ou à la non-mise en production de certains éléments de développement prévus. Dans ce cas, le test de validation en temps réel (CTT) permet de vérifier si des éléments manquent ou ont été modifiés et de remettre les environnements au même niveau avant le lancement du prochain élément de développement.

Versionnage de la configuration lors de son développement

Il est recommandé d'exporter une configuration avant de commencer le développement d'une nouvelle fonctionnalité, et occasionnellement pendant le développement. CTT permet de comparer ces versions d'un même environnement afin de visualiser la progression ou de comprendre ce qui est fait ou doit être fait pour le développement. CTT facilite également le débogage des modifications en cas de problèmes plus complexes.

Éléments de configuration actuellement pris en charge

À partir de la version actuelle, CTT fournit la prise en charge de la comparaison/du transport des éléments de configuration suivants :

Éléments non pris en charge

Actuellement, CTT ne prend pas en charge la visualisation ni le transport d' objets supprimés tels que les modèles, les classes ou les attributs. Par conséquent, l'importation d'un fichier de configuration généré par CTT vers ESM ne supprime aucun modèle, classe ou attribut de la configuration cible.

La comparaison des modifications dans CTT s'appuyant sur les codes de l'objet (tels que les codes d'attribut), CTT ne peut détecter les modifications de ces codes . Par exemple, un attribut dont le code a été modifié est affiché comme un nouvel attribut dans CTT.

Actuellement, CTT ne permet pas de détecter les attributs partagés dans les classes non partagées . Cela signifie que si de tels attributs sont transportés, ils seront créés comme nouveaux attributs dans le système cible.

Pour les attributs, le transport de la plupart des configurations de gestionnaire est pris en charge. Les configurations de gestionnaire ne faisant pas partie des métadonnées d'attribut ne sont pas prises en charge . Cela inclut, par exemple, les modèles de courrier EntityStateMail .

uid étape par étape

1. Exportation des configurations
   Exportez les configurations des environnements ESM source et cible (généralement de test et de production) via Maintenance → Paramètres système → Exporter les configurations . Sélectionnez tous les types de configuration applicables (sous « Effectuer les configurations »).

2. Utilisation du CTT
   1. Ouvrez l'application CTT.
   2. Téléchargez les configurations exportées vers CTT, sélectionnez Afficher les modifications .
      1. L'écran de téléchargement devrait s'afficher immédiatement après l'ouverture de l'application. Si ce n'est pas le cas, cliquez sur « Télécharger des fichiers » dans l'en-tête pour l'ouvrir.

La source doit être le fichier de configuration contenant les modifications. Il s'agit généralement du fichier de configuration d'un environnement de test. La cible est généralement la configuration de production actuelle. Vous pouvez télécharger la configuration au format XML ou ZIP .
Remarque : pour les fichiers de configuration volumineux, le format ZIP est préférable, car il réduit le temps de téléchargement. La taille totale des fichiers doit être inférieure à 150 Mo.

3. Ce que vous pouvez voir dans CTT
   1. Différences dans les modèles
      Tous les modèles modifiés sont affichés dans le menu de gauche. Chaque modèle, classe et attribut, nouveau (vert) ou modifié (jaune), est affiché dans le menu. Si aucun changement n'a été apporté au modèle, à la classe ou à l'attribut, il n'est pas affiché. ( Remarque : les éléments actuellement supprimés ne sont ni affichés ni pris en charge.)
      
      La sélection d'un attribut (cliquez sur le nom de l'attribut) affichera les modifications apportées à cet attribut dans la vue de comparaison :

b. Différences entre les auditeurs
Tous les modèles contenant des écouteurs nouveaux ou modifiés sont affichés dans le menu de gauche. Sélectionnez un écouteur pour afficher les détails des modifications.

c. Différences dans les dossiers
Nouveaux dossiers (vert) et dossiers modifiés (jaune).

d. Différences de rôles
Nouveaux rôles (vert) et rôles modifiés (jaune). Remarque : la modification des autorisations de modèle, de dossier ou d'attribut d'un rôle n'est pas encore prise en compte.

4. Sélection des modifications et création du fichier de configuration
   1. Sélectionnez les modifications en cochant la case ( Remarque : actuellement, seuls les modèles/classes/attributs peuvent être sélectionnés).
   2. Cliquez sur Appliquer les modifications.
   3. Une boîte de dialogue s'ouvre pour vous permettre de vérifier si le fichier de configuration généré présente des problèmes ou des avertissements. Cliquez sur « Télécharger le fichier de configuration » pour télécharger le fichier.
      

5. Importation de la configuration générée vers ESM
   Remarque : L'importation du fichier de configuration créé par CTT vers ESM est prise en charge à partir d'ESM 2023.3. Consultez également les pratiques d'administration ci-dessous pour connaître les exigences.
   

Filtres et recherche

À gauche, au-dessus de l'arborescence des modifications, vous trouverez des fonctionnalités de filtrage et de recherche de données. Notez que les filtres et la recherche n'affectent que les données affichées à gauche (arborescence des modifications). Si vous avez sélectionné des modifications masquées par un filtre ou une recherche, elles resteront sélectionnées.

Filtres d'état

Les filtres d'état sont disponibles pour tous les types d'éléments de configuration : modèles, dossiers et rôles. Décocher un filtre masque ces modifications. Notez que pour les éléments modifiés, tels que les modèles ou les classes, s'ils contiennent de nouveaux éléments, le filtre ne masque pas ces modifications.

Filtres de Pro

Des filtres de propriétés spécifiques peuvent être utilisés avec les modèles. Décocher un filtre masquera les modifications qui ne contiennent que ce type de modification. Par exemple, pour les localisations, si un attribut contient uniquement une modification de localisation (ajout/modification de traductions), celui-ci sera masqué lors de l'utilisation du filtre. Si l'attribut contient des modifications de localisation et d'autres modifications, il ne sera pas masqué.

Commande

L'ordre fait référence aux numéros d'ordre des classes ou des attributs dans le modèle. En décochant ce filtre, ces modifications sont masquées dans la vue où seule la modification concerne le numéro d'ordre.

Localisation

La localisation fait référence aux traductions ajoutées ou modifiées pour les modèles, les classes et les attributs. En décochant ce filtre, ces modifications sont masquées dans la vue où la seule modification concerne la localisation.

Recherche

La recherche peut être utilisée avec des modèles pour filtrer l'affichage. Vous pouvez utiliser des noms ou des codes pour rechercher des modèles, des classes et des attributs. La recherche peut être utilisée en combinaison avec des filtres. Pour plus de clarté, la recherche n'affiche que les résultats des modifications non masquées par les filtres.

Document des modifications sélectionnées

Vous pouvez télécharger un document PDF contenant toutes les modifications apportées aux modèles, classes et attributs. Après avoir sélectionné les modifications souhaitées, sélectionnez « Appliquer les modifications » . Sélectionnez ensuite « Télécharger le fichier de documentation » .

Pratiques administratives lors de l'utilisation de CTT

• CTT est conçu pour prendre en charge les cas d'utilisation où les modifications sont apportées via l'environnement source. Modifier l'environnement cible sans importer CTT peut perturber certaines fonctionnalités lors de l'importation.
• ESM doit avoir le paramètre de plate-forme configuration.import.update défini sur true pour permettre la mise à jour de la configuration dans l'importation de configuration avec le fichier de configuration généré par CTT
  • CTT produit également un marqueur dans le fichier de configuration généré, qui doit être présent pour l'importation.
  • Sans le paramètre de plate-forme et le marqueur de fichier , l'importation de configuration fonctionne comme avant - elle crée uniquement de nouveaux objets et ne met rien à jour (utile pour importer une configuration entière dans une base de données vide)
• Tous les objets de la configuration doivent avoir des codes définis : modèles, classes, attributs, valeurs statiques, dossiers, rôles, etc. CTT utilise des codes pour faire correspondre les objets et trouver les différences dans la configuration.
  • La fonctionnalité ESM dans Maintenance → Paramètres système → Exécuter la vérification du système peut être utilisée pour rechercher et ajouter des codes pour les attributs.
  • Pour pouvoir ajouter des codes pour les rôles, le paramètre de plateforme adminrole.code.editable doit être défini sur true .
• Bien que la mise à jour du nom d'un écouteur pour inclure une date ou un numéro de version soit la meilleure pratique actuelle, vous ne pouvez actuellement voir les différences d'un écouteur modifié que si le nom reste le même .
  • Il en va de même pour les autres objets qui ne sont identifiés que par leur nom (événements de modèle, tableaux de bord, vues, tâches planifiées)
    • Remarque : CTT ne prend actuellement pas en charge les objets mentionnés ci-dessus. Cette prise en charge pourrait être ajoutée dans les versions ultérieures.
• Les valeurs statiques doivent avoir des codes pour fonctionner avec CTT.