Exporter/importer XML

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

informations générales

  • Lorsqu'il s'agit d'import/export XML, chaque objet a un identifiant unique, le soi-disant TID (Third party ID)

  • Un TID identifie un objet SKOOR Engine globalement (sur toutes les instances SKOOR Engine )

  • Si un TID doit être stocké à la suite d'un verrouillage d'identité, le TID est stocké en tant que propriété appelée tid (veuillez vous référer 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'alarmes

  • Modèles d'alarme

  • Dispositifs

  • Dossiers (dans les modèles)

  • Groupes

  • Emplois

  • Filtrer les cartes

  • OPM

  • Objets de processus

  • Propriétés

  • Rapports (PDF uniquement)

  • Planificateurs de rapports

  • Des horaires

  • SLC

  • SLO

  • Modèles (veuillez vous référer à la section Modèles concernant la fonctionnalité d'exportation/importation XML pour les modèles)

  • Utilisateurs (importation uniquement)

  • Groupes d'utilisateurs (importation uniquement)

Les graphiques tels que l'historique d'état, l'historique des valeurs ou l'historique des valeurs plus ne peuvent pas être gérés par la fonctionnalité d'importation/exportation XML et peuvent entraîner des avertissements dans le processus d'exportation/importation

Définition de l'interface :

  • L'import/export XML est conforme à la norme XML 1.0

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

XML - exportation

Il existe deux manières d'exporter des objets au format XML.

Exportation unique

La première et la plus rapide consiste à ouvrir le menu des fonctions d'un groupe et à cliquer sur XML Export :

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

Exporter la configuration

La seconde façon est de créer un objet de type XML export sous /root/Configurations :

Configuration de l'exportation XML :

Propriété

Description

Nom

Exporter le nom de la configuration

Exporter

Le chemin sous lequel les objets doivent être exportés

Post-processeur

Cette fonctionnalité n'est pas utilisée actuellement

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

Appuyez sur le bouton Générer :

Le fichier d'export 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 suivantes, peuvent être provoqué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 doivent pas être affectés par ceci :

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

XML - importation

Plusieurs modes d'import 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é sera 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

  • N'importe quel nombre de mises à jour sur chaque objet est possible

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

Ajouter/mettre à jour les principaux objets XML

  • Fonctionne comme Update 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 avec 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 partout dans 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 considérée

    • N'importe quel nombre de mises à jour du même objet est possible

Si des objets sont importés sur le même système que celui où ils ont été exportés auparavant, le mode Ajouter peut conduire à des objets dupliqués comme des dispositifs d'alarme qui sont liés à des objets exportés

Ces modes d'importation sont répertoriés dans la liste déroulante respective avec le titre Instance afin de les séparer des modes d'importation à utiliser uniquement pour les modèles qui sont répertoriés avec 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 XML Import dans le menu fonction du groupe qui doit contenir les objets après l'import :

Téléchargez et sélectionnez un fichier à importer et choisissez le mode requis dans la liste déroulante :

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. Lorsque la vérification a réussi, cliquez sur Importer :

Importer la configuration

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

Configuration de l'importation XML :

Propriété

Description

Nom

Nom de la configuration d'importation XML

Mode d'importation

Mode d'importation (voir description ci-dessus)

Dessous

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

Déposer

Fichier XML à importer (doit être téléchargé en premier)

Préprocesseur

Actuellement non utilisé

Téléverser un fichier

Faites glisser et déposez un fichier XML pour télécharger le fichier sur SKOOR Engine et 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 Importation réussie comme code de résultat . Un résumé sera affiché et écrit dans le fichier journal. En cliquant sur le fichier journal, une nouvelle fenêtre apparaît avec des informations détaillées sur l'importation.

Vérifier et finalement importer un fichier XML peut prendre une heure voire plus, selon le nombre d'objets impliqués et le mode d'importation choisi. Appuyer sur le bouton Importer déclenchera finalement l'importation. Ne faites cela que si la vérification a réussi, comme indiqué à côté du code de résultat

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

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

Modifier 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 l'importer à nouveau. Cependant, les modifications de configuration peuvent parfois être plus rapides si elles sont effectuées dans le 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 système SKOOR différent.

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

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

Ajoutez ensuite un nouveau tag Agent avec les conventions suivantes :

  • Entrez un ID Agent qui commence par un caractère alphabétique. Cet identifiant n'est lié à aucun objet dans le SKOOR Engine , il est utilisé uniquement à l'intérieur du 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>

Désormais, l' identifiant Agent peut être utilisé pour configurer le nouveau collecteur pour tous les travaux dans la balise Jobs . Définissez la balise Agent des travaux en conséquence :

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