Exporter/importer XML

Une interface XML est intégrée à SKOOR Engine afin de permettre l'exportation et l'importation de toute structure d'objet à l'aide d'un seul fichier XML d'un système SKOOR Engine à un autre. Cela permet de créer une structure spécifique dans un environnement de test SKOOR Engine, de l'exporter, puis de l'importer dans votre environnement de production SKOOR Engine une fois la structure correctement configurée. L'interface XML vous permet également de synchroniser SKOOR Engine avec n'importe quel outil tiers (par exemple, CMDB, autres outils de surveillance existants).

Informations générales

  • Lors de l'importation/exportation XML, chaque objet possède un identifiant unique, appelé TID (Third party ID).

  • Un TID identifie un objet SKOOR Engine de manière globale (sur toutes les instances SKOOR Engine).

  • Si un TID doit être stocké à la suite d'un verrouillage d'identité, il est stocké en tant que propriété appelée tid (veuillez vous reporter aux modes d'importation dans la section suivante XML - importation).

Objets pris en charge pour les importations/exportations XML

  • ACL (importation uniquement)

  • Dispositifs d'alarme

  • Groupes d'alarme

  • Modèles d'alarme

  • Dispositifs

  • Dossiers (dans Modèles)

  • Groupes

  • Tâches

  • Cartes de filtrage

  • OPM

  • Objets de processus

  • Propriétés

  • Rapports (PDF uniquement)

  • Schedulers de rapports

  • Calendriers

  • SLC

  • SLO

  • Modèles (veuillez vous reporter à la section Modèles pour plus d'informations sur la fonctionnalité d'exportation/importation XML pour les modèles)

  • Utilisateurs (importation uniquement)

  • Groupes d'utilisateurs (importation uniquement)

Les graphiques tels que l'historique des états, l'historique des valeurs ou l'historique des valeurs plus ne peuvent pas être traités par la fonctionnalité d'importation/exportation XML et peuvent entraîner des Warnings lors du processus d'exportation/importation

Définition de l'interface :

  • L'importation/exportation XML est conforme à la norme XML 1.0

  • Prend en charge toutes les normes de post-traitement XML w3c 

XML - exportation

Il existe deux façons d'exporter des objets au format XML.

Exportation unique

La première méthode, qui est aussi la plus rapide, consiste à ouvrir le menu des fonctions d'un groupe et à cliquer sur Exportation XML :

Cette action exportera immédiatement les objets situés sous ce groupe :

Exportation de la configuration

La deuxième méthode consiste à créer un objet de type Exportation XML sous /root/Configurations :

Configuration de l'exportation XML :

Propriété

Description

Nom

Nom de la configuration d'exportation

Export

Chemin d'accès sous lequel les objets doivent être exportés

Post-processeur

Cette fonctionnalité n'est actuellement pas utilisée

L'objet sera créé sous le nœud /root/Configurations/Import / Export. Pour lancer l'exportation et créer le fichier XML, accédez à /root/Configurations/Import / Export et cliquez sur Générer sur l'objet précédemment créé :

Appuyez sur le bouton Générer :

 Le fichier d'exportation XML apparaîtra et pourra être téléchargé via le navigateur :

Les messages avec des liens non résolus, comme indiqué dans la section Informations sur les résultats ci-dessous, peuvent être causés par des objets tels que des graphiques qui ne sont pas pris en charge par la fonctionnalité d'exportation XML. Les autres objets ne devraient pas être affectés par cela :

Les références de propriété dans des objets tels que <$PID18$> qui peuvent être utilisées dans des champs de texte sont ignorées

XML - importation

Plusieurs modes d'importation sont disponibles :

Mode d'importation

Description

Ajouter

  • Les objets définis par le fichier XML sont ajoutés sous le groupe sélectionné

  • L'identité est perdue pour tous les objets ajoutés (le même objet peut être ajouté plusieurs fois)

  • Aucun TID ne sera stocké

Mise à jour

Les objets sous le groupe d'importation sont mis à jour avec ceux définis par le fichier XML

  • L'identité est conservée et prise en compte pour tous les objets définis par le fichier XML

  • Les objets nouvellement ajoutés obtiennent le TID défini par le fichier XML

  • Un nombre illimité de mises à jour est possible pour chaque objet

  • Les objets sous le groupe d'importation qui ne figurent pas dans le fichier XML seront supprimés

Ajouter/mettre à jour les objets XML supérieurs

  • Fonctionne comme la mise à jour, mais seuls les objets supérieurs définis dans le fichier XML sont pris en compte

  • Les objets existants dans le groupe d'importation ne sont pas supprimés comme ils le seraient lors d'une importation normale

Portée libre

  • La portée est définie par le fichier XML (aucun objet racine n'est requis)

  • Les objets peuvent être dispersés dans toute la base de données SKOOR Engine. Leurs dépendances sont mises à jour comme défini par le fichier XML

    • L'identité sera conservée et prise en compte

    • Il est possible d'effectuer un nombre illimité de mises à jour du même objet

 

Si les objets sont importés sur le même système que celui d'où ils ont été exportés, le mode Ajouter peut entraîner la duplication d'objets tels que les dispositifs d'alarme liés aux objets exportés

Ces modes d'importation sont répertoriés dans le menu déroulant correspondant sous le titre Instance afin de les distinguer des modes d'importation à utiliser uniquement pour les modèles, qui sont répertoriés sous le titre Modèle

Importation unique

Comme pour l'exportation XML, les importations peuvent être effectuées directement sur n'importe quel objet de groupe. Cliquez sur Importation XML dans le menu des fonctions du groupe qui doit contenir les objets après l'importation :

Téléchargez et sélectionnez un fichier à importer, puis choisissez le mode requis dans le menu déroulant :

Cliquez sur Vérifier pour vérifier le fichier d'importation et corriger les erreurs si nécessaire. Veuillez consulter le fichier journal fourni pour analyser les erreurs. Une fois la vérification réussie, cliquez sur Importer :

Configuration de l'importation

Si une configuration d'importation persistante est nécessaire, elle peut être créée sous /root/Configurations/Import / Export :

Configuration d'importation XML :

 

Propriété

Description

Nom

Nom de la configuration d'importation XML

Mode d'importation

Mode d'importation (voir description ci-dessus)

Ci-dessous

Point d'entrée de l'arborescence d'objets pour ajouter des objets en dessous

Fichier

Fichier XML à importer (doit être téléchargé au préalable)

Préprocesseur

Actuellement non utilisé

Télécharger le fichier

Glissez-déposez un fichier XML pour le télécharger dans SKOOR Engine, puis sélectionnez-le dans le menu déroulant Fichier


La procédure d'importation est la même que celle décrite ci-dessus. Une importation réussie affichera le message « Importation réussie » comme code de résultat. Un résumé s'affichera et sera enregistré dans le fichier journal. En cliquant sur le fichier journal, une nouvelle fenêtre s'ouvrira avec des informations détaillées sur l'importation.

La vérification et l'importation finale d'un fichier XML peuvent prendre une heure, voire plus, selon le nombre d'objets concernés et le mode d'importation choisi. Appuyez sur le bouton « Import » pour lancer l'importation. Ne le faites que si la vérification a abouti, comme indiqué à côté du code de résultat

L'importation vérifie d'abord si une limite de licence est dépassée. Dans ce cas, l'utilisateur reçoit un message d'erreur et l'importation échoue.

Si une erreur se produit pendant l'importation, tous les objets nouvellement créés sont complètement supprimés - aucun objet isolé ne restera dans le système

Modifiez le fichier XML avant l'importation

En règle générale, il n'est pas nécessaire de modifier le fichier exporté avant de le réimporter. Cependant, il est parfois plus rapide d'effectuer les modifications de configuration dans le fichier XML avant l'importation.

Exemple : modifier le collecteur des tâches importées

Si plusieurs collecteurs de données sont configurés, il peut être nécessaire de les modifier lors de l'importation de tâches à partir d'un autre système SKOOR.

Recherchez d'abord la balise Agents dans le fichier XML (il peut y avoir plusieurs balises Agents à l'intérieur) :

<Agents>
  <Agent id="xxxx">
    <Name>collector-local</Name>
  </Agent>
</Agents>

Ajoutez ensuite une nouvelle balise agent en respectant les conventions suivantes :

  • Entrez un identifiant Agent commençant par une lettre alphabétique. Cet identifiant n'est lié à aucun objet dans le SKOOR Engine, il est uniquement utilisé dans le fichier XML lui-même

  • Dans la balise Name, ajoutez le nom d'un collecteur existant dans le système cible

<Agents>
  <Agent id="xxxx">
    <Name>collector-local</Name>
  </Agent>
  <Agent id="myNewCollectorId">
    <Name>external-collector-1</Name>
  </Agent>
</Agents>

L'identifiant Agent peut désormais être utilisé pour configurer le nouveau collecteur pour toutes les tâches dans la balise Jobs. Définissez la balise Agent des tâches en conséquence :

<Jobs>
  ...
    <Name>My Job</Name>
    <Agent>myNewCollectorId</Agent>
  ...
</Jobs>