AppSuite:Client Onoarding
activation/deactivation
The onboarding wizard can be activated simply by enabling the followning capability:
client-onboarding
With this feature enabled the following ui changes are applied. First of all the wizard itself is available and can be started. This can be done via a textlink in the topbar dropwon (burger menu) and also via a link in the new premium bar (in case it's activated). Further more a portal widget is available.
components
wizard
1. step: seleect platform
per default: windows, android, apple
2. step: select device
per default: pc, android smartphone, android tablet, iPhone, iPad, Mac
3. step: select scenario and action
Please take a look at the related middleware yaml config files and documentaion for more details.
extension points
For customization of the different actions (e.g. config via email or app download) please use the following exension point that mapps actions and corresponding views.
io.ox/onboarding/clients/views
upsell settings
Please refer to the upsell documentation for more details.
io.ox/core//features/upsell/client.onboarding/enabled
io.ox/core//features/upsell/client.onboarding/color
io.ox/core//features/upsell/client.onboarding/icon
metrics
With the metrics feature enabled the following user actions are trackend:
events
selections
The user selects an option
core/client-onboarding/platform/select
core/client-onboarding/device/select
core/client-onboarding/scenario/select
core/client-onboarding/action/select
execute
The user executes a action
action core/client-onboarding/action/execute
toggle between simple and expert mode
core/client-onboarding/mode/toggle
widget
extension points
simply enables the widget
io.ox/portal/widget
The main extension defining the widgets content
io.ox/portal/widget/client-onboarding
Defines that this widget is unique and can be added only once
io.ox/portal/widget/client-onboarding/settings
deprecated parts
The wizard replaces and extends the functionality of the old Download Section in settings and the correspoinding widgets. We recommend to disable these outdated parts.
- widget: get ox drive
- widget: update
- settings entry: downloads
remove settings section 'Downloads'
Edit the property file and change the value to `true:
io.ox/core//settings/downloadsDisabled
remove widgets
To remove the both related portal widget/tiles please refer to:
oxpedia > configuring portal plugins > Disablingatile_completely
- io.ox/portal/widget/oxdriveclients
- io.ox/portal/widget/updater