Scenario
Définition de votre scénario
Un scénario se présente sous la forme d'une archive regroupant votre logique d'enchaînement des étapes, ainsi que les médias et les ressources nécessaires à sa bonne exécution. Un scénario peut comporter plusieurs versions. Lors de la création d'un nouveau scénario, une première version est automatiquement générée. Pour supprimer définitivement un scénario, vous devez d'abord vous assurer qu'aucune version n'est actuellement déployée, puis procéder à la suppression de l'intégralité des versions existantes.
Votre point de départ, générer une archive, modifier, puis charger.
Reference
Endpoint
Swagger
Voir la documentation →
Exemple de structure d'un scenario simple.
Reference
Valeurs possibles
Description des champs du scénario, en liste
engine: Moteur Wogeez (REQUIRED)- Permet de spécifier les parametres du moteur de rendu
engine/version: Version du Wogeez (REQUIRED)- Permet de spécifier la version du moteur Wogeez à utiliser pour le rendu de ce scénario
1.0.0: Moteur de rendu 1.0.0 (REQUIRED)
metadata: Informations (REQUIRED)- Informations diverses sur le scenario
metadata/name: Nom (REQUIRED)- Nom de votre scénario
metadata/description: Description (REQUIRED)- Description de votre scénario
metadata/version: Version (REQUIRED)- Indiquez la version de votre scénario. Si cette version existe déjà sur le serveur, elle sera mise à jour (remplacée). Dans le cas contraire, une nouvelle version sera générée, permettant de conserver l'historique des anciennes versions.
scenario: Scenario (REQUIRED)- Ce module vous permet de définir la structure de votre scénario : de sa logique globale à l'organisation des étapes, en passant par le choix du thème et l'allocation des ressources.
scenario/enabled: Activer le scénario (REQUIRED)- Permet de rendre le scénario actif, un scénario inactif déployé sur une ensemble de bornes ne sera pas affiché.
true: Scenario actif (BETTER)false: Scenario inactif (OPTIONAL)
scenario/theme: Théme (REQUIRED)- Permet de décrire le théme de votre scénario.
scenario/theme/css: CSS (REQUIRED)- Ce code CSS sera global à votre scénario, pratique pour définir des styles globaux à l'ensemble de vos étapes.
scenario/steps: Etapes (REQUIRED)- Etapes de votre scénario.
scenario/openingHours: Jours d'ouverture de votre scénario (OPTIONAL)- Cette fonctionnalité permet de définir les plages de disponibilité de votre scénario : par défaut, celui-ci est actif en permanence, mais dès que des créneaux sont configurés, il devient capable de réagir aux changements d'état temporels. Ainsi, l'entrée dans une période d'activité déclenche automatiquement l'étape associée au trigger ON_OPEN, tandis que la sortie de ces horaires (passage en heures fermées) active instantanément le trigger ON_CLOSE, vous permettant d'automatiser des actions spécifiques à l'ouverture et à la fermeture.
scenario/steps/0/id: Identifiant de l'étape (REQUIRED)- L'identifiant d'une étape (jump) est un élément structurel critique car il sert de point de raccordement pour définir le flux du scénario : chaque liaison entre deux étapes repose exclusivement sur la correspondance exacte de ces IDs. Si une étape pointe vers un identifiant inexistant ou erroné, la continuité logique est rompue, ce qui entraîne une fin de scénario immédiate et normale, le système considérant qu'il n'y a plus d'instructions à suivre.
scenario/steps/0/description: Description de l'étape (REQUIRED)- La description sert de résumé synthétique pour chaque étape, permettant de comprendre en un coup d'œil la logique globale du flux sans avoir à analyser le contenu technique ou détaillé de l'étape complète. Elle offre ainsi une lecture fluide et rapide de l'architecture du scénario.
scenario/steps/0/type: Type de l'étape (REQUIRED)- Le champ type, désormais limité exclusivement au format HTML, définit la nature du contenu de l'étape : il garantit que le message sera interprété et rendu avec une mise en forme riche (balises, styles, liens), assurant ainsi une présentation visuelle structurée et cohérente lors de l'exécution du scénario.
HTML: Format HTML (REQUIRED)
scenario/steps/0/triggers: Declencheur de l'étape (REQUIRED)- Les agissent comme des interrupteurs automatiques déclenchés par le calendrier : lorsqu'une étape possède l'un de ces marqueurs, elle s'active dès que le scénario bascule dans l'état horaire correspondant. Toutefois, pour garantir l'unicité du flux, le système applique une règle de priorité stricte : si plusieurs étapes partagent le même trigger, seule la première rencontrée dans l'arborescence sera exécutée, les suivantes étant systématiquement ignorées afin d'éviter tout conflit de lancement.
ON_OPEN: Etape à déclencher lorsque le scénario est ouvert (REQUIRED)ON_CLOSE: Etape à déclencher lorsque le scénario est fermé (BETTER)
scenario/steps/0/triggers/type: Declencheur de l'étape (REQUIRED)- Les agissent comme des interrupteurs automatiques déclenchés par le calendrier : lorsqu'une étape possède l'un de ces marqueurs, elle s'active dès que le scénario bascule dans l'état horaire correspondant. Toutefois, pour garantir l'unicité du flux, le système applique une règle de priorité stricte : si plusieurs étapes partagent le même trigger, seule la première rencontrée dans l'arborescence sera exécutée, les suivantes étant systématiquement ignorées afin d'éviter tout conflit de lancement.
ON_OPEN: Etape à déclencher lorsque le scénario est ouvert (REQUIRED)ON_CLOSE: Etape à déclencher lorsque le scénario est fermé (BETTER)
scenario/steps/0/jumps: Les sauts d'étapes (REQUIRED)- Les sauts (ou transitions) permettent de définir la navigation entre les étapes en fonction d'événements spécifiques : les triggers ON_CLICK et ON_DELAY gèrent l'interaction utilisateur ou le passage du temps (déclenchant le saut après un clic ou un délai imparti), tandis que les triggers ON_SUCCESS et ON_FAILURE orientent le flux selon le résultat d'une action technique. Tout comme pour les triggers d'ouverture, la règle d'unicité s'applique : si plusieurs sauts de même type sont configurés pour une étape, seul le premier détecté dans la structure sera pris en compte, garantissant ainsi une redirection unique et sans ambiguïté vers l'étape suivante.
ON_SUCCESS: OK (REQUIRED)ON_FAILURE: Erreur (BETTER)ON_CLICK: Attendre le touch d'un utilisateur sur un composant HTML (OPTIONAL)ON_DELAY: Attendre une temporisation avant de passer à l'étape suivante (OPTIONAL)
scenario/steps/0/content: Contenu de l'étape (REQUIRED)- Il s'agit du code HTML ou de Widgets permettant de manipuler les ressources de votre scénario.
scenario/steps/0/css: Mise en forme de l'étape (OPTIONAL)- Il s'agit du code CSS permettant de définir la mise en forme de votre étape.
Gérer les scénarios
Reference
Endpoint
Swagger
Voir la documentation →
Endpoint
Swagger
Voir la documentation →
Swagger
Voir la documentation →
Swagger
Voir la documentation →
Endpoint
Swagger
Voir la documentation →
Déployer des versions de scenarios vers des bornes
Reference
Endpoint
Swagger
Voir la documentation →