Étape d’analyseur JSON

Identifiez les données structurées d'une charge utile JSON sans avoir à écrire de script. Mappez le contenu JSON entrant à une sortie d'objet complexe que vous pouvez utiliser dans d'autres étapes ou actions. Lors de l'exécution, les valeurs d'une charge utile JSON renseignent la sortie d'objet complexe.

Pour en savoir plus sur les objets complexes, consultez Données complexes.

Remarque :

Cette étape nécessite un abonnement Centre d'intégration. Pour plus d’informations, voir Calendriers juridiques : Centre d'intégration présentation. Une fois le module d’extension requis activé, l’étape est visible sous Intégrations.

Rôles et disponibilité

Disponible en tant qu’étape d’action Studio de workflow . Les utilisateurs disposant du rôle action_designer peuvent créer une action personnalisée avec une ou plusieurs étapes d’action.

Limite de taille de la charge utile

Lors de l’exécution, Étape de l’analyseur JSON prend en charge des charges utiles jusqu’à 10 Mo. Pour les charges utiles plus importantes, créez une Flux de données action. Pour plus d’informations sur les actions de flux de données, reportez-vous à la section Actions de flux de données et pagination.

Champs

Champ	Description
Source	Dans le champ Données sources , sélectionnez ou faites glisser une pastille de données contenant la charge utile JSON source. Par exemple, une pastille de données Corps de la réponse de l’étape REST. Lors de l’exécution, les valeurs de la source de données renseignent la sortie d’objet complexe. Sous Données sources et dans la fenêtre de script, saisissez un exemple de charge utile pour générer votre objet complexe. Par exemple, si vous analysez la réponse à partir d’une étape REST qui renvoie une liste d’utilisateurs, saisissez l’objet JSON attendu pour un seul utilisateur. Vous pouvez créer n’importe quel exemple de charge utile JSON avec les limitations suivantes : Les tableaux multidimensionnels ne sont pas pris en charge. Les tirets, les points, les espaces, les deux-points et le symbole @ dans les clés JSON ne sont pas pris en charge. Votre exemple de charge utile ne peut pas dépasser 2 Mo.
Vue de charge utile structurée	Affichez votre exemple de charge utile au format JSON normal ou activez/désactivez la vue Charge utile structurée pour afficher la charge utile dans une arborescence de nœuds structurée. Sélectionnez un nœud dans l’arborescence pour copier le JSONPath de l’élément. Si vous ajoutez manuellement de nouveaux éléments dans le champ Cible , vous pouvez coller ce JSONPath sous les options avancées d’un élément.
Générer la cible	Sélectionnez Générer la cible pour créer la structure de sortie de l’étape à partir de votre exemple de charge utile. La structure de vos données de sortie s’affiche dans le champ Cible . Les éléments enfants de chaque objet sont automatiquement générés en tant que type Chaîne. Vous pouvez également créer manuellement votre objet complexe cible en ajoutant des éléments dans le champ Cible .
Cible	Affichez ou modifiez la structure de sortie de la charge utile JSON. Créez une sortie structurée en cliquant sur Générer la cible ou ajoutez manuellement des éléments. Chaque élément contient les informations suivantes dans la vue Modifier l’objet : Étiquette : étiquette de pastille de données. Par défaut, le système utilise le nom de la clé JSON. Nom : nom interne de l’élément de sortie. Remarque : Les points d’exclamation, les deux-points, le symbole @ ou les chiffres uniquement ne sont pas des valeurs valides pour le nom d’un élément. Type : type de données, qui doit être String, Object, Array.String ou Array.Object. L’élément de niveau supérieur doit être un objet. Obligatoire : basculez pour rendre l’élément obligatoire. Cela ne s’applique qu’aux éléments de type Chaîne. Ajouter un élément enfant : sélectionnez l’icône Ajouter un élément enfant ( icône ) pour ajouter un élément enfant imbriqué. Les éléments de type Objet contiennent l’option avancée Enregistrer comme modèle , qui vous permet d’enregistrer la structure de votre objet en tant que modèle d’objet complexe. Vous pouvez ensuite utiliser ce modèle pour définir le schéma d’une sortie d’objet pour votre action. Pour les éléments de type Chaîne, vous pouvez également ajouter une longueur maximale, un conseil et une valeur par défaut en tant qu’options avancées. Dans l’en-tête Cible, sélectionnez Quitter le mode d’édition lorsque vous avez terminé d’apporter des modifications à la structure de votre sortie. Vous pouvez ensuite sélectionner l’icône d’activation/de désactivation des ) pour afficher l’option JSONPath . Le JSONPath est le chemin d’accès à l’élément. Modifiez le JSONPath pour changer la façon dont vos éléments de données sources sont mappés aux éléments de votre sortie. Si vous ajoutez manuellement des éléments, vous pouvez copier le JSONPath d’un nœud dans votre exemple de charge utile et le coller sous les options avancées d’un élément.

Exemple d’étape d’analyseur JSON

Cet exemple suit les problèmes nouvellement créés à partir d’une instance de production en tant que défauts dans une instance de test. Commencez par créer une action nommée Parse Problems from Production. Ajoutez une étape REST pour récupérer une liste de problèmes à partir de l’instance de production. Ensuite, ajoutez l’étape d’analyse JSON pour analyser les Response Body étapes REST et fournir une sortie d’objet complexe qui représente le schéma de la table Problème [problem]. Enfin, créez une sortie d’action de type Objet nommée Problems from Production. Déposez la pastille root de données de l’étape d’analyseur JSON dans le champ de valeur de cette sortie.

Figure 1. Analyser les problèmes à partir de l’action de production

Ensuite, créez un nouveau flux nommé Sync New Problems, qui est déclenché tous les jours à minuit. La première action dans le flux est l’action Parse Problems from Production . Ensuite, ajoutez un bloc de For Each logique de flux et déposez le Problèmes de production > réponse dans le champ Élément . Dans le bloc For Each (Pour chaque ), ajoutez un If bloc de logique de flux qui vérifie si l’état de chaque problème est nouveau, puis crée un enregistrement de défaut dans l’instance de test dont le groupe d’affectation et la brève description sont mappés à chaque nouveau problème de l’instance de production.

Figure 2. Synchroniser le flux des nouveaux problèmes