Variables

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.

Variables

Dans Application Integration, les variables sont définies ou initialisées à différents endroits :

• Variables de configuration : définies au moment de la conception pour stocker les données de configuration de l'intégration. Par exemple, vous pouvez l'utiliser pour définir une adresse e-mail cible pour les notifications, plutôt que de coder en dur cette adresse e-mail dans l'intégration.
• Variables système : générées automatiquement par le système pour stocker les données de configuration de l'intégration. Par exemple, la variable ExecutionId stocke l'ID d'exécution de l'intégration.
• Les variables d'intégration : définissez-les explicitement dans votre intégration pour suivre les données tout au long de l'exécution d'une intégration. Par exemple, vous pouvez définir une variable pour stocker le résultat d'une tâche et l'utiliser dans une tâche ultérieure.
• Les variables de tâche sont définies de manière implicite en exécutant des tâches spécifiques pour stocker le résultat de la tâche. Par exemple, la tâche Appeler un point de terminaison REST définit la variable responseBody pour stocker le corps de réponse du point de terminaison REST. Les variables de tâche sont également appelées variables générées automatiquement. Les variables générées automatiquement suivent une convention de dénomination spéciale : elles sont entourées d'accents graves.

Variables d'intégration

Les variables d'intégration, qui incluent des variables d'entrée et de sortie, 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 (également appelées variables d'entrée).
• Renvoyées sous forme de sorties de l'intégration, également appelées variables de sortie.
• Utilisées pour conserver l'état temporaire lors de l'exécution d'une intégration.

Remarque : Les rôles de variable répertoriés ci-dessus ne s'excluent pas mutuellement. Une variable donnée peut être une variable d'entrée, une variable de sortie, les deux ou aucune des deux.

Lorsque vous marquez une variable comme variable d'entrée, vous indiquez que sa valeur doit être fournie lorsque l'intégration est déclenchée. La valeur d'une variable d'entrée peut être modifiée lors de l'exécution de l'intégration.

Lorsque vous marquez une variable comme variable de sortie, vous indiquez que la valeur finale de la variable doit être renvoyée dans la réponse de l'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

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. Les variables de tâche sont également appelées variables générées automatiquement.

Le nom unique d'une variable de tâche suit une convention de dénomination spéciale : il utilise des accents graves autour du nom de la variable et inclut l'ID de la tâche. Il a le format suivant : `<Task ID>_<Variable Name>`.

Par exemple, la tâche Appeler un point de terminaison REST comporte une sortie pour le corps de la réponse. Si l'ID de cette tâche est Task_5, le nom unique de la variable de tâche pour le corps de la réponse est `Task_5_responseBody`.

Dans le volet Variables, les variables de tâche peuvent être listées par un nom de sortie commun, par exemple responseBody, sans l'ID de tâche ni les accents graves. Pour afficher le nom de variable complet et unique requis pour la référence, cliquez sur la variable dans le volet et consultez ses détails dans le panneau de droite.

Variables de configuration

Preview

Ce produit ou cette fonctionnalité sont soumis aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Les produits et fonctionnalités de pré-DG sont proposés "en l'état" et peuvent avoir une compatibilité limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Les variables de configuration vous permettent d'externaliser la configuration de 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 manuellement votre intégration 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 afficher et modifier les variables de configuration définies dans votre intégration, cliquez sur Variable de configuration de l'intégration  variable_add dans le volet Variables. Pour découvrir comment créer et utiliser des variables de configuration, consultez le tutoriel Créer une CICD pour votre intégration.

Variables système

Les variables système sont générées automatiquement lorsque vous créez une intégration. Vous pouvez utiliser ces variables dans vos tâches d'intégration et pour gérer les erreurs. L'intégration contient les variables générées par le système suivantes :

• ErrorInfo : en cas d'échec de l'exécution, vous pouvez accéder aux détails de l'erreur avec la variable ErrorInfo :

  {
    "ErrorInfo": {
    "message": String,
    "code": Number
    }
  }
  

  Vous pouvez accéder aux messages d'erreur en créant une variable d'intégration nommée ErrorMessage. Toutefois, nous vous recommandons d'utiliser la variable ErrorInfo.message générée par le système pour accéder aux messages d'erreur.

• ExecutionMode : mode d'exécution basé sur le déclencheur. Les valeurs valides sont SYNC et ASYNC.
• ExecutionId : ID d'exécution de l'intégration.
• IntegrationName : nom de l'intégration.
• Region : région de l'intégration.
• ProjectId : ID du projet contenant l'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 :

Afficher et modifier les variables de configuration

Preview

Ce produit ou cette fonctionnalité sont soumis aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Les produits et fonctionnalités de pré-DG sont proposés "en l'état" et peuvent avoir une compatibilité limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Pour afficher les variables de configuration définies dans votre intégration, cliquez sur variable_add Variable de configuration de l'intégration dans le volet Variables. Le volet Variables de configuration s'affiche et présente toutes les variables de configuration définies dans votre intégration. Il vous suffit de cliquer sur le champ Valeur pour modifier la valeur de la variable de configuration.

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

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 +Create (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.

   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 de l'intégration	Lors de l'exécution, la variable sera fournie en tant qu'entrée au déclencheur exécuté.
   Sortie de l'intégration	La valeur finale de la variable à la fin de l'exécution doit être transmise à l'appelant de l'intégration.
   Entrée et sortie de l'intégration	Lors de l'exécution, la variable sera fournie en entrée au déclencheur exécuté, et sa valeur finale sera transmise à l'appelant de l'intégration.

   3. 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 située à côté de son nom.

      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.

   4. Valeur par défaut : saisissez la valeur par défaut de la variable. Ce champ est facultatif.
   5. 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.
      Remarque : Ce champ ne s'affiche que pour les variables de type de données JSON.
   6. 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 savoir comment activer le masquage pour l'intégration et la région, consultez Modifier une intégration et Modifier des 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.

Fonctionnement des 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.

Le tableau suivant récapitule les différents types de variables et leur comportement :

Variable type	Description	Comportement	Exemple
Variable de configuration	Stocke les données de configuration de l'intégration.	Définies au moment de la conception, elles peuvent être modifiées lorsque vous publiez l'intégration.	Adresse e-mail cible pour la notification.
Variable système	Générée automatiquement par le système.	En lecture seule et ne peut pas être modifié.	Variable ExecutionId.
Variable d'intégration	Permet de suivre les données tout au long de l'exécution d'une intégration.	Définie explicitement dans votre intégration et modifiable lors de l'exécution de l'intégration.	Variable permettant de stocker le résultat d'une tâche.
Variable de tâche	Stocke le résultat d'une tâche spécifique.	Défini de manière implicite en exécutant une tâche et ne peut pas être modifié.	Variable responseBody de la tâche Appeler le point de terminaison REST.

Références de variables

Les tâches, les déclencheurs et les arêtes d'une intégration peuvent lire et écrire dans des variables à l'aide de références de variables. Une référence de variable prend la forme $paramKey$, où paramKey est le nom de la variable.

$isNameUnique$ = true AND $numAccounts$ >= 1

Exemple :

• Une vérification conditionnelle d'arête peut ressembler à ceci :

  $isNameUnique$ = true AND $numAccounts$ >= 1

  Dans cet exemple, isNameUnique est une variable du type de données booléen et numAccounts est un paramètre du type de données entier.

• Vous pouvez créer une notification par e-mail pour l'enregistrement d'un nouvel utilisateur dans un workflow d'intégration d'application. Supposons que vous ayez deux variables :
  • $userName$ : contient le nom du nouvel utilisateur (par exemple, "Alex").
  • $orderID$ : contient un identifiant de commande unique (par exemple, "ORD-12345").

  Le modèle pour le corps de l'e-mail pourrait être le suivant :

  Hello $userName$, thank you for your order! Your order ID is $orderID$.

  Lorsque ce message est envoyé, le système remplace les références de variables par leurs valeurs correspondantes. Le message final sera le suivant :

  Hello Alex, thank you for your order! Your order ID is ORD-12345.

Vous pouvez utiliser des références de variables aux emplacements suivants :

• Paramètres de la tâche
• Paramètres de déclencheur
• Conditions de périphérie

Lorsque vous faites référence à une variable générée automatiquement ou de tâche, vous devez utiliser son nom complet et unique, qui inclut des accents graves et l'ID de la tâche, entre les délimiteurs de signe dollar. Par exemple, pour faire référence à la sortie responseBody d'une tâche Appeler le point de terminaison REST avec l'ID Task_5, vous devez utiliser $`Task_5_responseBody`$.

Quotas et limites

Pour plus d'informations sur les quotas et les limites, consultez la section Quotas et limites.

Étapes suivantes

• Découvrez comment créer une intégration CI/CD.
• Découvrez comment masquer les données sensibles dans les journaux.
• Ajouter et configurer une tâche de mappage de données