Creating 'Open-Xchange Application' Resource Type
Create the Open-Xchange resource type on the basis of Application resource class, using the following instructions:
- Go to Products > Resources and click the Add New Resource Type button.
- Click the Application resource class.
- Fill out the Name and the Description fields. Use, for example, the following name: Open-Xchange. Click Next. The list of imported applications opens.
- Click the Open-Xchange application in the list.
- Specify the following Global settings of application:
- Master Administrator Login – Open-Xchange Admin Master Login.
- Master Administrator Password – Open-Xchange Admin Master Password.
- Open-Xchange installation host – Open-Xchange Administration Server IP Address or Hostname.
Note: This server is used for provisioning purposes. The
open-xchange-admin-soap
RPM package is installed on this server. - Open-Xchange public site address – Open-Xchange Frontend Server IP Address or Hostname.
Note: This server runs Open-Xchange UI.
- Open-Xchange administrator access level – Access level of Open-Xchange context administrator account. The all value should be used.
- Open-Xchange anti-spam protection interface – It defines whether the spam reporting functionality is enabled. If it is enabled, the Open-Xchange context user is able to mark messages as spam/not spam. Make it enabled.
- Public contacts folder – This parameter defines a name of Public Contact Folder, which is created in Open-Xchange context. This Public Contact Folder is used to store mailbox addresses, maillist addresses, forward only emails, and contacts. The folder is visible to all Open-Xchange context users, only the Open-Xchange context administrator has full access permissions for the folder. If this parameter is not specified, the Public Contact Folder is not created. Specify the following value: Public Contacts Folder.
- Enable data migration from Horde – It defines whether to migrate the calendar and contact data of a mailbox (true/false).
- URL to source Horde – It defines an URL of the Horde server where the calendar and contact data are resided. If the Enable data migration from Horde parameter is set to true, this parameter should be specified.
Note: The Enable data migration from Horde and URL to source Horde Activation Parameters should be specified when you prepare the Open-Xchange for migration of webmail service from Horde to Open-Xchange. To obtain information about the migration refer to CloudBlue CommerceLinux Mail Hosting Deployment Guide >> Migrating Webmail From Horde to Open-Xchange section.
- Service with OXtender for Business Mobility – defines if OXtender for Business Mobility is provisioned with the "Webmail account service" to support mobile devices.
Specify the following settings of Application service "Open-Xchange context":
- Open-Xchange context wide filestore quota (in MB) – Context size on the FileStore (in Megabytes). Default value is 1024 MB.
Important: The Open-Xchange FileStore limits should be taken into consideration when this parameter is specified. See the Preparing FileStore section for details.
- Branding scheme name – The name of the Open-Xchange theme which is applied to the context user. If the parameter is not specified, the default Open-Xchange theme is used.
Note: The instructions how to create and install Open-Xchange theme are provided in the http://oxpedia.org/wiki/index.php?title=Gui_Theming_Description article.
- Time zone – Select a Time zone for the context users.
Specify the following settings of Application service "Webmail Account":
- Open-Xchange module access level for Enduser – Access level for Open-Xchange context user. There are the following access levels:
- webmail_plus – Email and Contacts
- pim_plus – Email, Contacts, Calendar, and Tasks
- groupware_plus – Email, Contacts, Calendar, Tasks, and InfoStore
- premium – Email, Contacts, Calendar, Tasks, InfoStore, and the ability to use the Open-Xchange interfaces (ical, vcard, webdav, webdavxml).
- all – Access level of Open-Xchange context administrator account. It includes Email, Contacts, Calendar, Tasks, InfoStore, the ability to use the Open-Xchange interfaces (ical, vcard, webdav, webdavxml), and the ability to manage objects of Open-Xchange context.
Note: Access levels are defined in
/opt/open-xchange/etc/admindaemon/ModuleAccessDefinitions.properties
file. Each access level is associated with a set of modules. For example, to extend Webmail account with Mobile Devices Support under a specific access level,ModuleAccessDefinitions.properties
the access levels should include the corresponding modules.
To enable Mobile Devices Support in Webmail the Open-Xchange version 6.20-5 is required. However, this limitation is not applicable to other Open-Xchange modules. - Maximum size of all attachments in one message (in MB) – Maximum size of all attachments in one message (in Megabytes). Default value is 100 MB.
- Maximum size of one attachment (in MB) – Maximum size of one attachment (in Megabytes). Default value is 10 MB.
Click Next.
- Specify the parameters in the Additional Parameters area:
- Provision application on account's domain – This parameter defines whether an application can be installed on the customer domains. This parameter should be set to the No value (checkbox is clear).
- Provision application on vendor's domain – This parameter defines whether an application can be installed on a sub-domain of the domain, which is specified by the Base Domain Additional Parameter. The sub-domain is automatically created in CloudBlue Commerce. This parameter should be set to the No value (checkbox is clear).
- Show Application in Navigation Menu – This parameter defines how to display an application and Application Services in the navigation menu of CCP.
Note: Application Service is a component of application. Application Service can be created, configured, or removed by a customer for the exiting application instance. Application Service may have Application Sub-services. Examples of Application Services: Application User, Mobile Access for Mailbox.
There are the following options:
- No (check box is clear) – Application is shown in the list of the installed applications in CCP, Hosting > Configuration & Administration > Applications > APPLICATION_NAME. The Application Services are represented as corresponding tabs in CCP, Hosting > Configuration & Administration > Applications > APPLICATION_NAME > APPLICATION_SERVICE_NAME tab. The Application Sub-services are represented as corresponding tabs in CCP, Hosting > Configuration & Administration > Applications > APPLICATION_NAME > APPLICATION_SERVICE_NAME tab > APPLICATION_SERVICE_INSTANCE > APPLICATION_SUBSERVICE_NAME tab.
- Yes (check box is selected) – Application is shown in the navigation menu in CCP, Hosting > Configuration & Administration > APPLICATION_NAME. The Application Services are represented as corresponding menu items in CCP, Hosting > Configuration & Administration > APPLICATION_NAME > APPLICATION_SERVICE_NAME. The Application Sub-services are represented as corresponding tabs in CCP, Hosting > Configuration & Administration > APPLICATION_NAME > APPLICATION_SERVICE_NAME > APPLICATION_SERVICE_INSTANCE > APPLICATION_SUBSERVICE_NAME tab.
Note: You can configure how the particular Application Service is displayed in CCP using the instructions of the Configuring Application Service Layout in Customer Control Panel section.
- Custom Application Name or Localization Key – This parameter allows you to customize a name of application in CCP. When the custom name is specified, it is displayed in CCP. If parameter is not specified, the original name of application is displayed. Alternatively, you can specify a custom localization key for any non-English locale. First, create the key-value pair in the desired locale and enter the key name here. To read how to customize locales, refer to Operations Provider's guide >> Managing Accounts > Configuring Your Account > Managing Locales section.
- Custom Application Description or Localization Key – This parameter allows you to customize a description of application in CCP. When the custom description is specified, it is displayed in CCP. If parameter is not specified, the original description of application is displayed. Alternatively, you can specify a custom localization key for any non-English locale. First, create the key-value pair in the desired locale and enter the key name here. To read how to customize locales, refer to Operations Provider's guide >> Managing Accounts > Configuring Your Account > Managing Locales section.
- Custom Application Icon – This parameter allows you to specify a custom application’s icon, which is displayed in CCP.
- If parameter is not specified, the original icon of application is displayed.
- When the name of custom icon is specified, the custom application’s icon is displayed in the CCP.
Custom 16x16 and 32x32 pixel icons should be placed into the
images/icons
directory of the installed skin. Icons should be in the GIF format. Filenames should be the following:<
ICON_NAME>_16x16.gif
and<
ICON_NAME>_32x32.gif
, where the ICON_NAME parameter is the name of the custom icon.Note: The CloudBlue Commerce skins are located in
/usr/local/pem/ui/pem/skins/
directory. - Bind Domains to Application Instance – This parameter defines whether to re-configure the application instance, when a list of the account’s domains is changed in CloudBlue Commerce (for example: domain is added or removed). This parameter should be set to the No value (checkbox is clear).
- Embed Application User Interface – This parameter defines whether to show the user interface provided by application in the main frame of CCP. This parameter should be set to the No value (check box is clear).
- Mandatory For Service User – Select the check box if you wish to make the Open-Xchange application mandatory for service user. Otherwise, leave the check box clear.
- Click Next.
- Select the External Provisioning attribute and click Next.
- Check the resource type parameters carefully and click Finish.
After that the resource type is created, configure how the Application Services are displayed in CCP using the instructions of the Configuring Application Service Layout in Customer Control Panel section.
Important: The Contact Open-Xchange Service is an internal service and it should not be allowed to manage this Service from CCP. For this service the Show in control panel activation parameter should be set to No (default value).
Note: For application setting of the list type: use the 'plus' button to add new input field; use the 'cross' button to remove the existing input field with its value.