AppSuite:Client Onoarding: Difference between revisions

From Open-Xchange
No edit summary
No edit summary
Line 4: Line 4:
= activation/deactivation =
= activation/deactivation =


== capability ==
The onboarding wizard can be activated simply by enabling the followning capability:


<code>client-onboarding</code>
<code>client-onboarding</code>


== affects ==
With this feature enabled the following ui changes are applied.
 
First of all the wizard itself is available and can be started.
* portal widget
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).
* textlink entry in premium bar
Further more a portal widget is available.
* textlink entry in topbar dropdown (burger)
* wizard dialog


= components =
= components =
Line 19: Line 17:
== wizard ==
== wizard ==


=== actions ===
=== 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 ===


* download
Please take a look at the related middleware yaml config files and documentaion for more details.
* email
* sms
* display/easmanual
* display/davmanual
* display/mailmanual
* link/mailappinstall
* link/emclientinstall
* link/oxupdaterinstall
* link/drivewindowsclientinstall
* link/driveappinstall
* link/syncappinstall
* link/drivemacinstall


'''extension points'''
'''extension points'''


mapping of action and corresponding view
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.


<code>io.ox/onboarding/clients/views</code>
<code>io.ox/onboarding/clients/views</code>


=== upsell settings ===
=== upsell settings ===
Please refer to the upsell documentation for more details.


<code>
<code>
Line 50: Line 47:


=== metrics ===
=== metrics ===
With the metrics feature enabled the following user actions are trackend:


'''events'''
'''events'''


''selections''
''selections''
The user selects an option


<code>core/client-onboarding/platform/select </code><br>
<code>core/client-onboarding/platform/select </code><br>
Line 59: Line 61:
<code>core/client-onboarding/scenario/select </code><br>
<code>core/client-onboarding/scenario/select </code><br>
<code>core/client-onboarding/action/select</code>
<code>core/client-onboarding/action/select</code>


''execute''  
''execute''  
The user executes a action


<code>action core/client-onboarding/action/execute</code>
<code>action core/client-onboarding/action/execute</code>


''toggle between simple and expert mode''
''toggle between simple and expert mode''
Line 71: Line 77:


'''extension points'''
'''extension points'''


''simply enables the widget''
''simply enables the widget''


<code>io.ox/portal/widget</code>
<code>io.ox/portal/widget</code>


''The main extension defining the widgets content''
''The main extension defining the widgets content''


<code>io.ox/portal/widget/client-onboarding</code>
<code>io.ox/portal/widget/client-onboarding</code>


''Defines that this widget is unique and can be added only once''
''Defines that this widget is unique and can be added only once''


<code>io.ox/portal/widget/client-onboarding/settings </code>
<code>io.ox/portal/widget/client-onboarding/settings </code>


== deprecated parts ==
== deprecated parts ==


Disable/remove the 'old' widget and settings entries:
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: get ox drive
Line 92: Line 102:
* settings entry: downloads
* settings entry: downloads


Their functionality is now covered by the client onboarding wizard.


=== settings ===
=== remove settings section 'Downloads' ===


Edit the property file and change the value to `<code>true</code>:
Edit the property file and change the value to `<code>true</code>:
Line 100: Line 109:
<code>io.ox/core//settings/downloadsDisabled</code>
<code>io.ox/core//settings/downloadsDisabled</code>


=== widgets ===
=== remove widgets ===


To remove the both related portal widget/tiles please refer to:<br> [https://oxpedia.org/wiki/index.php?title=AppSuite:Configuring_portal_plugins#Disabling_a_tile_completely oxpedia &gt; configuring portal plugins &gt; Disabling''a''tile_completely]
To remove the both related portal widget/tiles please refer to:<br> [https://oxpedia.org/wiki/index.php?title=AppSuite:Configuring_portal_plugins#Disabling_a_tile_completely oxpedia &gt; configuring portal plugins &gt; Disabling''a''tile_completely]

Revision as of 08:54, 5 February 2016

This information is valid from 7.8.1


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
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Client_Onoarding&oldid=21379"