Product tour¶
Product tour is an in-app onboarding tool that helps users discover and learn Ibexa DXP features through interactive, step-by-step guided walkthroughs. Unlike static documentation, product tours provide real-time, contextual guidance directly within the application interface.
With product tours, you can create customized onboarding journeys tailored to specific client implementations, user roles, or business processes. This accelerates user adoption, reduces training time, and helps users confidently navigate the platform.
Product tour functionality is available from version 4.6.28 as part of the Integrated help package. To use product tours, you must first install the Integrated help LTS Update.
TODO: Arcade video here, showing a quick demo of the feature
Key concepts¶
Product tour consists of three main elements:
- Scenario - A complete onboarding scenario containing multiple steps that guide users through a specific feature or workflow
- Step - An individual instruction or explanation within a scenario, containing blocks, displayed as an overlay or tooltip
- Block - A content element within a step, such as text, images, videos, or links that provide information to the user
Scenario types¶
Ibexa DXP supports two types of scenarios, each designed for different use cases:
TODO: screenshot for each type
General scenarios¶
General tours display information in centered modals without targeting specific UI elements. These tours provide an overview of features or concepts without requiring interaction with particular interface elements.
General tours are ideal for:
- Introducing new users to the platform
- Explaining high-level concepts or feature overviews
- Welcoming users with customizable background images and branding
Targeted scenarios¶
Targeted scenarios highlight specific UI elements on the page and guide users through interactive workflows. Each step targets a particular element using CSS selectors, drawing attention to buttons, navigation elements, or other interface components.
Targeted scenarios are ideal for:
- Demonstrating specific features or workflows
- Guiding users through multi-step processes
- Teaching users how to interact with particular UI elements
The steps building the scenario support three interaction modes:
- Standard - Users navigate between steps using "Previous" and "Next" buttons
- Clickable - Users must click the highlighted element to proceed to the next step
- Draggable - Users must drag and drop an element to continue the scenario
TODO: Screenshot here
Scenario lifecycle¶
Depending on scenario configuration, they automatically appear to users when they first log in or visit a specific page. Each scenario appears only once for each user.
Users can complete a tour by finishing all steps or by skipping it with the "Exit tour" button. At any time, users can manually restart completed tours from their user settings.
To start building your custom onboarding scenarios, see configure product tour.