Résumé : Découvrez ce qu'est une interface BrynQ, quels statuts elle peut avoir et comment elle passe de la configuration à l'utilisation en production.

Prérequis : - Vous devez avoir accès à Interfaces pour consulter les interfaces. - Vous devez disposer des droits nécessaires pour créer (create), modifier (edit), publier (publish) ou exécuter (run) une interface. - Les applications source et cible doivent être actives avant qu'une interface puisse être activée et utilisée.

Concepts et cycle de vie d'une interface

Une interface relie une application source à une application cible afin que les données circulent de manière contrôlée entre elles.

Qu'est-ce qu'une interface

• Une interface définit quelles données sont échangées, d'où elles viennent, où elles vont et comment BrynQ doit les traiter.
• Une application source est l'application d'où proviennent les données.
• Une application cible est l'application vers laquelle les données sont envoyées.
• Un schedule (planification) détermine quand l'interface s'exécute. L'exécution peut être manuelle, programmée dans le temps ou déclenchée après une autre interface.
• Les Variables sont des valeurs utilisables lors de l'exécution de l'interface.

Types d'interfaces

• Choisissez Use our templates si vous souhaitez partir d'un modèle BrynQ standard.
• Choisissez Build together with us si vous avez besoin d'une solution sur mesure avec l'accompagnement de BrynQ.
• Une interface basée sur un modèle peut inclure Configuration, Scenarios, Data filters, Authorization, Mapping, Variables et Schedule.
• Une interface sur mesure peut inclure Scoping, Authorization, Mapping, Variables et Schedule.

Interfaces actives et inactives

• Les interfaces Active peuvent s'exécuter dès que la configuration requise est terminée.
• Les interfaces Inactive sont désactivées et ne peuvent pas s'exécuter.
• Lorsque vous désactivez une interface, BrynQ désactive également sa planification.
• Vous ne pouvez pas désactiver une interface pendant son exécution.
• Si une interface a besoin d'applications qui ne sont pas actives, BrynQ vous demande d'abord d'activer ces applications.

Les étapes du cycle de vie d'une interface

Une interface passe généralement par la création, la configuration en brouillon, l'utilisation en production, puis des modifications ultérieures si nécessaire.

Créer l'interface

• Ouvrez Interfaces.
• Sélectionnez New interface.
• Choisissez Use our templates ou Build together with us.
• Pour un modèle, choisissez celui qui correspond à vos applications source et cible.
• Pour une interface sur mesure, saisissez un nom d'interface clair.
• Sélectionnez Finish ou Confirm and start pour créer le premier brouillon.

Compléter le brouillon

• Un draft (brouillon) est la version modifiable de l'interface.
• BrynQ enregistre les modifications au fur et à mesure.
• Complétez tous les onglets obligatoires visibles pour votre type d'interface.
• Si un avertissement apparaît sur un onglet, ouvrez cet onglet et complétez les informations manquantes.
• Sélectionnez Continue later si vous voulez quitter le brouillon sans le publier.

Publier le brouillon

• Sélectionnez Publish lorsque toutes les parties obligatoires sont complètes.
• BrynQ vérifie le brouillon avant de le publier.
• La publication est bloquée si l'autorisation, la configuration, les scénarios, le mapping ou d'autres données obligatoires sont manquants.
• Après la publication, la version devient Live.
• Si l'interface a une planification active, la publication d'un nouveau brouillon peut avoir un effet sur la prochaine exécution.

Utiliser l'interface en production

• Une interface Live est la version publiée que BrynQ utilise pour les exécutions.
• Utilisez Run pour lancer une exécution manuelle si l'interface le permet.
• Utilisez Schedule pour exécuter l'interface automatiquement.
• Utilisez View logs pour consulter les exécutions passées, les erreurs et les messages.
• Si l'interface est active et dispose d'une planification valide, BrynQ peut l'exécuter sans action manuelle.

Modifier une interface en production

• Sélectionnez Create draft pour créer une nouvelle version modifiable à partir de la version en production.
• Sélectionnez Show draft si un brouillon existe déjà.
• Modifiez le brouillon et publiez-le lorsqu'il est prêt.
• La publication du brouillon en fait la nouvelle version en production.
• Les anciennes versions en production restent consultables. La restauration d'une ancienne version peut supprimer les données des versions ultérieures : ne le faites donc que si vous en êtes sûr.

Statuts d'une interface

Les statuts vous aident à savoir si une interface peut s'exécuter, est en cours de modification ou nécessite votre attention.

Statuts de version

• Draft signifie que la version est encore en préparation.
• Live signifie que la version est publiée et utilisée pour les exécutions.
• Old version signifie que la version était en production auparavant, mais n'est plus la dernière version en production.
• In development signifie que BrynQ travaille encore sur l'interface. Vous pouvez la consulter et éventuellement préparer l'autorisation ou le mapping, mais certaines modifications peuvent nécessiter l'aide du support.

Statuts d'exécution

• Idle signifie que l'interface ne s'exécute pas.
• Queued signifie que l'exécution attend de démarrer.
• Running signifie que l'interface traite des données.
• Stopping signifie que BrynQ est en train d'arrêter l'exécution.
• Unknown signifie que BrynQ ne peut pas afficher un état d'exécution clair.

Résultats de la dernière exécution

• Successful signifie que l'exécution s'est terminée sans erreur.
• Completed signifie que l'exécution s'est terminée, mais avec des erreurs ou des avertissements.
• Failed signifie que l'exécution ne s'est pas terminée correctement.
• Stopped signifie que l'exécution a été arrêtée par un utilisateur.
• Never run signifie qu'il n'existe encore aucun historique d'exécution.

Bonnes pratiques

Effectuez ces vérifications avant de publier ou d'exécuter une interface.

Avant la publication

• Vérifiez que Authorization est complète pour l'environnement de production.
• Vérifiez que les champs obligatoires de Configuration sont remplis.
• Vérifiez que les Scenarios et le Mapping obligatoires sont complets.
• Vérifiez que chaque scénario actif possède une Unique key lorsque c'est requis.
• Vérifiez le Schedule avant de publier si l'interface s'exécute déjà automatiquement.

Avant l'exécution

• Assurez-vous que l'interface est Active.
• Assurez-vous que les applications source et cible sont actives.
• Vérifiez si l'interface est déclenchée manuellement, par une planification ou par une autre interface.
• Vérifiez les Variables si l'exécution a besoin de valeurs qui peuvent changer d'une exécution à l'autre.
• Ouvrez View logs après une exécution si le résultat est en échec ou terminé avec des erreurs.

Plus d'informations Utilisez Interfaces pour les interfaces en production et inactives. Utilisez Setups pour trouver les interfaces qui ont encore un brouillon ou une configuration en cours.