Open-Xchange - User contributions [en]

AppSuite:EM Client for OX App Suite

2017-01-30T13:37:58Z

Christian.degen: /* Autodiscovery for partners and customers */

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:''' The automatic update via eM Client (client triggered update) will be available only a few days after Open-Xchange released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include their information to that mechanism need to apply a workaround at this point of time. Further information can be found [http://oxpedia.org/wiki/index.php?title=Product_eM_Client_for_AppSuite_FAQ#The_correct_set_up_is_mandatory: here]. Please contact your support if you need any further details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

= Known Limitations =

For known issues please have a look at the [http://oxpedia.org/wiki/index.php?title=Product_eM_Client_for_AppSuite_FAQ#Known_Limitations eM Client for OX App Suite FAQ]

AppSuite:EM Client for OX App Suite

2017-01-30T10:01:05Z

Christian.degen:

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:''' The automatic update via eM Client (client triggered update) will be available only a few days after Open-Xchange released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include their information to that mechanism need to apply a workaround at this point of time. Please contact your support for details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

= Known Limitations =

For known issues please have a look at the [http://oxpedia.org/wiki/index.php?title=Product_eM_Client_for_AppSuite_FAQ#Known_Limitations eM Client for OX App Suite FAQ]

AppSuite:EM Client for OX App Suite

2017-01-30T09:41:06Z

Christian.degen:

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:''' The automatic update via eM Client (client triggered update) will be available only a few days after Open-Xchange released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include their information to that mechanism need to apply a workaround at this point of time. Please contact your support for details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

= Known Issues =

For known issues please have a look at the [http://oxpedia.org/wiki/index.php?title=Product_eM_Client_for_AppSuite_FAQ eM Client for OX App Suite FAQ]

AppSuite:EM Client for OX App Suite

2016-11-24T10:24:04Z

Christian.degen:

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:''' The automatic update via eM Client (client triggered update) will be available only a few days after Open-Xchange released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include their information to that mechanism need to apply a workaround at this point of time. Please contact your support for details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-11-24T10:19:52Z

Christian.degen:

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:''' The automatic update via eM Client (client triggered update) will be available only a few days after Open-Xchange released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include that mechanism need to apply a workaround at this point of time. Please contact your support for details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-11-24T10:18:22Z

Christian.degen:

= eM Client for OX App Suite =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

'''The Essentials for Mail'''
* Advanced email rule management
* Spell-check across the application
* Templates, signatures, tags and categorizations

'''The Essentials for Calendar'''
* Various calendar views
* Share calendars and tasks with other people
* Full text search in appointments and tasks
* Schedule meetings using free / reserved

'''The Essentials for Contacts'''
* Custom contact views
* Unlimited number of data fields
* Categorization and folder support
* Easy merging of contacts
* Communication history

'''The Essentials for Tasks'''
* Create and manage tasks
* Add attachments
* Recurring tasks
* Assign tasks and set status

A more detailed overview of eM Client for OX App Suite features can be found at

http://software.open-xchange.com/products/emclient/doc/Product_Guide_eM_Client_for_App_Suite.pdf

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

In order to evaluate eM Client for OX App Suite please contact Open-Xchange Sales. Your Open-Xchange Sales rep can provide you with pricing information and license keys.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]].

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
https://software.open-xchange.com/products/emclient/stable/emclient/ (The package is available for all customers with a valid Open-Xchange eM Client for OX App Suite license)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

'''Please Note:'''The automatic update via eM Client will be available only a few days after we released a package officially.

== Download and Installation of eM Client for OX App Suite for UCS ==

If you have purchased the Open-Xchange App Suite for UCS, the eM Client for OX App Suite is part of the offering. Installation of the client with the following steps:

* eM Client for OX App Suite is provided via the Client Onboarding Wizard inside the web frontend
* The wizard trigger button is displayed in the setting menu. It is called “Connect your device”. If you click on this menu entry then the Onboarding Wizard will start.
* Inside the Wizard you can choose which app device you want to configure. The Wizard will then display the different mobile, or desktop, systems that are available to the user. For eM Client for OX App Suite, please select Windows.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange App Suite v.7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether a user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for systems which are on a yearly pricing plan, and the “premium” capability should be set for systems on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the [http://knowledgebase.open-xchange.com/fileadmin/user_upload/open-xchange/document/misc/eM_Client_App_Suite_Autodiscovery_Information.pdf information form], fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite. Customers and partners, that don't want to include that mechanism need to apply a workaround at this point of time. Please contact your support for details.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

PA APSv2 IntegrationGuide

2016-06-09T11:40:56Z

Christian.degen:

= OX APS 2.0 package for Odin Service Automation =

'''Attention:'''This APS 2.0 package is only for the Open-Xchange own OX as a Service platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.

The integration of OX as a Service APSv2 package into Parallels Automation consists of the following documentation:

;[[PA_OXaaS_APSv2_Deployment_Guide|Deployment Guide]]: Deployment Guide for the OX as a Service APSv2 package into Parallels Automation
;[[PA_OXaaS_APSv2_Provider_Guide|Provider Guide]]: Provider Guide for the OX as a Service APSv2 package into Parallels Automation
;[[PA_OXaaS_APSv2_User_Guide|User Guide]]: User Guide for the OX as a Service APSv2 package into Parallels Automation

PA OXaaS APSv2 Provider Guide

2016-06-09T11:21:03Z

Christian.degen:

= Provider Guide for the OX as a Service APSv2 package into Odin Service Automation =

This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.

This guide describes the integration of Odin Service Automation with Open-Xchange services. This document was developed by Odin Service Automation. For additional information, please contact support@odin.com.

== Terms and Abbreviations ==

Below is the list of concepts and abbreviations you will find in this page.

{|border="2" rules="all" align="left">
|'''Abbreviation'''
|'''Definition'''
|-
|API
|Application Programming Interface
|-
|APS
|Application Packaging Standard, an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry.
|-
|CSV
|Comma-Separated Values
|-
|CRUD
|Create, Read, Update, Delete
|-
|KB
|KiloByte
|-
|OSA
|Odin Service Automation (former Parallels Automation), which includes both POA and PBA
|-
|OX
|Open-Xchange
|-
|PBA
|Parallels Business Automation
|-
|POA
|Parallels Operations Automation
|-
|SaaS
|Software as Service
|-
|SSO
|Single Sign On
|-
|URL
|Uniform Resource Locator
|-
|}

== Requirements ==

The APS Package v1.1-9 requires POA 5.5 or higher and OX App Suite 7.2.1 or higher.

== Business Model Overview ==

=== About Open-Xchange===
The standard business model of Open-Xchange consists of two major components: a platform fee and a revenue share. With the platform fee the customer pays the basic access to the hosted service or the software and it usually includes a certain amount of basic packages that are ideally distributed to a wide audience of users by bundling them into other products.

=== Open-Xchange Services Provided===

Below is the list of resources provided by Open-Xchange:

{|border="2" rules="all" align="left">
|'''Resource Name'''
|'''Resource Class'''
|'''Limit'''
|'''Auto-Provide'''
|-
|OX Globals
|Application Service Reference
|1
|No
|-
|OX Brand
|Application Service Reference
|1
|No
|-
|OX Profile Webmail
|Application Service Reference
|Unlimited
|No
|-
|OX Profile Basic
|Application Service Reference
|Unlimited
|No
|-
|OX Profile Advanced
|Application Service Reference
|Unlimited
|No
|-
|OX Profile Pro
|Application Service Reference
|Unlimited
|No
|-
|OX Shared Domain*
|Application Service Reference
|Unlimited
|No
|-
|OX Shared Subdomain*
|Application Service Reference
|Unlimited
|No
|-
|Parallels Business Automation
|Application Service Reference
|1
|No
|-
|OX Tenant
|Application Service
|1
|Yes
|-
|OX User
|Application Service
|Unlimited
|No
|-
|OX Email Address
|Application Service
|Unlimited
|No
|-
|OX Domain
|Application Service
|Unlimited
|No
|-
|OX Purchase Request
|Application Service
|Unlimited
|No
|-
|OX Group
|Application Service
|Unlimited
|No
|-
|OX Subdomain
|Application Service
|Unlimited
|No
|-
|OX Resource
|Application Service
|Unlimited
|No
|-
|OX Storage Quota
|Application Counter (KB)
|Unlimited
|No
|-
|}
* You can add as many as necessary.

== Integration Workflow ==

The integration workflow looks as follows:

=== Deployment ===
Please refer to the Deployment Guide for more detailed information. This action is performed once and consists of:
# Deploying Open-Xchange application endpoint.
# Importing Open-Xchange application package.
# Creating service instance in the Provider Control Panel.

=== OSA Integration ===
# Creating the required resource types. For further details, please refer to the Resource Creation section of this guide.
# Creating the service template. For further details, please refer to the Service Template Creation section of this guide.

== Localization List ==

Open-Xchange has been localized in the following languages for each category:
* Customer Interface: English
* OSA task manager error logging: English
* Open-Xchange API error messaging: English

== Technical Overview ==

This section contains an outline of how the integration of Open-Xchange and OSA is performed and the list of Open-Xchange features that are supported within the integration package.

=== General Architecture ===

The following scheme represents the architecture of POA and Open-Xchange integration:

[[Image:OpenXChange_APS2_Prov-guide_v1.0.3_20150717.png]]

==== Components ====

The following table shows the main actions offered by the APS through the different panels of OSA.

{|border="2" rules="all" align="left">
|'''Components'''
|'''Actions'''
|-
|Odin Admin
|
* Import APS package.
* Create an APS instance.
* Manage application settings:
** CRUD tasks to automatize report creation.
** CRUD brands.
** Edit OX App Suite branding settings.
** Download reports.
** CRUD shared domains / subdomains.
** CRUD profiles.
|-
|Odin Customer Manager
|
* Buy subscriptions.
* View resource usage.
* Buy more profiles (in app purchase).
* Create service users.
* Enable / Disable OX App Suite for a service user.
* Add email aliases to an existing user of OX App Suite.
* Change profile of an existing OX App Suite user.
* View mailbox and storage usage per user.
* CRUD user groups.
* CRUD resources.
* CRUD domains / subdomains.
* Configure catch all for existing domains.
* View all users’ purchase requests.
|-
|Odin Service User
|
* View profile features.
* Go to OX App Suite.
|-
|}

== Download ==

=== APS package ===

Download the APS package from the APS catalog: http://dev.apsstandard.org/apps/2.0/Open-Xchange/Open-Xchange/Mamasu/

=== Open-Xchange ===

Please contact Open-Xchange for further download and configuration information via info@open-xchange.com.

== OSA Integration ==

=== Configuring Services for Selling - POA ===

Learn about how to configure the service templates that are necessary to create Open-Xchange APS subscriptions for sale.

==== Instance Configuration ====

===== Minimum Instance Configuration=====
In order to configure the instance, the following minimum steps need to be observed:
# Configure the settings (please refer to the '''APP Settings''' subsection, under the Detailed Configuration section).
# Configure the reseller’s brands (please refer to the '''Brands''' subsection, under the Detailed Configuration section).
# Configure the profiles (please refer to the '''Profiles''' subsection, under the Detailed Configuration section). The type of profiles that needs to be created in a common OX configuration are “Webmail”, “Basic”, “Advanced”, “Pro”. Profiles and profiles’ configuration values of each one need to be provided by OX.

=====Detailed Instance Configuration=====

A description follows on how to configure all the specific settings of this particular instance.

;Accessing the Instance

# In the POA Provider Control Panel, navigate to '''Services>Applications'''.
# Click on the latest version of the '''Open-Xchange''' APS package.
# Go to the '''Instances''' tab.
# Click '''Open-Xchange'''.

;App Settings

On this tab the list of possible scripts that can be configured as background tasks for this Open-Xchange APS2 is displayed. These scripts are used to create the reports.
[[Image:aps2_1.png]]

* You can see the script name, file, next execution, period as well as their status, which can be:

[[Image:aps2_2.png]]: enabled 
[[Image:aps2_3.png]]: pending

* In order to create a cron, click '''Create'''. As soon as it is ready the status will change to “Enabled”, then it can also be Disabled, Edited or Deleted.
* This tab also shows the last 10 cron executions to check their current status.
[[Image:aps2_4.png]]

* The status of the executions can be:
[[Image:aps2_2.png]]: the execution was successful. 
[[Image:aps2_5.png]]: the execution is in process. 
[[Image:aps2_6.png]]: an error has occurred during the execution.

;Brands

This tab is used to assign each Open-Xchange reseller with a brand. To do so:
# Click on '''Add new brand'''.
# Fill in the required fields:
#* Name: name of the brand.
#* Username: username of the brand. It has to be provided by OX.
#* Password: password or the brand. It has to be provided by OX.
#* API URL: URL where the API is located. It has to be provided by OX.
#* SSO URL: URL of the Single Sign On. It has to be provided by OX.
#* APP Suite Login Page: login page of the APP Suite. It has to be provided by
OX.
#* Label of service name: name that will be displayed on all buttons and tabs and refers to the service. It could be “App Suite”, but if the provider has his own service name, which is used for his brand, it can also be defined here.
#* Select “Purchase request enabled” and “Catch all enabled for customers”, if appropriate. If the first option is enabled users are allowed to request customers some extra resources or services. The second one is to enable or disable the use of a catch all email in customers’ domains.
# Click on '''Create''' to add the brand.
# Once the brand has been created, you can view or edit the settings, branding and list of domains and subdomains. [[Image:aps2_7.png]]
# By clicking on '''View''', you can:
#* See and edit the settings previously defined. You can also download the “Last contexts report” or the “Last users report” in CSV format. [[Image:aps2_8.png]]
#* See the brand’s settings:
#** Application URL.
#** Global settings: these settings affect all instances of the application.
#** Global application settings: MX Target 1, MX Target 2, MX Target 3, MX Target 4, Domain prefix, Domain name.
#** Various theme settings that can be defined per brand: frame color, icon color, selection color, logo width, logo URL. [[Image:Aps2_8a.png]]
#Set the branding settings, all of them are optionnal:
#*Application URL: Passed to the OX API. It accepts 4 differents type of application URL. Type and value has to be provided by OX.
#*URL path of brand website: The value corresponds to the suffix: ''oxaasbrand.org/{value}''
#*Subdomain of brand domain: The value corresponds to the subdomain: ''{value}.oxaasbrand.org''
#*Custom URL: The value corresponds to the full domain of the application URL
#*None: No application URL used
#*MX target 1: Not mandatory. It has to be provided by OX.
#*MX target 2: Not mandatory. It has to be provided by OX.
#*MX target 3: Not mandatory. It has to be provided by OX.
#*MX target 4: Not mandatory. It has to be provided by OX.
#*Domain prefix: Not mandatory. It has to be provided by OX.
#*Domain name: Not mandatory. It has to be provided by OX.
#*Frame Color: Frame color of the embedded OX interface.
#*Icon Color: Icon color of the embedded OX interface.
#*Selection Color: Selection color of the embedded OX interface.
#*Logo width: width of the embedded OX interface.
#*Logo URL: URL of the logo of the embedded OX interface.
#* Add, edit or delete the reseller’s shared domains and subdomains: [[Image:aps2_9.png]]
#** Click on '''Add new domain''' or '''Add new subdomain''' to specify the domain name and login (login of an existing user in the current Open-Xchange reseller). Domain name is mandatory, login is optional. If an error occurs, it will be displayed on the interface as an alert. Then click on '''Save''': [[Image:aps2_10.png]]
#** You can also edit an existing domain or subdomain by clicking on '''Edit'''. [[Image:aps2_11.png]]

;Profiles

On this tab you can add, edit and delete a profile.
[[Image:aps2_12.png]]

Click on '''Add new profile''' and specify the following features, then click on '''Save'''.
[[Image:aps2_13.png]]

* Name: profile name.
* Feature level: select the level from the drop-down list.
* Mail quota: mail quota provided (defined in KB).
* Disk quota: disk quota provided (defined in KB).
* Feature level defines a preset of add-ons, but two additional add-ons can be enabled apart from the predefined list. These are:
** Documents.
** Guard.

==== Resource Creation====

# In the POA Provider Control Panel, navigate '''Services>Applications'''.
# Click '''Open-Xchange''' in the APS Packages tab.
# Go to the '''Resource Types''' tab.

===== Application Service Reference=====

;Creating a Globals Resource
# Click on Create, then on Application Service Reference.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Globals.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish. [[Image:aps2_14.png]]
# Click Next, then select Open-Xchange Application as the APS type. [[Image:aps2_15.png]]
# Click on the instance. [[Image:aps2_16.png]]
# Click '''Finish'''. The resource has been created.

;Creating a Brand Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Brand.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Brand''' as the APS type and then click on the instance.
# Click '''Finish'''. The resource has been created.

;Creating a Profile Basic Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Basic.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Profile''' as the APS type and click on the instance.
# Click '''Finish'''. The resource has been created.

;Creating a Profile Webmail Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Webmail.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Profile''' as the APS type and then click on the instance.
# Click '''Finish'''. The resource has been created.

;Creating a Profile Advanced Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Advanced.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Profile''' as the APS type and then click on the instance.
# Click '''Finish'''. The resource has been created.

;Creating a Profile Pro Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Pro.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Profile''' as the APS type and then click on the instance.
# Click '''Finish''' The resource has been created.

;Creating a Shared Domain Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Shared Domain.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Shared Domain''' as the APS type and then click on the instance.
# Click '''Finish'''. The resource has been created.
'''NOTE: Please remember that you can add as many Shared Domain resources as necessary.'''

;Creating a Shared Subdomain Resource
# Click on '''Create''', then on '''Application Service Reference'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Shared Subdomain.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', select '''Open-Xchange Shared Subdomain''' as the APS type and then click on the instance.
# Click '''Finish'''. The resource has been created.
'''NOTE: Please remember that you can add as many Shared Subdomain resources as necessary.'''

===== Application Service =====

;Creating a Tenant Resource

# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#*Name: enter the name of the application and the type of resource. In this case, Open-Xchange Tenant.
#*Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish. [[Image:aps2_17.png]]
# Click '''Next''', then select '''Open-Xchange Tenant''' as the APS type. [[Image:aps2_15.png]]
# Tick the “Automatically provision service” checkbox and leave the Priority field blank [[Image:aps2_19.png]]
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a User Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange User.
# *Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select''' Open-Xchange User''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating an Email Address Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Email Address.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Email Address''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a Domain Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Domain.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Domain''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a Purchase Request Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Purchase Request.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Purchase Request''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a Group Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Group.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Group''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a Subdomain Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Subdomain.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Subdomain''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

;Creating a Resource Resource
# Click on '''Create''', then on '''Application Service'''.
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Resource Resource.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Open-Xchange Resource''' as the APS type.
# Leave the “Automatically provision service” box unchecked and the Priority field blank.
# Click '''Next''', then '''Finish'''. The resource has been added.

===== Application Counter =====

;Creating a Storage Quota Resource
# Click on '''Create''', then on '''Application Counter''' (KB).
# Fill in the following fields:
#* Name: enter the name of the application and the type of resource. In this case, Open-Xchange Storage Quota.
#* Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
# Click '''Next''', then select '''Tenant Storage Quota''' as the APS type.
# Click '''Finish'''. The resource has been added.

'''Please ensure that BPA upsell APS has been created (see Deployment Guide, section “Prerequisites for the endpoint” for further details).'''

==== Service Template Creation====

# In the POA Provider Control Panel, navigate '''Products>Service Templates'''.
# Click on the '''Add New Service Template''' button. [[Image:aps2_20.png]]
# Configure the service template’s general parameters:
#* Name: enter the name, for example: Open-Xchange.
#* Description: this field is used to describe the template. Leave it blank or enter the information you wish.
#* Tick the “Autoprovisioning” checkbox.
#* Type: set the type as “Custom”. [[Image:aps2_21.png]]
# Click '''Next'''. The template has been created.
# Select all the resources created earlier as well as Odin Business Automation, then click '''Next'''.
# Set the limits for the resource types included in the service template.
#* For Globals, Brand, Tenant and Odin Business Automation uncheck the Unlimited checkbox and set the limit as 1.
#* For the rest of resources, leave the Unlimited checkbox marked.
# Click '''Next''', then '''Finish'''
# To activate the service template:
# Open the newly created service template (Open-Xchange).
# In the '''General''' tab, click on '''Activate'''. [[Image:aps2_22.png]]

PA OXaaS APSv2 User Guide

2016-06-09T11:20:14Z

Christian.degen:

= User Guide for the OX as a Service APSv2 package into Odin Service Automation =

This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.

This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide describes all the tasks administrators can carry out from the Customer Control Panel.

This guide is intended for administrators who intend to manage the services provided by Open-Xchange.

== Terms and Abbreviations ==

Below is the list of concepts and abbreviations you will find in this page.

{|border="2" rules="all" align="left">
|'''Abbreviation'''
|'''Definition'''
|-
|API
|Application Programming Interface
|-
|APS
|Application Packaging Standard, an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry.
|-
|CCP
|Customer Control Panel
|-
|OSA
|Odin Service Automation, which includes both POA and PBA.
|-
|OBA
|Odin Business Automation.
|-
|POA
|Parallels Operations Automation.
|-
|SaaS
|Software as a Service.
|-
|}

== Customer Control Panel ==

In the Customer Control Panel (CCP) you can manage all the Open-Xchange settings.

=== User’s Tab ===

From this tab you can add, manage and delete service users registered within the current subscription.

# To add a user click on Add New Service User. [[Image:aps2_u1.png]]
# Fill in all the fields and click on '''Next'''.
#* User photo: you can upload a photo to add to your profile.
#* Display name: enter the display name you wish to have.
#* Login: choose a login name and select your domain from the dropdown list.
#* Password: choose your password. (You may also click '''Generate Password''' to create one automatically and you will see it under the Password field).
#* Confirm password: reenter your password.
#* Tick the Open-Xchange service checkbox. [[Image:aps2_u2.png]]
# A summary of the user information will appear. Click '''Finish''' for confirmation. [[Image:aps2_u3.png]]
# You can then see that the status of the user will be [[Image:aps2_u4.png]] [[Image:aps2_u5.png]]

=== OX Service Tab ===
From the Open-Xchange tab you can purchase requests and manage users, groups, resources, domains and purchase requests.

==== Users ====
On this tab you can add new users, manage profiles and edit, enable and disable them.

By default you will see the Active view, where you can see each user’s status. There are three different possibilities: [[Image:aps2_u6.png]] [[Image:aps2_u7.png]] [[Image:aps2_u8.png]] 
[[Image:aps2_u9.png]]

You may also wish to see the Classic view by clicking [[Image:aps2_u10.png]] and selecting “Classic list”: [[Image:aps2_u11.png]]. From here you will be able to see the same information and perform the same actions that are allowed in the Active view mode.

===== Add New User =====
To add a new user:
# Click '''Add New User'''.
# Fill in the following fields: [[Image:aps2_u12.png]]
# Click '''Next'''.
# The status will appear as [[Image:aps2_u13.png]]. If an error occurs during creation, the status will be [[Image:aps2_u14.png]].

===== Manage Profiles =====
To manage profiles, follow these steps:
# Select the user whose profile you want to manage and then click '''Manage Profiles'''. [[Image:aps2_u15.png]]
# Select the new profile you want to assign to a user from the drop-down list. [[Image:aps2_u16.png]]
# Click OK to save the changes.

===== Edit =====
# Select the user whose profile you want to edit and then click '''Edit'''. [[Image:aps2_u17.png]]
# Enter the alias and select the appropriate domain from the drop-down list. [[Image:aps2_u18.png]]
# Click '''Save'''.

===== Enable =====
To populate the service user information to Open-Xchange:
# Select the user whose profile you want to enable and then click '''Enable OX App Suite2'''. [[Image:aps2_u19.png]]
# Enter the email and choose the domain, then select the profile you want to assign to the user. You can also add one or more aliases to the user by clicking on '''Additional Settings'''. [[Image:aps2_u20.png]]
# Click '''Next''' to save the changes. The user’s status will now be Enabled.

===== Disable =====
To delete an Open-Xchange user:
# Select the user whose profile you want to disable by ticking the appropriate box, then click '''Disable'''. [[Image:aps2_u21.png]]
# A message will ask you to confirm that you want to disable the user. Click '''Accept''' for confirmation.

==== Groups ====
On this tab you can create, delete and edit groups of users. [[Image:aps2_u22.png]]

===== Add new group =====
To add a new group:
# Click on the Add new group button. [[Image:aps2_u23.png]]
# Enter a name for the group.
# Select the users that you want to add to the group and click [[Image:aps2_u24.png]] to add them. Then click '''Save'''.
# You will then see the group you have created and the users that belong to it. [[Image:aps2_u25.png]]

===== Delete group =====
In order to delete a group, select it by ticking the appropriate box and then click '''Delete selected groups'''. [[Image:aps2_u26.png]]

===== Edit group =====
You can also edit the name of the group or add/remove members. To do that, click on the group’s name. You will then see the group’s details and you can edit its name and add or remove users by selecting them and clicking [[Image:aps2_u27.png]] or [[Image:aps2_u28.png]] accordingly. [[Image:aps2_u29.png]]

==== Resources ====
On this tab you can add, delete and edit any resources you may need.

===== Add resource =====
To add a resource:
# Click on Add new resource.
# Enter the resource’s details:
#* Resource name: name that you want to call the resource.
#* Resource manager: select the person that will manage the resource from the drop-down list.
#* Display name: resource name that will be displayed.
#* Description: description of the resource. This field is not mandatory.
#* Resource email: enter the email and choose the domain from the drop-down list. [[Image:aps2_u30.png]]
# Click '''Save resource'''.

===== Delete resource =====
In order to delete a resource, select it by ticking the appropriate box and then click '''Delete resources'''. [[Image:aps2_u31.png]]

===== Edit resource =====
You can also edit resources to change their details. In order to do so, click on the resource’s display name. All the details will be shown so that you can change any information. Click '''Save resource''' to save the details. [[Image:aps2_u32.png]]

==== Domains ====
On this tab you can add and delete domains and subdomains.

===== Add domain =====
To add a domain:
# Click on Add domain.
# Select the catch all address from the dropdown list to avoid losing email due to misspellings. [[Image:aps_domain.jpg]]
# Click Save.

===== Add subdomain =====
# Click on '''Add subdomain'''.
# Enter the following details:
#* Subdomain: enter the subdomain’s name and select the domain from the dropdown list.
#* Catch all: select, if appropriate, the catch-all email address from the drop-down list. [[Image:aps2_u33.png]]
# Click '''Save'''.

===== Remove domains =====
To remove a domain, you just have to tick the appropriate one from the list of existing domains and click on '''Remove domains'''. [[Image:aps2_u34.png]]

===== Edit domains =====
To edit a domain, click on the pencil button under the Actions column. The details will be displayed for you to change, if necessary. Then click '''Save''' to save the changes. [[Image:aps2_u35.png]]

===== Purchase Requests =====
The purchase requests tab shows all purchases that users have requested. These are made from the OX App Suite application as an upgrade request. After that, they will be listed on this tab and from here the customer will be able to proceed with the profile upgrade or cancel it using the “Proceed” or “Reject” buttons, accordingly. 
[[Image:aps2_purchase_request.jpg]]

PA OXaaS APSv2 Deployment Guide

2016-06-09T11:17:16Z

Christian.degen:

= Deployment Guide for the OX as a Service APSv2 package into Odin Service Automation =

This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.

This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide is intended for providers that use Odin Service Automation and want to sell Open-Xchange services to customers.

== Terms and Abbreviations ==

Below is the list of concepts and abbreviations you will find in this page.

{|border="2" rules="all" align="left">
|'''Abbreviation'''
|'''Definition'''
|-
|API
|Application Programming Interface
|-
|APS
|Application Packaging Standard, an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry.
|-
|HTTP
|Hypertext Transfer Protocol
|-
|OSA
|Odin Service Automation (former Parallels Automation), which includes both POA and PBA
|-
|PBA
|Parallels Business Automation.
|-
|POA
|Parallels Operations Automation.
|-
|SaaS
|Software as a Service.
|-
|SSO
|Single Sign-On.
|-
|URI
|Uniform Resource Identifier
|-
|URL
|Uniform Resource Locator
|-
|VM
|Virtual Machine
|-
|VPS
|Virtual Private Server
|-
|}

== Conventions ==

Below is the list of conventions you will find in this page.

{|border="2" rules="all" align="left">
|'''Abbreviation'''
|'''Definition'''
|-
|Open-Xchange-xxxx.app.zip Package
|Open-Xchange is the name of the package and xx-xx is the placeholder for a specific version of the APS
|-
|Foldername
|Name of the folder where a specific file is located. In this case, “open-xchange”
|-
|https://endpoint-ip-or-dns
|IP or URL of the environment
|-
|}

== Business Model Overview ==

=== About Open-Xchange===
The standard business model of Open-Xchange consists of two major components: a platform fee and a revenue share. With the platform fee the customer pays the basic access to the hosted service or the software and it usually includes a certain amount of basic packages that are ideally distributed to a wide audience of users by bundling them into other products.

== Technical Overview ==

This section contains an outline of how the integration of Open-Xchange and PA is performed and the list of Open-Xchange features that are supported within the integration package.

=== Supported Architecture and Requirements ===

==== The Principle of OSA & APS 2 ====

The usual way that users use Odin, in order to get OX App Suite, is as follows:

# Open-Xchange published an APS 2 package into the Odin catalogue/ecosystem.
# Odin customers, and service resellers, see the package and want to resell OX App Suite.
# The service resellers downloads the APS 2 package and installs it into their OSA system
# The OSA system will ask for the location of a running and compliant OX App Suite System (This can be OXaaS or a compliant in-house OX App Suite System)
# The reseller can then sell OX App Suite accounts.

==== Compliant OX App Suite System ====

There are two options to connect an OX App Suite system:
# Use the OXaaS service that is provided by Open-Xchange
# Use an on-premise installation that includes a complete OX App Suite system, a Dovecot mail system and all the related services.

Use the standard recommend components together with provided configurations for:
* Apache
* Mysql
* Openldap (with a dedicated Open-Xchange schema)
* HAproxy
* Postfix
* S3 compatible Objectstore (as a file/email backend)

Please refer to following high level architecture diagram and if you have any questions please contact sales@open-xchange.com

[[Image:Odin_Architecture.png]]

== Download ==

=== APS package ===

Download the APS package from the APS catalog: http://dev.apsstandard.org/apps/2.0/Open-Xchange/Open-Xchange/Mamasu/

=== Open-Xchange ===

Please contact Open-Xchange for further download and configuration information via info@open-xchange.com.

== Integration Prerequisites ==

Before you start integrating Open-Xchange into OSA, learn about the necessary preparations for the process.

=== Prerequisites for the OSA Platform ===

The APS Package requires POA v6.0.4 or higher and OX App Suite 7.8.0 or higher.

PBA upsell APS must be enabled (to install it, follow this link: https://doc.apsstandard.org/2.1/pa/upsell/deploy/)

=== Prerequisites for the Endpoint ===

{|border="2" rules="all" align="left">
|'''Prerequisites'''
|'''Notification code server'''
|-
|Description
|Specific node with Apache and PHP used to install the system script.
|-
|Software
|
* Apache >= 2.2.15 with mod_ssl
* PHP >= 5.3.3
* aps_php_runtime >= 2.1-292
|-
|}

=== Preparing the Endpoint Host Server ===

Open-Xchange APS Package requires an application host server to be set up before it can be successfully imported and used in OSA. This endpoint server can be provisioned as a VPS or a VM in the same infrastructure as OSA systems. Please make sure you have OSA (POA + PBA) infrastructure set up properly before continuing. The Provider’s guide for setting up OSA can be found at http://download.pa.parallels.com/pa/6.0/doc/.

You can either choose the automated endpoint deployment by using the endpoint.sh script file or use the manual installation process by continuing reading this chapter. For more information about automated endpoint deployment, please refer to https://doc.apsstandard.org/2.1/pa/deployment/#automated-setup-based-onendpoint-sh for instructions on how to download and use the script endpoint.sh.

Please verify if the endpoint is compliant with the above-mentioned prerequisites.

These deployment instructions are based on the fresh installation of CentOS 6. All required packages are installed and managed by its yum package manager.

Before carrying out the steps described below, you must have:
* Server path
* Credentials: ID and password

# Install PHP interpreter via yum install PHP and Apache HTTP server via yum install httpd if your Linux distribution does not include them. Please check your installed version of PHP via:
#:[root@endpoint ~]# php -version
#:And ensure your Apache HTTP server is up and running:
#:[root@endpoint ~]# service httpd status
#:The answer should be:
#:httpd (pid 5749) is running...
#:The default document root directory for Apache HTTP Server is located at ''/var/www/html/''.
# The application host server requires the APS PHP Runtime library. Check if you have installed the appropriate version by using the following command:
#:[root@endpoint~]# rpm –qa | grep aps
#:Otherwise, it can be downloaded from ''http://doc.apsstandard.org/tools/php_lib/''.
#:If you need to copy files from different servers, we recommend using an FTP client.
#:If you have an older version installed, execute the command below:
#:[root@endpoint~]# rpm -Uvh aps-php-runtime-{version}.noarch.rpm
#:If you do not have PHP runtime installed on your server, do the following:
#:[root@endpoint~]# rpm -ivh aps-php-runtime-{version}.noarch.rpm
#:Where ''aps-php-runtime-{version}.noarch.rpm'' is the name of the PHP runtime library, and {version} is the version number you download from the above link. After the installation, the ''/usr/share/aps/php'' directory will be added to the system ''php.ini'' file automatically.
#Create a new folder under ''/root/''
#:[root@endpoint~]# mkdir /root/Open-Xchange-[x.x-x]
#Upload the APS package zip file on your application endpoint. This guide assumes you place it under ''/root/Open-Xchange-[x.x-x]/Open-Xchange-[x.x-x].app.zip''. If you need to copy files from different servers, we recommend using an FTP client.
#Move to folder /root/Open-Xchange-[x.x-x]
#:[root@endpoint~]# cd /root/Open-Xchange-[x.x-x]
#Unzip the uploaded zip Open-Xchange-[x.x-x].app.zip
#:[root@endpoint~]# unzip Open-Xchange-[x.x-x].app.zip
#Copy the “scripts” folder to the folder where Apache is set up as Virtual Host:
#:[root@endpoint~]# cp -R /root/Open-Xchange -[x.x-x]/scripts/
#:/var/www/html/foldername
#Access ''/var/www/html/foldername''.
#Ensure that the end-point is correctly deployed.
#:*Verify that the directory root exists and contains all project scripts.
#:ll -aR /var/www/html/foldername
#:*Verify that the .htaccess contains rewrite rules for all the application services
#:cat /var/www/html/foldername/.htaccess
#The .htaccess file must be like:
#:Options +FollowSymLinks +ExecCGI
#:<IfModule mod_rewrite.c>
#:RewriteEngine On
#:RewriteBase /openxchange
#:RewriteCond %{REQUEST_FILENAME} !-f
#:RewriteCond %{REQUEST_URI} !=/favicon.ico
#:RewriteRule ^brand(|/.*)$ brand.php?q=$1 [L,QSA]
#:RewriteRule ^domain(|/.*)$ domain.php?q=$1 [L,QSA]
#:RewriteRule ^emailaddress(|/.*)$ emailaddress.php?q=$1
#:[L,QSA]
#:RewriteRule ^globals(|/.*)$ globals.php?q=$1 [L,QSA]
#:RewriteRule ^group(|/.*)$ group.php?q=$1 [L,QSA]
#:RewriteRule ^profile(|/.*)$ profile.php?q=$1 [L,QSA]
#:RewriteRule ^purchaserequest(|/.*)$ purchaserequest.php?q=$1
#:[L,QSA]
#:RewriteRule ^resource(|/.*)$ resource.php?q=$1 [L,QSA]
#:RewriteRule ^subdomain(|/.*)$ subdomain.php?q=$1 [L,QSA]
#:RewriteRule ^shareddomain(|/.*)$ shareddomain.php?q=$1
#:[L,QSA]
#:RewriteRule ^sharedsubdomain(|/.*)$ sharedsubdomain.php?q=$1
#:[L,QSA]
#:RewriteRule ^tenant(|/.*)$ tenant.php?q=$1 [L,QSA]
#:RewriteRule ^user(|/.*)$ user.php?q=$1 [L,QSA]
#:RewriteRule ^cron(|/.*)$ cron.php?q=$1 [L,QSA]
#:RewriteRule ^crontask(|/.*)$ crontask.php?q=$1 [L,QSA]
#:RewriteRule ^api/createrequest(|/.*)?$
#:api.php?call=createrequest [L,QSA]
#:RewriteRule ^api/getupsellresources/([a-zA-Z0-9/@/.]+)?$
#:api.php?call=getupsellresources&login=$1 [L,QSA]
#:</IfModule>
#Set the user to Apache:
#:chown -R apache:apache /var/www/html/foldername
#Set the rights to read/write/execute:
#:chmod -R a+w /var/www/html/foldername
#Check that the end-point has been installed successfully by visiting the endpoint’s URL in your browser: ''https://endpoint-ip-ordns/foldername/globals.''
#:If you get the following error, the endpoint has been deployed successfully and the process finishes here.
#:{ "code": 500, "type": "Exception", "message": "APS-Instance-Id header not set." }
#:If you get the following one, please see the instructions below.
#:{
#:"code": 404,
#:"type": "RuntimeException",
#:"message": "Not Found: No appropriate method found for url…"
#:}
#:Set the AllowOverride All option for the folder that will be the parent of application endpoints. It is usually var/www/html in Apache. For example, in the /etc/httpd/conf/httpd.conf file, find the <Directory “var/www/html”> section and edit the following line.
#:AllowOverride All
#Restart the Apache service with the following command: service httpd
#:restart.

=== Creating the crontab task in the Endpoint Host Server===
This APS needs that a crontab task in order to execute periodical tasks. This steps has to be done in automatic and manual deployment.

*Set the crontab in order to execute periodical tasks
*Open the crontab

[root@endpoint~]# crontab -e

*Set the crontab and save

*/30 * * * * cd /var/www/html/foldername; /usr/bin/php cronjob.php

== Deploying the Open-Xchange APS Package==

To deploy the Open-Xchange APS package on the provisioning host, you need to prepare the host and then import your Open-Xchange APS package in OSA. Find information about how to do it in this chapter.

=== Importing Open-Xchange Application ===

To import the Open-Xchange application to POA:

#Log in as a service provider administrator.
#In the POA Control Panel, navigate to Services>Applications.
# Click Import Package, in the APS Packages tab. [[Image:aps_package_import.jpg]]
#Upload the package zip file from your local workstation to the POA environment. Select local file and browse for the correct application file. In this case Open-Xchange-[x.x-x].app.zip.
#Click on Submit to upload the file.
#Click the Refresh icon, in the upper right corner, to check that the package has been uploaded.
#The package will successfully uploaded once you see the icon next to the package name. [[Image:aps_ox_package_available.jpg]]
#Click on Open-Xchange to create a new instance.
#Go to the Instances tab.
#Click Install.
#Type the Application API end-point URI: ''https://endpoint-ip-ordns/foldername''
#Click Finish, to confirm the creation of a new instance.

AppSuite:EM Client for OX App Suite

2016-06-02T13:23:57Z

Christian.degen: /* Comparison eM Client for OX App Suite and eM Client */

{{Stability-experimental}}

= eM Client for OX App Suite (soon to be released) =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

eM Client for App Suite provides all the essentials for today’s email:
* Secure communication (SSL and TLS)
* Advanced email rules management
* Spelling check across the entire application
* Templates, signatures, tagging, and categorization

The following essential calendar features are provided, among others:
* Various calendar views
* Sharing of calendars and tasks
* Full-text search covering all events and tasks
* Meeting scheduling that uses “Free”/”Busy” indicators

The following key features are provided for handling contacts:
* Custom contact views
* A full range of data fields
* Support for categorization and folders
* Easy merging of contacts
* Maintaining a communication history

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. On-boarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

Please contact Open-Xchange Sales for further information and pricing details.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]] (Link will be valid with official launch).

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
http://software.open-xchange.com/products/emclient_appsuite/stable/ (Will be valid with official launch)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange Server v. 7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether the user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for users who are on a yearly pricing plan, and the “premium” capability should be set for users who are on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the information form (will be available with official launch), fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-06-02T13:23:31Z

Christian.degen: /* Comparison eM Client for OX App Suite and eM Client */

{{Stability-experimental}}

= eM Client for OX App Suite (soon to be released) =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

eM Client for App Suite provides all the essentials for today’s email:
* Secure communication (SSL and TLS)
* Advanced email rules management
* Spelling check across the entire application
* Templates, signatures, tagging, and categorization

The following essential calendar features are provided, among others:
* Various calendar views
* Sharing of calendars and tasks
* Full-text search covering all events and tasks
* Meeting scheduling that uses “Free”/”Busy” indicators

The following key features are provided for handling contacts:
* Custom contact views
* A full range of data fields
* Support for categorization and folders
* Easy merging of contacts
* Maintaining a communication history

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider (e.g. Onboarding Wizzard)
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

Please contact Open-Xchange Sales for further information and pricing details.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]] (Link will be valid with official launch).

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
http://software.open-xchange.com/products/emclient_appsuite/stable/ (Will be valid with official launch)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange Server v. 7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether the user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for users who are on a yearly pricing plan, and the “premium” capability should be set for users who are on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the information form (will be available with official launch), fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our [http://oxpedia.org/wiki/index.php?title=AppSuite:Client_Onboarding App On-boarding Wizard]. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-06-02T09:06:57Z

Christian.degen: /* The On-boarding Wizard and updates */

{{Stability-experimental}}

= eM Client for OX App Suite (soon to be released) =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

eM Client for App Suite provides all the essentials for today’s email:
* Secure communication (SSL and TLS)
* Advanced email rules management
* Spelling check across the entire application
* Templates, signatures, tagging, and categorization

The following essential calendar features are provided, among others:
* Various calendar views
* Sharing of calendars and tasks
* Full-text search covering all events and tasks
* Meeting scheduling that uses “Free”/”Busy” indicators

The following key features are provided for handling contacts:
* Custom contact views
* A full range of data fields
* Support for categorization and folders
* Easy merging of contacts
* Maintaining a communication history

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider store
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

Please contact Open-Xchange Sales for further information and pricing details.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]] (Link will be valid with official launch).

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
http://software.open-xchange.com/products/emclient_appsuite/stable/ (Will be valid with official launch)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange Server v. 7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether the user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for users who are on a yearly pricing plan, and the “premium” capability should be set for users who are on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the information form (will be available with official launch), fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our App On-boarding Wizard. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.

You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url".
This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-06-02T09:05:21Z

Christian.degen: /* Comparison eM Client for App Suite and eM Client */

{{Stability-experimental}}

= eM Client for OX App Suite (soon to be released) =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

eM Client for App Suite provides all the essentials for today’s email:
* Secure communication (SSL and TLS)
* Advanced email rules management
* Spelling check across the entire application
* Templates, signatures, tagging, and categorization

The following essential calendar features are provided, among others:
* Various calendar views
* Sharing of calendars and tasks
* Full-text search covering all events and tasks
* Meeting scheduling that uses “Free”/”Busy” indicators

The following key features are provided for handling contacts:
* Custom contact views
* A full range of data fields
* Support for categorization and folders
* Easy merging of contacts
* Maintaining a communication history

== Comparison eM Client for OX App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider store
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

Please contact Open-Xchange Sales for further information and pricing details.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]] (Link will be valid with official launch).

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
http://software.open-xchange.com/products/emclient_appsuite/stable/ (Will be valid with official launch)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange Server v. 7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether the user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for users who are on a yearly pricing plan, and the “premium” capability should be set for users who are on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the information form (will be available with official launch), fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our App On-boarding Wizard. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.
You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url". This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.

AppSuite:EM Client for OX App Suite

2016-06-02T09:04:55Z

Christian.degen:

{{Stability-experimental}}

= eM Client for OX App Suite (soon to be released) =

Open-Xchange’s eM Client for OX App Suite is a full-featured email client with a modern and easy-to-use interface for Windows users. In addition to user-friendly email functionality, this application offers several integrated features: a calendar, tasks, contacts, and even chat. Additionally, eM Client for OX App Suite can be used offline with full OX App Suite synchronization. This new product uses open and proven industry-standard protocols such as IMAP, SMTP, and CardDAV/CalDAV for safe and hassle-free connection to OX App Suite.

The application stores data locally on the client machine. This guarantees that end users can access their data even when offline. Any changes made in offline mode are automatically synchronized: when the user is online again, they are sent back to the OX App Suite server.

eM Client for OX App Suite supports the latest versions of Windows and is compatible with all available versions of eM Client.

== Key features ==

eM Client for App Suite provides all the essentials for today’s email:
* Secure communication (SSL and TLS)
* Advanced email rules management
* Spelling check across the entire application
* Templates, signatures, tagging, and categorization

The following essential calendar features are provided, among others:
* Various calendar views
* Sharing of calendars and tasks
* Full-text search covering all events and tasks
* Meeting scheduling that uses “Free”/”Busy” indicators

The following key features are provided for handling contacts:
* Custom contact views
* A full range of data fields
* Support for categorization and folders
* Easy merging of contacts
* Maintaining a communication history

== Comparison eM Client for App Suite and eM Client ==

{|border="2" rules="all" align="left">
|
|'''eM Client for OX App Suite'''
|'''eM Client'''
|-
|'''Availability'''
|Available via provider store
|Obtained from eM Client directly
|-
|'''License check'''
|Capability of being set on OX server – no handling of license keys required
|Use of a license server from eM Client – need for a license key at the user site
|-
|'''Branding'''
|Either the OX brand or, for a fee, provider branding
|eM Client brand
|-
|'''Margin'''
|Additional revenue potential with the usual revenue-sharing
|Need for an additional reseller agreement
|-
|'''Support'''
|Full support for OX App Suite
|no support from Open-Xchange
|}

== Pricing and availability ==

Please contact Open-Xchange Sales for further information and pricing details.

== System requirements ==

The requirements are listed at [[AppSuite:OX_System_Requirements#eM_Client_for_OX_App_Suite | eM Client for OX App Suite and Platform Requirements]] (Link will be valid with official launch).

= Download and installation of eM Client for OX App Suite =

Installation packages for eM Client for OX App Suite are available for download at the following URL:
http://software.open-xchange.com/products/emclient_appsuite/stable/ (Will be valid with official launch)

After download is complete, you can start the installation by double clicking on the package. The first screen presents information about the eM Client for OX App Suite product. Then, the wizard guides you in the steps for installation. Please be sure to read the license agreement with Open-Xchange carefully.

= Server-side configuration =

This section describes what needs to be configured on the OX App Suite server back end in order to support use of eM Client for OX App Suite.

== Prerequisites ==

Use requires Open-Xchange Server v. 7.8.1 or above (“open xchange core”).

== Configuration ==

As many other clients are, the original eM Client is able to connect to OX App Suite without any additional server-side configuration, if you allow access to IMAP, SMTP, CardDAV, and CalDAV. For that reason, eM Client for OX App Suite requires only a little configuration work at the back end. Besides using the standard protocols listed above, you need to use a “user capability” setting (described below) and must decide whether to offer the product via the On-boarding Wizard.

== Enabling eM Client for OX App Suite for users ==

To eliminate the need for any handling of license keys on the user side, we have decided to use a “capability” setting and thereby check whether the user is entitled to access the client. To enable a user for eM Client for OX App Suite, you must have set either the capability

com.openexchange.capability.emclient_basic

or

com.openexchange.capability.emclient_premium

The “basic” capability needs to be set for users who are on a yearly pricing plan, and the “premium” capability should be set for users who are on one of the monthly plans.

More details about capabilities can be found on the “App Suite: Capabilities” page, at http://oxpedia.org/wiki/index.php?title=AppSuite:Capabilities. Furthermore, these capabilities can be used in the Config Cascade. For information, please see http://oxpedia.org/wiki/index.php?title=ConfigCascade.

= Autodiscovery for partners and customers =

End users don’t want to bother with server settings or port numbers. For that reason, the on-boarding experience has to be made as smooth and trouble-free as possible for them. To enable the best possible user experience with eM Client for OX App Suite, Open-Xchange requires some additional information. This information will allow us to provide a seamless setup of eM Client for App Suite for your users.

Please download the information form (will be available with official launch), fill out the parts marked in the XML snippet, and send the completed form to emclient@open-xchange.com.

Your information will then be included in the next update of eM Client for OX App Suite.

= The On-boarding Wizard and updates =

We recommend making eM Client for OX App Suite available to end users via our App On-boarding Wizard. For this, you must install and configure the wizard for eM Client for OX App Suite users.

To make the app download available via the On-boarding Wizard, you need to enable the corresponding scenario. Open the file <code>/opt/open xchange/etc/client-onboarding-scenarios.yml</code> for editing. In the <code>emclientinstall</code> section, you have to set the value for the “enabled” property to “true”; then, save the file.
You have to specify the download URL of the client at /opt/open-xchange/etc/client-onboarding-emclient.properties by changing the value for "com.openexchange.client.onboarding.emclient.url". This property available via the ConfigCascade and for that reason can have different values for different contexts/users.

After installation, eM Client for OX App Suite will automatically check for the latest updates on the central server (or the corresponding branded update server).

= A custom branded version =

eM Client for OX App Suite can be purchased with custom branding. This will also include the software for a custom update server.

With a custom branded version, you can choose your own name for the product (please remember that we will not perform any trademark checks). In addition to the name, you can change the logo shown in all parts of the product, from the installation process to the desktop icon.

== The branding/customization process ==

For customization, you need to provide specific information such as the following:

* Confirmation that you are running OX App Suite 7.8.1, including the latest patch.
* The full information from the autodiscovery XML sheet
* Two test accounts in your OX App Suite service, with which we can verify that the OX App Suite system works as expected.
* A “logo” and “name” for your service. This information will be used in the client itself.

Note that the “logo” needs to be delivered in certain formats and resolutions.

Please contact Open-Xchange Sales for further information and pricing details.