Ajouter des variables aux interfaces

Ajouter des variables aux interfaces

Résumé : Ajoutez des variables à une interface afin que les utilisateurs puissent modifier certaines valeurs avant une exécution manuelle, sans modifier la configuration de l'interface.

Prérequis : - Vous devez avoir accès à Interfaces. - Vous devez avoir l'autorisation de modifier l'interface. - L'interface doit disposer d'une version brouillon modifiable avant que vous puissiez changer les variables.

Ajouter des variables aux interfaces

Les variables sont des valeurs réutilisables que BrynQ peut lire lors de l'exécution d'une interface. Utilisez-les pour des valeurs qui peuvent changer d'une exécution à l'autre, comme une période de reporting, un code société, un service, un nom de fichier ou tout autre paramètre qui ne doit pas être figé dans la logique de l'interface.

Comprendre le fonctionnement des variables

  • Le champ Name identifie la variable dans la logique de l'interface. Le nom est obligatoire et doit être court, clair et stable.
  • Le champ Default value est la valeur utilisée par BrynQ lorsque l'utilisateur ne saisit pas d'autre valeur avant une exécution manuelle. Ce champ est obligatoire.
  • Le champ Description explique ce que contrôle la variable. Ce champ est facultatif, mais il aide les utilisateurs à choisir la bonne valeur lorsqu'ils exécutent l'interface.
  • Les variables n'ont d'effet sur une exécution que si la logique de l'interface utilise le Name de la variable. Ajouter une ligne sur la page Variables ne modifie pas le résultat à lui seul.

Ouvrir la page Variables

  • Dans la navigation de gauche, ouvrez Interfaces.
  • Ouvrez l'interface que vous souhaitez configurer.
  • Dans la navigation de l'éditeur d'interface, cliquez sur Variables. La page de gestion des lignes de variables s'ouvre.
  • Si l'interface est en production ou en lecture seule, utilisez la zone d'actions en haut de l'éditeur d'interface pour ouvrir ou créer un brouillon modifiable avant de modifier les variables.

Ajouter une variable

  • Si la page affiche Add variables, cliquez sur Add variable au centre de la page. BrynQ ouvre le tableau des variables.
  • Dans la colonne Name, saisissez le nom de la variable. Utilisez un nom que la logique de l'interface peut reconnaître, par exemple month, company_code ou file_name.
  • Dans la colonne Default value, saisissez la valeur que BrynQ doit utiliser lorsqu'aucune valeur personnalisée n'est saisie avant une exécution manuelle.
  • Dans la colonne Description, expliquez à quoi sert la variable et quel type de valeur l'utilisateur doit saisir.
  • Dès que vous commencez à remplir la ligne, BrynQ ajoute une nouvelle ligne vide en dessous. Utilisez-la uniquement si vous avez besoin d'une autre variable.
  • Attendez que l'état de l'enregistrement automatique indique que les modifications sont enregistrées. La page Variables enregistre les modifications automatiquement.
Add variable to variables table
Ajouter une variable au tableau des variables

Ajouter d'autres variables

  • Utilisez la ligne vide en bas du tableau des variables pour ajouter une autre variable.
  • Renseignez Name et Default value pour chaque variable. Ajoutez une Description lorsque les utilisateurs ont besoin de contexte avant d'exécuter l'interface.
  • Limitez chaque variable à une seule valeur. Par exemple, utilisez une variable pour start_date et une autre pour end_date au lieu de mettre les deux dates dans un seul champ.
  • Évitez de modifier le Name d'une variable une fois qu'il est utilisé dans la logique de l'interface. L'exécution peut échouer ou utiliser une mauvaise valeur si la logique attend toujours l'ancien nom.

Supprimer une variable

  • Dans le tableau des variables, repérez la ligne à supprimer.
  • Placez votre curseur sur la partie droite de la ligne.
  • Cliquez sur l'icône de corbeille qui apparaît à côté de la ligne.
  • Ne supprimez une variable que si la logique de l'interface ne l'utilise plus. Si la logique lit encore ce nom de variable, la prochaine exécution peut échouer ou utiliser des données incomplètes.

Utiliser les variables lors de l'exécution d'une interface

Les variables peuvent être modifiées avant une exécution manuelle. Vous pouvez ainsi exécuter la même interface avec des valeurs d'entrée différentes sans modifier la configuration enregistrée de l'interface.

Saisir des valeurs avant une exécution

  • Dans la vue d'ensemble Interfaces, repérez l'interface que vous souhaitez exécuter.
  • Dans la zone d'actions de la ligne de l'interface, cliquez sur Run. Si l'interface comporte des variables, BrynQ ouvre la fenêtre Run interface.
  • Lisez le texte en haut de la fenêtre. Il explique que vous pouvez saisir des valeurs pour les variables que vous souhaitez remplacer, ou les laisser vides pour utiliser les valeurs par défaut.
  • Dans le tableau, vérifiez Name, Description et Value.
  • Dans la colonne Value, saisissez une valeur personnalisée uniquement pour les variables que vous souhaitez remplacer pour cette exécution.
  • Laissez Value vide : BrynQ utilise alors la Default value.
  • Cliquez sur Run dans la zone d'actions en bas de la fenêtre pour lancer l'interface avec ces valeurs.

Choisir des valeurs de variables utiles

  • Utilisez le format attendu par la logique de l'interface. Par exemple, saisissez une date, un code ou un texte exactement comme l'interface a été conçue pour le lire.
  • Consultez Description si vous n'êtes pas sûr de ce que contrôle une variable.
  • Utilisez la valeur par défaut lorsque vous souhaitez le comportement d'exécution habituel.
  • Saisissez une valeur personnalisée lorsque cette exécution nécessite une autre période, une autre société, un autre fichier ou un autre paramètre.

Plus d'informations

Exemple : une interface importe les données de paie d'un mois. Vous pouvez ajouter une variable nommée month avec la valeur par défaut 2026-06 et la description Payroll month in YYYY-MM format. Lors d'une exécution manuelle, les utilisateurs peuvent laisser Value vide pour exécuter juin, ou saisir 2026-07 pour exécuter juillet sans modifier la configuration de l'interface.

Les variables ne remplacent pas Scenarios, Mapping, Data filters ou Schedule. Elles fournissent uniquement des valeurs que l'interface peut lire pendant son exécution. Si une variable n'est pas utilisée dans la logique de l'interface, l'ajouter à la page Variables ne changera pas le résultat de l'exécution.