Utiliser des variables dans Apigee Integration

Une variable est un élément d'intégration qui contient et transmet des données entre les tâches, les déclencheurs et les arêtes d'une intégration.

  • Les variables peuvent être définies de manière statique en conception ou transmises de manière dynamique à l'intégration au moment de l'exécution.
  • Les variables peuvent référencer d'autres variables dans une intégration.
  • Les variables peuvent être accessibles globalement pour toutes les tâches ou accessibles localement à une tâche spécifique.

Trois types de variables sont disponibles :

Variables d'intégration

Les variables d'intégration sont semblables aux variables utilisées dans un langage de programmation. Les données des variables peuvent être lues et écrites tout au long de l'exécution de l'intégration.

Les variables d'intégration peuvent être utilisées de différentes manières :

  • Comme entrées dans l'intégration (variables d'entrée).
  • Renvoyées sous forme de sorties de l'intégration (variables de sortie).
  • Utilisées pour conserver l'état temporaire lors de l'exécution d'une intégration.

Il n'est pas nécessaire de définir la valeur d'une variable de façon statique dans l'intégration. Les valeurs des variables peuvent être transmises dans une intégration via l'utilisation d'un déclencheur. Toutefois, si une variable est définie de manière statique dans l'intégration et si la même variable est fournie de manière dynamique avec le déclencheur, l'attribution de valeur dynamique remplace l'attribution statique.

Types de données acceptés par les variables d'intégration

Les types de données suivants sont acceptés pour les variables d'intégration :

  • Chaîne et tableau de chaînes
  • Entier et tableau d'entiers
  • Double et tableau de doubles
  • Booléen et tableau de booléens
  • JSON

Variables de tâche

Les variables de tâche sont des variables prédéfinies et générées automatiquement d'une tâche. Si une tâche produit une sortie, ces résultats sont disponibles dans une variable de tâche. Vous ne pouvez pas supprimer ni modifier une variable de tâche. Par exemple, dans la tâche Call REST Endpoint, le corps de la réponse est stocké dans la variable responseBody.

Variables de configuration

Les variables de configuration vous permettent d'externaliser la configuration pour l'intégration. Les variables de configuration vous permettent de configurer certains aspects de votre intégration, tels que les détails du connecteur, les détails d'authentification ou les points de terminaison d'URL, qui sont basés sur l'environnement de développement (contrôle qualité, préproduction ou production). Vous n'avez pas besoin de mettre à jour votre intégration manuellement avant de l'importer dans un nouvel environnement. Application Integration vous permet de saisir des valeurs pour les variables de configuration lorsque vous publiez l'intégration.

Pour savoir comment créer des variables de configuration et les utiliser, consultez le tutoriel Créer un CICD pour votre intégration.

Afficher les variables

Vous pouvez utiliser le volet Variables pour créer, modifier, afficher, dupliquer et supprimer des variables dans votre intégration. Le volet Variables affiche également le nombre total de références de variables dans l'intégration.

Pour afficher le volet Variables, cliquez sur (Afficher/Masquer le panneau) dans la barre de navigation du concepteur.

L'image suivante présente un exemple de mise en page du volet Variables :

Variables du concepteur d'intégrations Variables du concepteur d'intégrations

Créer une variable

Pour créer une variable, procédez comme suit :

  1. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur (Afficher/Masquer le panneau) pour afficher le volet Variables.
  2. Cliquez sur Créer.
  3. Procédez comme suit dans le volet Créer une variable :
    1. Nom : saisissez le nom de la variable.
    2. Type de variable : choisissez le type de variable.
    3. Type de données Description
      Aucune Variable locale dans une intégration.
      Variable de configuration pour l'intégration Une variable de configuration dans une intégration.
      Entrée dans l'intégration Pendant l'exécution, la variable est fournie en tant qu'entrée dans le déclencheur exécuté.
      Résultat de l'intégration La valeur finale de la variable à la fin de l'exécution doit être renvoyée à l'appelant de l'intégration.
      Entrée et sortie de l'intégration Lors de l'exécution, la variable est fournie en tant qu'entrée au déclencheur exécuté et sa valeur finale est envoyée à l'appelant de l'intégration.
    4. Type de données : choisissez le type de données de la variable. Vous pouvez identifier le type de données d'une variable à l'aide de l'icône en couleur située à côté du nom de la variable.
      Type de données Exemple
      Chaîne Alex
      Entier 30
       Double 30.5
      Booléen true
      JSON { "employee":{"name":"Alex", "age":30, "city":"Mountain View"} }
       Tableau de chaînes Alex, Kai, Raha
       Tableau d'entiers 30, 25, 22
       Double tableau 30.5, 25.34, 22.134
       Tableau booléen true, false, false

      Pour en savoir plus sur les types de données acceptés, consultez la page Types de données acceptés.

    5. Valeur par défaut : saisissez la valeur par défaut de la variable. Ce champ est facultatif.
    6. Schéma : sélectionnez le schéma JSON de la variable.
      • Inférer à partir d'un exemple de charge utile JSON : générez un schéma JSON à partir d'un exemple de charge utile JSON. L'exemple de charge utile est supprimé une fois le schéma généré. Seul le schéma généré sera enregistré.
      • Saisissez un schéma JSON : saisissez manuellement un schéma JSON complet.
      • Inférer à partir de la valeur par défaut : générez un schéma JSON à partir de la valeur par défaut fournie.
      • Aucune : aucun schéma JSON.
    7. Masquer la variable dans les journaux (bêta) : sélectionnez cette option pour activer le masquage de la variable dans les journaux d'exécution de l'intégration. Pour activer le masquage de la variable, vous devez activer les variables de masquage pour votre intégration et votre région. Pour en savoir plus sur l'activation du masquage pour l'intégration et la région, consultez les sections Modifier une intégration et Modifier les régions.

      Pour en savoir plus sur le masquage, consultez la section Masquer les données sensibles dans les journaux.

  4. Cliquez sur Créer.

Utiliser des données de variables dans les intégrations

Lors de l'exécution d'une intégration, les données d'exécution sont transmises sous forme de variables déclarées pour l'intégration ou la tâche. Une fois l'exécution démarrée, les données d'entrée sont converties en objet en mémoire appelé événement.

Une fois l'objet d'événement créé, un graphique de tâches en mémoire est créé à l'aide de la définition d'intégration. Les valeurs des variables entrantes sont transmises aux tâches en fonction de votre configuration. Au fur et à mesure de l'exécution de l'intégration, les tâches lisent et écrivent des données dans l'objet d'événement pour qu'elles soient utilisées par les tâches ultérieures ou pour former les données de sortie de l'intégration.