Créer une règle d’analyse

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 5 minutes de lecture
  • Renseignez les variables de sortie définies dans une activité personnalisée avec les données de charge utile renvoyées à partir d’un test d’entrées sur un point de terminaison ou un hôte externe.

    Avant de commencer

    Rôles requis : activity_admin, activity_creator

    Pourquoi et quand exécuter cette tâche

    Procédure

    1. Accédez à la Tout > Workflow > Éditeur de workflow.
    2. Dans l’onglet Personnalisé de la palette, ouvrez une activité personnalisée.
    3. Dans le formulaire Concepteur d’activité, passez à l’étape Sortie .
    4. Faites glisser une variable de sortie du générateur de structure de données vers le champ Nom de variable du générateur de règles d’analyse .
      Figure 1. Mappage des variables aux règles d’analyse
      Mappage des variables aux règles d’analyse

      Le formulaire de règles d’analyse s’affiche pour la variable sélectionnée. Par défaut, le type d’analyse est défini sur Direct, ce qui remplit la variable avec toutes les données de la charge utile sélectionnée, sans analyser le contenu. Chaque modèle dispose d’une source d’analyse par défaut spécifique.

    5. Remplissez le formulaire à l'aide des champs de la table.
      Dans cet exemple, le type d’analyse sélectionné est XML, ce qui vous permet de sélectionner des paramètres spécifiques dans la charge utile à analyser.
      Formulaire Règles d’analyse
      Tableau 1. Champs de règles d’analyse
      Champ Description
      Source de l'analyse Source des données renvoyées à partir de l’hôte ou du point de terminaison cible. Chaque modèle s’ouvre sur une charge utile spécifique par défaut. Les choix disponibles dépendent du modèle d’exécution sélectionné pour l’activité. Vous pouvez également utiliser des variables locales comme source d’analyse si une règle d’analyse a été préalablement définie pour elles. Pour obtenir la liste des charges utiles disponibles pour chaque modèle, reportez-vous à la section Sources des analyses du concepteur d’activité.
      Expression Expression utilisée pour extraire des données spécifiques de la source d’analyse sélectionnée. Cette expression est créée à partir de données cliquables dans l’exemple de charge utile et s’affiche au format sélectionné dans le champ Type d’analyse . Lors du test, l’expression peut renvoyer plusieurs résultats. Discernez quel choix donne des résultats fiables ou prévisibles avant de choisir votre expression.
      Remarque :
      Le système ne peut pas générer d’expressions RegEx cliquables à partir d’exemples de données. Vous devez écrire toutes les expressions régulières manuellement.
      Nom de variable Nom de variable révisé tel qu’il est utilisé dans l’expression de sortie finale. Le système ajoute le préfixe activityOutput ou activityLocal à la variable que vous spécifiez.
      Type d’analyse Langue à utiliser pour interroger la charge utile de l’hôte cible. Les sélections sont les suivantes :
      • Direct : mappe à l’ensemble du contenu de la charge utile sélectionnée dans le champ Source d’analyse , sans aucune analyse. Il s’agit du type d’analyse par défaut.
      • XML : requête XPath utilisée pour sélectionner des nœuds à partir d’une charge utile XML.
      • JSON : requête JSONPath pour sélectionner des parties d’une charge utile JSON.
      • RegEx : méthode d’analyse qui utilise une expression régulière pour extraire les données d’une charge utile. Le type d’analyse RegEx ne prend pas en charge l’analyse multiligne et n’est pas sensible à la casse.
      Description courte Brève description de cette règle d’analyse.
      Exemples de données de charges utiles Exemples de données provenant de la source contenant les données demandées. Ce champ n’est pas disponible pour les types d’analyse directe . Après avoir cliqué sur Analyser les exemples de données, les données de ce champ ne peuvent pas être modifiées, mais deviennent cliquables dans le but de créer des expressions. Cliquez sur Modifier les exemples de données pour rendre le champ à nouveau modifiable.
      Analyse des résultats Affiche les données renvoyées de la source par l’expression sélectionnée. Ce champ n’est pas disponible pour les types d’analyse directe .
    6. Pour tester à nouveau les entrées, cliquez sur Obtenir un exemple de charge utile à partir du test.
      Cette action rouvre le formulaire de test, ce qui vous permet de remplacer des valeurs de test différentes et de créer une charge utile différente.
    7. Cliquez sur Enregistrer pour que les règles d’analyse remplacent la charge utile précédente par celle que vous venez de créer.
    8. Pour créer une expression pour la règle d’analyse, cliquez sur le paramètre spécifique que vous souhaitez voir dans l’exemple de charge utile.
      La valeur de ce paramètre apparaît dans le champ Résultat d’analyse et le système crée l’expression appropriée dans le champ Expression .
    9. Cliquez sur Envoyer pour enregistrer la règle d’analyse de cette variable.

    Sources des analyses du concepteur d’activité

    Ce tableau répertorie les sources d’analyse disponibles avec chaque modèle d’exécution.

    Tableau 2. Sources d’analyse
    Modèle Source
    SOAP Web Service
    • executionResult.body (par défaut)
    • executionResult.status_code
    • executionResult.header
    • executionResult.error
    JDBC
    • executionResult.output (par défaut)
    • executionResult.errorMessages
    • executionResult.probeCompletedEccId
    • executionResult.totalRows
    Sonde JavaScript
    • executionResult.payload (par défaut)
    • executionResult.output
    • executionResult.eccSysId
    • executionResult.errorMessages
    Powershell
    • executionResult.output (par défaut)
    • executionResult.tags
    • executionResult.hresult
    • executionResult.eccSysId
    • executionResult.errorMessages
    REST Web Service
    • executionResult.body (par défaut)
    • executionResult.status_code
    • executionResult.header
    • executionResult.error
    SFTP
    • executionResult.output (par défaut)
    • executionResult.eccSysId
    • executionResult.errorMessages
    • executionResult.tags
    Sonde
    • executionResult.output (par défaut)
    • executionResult.payload
    • executionResult.eccSysId
    SSH
    • executionResult.output (par défaut)
    • executionResult.eccSysId
    • executionResult.errorMessages
    • executionResult.tags
    JMS
    • executionResult.status
    • executionResult.standardHeaders
    • executionResult.customHeaders
    • executionResult.messagePayload
    • executionResult.eccSysId
    • executionResult.errorMessages

    Exemple de règle d’analyse du concepteur d’activité

    Dans cet exemple, la règle d’analyse est configurée pour renseigner la variable activityOutput.ipv4 avec la valeur de l’adresse IP d’un serveur de domaine, à l’aide de PowerShell.

    Avant de commencer

    Rôle requis : activity_creator, activity_admin

    Pourquoi et quand exécuter cette tâche

    Pour générer les exemples de données, l’administrateur doit exécuter la commande sur l’hôte, puis coller les données renvoyées dans le champ Données d’exemple de charge utile lors de la création de la règle d’analyse. L’administrateur peut ensuite créer une expression qui renvoie les adresses IP de cet exemple dans deux formats : ipv4 et ipv6. Dans cet exemple, le système produit deux expressions à utiliser pour la règle d’analyse.

    Procédure

    1. Accédez à la Tout > Workflow > Éditeur de workflow et ouvrez l’activité qui s’exécute sur l’hôte.
    2. Cliquez sur l’onglet Entrées et notez la commande.
      Figure 2. Règle d’analyse Commande des entrées PowerShell
      Règle d’analyse Commande des entrées PowerShell
    3. Dans une console PowerShell, exécutez la commande sur l’hôte pour extraire l’exemple XML qui contient les valeurs dont vous avez besoin.
    4. Copiez les données renvoyées dans le presse-papiers.
    5. Dans le concepteur d’activité, cliquez sur l’onglet Sorties et collez les données renvoyées dans le champ Données d’exemple de charge utile .

      Dans cet exemple, les données incluent les adresses IP dans deux formats différents et le nom de domaine.

    6. Sélectionnez le type d’analyse pour la source.
      Dans l’exemple suivant, sélectionnez XML.
      Données de charge utile brutes de règle d’analyse
    7. Cliquez sur Analyser les exemples de données.

      Le système affiche le XML au bon format et il devient cliquable. Dans cette vue, le système peut convertir les données sélectionnées de l’échantillon en une expression.

      Règle d’analyse Données de charge utile analysées
    8. Pour créer l’expression, cliquez sur les éléments de l’exemple de données que vous souhaitez mapper à la variable.

      Sur la base des exemples de données sur lesquels vous avez cliqué, le système crée deux expressions.

      Créer des expressions de règle d’analyse
    9. Sélectionnez une expression dans la liste.

      Le résultat souhaité est l’adresse IP dont l’attribut de typeest ipv4. Le système renseigne le champ Expression avec ce choix.

      Sélection d’une expression de règle d’analyse
    10. Cliquez sur Tester l’expression.

      Le système analyse la charge utile à l’aide de l’expression sélectionnée et renvoie les données demandées dans le champ Résultat d’analyse

      Test d’une expression de règle d’analyse
    11. Cliquez sur Envoyer.

      La vue revient à l’onglet Sorties du concepteur d’activité. La nouvelle règle d’analyse s’affiche dans la liste, et une ligne vide est disponible pour une autre règle.

      Liste des règles d’analyse terminées