AppSuite:Guided tours

Synopsis: Guided tours are series of little steps meant to explain the various functions of OX to an end user. They can be configured by system administrators.

Basic framework

Guided tours are built on LinkedIn's hopscotch.js framework. It forms a series of small information "bubbles" that point to UI elements and display a text as well as small navigation elements.

State before 7.4.1

In 7.4.0, Guided Tours could not be configured.

State after 7.4.1

Package

Guided tours are contained in a separate package, named open-xchange-guidedtours. This will install UI as well as backend components (in the form of a config file).

Configuration

Several configuration parameters guide the running of Guided Tours:

io.ox/tours//server/disableTours	Disabled the tours completely
io.ox/tours//server/disable/$moduleName	Disables the tour for a specific module, e.g. "io.ox/tasks"
io.ox/tours//server/startOnFirstLogin	start the tour the first time a user logs in
io.ox/tours//server/version	arbitrary integer denoting the version of the tour. If startOnFirstLogin is true, the user might have seen a previous version but not the recent one. Increasing the number makes sure the users sees the updated version again.