Creating Resource Type on Basis of 'Application' Resource Class

The Application resource class is a foundation for creating Application resource types. The Application resource type contains settings, which are used to provision an application instance, application services, and application resources.

Note: It is required to create a resource type on the basis of the Application resource class for every application, which is planned to provision.

To create a resource type based on the Application resource class, perform the following steps:

1. Go to Products > Resources and click the Add New Resource Type button.
2. Click the Application resource class.
3. Fill out the Name and the Description fields. Click Next. A list of imported applications opens.
4. Select the required application in the list.
5. Specify the following settings of the application:
   • Global settings – These settings affect the whole application.

     Note: Global settings of application can be modified. The changes are propagated to all existing instances of the application, which are provisioned on the basis of appropriate resource type.

   • Settings for application’s services – These settings affect the services, which are provided by the application.

     Note: Settings for application’s services can be modified. The changes are not propagated to all existing instances of the application, which are provisioned on the basis of appropriate resource type. Only the new instances of the application will obtain the new settings.

   These settings are used by CloudBlue Commerce for auto-provisioning purposes. Click Next.

   Notes:
   1. Application settings may vary depending on the type of application. Refer to the application's documentation to learn more about the settings.
   2. 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.

6. Specify the parameters in the Additional Parameters area:
   • Provision application on account's domain – This parameter defines whether the application can be installed on the customer's domains. There are the following options:
     • Yes (the check box is selected) – Application can be installed on the customer's domains.
     • No (the check box is clear) – Application cannot be installed on the customer's domains. This is the default option.

       Notes:
       1. Application can be installed on customer's domain when the following conditions are satisfied: domain has internal DNS Hosting in CloudBlue Commerce; there is no installed application or Web Hosting on the domain.
       2. When the Provision application on account's domain option is set to Yes the customer obtains ability to install application on the domain from another subscription. In that case, all available for application installation domains are displayed in the Application Access Domain area in CCP.
       3. Domains added automatically are subject to the following restrictions:
       - Domains are added unless they result in no conflicts in DNS records.
       - Domains are added automatically only if there is web, mail or DNS hosting available.

   • Provision application on vendor's domain – This parameter defines whether the application can be installed on a sub-domain of the domain, which is specified by the Base Domain parameter. The sub-domain is automatically created in CloudBlue Commerce.
     • Yes (the check box is selected) – Application can be installed on the auto-generated domain. This option is selected by default.
     • No (the check box is clear) – Application cannot be installed on the auto-generated domain.
   • Base domain – Select the domain to be used as part of URL to access the application's web interface. The list includes all domains and subdomains (up to fourth-level subdomains) registered under your account.
   • Access URL template – View the template according to which the application URLs for customers are formed.

     These URLs are placed in CCP as access links to the application's web interface. You can customize the URL template if necessary.

     The template has the following format: http://prefix.${company_name}.${base_domain}, where:

     • prefix – Is the customizable part of the URL. By default, it contains the name of the current application category (for example, crm for CRM applications, store for E-Commerce applications, etc.). If necessary, you can replace this value with your custom application name.
     • {company_name} – Is the placeholder that will be replaced with the customer's Company name.
     • {base_domain} – Is the placeholder that will be replaced with the domain specified as the Base domain (see above).

       Note: Customization is allowed for the prefix part only. Replacing placeholders with real names, placing custom content between the placeholders or after the {base_domain} placeholder (for example, http://prefix.${company_name}.abc.${base_domain}/somepath) is not allowed.

     The access URLs in CCP may look as follows:

     • If prefix has not been customized – http://crm.company.domain.com
     • If prefix has been customized – http://application.company.domain.com
     • If one application is used several times in one subscription: http://crm.company.domain.com, http://crm2.company.domain.com, http://crm3.company.domain.com and so on.
   • Auto host domains parameter determines ability to automatically provision the application on domains in one of the following cases:
     • When a hosting service (Application subscription) is added to a domain using pem.bindServicesToDomain Open API method.
     • When a domain together with a hosting service is added using the pem.addDomain Open API method

     For details about these Open API methods, refer to Operations Public API Reference guide.

   • Automatically provision application – allows provisioning of the application in subscription automatically.
   • Prohibit service users with custom UPN – users with custom UPN are not allowed to use the application.
   • Prohibit application instance deinstallation – this setting determines a customer's ability to uninstall the application in CCP.
   • 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 (domain is added or removed). There are the following options:
     • No (check box is clear) – CloudBlue Commerce does not add domains to the application automatically.
     • Yes (check box is selected) – CloudBlue Commerce adds domains to the application instance if the domain has a hosting (mail or DNS) in the subscription with the application.

       Notes:
       1. This setting is displayed only for Applications that may be installed on multiple domains.
       2. Domains added automatically are subject to the following restrictions:
       - Creating domains does not create conflicts in DNS records.
       - Hosting must be available on the domains (mail, DNS, web).

   • SSL Protection – This parameter defines whether a shared web server application is SSL-protected and its web interface is accessible over the HTTPS protocol.
     • SSL disabled – SSL-protection is disabled for application. Application's web interface is accessible over the HTTP protocol only.
     • SSL enabled, HTTP entry points – SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTP entry points are displayed.
     • SSL enabled, HTTPS entry points – SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTPS entry points are displayed.
   • Allow account's SSL certificate – This setting defines whether a customer can use their own SSL Certificate for an SSL-protected application. This setting has effect only when SSL Protection is enabled and likewise is applicable only for shared web server applications.
     • No – In this case web server's SSL Certificate is used.
     • Yes – In this case a customer can install own SSL Certificate (self-signed or issued by well-known Certificate Authority).

     Various combinations of values set for SSL Protection and Allow account's SSL certificate determine constrains imposed on access to the application. These constraints are summarized in the following table:

	SSL disabled	SSL enabled, HTTP entry points	SSL enabled, HTTPS entry points
Allow account's SSL certificates: Yes	HTTPS connections are prohibited	SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTP entry points are displayed. A customer can install his own SSL certificate. Each application instance requires a designated IP address allocated from the provider's pool.	SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTPS entry points are displayed. A customer can install his own SSL certificate. Each application instance requires a designated IP address allocated from the provider's IP pool.
Allow account's SSL certificates: No	HTTPS connections are prohibited	SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTP entry points are displayed. Web server's SSL certificate is used. A single provider's certificate installed on the host is used to authorize connection to the application.	SSL-protection is enabled. Application's web interface is accessible over the HTTPS and HTTP protocols. In CCP, the HTTPS entry points are displayed. Web server's SSL certificate is used. A single provider's certificate installed on the host is used to authorize connection to the application.

Note: Both SSL Protection and Allow Account's SSL Certificate are defined by provider only. Customers have no way to change either SSL protection mode or type of SSL certificate used.

• Show Application in Navigation Menu – This parameter defines how to display the application and Application Services in the Navigation Menu of CCP and MyCP.

  Note: Application Service is a component of application. Application Service can be created, configured, or removed by customer for the exiting application instance. Application Service may have application sub-services. Examples of Application Services are: 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, Applications > APPLICATION_NAME. The Application Services are represented as corresponding tabs in CCP, Applications > APPLICATION_NAME > APPLICATION_SERVICE_NAME tab. The Application Sub-services are represented as corresponding tabs in CCP, 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, Applications > APPLICATION_NAME. The Application Services are represented as corresponding menu items in CCP, Applications > APPLICATION_NAME > APPLICATION_SERVICE_NAME. The Application Sub-services are represented as corresponding tabs in CCP, Applications > 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 instructions of the Configuring Application Service Layout in Customer Control Panel section.

• Embed application user interface – This parameter defines whether to show the user interface provided by application in the main frame of CCP. There are the following options:
  • No (check box is clear) – CloudBlue Commerce screens are shown in the main frame of CCP. Application is managed through the UI provided by CloudBlue Commerce.
  • Yes (check box is selected) – Screens of the application’s user interface are shown in the main frame of CCP. Application is managed through the UI provided by the application.

    Note: This parameter can be turned on for applications, which provide own UI and this UI can be used as a replacement of the CloudBlue Commerce UI.

• 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 /usr/local/pem/ui/pem/images/applications directory on the UI server. Icons should be in the GIF or PNG format. File name should be the following: <ICON_NAME>_16x16.gif or <ICON_NAME>_32x32.gif, where the ICON_NAME parameter is the name of the custom icon (all the other icons in CCP are of the 64 x 64 pixels).

  1. Click Next to proceed. If the application requires a designated IP address, the next page will prompt you to select an available IP pool which will serve as a source for an IP address. Check the required IP pool(s) and click Next to proceed. If the application does not require a designated IP address, this page will be skipped.
  2. Click Next. If the application requires provisioning parameters, they will be presented on the next page. Otherwise, skip to item 9. Some parameters may remain invisible depending on the value of an associated multi-value (boolean or enum) setting. Select the necessary provisioning attributes and click Next to proceed.
  3. Check the resource type parameters carefully and click Finish.

Note:
You can also start the resource type creation Wizard right from the Applications screen:
1. Go to Services > Applications.
2. In the APS Connectors tab, select name of the required application, and on the Resource Types tab click Create. A list of resource classes opens.
3. Select the Application resource class, then follow the Wizard.

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

Editing Application Activation Parameters

If your application declares activation parameters, you can access them as described in Operations Provider's guide >> Managing Service Templates > Modifying Resource Type Activation Parameters. Note that number of sub-tabs inside the Activation Parameters tab may vary depending on application. A resource type of the Application resource class contains the following activation parameters.

• General: domain configuration, autoprovisioning options, customer’s UI customization options.
• Default settings: this tab is available only if such values are defined in the APS package. If so, you will be able to confirm or customize the default values. Some settings may be bound to the value of a different, boolean or enum, setting. Depending on the value of the boolean or enum setting, associated settings may be displayed or hidden in CloudBlue Commerce CCP.
• Services: this tab combines configuration for services if application contains multiple ones. The set of services may vary depending on each specific application. See details in the Configuring Application Service Layout in Customer Control Panel section.
• Network: this tab is available if the application requires IP address. This tab lists IP pools, the IP addresses are allocated from.

Autoprovisioning of Singular Services

If you are creating a resource type for an application featuring extra services, you may want to enable autoprovisioning for such services. That is, such services will be provisioned automatically with the application. To enable autoprovisioning, perform the following steps.

1. Go to Services > Applications to view the list of available applications.
2. Open Resource Types tab and click the name of the application resource type you created above.
3. Open Activation Parameters tab and then open the Services sub-tab below.
4. Click the Edit link in the settings area of the required service. The settings will become available for change.
5. Check Autoprovisioning to enable automatic provisioning and click Submit to save settings.