Skip to content

Scenario context

Wogeez Engine Wogeez Engine

What is a scenario ?

A scenario is a sequence of steps executed on a kiosk (e.g., filling out a form, choosing options, making a payment). Each step may end in success or failure, and together they form the user journey.

The notion of context

During execution, the system builds a context that contains:

  • User inputs (e.g., form fields).
  • Step results (success / failure).
  • Technical information required to continue the scenario.
Info

👉 The context acts as the temporary memory of the ongoing scenario.

The scenario context snapshot

The context cannot be accessed directly during execution. At the end of the scenario, a snapshot (a frozen copy of the context) is generated:

  • either immediately if the rendering engine is connected to our servers,
  • or as soon as the connection is restored

The snapshot allows you to:

  • Retrieve all data collected during the scenario.
  • Review the full step history (success / failure).
  • Analyze the complete user journey.

Correlation number and mission number

Each scenario execution is uniquely identified by two complementary identifiers. The correlation number is a technical, system-generated ID that tracks all actions and calls within the scenario context. Its human-readable counterpart, the mission number, is derived from the correlation number and provides a simple, two-word phrase that can be used for support and troubleshooting. Both identifiers are generated at the start of each scenario execution and are unique per context, ensuring precise traceability for every scenario run.

Correlation number

  • A unique technical identifier generated at the beginning of each scenario execution.
  • Unique per context, meaning no two scenario contexts share the same correlation number.
  • Used to link together all the calls across the Wogeez components during execution.
  • Typically long and not human-readable.

Example: 

DEVICESERIAL1-5634bdf4-f0a3-499c-9999-67175220f2a3-30d5b095-8844-4ab6-b4f9-e63c4f4f26a4-1758100247784-mammoth-crawdad
Sequence Example Description
#1 DEVICESERIAL1 Device identifier
#2 5634bdf4-f0a3-499c-9999-67175220f2a3 Scenario identifier
#3 30d5b095-8844-4ab6-b4f9-e63c4f4f26a4 Scenario version identifier
#4 mammoth-crawdad Unique number
#5 mammoth-crawdad Mission number

Mission number

  • A human-readable version of the correlation number.
  • Also unique per context and generated at the start of each scenario execution.
  • Represented as a phrase of two simple words.

Example:

orange-lion

May be displayed on a kiosk in case of an error (e.g., no paper left, payment refused). Or can be displayed during the scenario for informational purposes or on printed/generated materials from the kiosk, such as tickets or receipts.

Example

For a printed/generated ticket

Ticket with correlation and mission number

Support usage

The mission number serves as a simple reference for user support. If an issue occurs, the user can provide the mission number to the hotline. Using this number, support staff can retrieve the associated correlation number, access the snapshot via API, and analyze the scenario execution to quickly identify and resolve any issues. This process ensures fast diagnosis and efficient support for any incident.

Data access via API

The snapshot is the only entry point to access scenario data. Access is provided exclusively through our APIs:

  • You query the API with search parameters.
  • The API returns the full snapshot (or multiple snapshots, if using a batch query).

It is possible to retrieve multiple snapshots in a single request. The following parameters can be combined:

  • Company identifier (mandatory)
  • Device (kiosk) identifier
  • Scenario identifier
  • Scenario version identifier
  • Correlation number
  • Mission number

Tip

This enables fine-grained searches, whether you want to investigate a single incident or process a large set of scenarios.

Key takeaways

  • The context is temporary and only becomes available at the end, as a snapshot.
  • A snapshot is generated immediately if the rendering engine is connected to the servers, or once the connection is restored.
  • Data access is provided exclusively via API.
  • Snapshots can be retrieved in batches, filtered by multiple parameters (company, device, scenario, version, correlation, mission).
  • The correlation number ensures technical traceability.
  • The mission number is a simplified, human-readable identifier, useful during execution, on printed materials, and for user-facing errors.

Context graph

Data retention

At Wogeez, data retention is contractually defined and aligned with GDPR requirements. Data is not intended to remain with us indefinitely and is automatically deleted once the defined retention period expires. A data invalidation web service will soon be available to allow for early deletion as soon as the data has been consumed.

Next ?

We invite you to consult the developer documentation to understand API queries and data exchange structures.

Lab

Additionally, a notification webhook that pushes data directly to Wogeez clients is under development to avoid the need for manual queries. Other data formats, such as Excel and CSV, are also being evaluated for future support.