PA OXaaS APSv2 Provider Guide

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 5.5 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.

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:

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
Odin 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:

1. Deploying Open-Xchange application endpoint.
2. Importing Open-Xchange application package.
3. Creating service instance in the Provider Control Panel.

OSA Integration

1. Creating the required resource types. For further details, please refer to the Resource Creation section of this guide.
2. 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:

Components

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

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:

1. Configure the settings (please refer to the APP Settings subsection, under the Detailed Configuration section).
2. Configure the reseller’s brands (please refer to the Brands subsection, under the Detailed Configuration section).
3. 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

1. In the POA Provider Control Panel, navigate to Services>Applications.
2. Click on the latest version of the Open-Xchange APS package.
3. Go to the Instances tab.
4. 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.

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

: enabled
: 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.

• The status of the executions can be:

: the execution was successful.
: the execution is in process.
: an error has occurred during the execution.

Brands

This tab is used to assign each Open-Xchange reseller with a brand. To do so:

1. Click on Add new brand.
2. Fill in the required fields:
   • Name: name of the brand.
   • Username: username of the brand.
   • Password: password or the brand.
   • API URL: URL where the API is located.
   • SSO URL: URL of the Single Sign On.
   • APP Suite Login Page: login page of the APP Suite.
   • 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.
3. Click on Create to add the brand.
4. Once the brand has been created, you can view or edit the settings, branding and list of domains and subdomains.
   
   
5. 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.
     
     
   • See the brand’s settings:
     • Application URL.
     • Global settings.
     • 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.
       
       
6. 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:
     
     
     • 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), then click on Save:
       
       
     • You can also edit an existing domain or subdomain by clicking on Edit.
       
       

Profiles

On this tab you can add, edit and delete a profile.

Click on Add new profile and specify the following features, then click on Save.

• 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

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

Application Service Reference

Creating a Globals Resource

1. Click on Create, then on Application Service Reference.
2. 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.
     
     
3. Click Next, then select Open-Xchange Application as the APS type.
   
   
4. Click on the instance.
   
   
5. Click Finish. The resource has been created.

Creating a Brand Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Brand as the APS type and then click on the instance.
4. Click Finish. The resource has been created.

Creating a Profile Basic Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Profile as the APS type and click on the instance.
4. Click Finish. The resource has been created.

Creating a Profile Webmail Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
4. Click Finish. The resource has been created.

Creating a Profile Advanced Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
4. Click Finish. The resource has been created.

Creating a Profile Pro Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
4. Click Finish The resource has been created.

Creating a Shared Domain Resource

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Shared Domain as the APS type and then click on the instance.
4. 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

1. Click on Create, then on Application Service Reference.
2. 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.
3. Click Next, select Open-Xchange Shared Subdomain as the APS type and then click on the instance.
4. 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

1. Click on Create, then on Application Service.
2. 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.
     
     
3. Click Next, then select Open-Xchange Tenant as the APS type.
   
   
4. Tick the “Automatically provision service” checkbox and leave the Priority field blank
   
   
5. Click Next, then Finish. The resource has been added.

Creating a User Resource

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

Creating an Email Address Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Email Address as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Creating a Domain Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Domain as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Creating a Purchase Request Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Purchase Request as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Creating a Group Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Group as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Creating a Subdomain Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Subdomain as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Creating a Resource Resource

1. Click on Create, then on Application Service.
2. 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.
3. Click Next, then select Open-Xchange Resource as the APS type.
4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
5. Click Next, then Finish. The resource has been added.

Application Counter

Creating a Storage Quota Resource

1. Click on Create, then on Application Counter (KB).
2. 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.
3. Click Next, then select Tenant Storage Quota as the APS type.
4. Click Finish. The resource has been added.

Template Creation

Please ensure that Parallels Business Automation resource has been created (see Deployment Guide, section “Prerequisites for the endpoint” for further details).

1. In the POA Provider Control Panel, navigate Products>Service Templates.
2. Click on the Add New Service Template button.
   
   
3. 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”.
     
     
4. Click Next. The template has been created.
5. Select all the resources created earlier as well as Odin Business Automation, then click Next.
6. 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.
7. Click Next, then Finish
8. To activate the service template:
9. Open the newly created service template (Open-Xchange).
10. In the General tab, click on Activate.