AppSuite:Client Onboarding - Revision history

Khgras at 12:42, 7 May 2026

2026-05-07T12:42:37Z

← Older revision		Revision as of 12:42, 7 May 2026
Line 17:		Line 17:
	* CalDAV		* CalDAV
	* CardDAV		* CardDAV
	* OX Mail App
	* OX Drive App		* OX Drive App
	* Connector for Microsoft Outlook®
	* Sync App for Android
	* Microsoft ActiveSync		* Microsoft ActiveSync
	* Mail (IMAP/SMTP)		* Mail (IMAP/SMTP)
Line 108:		Line 105:

	Please check [https://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive#OX_Drive_for_Windows ''this''] documentation for more details.		Please check [https://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive#OX_Drive_for_Windows ''this''] documentation for more details.

	~~=== Sync App ===~~

	~~Identifier: <code>syncapp</code>~~

	~~The provider for the Sync App for Android. Requires "caldav" and "carddav" capabilities.~~

	~~The link to Google Play Store is specified via property <code>com.openexchange.client.onboarding.syncapp.store.google.playstore</code> in <code>client-onboarding-syncapp.properties</code> file. -->~~

	=== Mail (IMAP/SMTP) ===		=== Mail (IMAP/SMTP) ===
Line 172:		Line 161:
	</blockquote>		</blockquote>

	This exemplary setting specifies that ~~Mail App,~~ Drive App, EAS, Native Mail (IMAP/SMTP) and CalDAV/CardDAV are available in given order for iPhone devices.		This exemplary setting specifies that Drive App, EAS, Native Mail (IMAP/SMTP) and CalDAV/CardDAV are available in given order for iPhone devices.

	Once a scenario is made accessible through configuration it is visible to users trying to perform a client onboarding using one of associated devices. However, whether a user is effectively allowed to execute that scenario is determined by the required capabilities of the denoted providers; if not allowed it gets displayed as an upsell opportunity.		Once a scenario is made accessible through configuration it is visible to users trying to perform a client onboarding using one of associated devices. However, whether a user is effectively allowed to execute that scenario is determined by the required capabilities of the denoted providers; if not allowed it gets displayed as an upsell opportunity.

Daniel.dickhaus at 10:54, 5 May 2021

2021-05-05T10:54:21Z

← Older revision		Revision as of 10:54, 5 May 2021
Line 2:		Line 2:

	{{VersionFrom\|7.8.1}}		{{VersionFrom\|7.8.1}}

			With version 7.10.5 we introduced a new wizard.
			This config is still valid since the old wizard can still be enabled via setting.
			See https://documentation.open-xchange.com/7.10.5/ui/configuration/settings-list-of.html#onboarding for details on the new wizard.

	__TOC__		__TOC__

Khgras at 10:13, 28 January 2021

2021-01-28T10:13:56Z

← Older revision		Revision as of 10:13, 28 January 2021
Line 18:		Line 18:
	* Sync App for Android		* Sync App for Android
	* Microsoft ActiveSync		* Microsoft ActiveSync
	* eM Client
	* Mail (IMAP/SMTP)		* Mail (IMAP/SMTP)
	* Generic Mobile App provider		* Generic Mobile App provider
Line 105:		Line 104:

	Please check [https://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive#OX_Drive_for_Windows ''this''] documentation for more details.		Please check [https://oxpedia.org/wiki/index.php?title=AppSuite:OX_Drive#OX_Drive_for_Windows ''this''] documentation for more details.

	~~<!-- === eM Client ===~~

	~~Identifier: <code>emclient</code>~~

	~~The provider for the eM Client needs the "emclient" capability.~~

	~~Allows to configure the URL pointing to the executable file through <code>com.openexchange.client.onboarding.emclient.url</code> in file 'client-onboarding-emclient.properties' file.~~

	=== Sync App ===		=== Sync App ===

Kevin.ruthmann: /* OX Updater */

2018-01-29T12:10:04Z

OX Updater

← Older revision		Revision as of 12:10, 29 January 2018
Line 133:		Line 133:

	Configures the ActiveSync account on target device. Allows specifying the EAS end-point through <code>com.openexchange.client.onboarding.eas.url</code> property in 'client-onboarding-eas.properties'.		Configures the ActiveSync account on target device. Allows specifying the EAS end-point through <code>com.openexchange.client.onboarding.eas.url</code> property in 'client-onboarding-eas.properties'.

	~~=== OX Updater ===~~

	~~Identifier: <code>oxupdater</code>~~

	The provider offering the download for the OX Client Updater ([http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''http:''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''//oxpedia''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''.''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''org/wiki/index''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''.''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''php''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''?''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''title=AppSuite''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater '':''][http://oxpedia.org/wiki/index.php?title=AppSuite:Open-Xchange_Updater ''Open-Xchange_Updater'']). The provider is available as soon as the according package is installed and at least one product can be installed/updated via it by the user. A pre-configured scenario 'oxupdaterinstall' is already contained in <code>/opt/open-xchange/etc/client-onboarding-scenarios.yml</code>.

	== Configuring Onboarding scenarios ==		== Configuring Onboarding scenarios ==

Thorben: /* How can I add my own App? */

2017-03-15T09:17:42Z

How can I add my own App?

← Older revision		Revision as of 09:17, 15 March 2017
Line 325:		Line 325:
	* "url" sub-attribute containing the actual link pointing to the URL location		* "url" sub-attribute containing the actual link pointing to the URL location
	* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common". The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.		* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common". The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.
	* "image" sub-attribute containing the link pointing to the App's image		* "image" sub-attribute containing the link pointing to the App's image. Supported with v7.8.4

	The "icon" attribute is supposed to contain a comma-separated list of Font Awesome icons (only the ones from v4.4.0 are currently supported) that represent the App; e.g.		The "icon" attribute is supposed to contain a comma-separated list of Font Awesome icons (only the ones from v4.4.0 are currently supported) that represent the App; e.g.

Thorben: /* How can I upsell my own app? */

2017-03-15T09:16:47Z

How can I upsell my own app?

← Older revision		Revision as of 09:16, 15 March 2017
Line 345:		Line 345:
	Example		Example

	<blockquote>mygoogleapp:<br />		<blockquote>
	enabled: true<br />		mygoogleapp:<br />
	type: link<br />		enabled: true<br />
	link:<br />		type: link<br />
	url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />		link:<br />
	type: playstore<br />		url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />
	'''capabilities: "mygoogleapp_capability"'''<br />		type: playstore<br />
	providers: [app]<br />		'''capabilities: "mygoogleapp_capability"'''<br />
	alternatives: []<br />		providers: [app]<br />
	icon: fa-cloud<br />		alternatives: []<br />
	displayName_t10e: "My App for synchronizing files"<br />		icon: fa-cloud<br />
	description_t10e: "Synchronize your files with our Drive application."		displayName_t10e: "My App for synchronizing files"<br />
			description_t10e: "Synchronize your files with our Drive application."
	</blockquote>		</blockquote>
	The special "capabilities" attribute is only supported for scenarios of type "link" with the special "app" provider.		The special "capabilities" attribute is only supported for scenarios of type "link" with the special "app" provider.

Thorben: /* How can I add my own App? */

2017-03-15T09:15:11Z

How can I add my own App?

← Older revision		Revision as of 09:15, 15 March 2017
Line 324:		Line 324:

	* "url" sub-attribute containing the actual link pointing to the URL location		* "url" sub-attribute containing the actual link pointing to the URL location
	* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common".~~<br />~~		* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common". The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.
	The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.
	* "image" sub-attribute containing the link pointing to the App's image		* "image" sub-attribute containing the link pointing to the App's image

Thorben: /* How can I add my own App? */

2017-03-15T09:14:44Z

How can I add my own App?

← Older revision		Revision as of 09:14, 15 March 2017
Line 305:		Line 305:
	Hence, an appropriate section is supposed to be added to the 'client-onboarding-scenarios.yml' file having a unique name and "provider" attribute set to "[app]":		Hence, an appropriate section is supposed to be added to the 'client-onboarding-scenarios.yml' file having a unique name and "provider" attribute set to "[app]":

	<blockquote>mygoogleapp:<br />		<blockquote>
	enabled: true<br />		mygoogleapp:<br />
	type: link<br />		enabled: true<br />
	link:<br />		type: link<br />
	url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />		link:<br />
	type: playstore<br />		url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />
	providers: [app]<br />		type: playstore<br />
	alternatives: []<br />		image: http://my.fine.host/image001.png<br />
	icon: fa-cloud<br />		providers: [app]<br />
	displayName_t10e: "My App for synchronizing files"<br />		alternatives: []<br />
	description_t10e: "Synchronize your files with our Drive application."		icon: fa-cloud<br />
			displayName_t10e: "My App for synchronizing files"<br />
			description_t10e: "Synchronize your files with our Drive application."
	</blockquote>		</blockquote>
	The attribute "type" needs to be set to "link".		The attribute "type" needs to be set to "link".
Line 324:		Line 326:
	* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common".<br />		* "type" sub-attribute specifying of what type that link is: either "appstore", "macappstore", "playstore" or "common".<br />
	The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.		The type "common" is supposed to be used for links that do not point to a commercial App Store, but to a downloadable executable/installer file.
			* "image" sub-attribute containing the link pointing to the App's image

	The "icon" attribute is supposed to contain a comma-separated list of Font Awesome icons (only the ones from v4.4.0 are currently supported) that represent the App; e.g.		The "icon" attribute is supposed to contain a comma-separated list of Font Awesome icons (only the ones from v4.4.0 are currently supported) that represent the App; e.g.

Thorben: /* Adding custom scenarios */

2017-03-15T09:12:03Z

Adding custom scenarios

← Older revision		Revision as of 09:12, 15 March 2017
Line 213:		Line 213:
	<blockquote>		<blockquote>
	mygoogleapp:<br />		mygoogleapp:<br />
	enabled: true<br />		enabled: true<br />
	type: link<br />		type: link<br />
	link:<br />		link:<br />
	url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />		url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />
	type: playstore<br />		type: playstore<br />
	image: http://my.fine.host/image001.png<br />		image: http://my.fine.host/image001.png<br />
	providers: [app]<br />		providers: [app]<br />
	alternatives: []<br />		alternatives: []<br />
	icon: fa-cloud<br />		icon: fa-cloud<br />
	displayName_t10e: "My App for synchronizing files"<br />		displayName_t10e: "My App for synchronizing files"<br />
	description_t10e: "Synchronize your files with our Drive application."		description_t10e: "Synchronize your files with our Drive application."
	</blockquote>		</blockquote>

Thorben: /* Adding custom scenarios */

2017-03-15T09:11:41Z

Adding custom scenarios

← Older revision		Revision as of 09:11, 15 March 2017
Line 216:		Line 216:
	type: link<br />		type: link<br />
	link:<br />		link:<br />
	url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />		url: http://play.google.com/store/apps?id=mygoogleapp.invalid<br />
	type: playstore<br />		type: playstore<br />
	image: http://my.fine.host/image001.png<br />		image: http://my.fine.host/image001.png<br />
	providers: [app]<br />		providers: [app]<br />
	alternatives: []<br />		alternatives: []<br />