APS Package Certification Guide

Transcription

1 APS Package Certification Guide Revision Copyright by Parallels Holdings Ltd. and its affiliates. rights reserved. All

2 Contents Feedback If you have found a mistake in this guide, or if you have suggestions or ideas on how to improve this guide, please send your feedback using the online form at APS Standard website Please include in your report the guide's title, chapter and section titles, and the fragment of text in which you have found an error. Feedback 2 Chapter 1 Introduction 4 Chapter 2 Application Testing 6 Testing in Parallels Automation... 6 Testing of Application Provisioning... 7 Testing Application in Online Store User Integration Testing Domain Integration Testing Mailbox Integration Testing Add-on Testing Testing Usage Limits of Application Services Ordering Application Service Instances Testing Applications with Upsell Services License Integration Testing Monitoring Application Resource Usage Testing Usage Limits of Service Resources Testing of Table Settings Cross-Service Integration Testing Troubleshooting Testing in Parallels Plesk Panel Chapter 3 APS Package Certification 40 Certification Workflow Uploading and Testing APS Packages Viewing Test Results Validation Report Test Report... 45

3 Contents 3 Status Package Details Environment Links Relations Publishing an Application Appendix A Configuration of APS Test Server 49 Index 51

4 C H A P T E R 1 Introduction The purpose of this document is to provide guidelines for testing and certification of APS packages this is SaaS applications being packaged in accordance with the Application Packaging Standard. The Certification procedure is a required step in the process of publishing APS packages in APS Catalog The document is intended for application vendors. The guide covers the following matters: Application Testing section contains instructions for verification of APS package with Parallels Automation and Parallels Plesk Panels. Package Certification section provides guideline for APS package certification and publication. Abbreviations, Definitions and Conventions APS is used instead of Application Packaging Standard in some long sentences where using it will not change the meaning of the sentence. Application Package, APS Package or Package is a web-based application which includes all application and application-related files created, structured and packed according to APS. Application Instance is a web-based application installed from an APS package on a particular website and accessible at a unique URL. POA (Parallels Operations Automation) - a customizable multi-server management system offering automated back-office provisioning and service management for large-scale cloud service delivery. Part of Parallels Automation suite. PBA (Parallels Business Automation) - a customizable management and control system covering the full life cycle of business and marketing operations for selling cloud services and applications. Part of Parallels Automation suite. Control panel - a web-based component comprising a separate management tier in Parallels Automation and offering related controls for a certain role (see also PCP, MyCP, CCP and PPP). APS Catalog - a public web source for APS packages. MyCP - a control panel providing a Service User with access to applications, websites and mailboxes. PCP (Provider Control Panel) - a control panel, part of Parallels Automation offering access to provider-related tools and tasks, such as: reseller and customer management, allocation of hardware resources and import of APS packages. CCP (Customer Control Panel) - a control panel, part of Parallels Automation, providing access to customer-related tools and products purchased by the customer. PKA (Parallels Key Administrator) - a license management service.

5 Introduction 5 PPP (Parallels Plesk Panel) - a control panel for application and service management running on a single server. Provisioning Gateway - a host machine, part of POA infrastructure, where files of APS application instances are located. Resource - a specific countable entity that may be consumed by users: traffic, databases, applications, etc. Resource type - a configurable template for provisioning of resource. Contains configuration of APS application. Service template - group of Resource Types with provisioning rules and limits for each Resource Type. Service Templates enable POA to automatically provision resources and services on millions of customer accounts. Subscription - a group of Resource Types with usage information based on a single Service Template. Service Plan a commercial offer of a computer resource package. When customers buy Service Plans, they accrue a right to use up certain amount of hosting resources at a certain rate over a certain period of time in the future, usually starting from the day of purchase. Purchasing a Service Plan is equivalent to subscribing to the services listed in the plan. Certification Level - a grade assigned to APS package based on its compliance to Application Packaging Standard (see APS Application Certification Criteria for details).

6 C H A P T E R 2 Application Testing To be certified successfully, an APS package must be created in accordance with APS specification (see APS Packaging Guide and tested in the following APS-compliant control panels: Parallels Automation ("Testing in Parallels Automation" on page 6) Parallels Plesk Panel ("Testing in Parallels Plesk Panel" on page 38) Note: PPP does not support APS packages requiring PVC aspect, and therefore such packages may not operate as designed. Note: The above mentioned control panels do not support the following Qualified Technologies: Perl aspect, DLL aspect and IIS aspect. Testing in Parallels Automation To perform the following test you must have access rights to Parallels Automation APS test server located at ( If you don't, submit a request through the APS Support contact form Testing of an Application in Parallels Automation comprises the mandatory steps: Testing of installation, removal and entry points (see Testing Application Provisioning ("Testing of Application Provisioning" on page 7)) If the application supports integration with POA objects, such as users, domains and so on, additional tests may be required. Testing Application in Online Store (on page 14) User Integration Testing (on page 16) Domain Integration Testing (on page 18) Mailbox Integration Testing (on page 18) Add-on Testing (on page 19) License Integration Testing (on page 25) Monitoring Application Resource Usage (on page 28) Testing Usage Limits of Service Resources (on page 31) Testing of Table Settings (on page 32) Cross-Service Integration Testing (on page 33)

7 Application Testing 7 Testing of Application Provisioning Importing an Application 1 Login to POA PCP at the test server. 2 Click Import Package button in Service director > Application Manager > Applications menu. 3 Select local file and browse for the APS package on your local drive. If the APS Package exceeds 10MB in size, select URL and point to the remote location where the APS package resides. Adding Resource Type for Application To apply usage limits to the Application you have to create a Resource Type based on "Application" class. Here is how to do it: 1 Go to Service Director > Application Manager > Applications. 2 Click the link of the required Application and open Resource Types tab. 3 Click Create button to add a new Resource Type. 4 Select Application resource class. 5 Complete Name and Description (optional) fields as required. 6 Specify values of following Application settings: Global settings Default setting for application services

8 8 APS Package Certification Guide Application Packaging Standard 7 Click Next button to proceed to the list of provisioning attributes. 8 Leave default values and click Next button to proceed to the settings summary. 9 Review all settings and click Finish button. Note: The following settings do not require definition of values and, thus, they are not displayed to Provider: 1. Settings with APS classes (filled by APS controller), see Settings Semantics in APS specification, 2. Settings with PA classes, see PA-specific classes in Integrating Applications with Parallels Automation via APS, 3. Domain settings (class="domain-name"), 4. Custom status setting (class="status"), 5. Password setting (type="password"), 6. Protected settings, 7. Settings which values are inherited from parent service (via "value-of-setting" attribute). Adding a Resource Type for Application Service An Application may include multiple services. The process of adding such resources is similar to that described above: 1 Go to Service Director > Application Manager > Applications. 2 Click the link of the required Application and open Resource Types tab. 3 Click Create button to add a new Resource Type. 4 Select Application Service resource class. 5 Complete Name and Description (optional) fields as required. Click on the Next button, the list of available services opens. 6 Select Application Service from the list. 7 Specify the Application Service settings. Click Next button. 8 Specify the Priority parameter (optional). This parameter defines the order of displaying of Resource Types when Customer selects it for an Application Service instance. 9 Review all settings and click Finish button. Notes: Step 7 is available if the service has the settings with visibility="hidden" attribute (see Service Settings in APS Specification Such settings can not be changed by Customer or Service User but they can be defined by Provider.

9 Application Testing 9 Customer can change resource type of existing Application Service instance on different one from the same subscription if its limit has not been reached. When the change is done, the service instance is reconfigured with setting values from new resource type. However, if all settings of resource type (defined at step 7) have installation-only="true" attribute, Customer cannot change the resource type and perform reconfiguration of existing service instance. Configuring Availability of Application Services By default, Customer can manage of all application services. However, a service may be disabled for a Customer with one of following methods: 1 Addition of Application Service Resource Type of the service to subscription with limit 0. 2 Disabling of the service in Activation Parameters > Services of Application Resource Type. 3 Disabling of the service in Activation Parameters > Services of parent service's Application Service Resource Type. The difference between 2 and 3 is that in the last case the service is disabled for only parent service instances which use the Resource Type. To define availability of sub-services in parent service's Resource Type, perform the following steps: 1 Go to Top > Service Director > Application Manager > Applications. The list of Applications opens. 2 Click on the name of the required Application. The General tab opens. 3 Go to the Resource Types tab and click the Resource Type of service for which you want to define availability. 4 Open Activation Parameters tab and on that tab click on Services sub-tab. The sub-tab will list all sub-services of the service associated with this Resource Type. 5 Click Edit button against a sub-service. 6 Uncheck Enable checkbox to make the service unavailable for Customers. Notes: 1. These activation parameters override the same ones from Application Resource Type. 2. Making provisioned services unavailable will not immediately unprovision existing sub-services. Change of availability status applies only to new service instances. Also, if a Customer switches the Resource Type of a parent service, its sub-service will be removed if disabled. 3. Autoprovisioning option enables automatic provisioning of sub-service with parent service instance (including case with switching Resource Type of existing instance). This option also denies Customer to activate and deactivate the sub-service (but change of sub-service settings is allowed). Creating a Service Template

10 10 APS Package Certification Guide Application Packaging Standard 1 Go to Service Director > Provisioning Manager > Service Templates and click Add New Service Template button. A list of general parameters will display. 2 In the Name field enter the service template name, check Autoprovisioning and click Next button to confirm. 3 In the list of available resource types select the resource type of your application. 4 Check Unlimited checkbox against each resource the and click Next button to proceed to the settings summary. 5 Review the settings and click Finish button. A new Service Template will display in the list. 6 Select the template by clicking respective link and then click Activate button to make this template available for subscriptions. Next thing you have to do is create a Subscription based on the newly created service template. Creating a New Service Plan To let a Customer install and use an application, you will also have to define a new Service Plan based on a service template created above. If POA is not integrated with PBA, this step may be skipped. 1 In POA PCP click Billing icon in the top right corner to login to PBA. 2 Go to Product Director > Plan Manager > Service Plans. A list of available service plans will display. 3 Click Add New Service Plan button. 4 Complete Service Plan with the name of a new plan (e.g. "My Application"). 5 Click magnifier icon next to Service Template field and select the service template created above. 6 Enter description in Short Description and Long Description fields. 7 Check Published box. 8 In Billing Period field enter 1. 9 Leave default values for other fields and click Next button to define a subscription period. 10 Check any period and click Next button to confirm. 11 Click Finish. A new service plan will be added to the list. Setting Up a Customer Account The next logical step will be creating a new customer account. If you already have one, skip this step. 1 In PBA go to Operation Director > Accounts Manager > Accounts. A list of registered customers will display. 2 Click New Customer Account button. 3 Click Next button to skip settings on Begin tab.

11 Application Testing 11 4 Complete the company name, address and billing details. Click Next button to proceed. 5 Enter your login name in Login Name field, and then enter your password in Password and Confirm Password fields. 6 Click Finish button to save. A new customer account is added. 7 Go to Operations Director > E-Commerce Manager > Payment Methods and select Cash/Check payment method by clicking the related link. 8 Click Set Default For Customers button. From this point onwards this payment method will make it unnecessary to select it each time a new order is placed. Creating a Subscription To let a customer install and use an application, you will also have to define a new subscription based on a service template created above. This way you will create a link between the application and terms of use defined in the template. 1. In PBA go to Operation Director > Sales Manager > Customers Orders. A list of customers orders will display. 2. Click Add New Order button. 3. Click the magnifier magnifier icon next to Account field and in the appeared window select the Customer by clicking the respective link. For convenience, enter the name of the earlier created Customer in Account Name field of the filter bar above. 4. Click the magnifier icon next to Service Plan field and in the appeared window select the Service Plan ("MyApp") by clicking the respective link. For convenience, enter MyApp in Name field of the filter bar above. 5. Click the magnifier icon next to Subscription Period field and in the appeared window select the Subscription Period defined in your Service Plan. 6. Click Next button to proceed to the next tab. 7. Leave Domain field empty and proceed by clicking Next button. 8. Review order details and click Place Order button. Checking PVC Templates If your APS package uses PVC aspect, check that all PVC templates, which are referenced from the package and, have been imported in Service Director > Virtuozzo Manager > Application Templates menu Note: If the PVC template, being referenced from APS package, is contained in the package, the template is not required to be imported in advance.

12 12 APS Package Certification Guide Application Packaging Standard Installing the Application To test the application on the Customer end, perform the following steps. 1 Go to Operations Director > Customers Manager > Customers. A list of customers will display. 2 Locate the Customer you created above and click the respective link. Use filter bar above to search for the required entry. 3 Open General tab and then open Staff members sub-tab. 4 In the list of Staff Members you will see the only entry. Click Login as Customer link against the Staff Member's name to login to POA CCP. 5 Select the Subscription which contains your application. If any of the Subscriptions is marked as default, this step will be skipped. 6 Click Application in the navigation bar on the left to display a list of installed applications. 7 Click Install New Application button to display a list of applications that may be installed under the current subscriptions. 8 Select your application by clicking the respective link. The next page will display the settings for application services. 9 Leave default values or change them if necessary. When done, click Next button to proceed to the summary page. 10 Review the settings and click Finish button. Checking Entry Points Now that you have installed the application, you have to make sure that all of its services are accessible from the PCP. To do this, perform the following steps. 1 While in the list of installed application, click the link of your application. 2 Check that all application entry points work properly. Entry points are located under Upgrade and Uninstall buttons and in the tabs for each individual application service (if provided). Each entry point is associated with a certain part of the Application (control panel, login page or main page of the Application). Some entry points may change their state depending on the current status of the external service, if external such behaviour is supported by the application and declared in the APS package. In this case testing entry points will include testing each entry point against the statuses of the external service. Specifically, you will have to ensure that the following requirements are met: The text and icons display as defined in the APS package; The configuration script runs correctly. To ensure that the configuration script returns correct values, perform the following steps.

13 Application Testing In POA PCP go to System Director > Task Manager and on the Background tab see if there is any failed tasks showing the name of the service. 2. If such tasks actually exist, click to see the reason in Last execution output field. If none of such failed task exist, follow to Background > Task Log. 3. In the list of complete tasks search for the one that contains the name and the id of your service in the Name field. Click it and in the Output field view the structured output returned ny the configuration script. Note: You should ensure that the application domain is resolved to IP address properly within your network. You may use demo.aps.sw.ru DNS server to get application domain resolved. Alternatively, you may request the DNS server about IP address using command nslookup -q=a <application-domain> demo.aps.sw.ru and add it to your /etc/hosts file manually. Note: By default, each application instance gets an auto-generated sub-domain of demo.aps.sw.ru one. You may see the exact domain name of the application instance when browsing its entry point. Changing Application Settings To make sure that the Controller is able to reconfigure the Application, perform the following steps. 1 While on the Application page, open Settings tab. 2 Open Settings tab of the application, click Edit button 3 Change a setting, then click Submit button 4 After application receives Ready status, check that the setting has been changed in the application instance. Uninstalling the Application 1 Click Applications in the navigation bar on the left to display the list of installed applications. 2 Select your application by clicking the respective link. 3 Click Uninstall button. 4 When prompted to confirm the action, click OK button to uninstall the application.

14 14 APS Package Certification Guide Application Packaging Standard Testing Application in Online Store An application can be exposed to PA Online Store as a part of Service Plan. Application's end-user license agreement (EULA) can be also defined in Service Plan and displayed in the store. Online Store of APS sandbox is located at URL. To publish a Service Plan with application in Online Store you have to do the following steps in PBA: 1 Open sales categories in Product Director > Sales Categories 2 Click on Add New Sales Category, fill Category Name ("Applications" for example) and Description, click Save 3 Add your Service Plan in the category by opening it, selecting Service Plans tab and clicking Add New Plan button 4 Remember ID of the sales category. 5 Open store screens in Product Director > Online Store Manager > Screens 6 Click Add New Screen, enter Screen ID (APP for example), select HOSTING as Template Name 7 Click Save, list of screens is displayed 8 Open the screen which has been just created, select Parameters tab, list of screen parameters is displayed 9 Click on CATEGORY_LIST_ID parameter, click Edit, enter ID of sales category in the Value field and click Save 10 Open store usage scenarios Product Director > Online Store Manager > Usage Scenarios 11 Click Add New Store Usage Scenario button, enter ID (APP_SCENARIO for example) and scenario name in Path Name ("Application scenario" for example), check Enabled and click Save 12 Open the scenario which has been just created. List of its screens is displayed (empty so far) 13 Click Add New Path Screen button, select your screen (APP) for Store Screen field, fill 1 in Order, click Save 14 Click Add New Path Screen button again, select CHECKOUT_SCREEN screen in Store Screen, fill 99 in Order, click Save. 15 Synchronize the changes with Online Store by clicking Synchronize button in Product Director > Online Store Manager > Syncronization settings. 16 Open Online Store URL. Hyperlink with name of your scenario (Application scenario) is displayed 17 Click on the link and go through process of subscription purchase.

15 Application Testing 15 An APS package of application contains EULA as either text file of URL (see License Agreement You can copy text of the EULA into Online Store configuration in PBA. Assuming application has already been published in Online Store (see above), you have to perform the following steps in PBA: 1 Open Configuration Director > Sales & Financial Settings. List of Terms and Conditions is displayed. 2 Click Add New Terms and Conditions button, enter its name, enable Active and paste text of EULA in Text field. Click Save 3 Open store screens in Product Director > Online Store Manager > Screens. List of store screens is displayed. 4 Check that screen with Template TERMS exists in the list. Otherwise click Add New Screen, enter Screen ID (TERMS_SCREEN for example), select TERMS as Template Name and click Save. 5 Remember Screen ID of the terms screen. 6 Open store usage scenarios Product Director > Online Store Manager > Usage Scenarios, select your scenario (APP_SCENARIO) 7 Click Add New Path Screen button, select your terms screen (TERMS_SCREEN) for Store Screen field, fill 90 in Order (for screen with EULA to be displayed before checkout screen) and click Save 8 Synchronize the changes with Online Store by clicking Synchronize button in Product Director > Online Store Manager > Syncronization settings. 9 Open Online Store. Check that your scenario displays EULA and requires user to accept it before application purchase.

16 16 APS Package Certification Guide Application Packaging Standard User Integration Testing To test integration with customer s users, perform the following steps. 1 Edit the APS Package to include a service of account class as described in the APS Package Developer's Guide (see Packaging Scenarios > Packaging Open-Xchange Application > Services Hierarchy and Open-Xchange Sample Metadata File). 2 In POA PCP go to Operations Director > Customer Manager > Customers. 3 Locate the Customer who is subscribed to your application (see Setting Up a Customer Account ("Testing in Parallels Automation" on page 6)). 4 Install the application (see Installing the Application ("Testing in Parallels Automation" on page 6)). 5 Click Service Users in the navigation bar on the left and click Add new Service User button. 6 Complete Display name, Login, Password and Confirm Password fields and click Next button. 7 Click the application in the navigation bar on the left and in the Service Users tab click Add button. 8 Check Existing Service User item and click Next button to proceed. 9 Select the existing Service User you created above by clicking a link with his name. 10 Click Finish button. 11 Go back to the application and ensure that all entry points work: Click Login at the user in Service Users menu, user s control panel (MyCP) opens. Click at the application in Applications menu in MyCP, application opens.

17 Application Testing Unregister the user in the application. Open the application page and check that the user has been removed. Testing Access Right for Sub-service Some Applications may feature sub-services with limited or full access defined in the APS Package. Access level determines a Service User's ability to activate a service under a root service of account type. It is assumed here that you already have an APS Package with a root account service and also a sub-service which can be managed by the Service User. To test an Application, perform the following steps: 1 Import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 2 Create Resource Types for the parent service and a sub-service. 3 Create a Resource Type based on 'Application' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)). 4 Include all four Resource Types into a new Service Template (see Creating a Service Template ("Testing in Parallels Automation" on page 6)). 5 Subscribe a Customer to your application (see Creating a Subscription ("Testing in Parallels Automation" on page 6)). 6 Go to POA CCP and install the application. 7 Create a new Service User account (see steps 6-7 in User Integration Testing (on page 16)). Under Service User's login details, select the checkbox with Application name to register the Service User in the Application. 8 Login to the Service User's account in MyCP by clicking Login link against his name in the list of Service users. 9 In the left menu bar click the service that you want to activate. 10 Click New button to add a new service account for the selected Service User. For singular services you have to click Activate link before adding a new account. 11 Complete the settings and click Finish button. Once the service is provisioned, Ready status will display for it and the resource statistics in will be incremented respectively in POA CCP ( Statistics & Analisys > Resource Usage ).

18 18 APS Package Certification Guide Application Packaging Standard Domain Integration Testing Some applications may feature integration with one or multiple domains. It allows a user to install application on own domain or to add/remove domains to application. See APS Packaging Guide, Integration with Domains chapter on details about packaging of domain integration. To test integration with customer s domains you need: 1 Open Resource Type of Application class for the application, go to Activation Parameters tab. 2 Select type of domain with will be available to application via switching on Provision Application on Account s domain option if it's customer's domains only and/or Provision application on vendor's domain option if it's sub-domains of Provider or Reseller. 3 Create subscription with the application and open it, see Testing of Application Provisioning (on page 7) chapter. 4 Click on Application (or application name) in the navigation bar on the top. 5 Click Install New Application button. 6 Screen with drop-box with list of domain available for application is displayed, in case application supports integration with single domain. Otherwise list of domains is displayed where multiple domains can be selected. 7 Select one or multiple domains and click Next button to proceed to settings and other installation options. 8 After entering other options click Finish button. 9 Application is installed on the domain(s) successfully. 10 If application support single domain, open the application and check that the domain is used in application entry point. 11 If application support multiple domains, open the application, click on Domains tab. Check that all domains selected during installation are displayed. 12 If application requires DNS records, go to Home tab, click on Hosted Domains, select a domain you have added to application, open DNS > DNS Records tab and check that required DNS records have been created. Mailbox Integration Testing To test integration with customer s mailboxes you need: 1 Edit the APS Package to include mail requirements as described in the APS Packaging Guide (see Packaging Scenarios > Packaging Open-Xchange > Used Technologies and Open-Xchange Sample Metadata File). 2 Create a mailbox by adding an service to an existing user in CCP (see User Integration Testing (on page 16)) Open the user in Service Users menu Click Add Service button

19 Application Testing 19 Select checkpoint 3 Install the application. 4 Register the user in the application (see User Integration Testing (on page 16)). 5 Check that Web Mail link of the mailbox works properly in > addresses menu. 6 In PBA set the maximum number of mailbox accounts a customer can create. To do this, set 1 in Inc. Units and Max Units for the Resource included in the Service Plan and associated with mailbox accounts. 7 When the Resource Rate is reached, you will not be able to add a new mailbox: the service will be marked as limit reached. Add-on Testing To test an Application with add-ons you need: 1 Prepare an APS Package as described in the APS Packaging Guide (see Packaging Scenarios > Packaging German Translation Add-on for WordPress). 2 Import APS package of add-on as described in Importing an Application ("Testing in Parallels Automation" on page 6). 3 Enable the add-on in Add-ons tab of activation parameters of master application resource type. Note: To be displayed in the resource type, add-on APS package must reference APS package of master application properly. See packaging details in Application Packaging Guide. 4 Install the add-on in Add-ons tab of master application instance in Applications menu of CCP. 5 Check that add-ons has been installed successfully in master application. 6 Uninstall the add-on in Add-ons tab of master application instance. For more details about working with APS applications in Parallels Automation, contact APS Support

20 20 APS Package Certification Guide Application Packaging Standard Testing Usage Limits of Application Services Any application is supposed to provide services. To enable this service for customers, a provider has to create an associated resource type and to add it in subscription with usage limits. This is done by following the steps below. 1 Prepare an APS Package for an application with at least one service as described in the APS Packaging Guide (for example, see Packaging Scenarios > Packaging Open-Xchange > Services Hierarchy). 2 In POA PCP import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 3 Create a Resource Type based on Application Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) for the application. 4 Create a Resource Type based on Application Service Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) for the child service. 5 Include both Resource Types into a new Service Template and put 1 for each Resource Limit (see Creating a Service Template ("Testing in Parallels Automation" on page 6)). 6 Subscribe a Customer to your application (see Creating a Subscription ("Testing in Parallels Automation" on page 6)). 7 Go to POA CCP and install the application. 8 Go to Statistics & Analysis > Resource Usage. Usage values should be 1 for the application and 0 for the application service resources. 9 Go to the application details and open the tab with the name of the service (the tab title appears as defined in the APS package details). 10 Click New button. The service will be provisioned. 11 Go to Statistics & Analysis > Resource Usage. Usage value for the resource has increased to 1. Attempting to provision another instance of the resource will result in an error message. To allow provisioning limit of resource must be increased.

21 Application Testing 21 Ordering Application Service Instances Service instances may be ordered in a way that the service will be initiated/launched in the order defined by the Customer. This may be practicable when a telephony service is shared by multiple employees, and incoming calls are automatically transferred in a certain sequence. To make service instances sortable, it should include a setting of 'order' class (see details in Integrating Application with Parallels Automation by APS). To see sorting of service instances in action, perform the following steps. 1 Prepare an APS Package for an application with at least one service. 2 In POA PCP import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 3 Create a Resource Type based on 'Application' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) for the application. Give this Resource Type a meaningful name, e.g. Mail Application. 4 Create a Resource Type based on 'Application Service' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) for the child service. Give this Resource Type a meaningful name, e.g. Mail Account. 5 Subscribe a Customer to your application (see Creating a Subscription ("Testing in Parallels Automation" on page 6)). 6 Go to POA CCP and install the application. 7 Create three instances of the same service and complete the Employee Name setting with the following values: John, Pete, Mike. 8 Once all service instances are provisioned, check the bottom one (e.g. Mike) and click Move up button. Reconfiguration task will be executed and a new instance will advance by one step. 9 Check the same service instance again and click Move down button. A regonfiguration task will be executed, and this instance will descend by one step.

22 22 APS Package Certification Guide Application Packaging Standard Testing Applications with Upsell Services Many applications may include features which are offered to subscribers in various editions. This chapter will help you create a service offer, which will include two editions, one of which is included by default, and the other one is purchased separately. It is assumed that the application is packaged appropriately (see "Packaging Applications with Upsell Services" in APS Package Developer's Guide) and the name of the application service, as specified in the metadata, is "Service Package". Before you test upsell services of the Application, you will have to prepare it for provisioning and then install in on the Customer's end as follows: 1 Import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 2 Create a Resource Type based on 'Application' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) and define the following settings: 2.1 Open Activation Parameters tab of the Resource Type and then open Services sub-tab. 2.2 Click Edit link against 'Service Package'. 2.3 Check Autoprovisioning and click Submit button to confirm changes. 3 Create two Resource Types based on 'Application Service' Resource Class: Basic and Gold feature sets: 3.1 Go to Service Director > Application Manager > Applications. 3.2 Click the link of the required Application and open Resource Types tab. 3.3 Click Create button to add a new Resource Type. 3.4 Click Application Service link. 3.5 Complete Name and Description (optional) fields as required. 3.6 Click the application service which will be associated with this Resource Type and click Next button to proceed to the list of settings. 3.7 To match a Resource Type with a specific application edition, enter the following setting values. For Basic Resource Type enter Basic. For Gold Resource Type enter Gold. 3.8 Click Next button to proceed to the settings summary. 3.8 Review all settings and click Finish button.

23 Application Testing 23 4 Include the three above Resource Types into a new Service Template and put 1 for each Resource Limit (see Creating a Service Template ("Testing in Parallels Automation" on page 6)). 5 Create a Service Plan and define resource usage limits. "Basic" edition should install with the application by default, while "Gold" edition should be purchased separately. To define these terms, set up a Service Plan as follows. Note: It is not possible to purchase resources that are not added to some resource category in POA PBA. 5.1 Log in to POA PBA by clicking the Billing icon in the upper-right corner of the page. 5.2 Go to Product Director > Resource Manager > Resource Categories and click Add New Resource Category button. 5.3 Enter Application with Upsell Services in the Name field and then click Add button. 5.4 Find the created category in the list of categories and click the link with its name. 5.5 Open the Resources tab of the category and click Add New Resource to Category button. 5.6 Select the check boxes of the three Resources of your application and then click Add Selected Resource(s) button. 5.7 Go to Product Director > Plan Manager > Service Plans and click Add New Service Plan button. 5.8 Complete the required fields as follows: Name: Application with Upsell Services. Service Template: Service Template created in step 4 above (use magnifier icon on the right to display a list of available Service Templates). Short Description: enter Automatically provision application. Long Description: enter Automatically provision application. Billing Period: enter 1. Click Next button to proceed to the fees page. 5.9 Check 1 year(s) and click Next button to proceed to the settings summary Click Setup Plan Rates button. A table of resources and fees will be displayed Check Basic and Gold editions and complete usage limits as follows: Basic: 1 Inc.Units and 1 Max Units Gold: 0 Inc. Units and 1 Max Units Inc. Units value shows the number of service instances provisioned in the subscription by default, whereas Max Units shows the number of Services which may be purchased additionally Click Finish button Click the link of the newly created Service Plan and open Resource Rates tab to display the included Resource Rates Click Gold in to select the Resource Rate Click Edit button to edit the Resource Rate.

24 24 APS Package Certification Guide Application Packaging Standard 5.16 Check Show in CP box to display this Resource in POA CCP Click Save button to save changes. 6 Subscribe a Customer to your Application (see Creating a Subscription ("Testing in Parallels Automation" on page 6)). 7 In POA CCP Activate "Basic" edition to later upgrade it to Gold. 7.1 Go to the application page and open Service Package tab. Note: The tab title may be different and matches that specified in APS Package. 7.2 Click Activate link. You will see that only Basic is available for activation, while Gold is disabled (marked as Limit reached). 7.3 Click Next button to proceed. 7.4 Click Finish button to activate "Basic" edition. 7.5 Go to Analysis and Statistics > Resource Usage in the navigation bar on the left. Ensure that Usage value for Basic has increased by 1. 8 Order "Gold" resource. 8.1 Click Billing link in the top menu bar. 8.2 Click Buy Additional Resource icon. 8.3 Select the Subscription where you want a new resource to be activated. It has to be the same Subscription where you have already installed the application. 8.4 You will see a list containing only one resource. Click Upgrade link on the right. 8.5 Click Next button to proceed. 8.6 Click Place Order button. 9 Activate "Gold" edition. 9.1 Click Hosting in the top menu to return to your Subscription. 9.2 Go to the application page and open Service Package tab. 9.3 Click Change link to switch edition. Gold is now available for activation. 9.4 Select Gold and click Next button to proceed. 9.5 Click Finish button to activate "Gold" edition. 10 Go to Analysis and Statistics > Resource Usage in the navigation bar on the left. Ensure that Usage value for Gold has increased by Open Applications and login to the Application instance. "Gold" edition should now be enabled in the Application.

25 Application Testing 25 License Integration Testing To test that a license key is delivered for your application, you will have to perform the following steps in Parallels Business Automation (PBA). The license integration testing consists of several stages. Follow the instructions observing the order of the stages below. Preparing Application for Provisioning Adding License Resources Installing the Application Purchasing a New License and Installing it into the Application Parallels Plesk Panel requires that APS license type is declared in the following format: urn:pla:<product-alias>:<license-version> To have a license key automatically delivered to the application (if such is allowed by the application itself), the APS Package should include the following requirement, where: 1 <product-alias>: an alphanumeric string allowing dashes. Example: pinnacle-cart. 2 <license-version>: a three-digit version in a dotted format, where second and third digits are optional. Examples: or 9.12 or 9. If a package allows for automatic delivery of a license key you should also to be processed by the Key Administrator and For applications with automatic delivery of a license key, the APS package should contain a type attribute should be presented in the following. Preparing Application for Provisioning Before you define licensing terms for application features, perform the following steps. 1 Ensure that your license service is integrated in PKA. 2 Check that license class and features of your application are created in PBA. To verify this, perform the following steps: Find API constants for your license and features in Key Administrator Remote API Guide (see Additional Keytypes section). In PBA PCP go to External Services Director > License Manager > License Classes. A list of available license classes will be displayed. Find the License Class with a class identifier matching API constant of your license. Open Features tab of the License Class and check that it contains all required Features with identifiers matching API constants of your features.

26 26 APS Package Certification Guide Application Packaging Standard 3 Import the Application (see Importing an Application ("Testing in Parallels Automation" on page 6)). 4 Create a Resource Type based on 'Application' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)). 5 Include the Resource Type into a new Service Template and put 2 for each Resource Limit (see Creating a Service Template ("Testing in Parallels Automation" on page 6)). 6 Create a new Service Plan (see Creating a New Service Plan ("Testing in Parallels Automation" on page 6)). 7 Create a new Customer for whom you wish to subscribe to your Application (see Setting Up a Customer Account ("Testing in Parallels Automation" on page 6)). 8 Subscribe a Customer to your Application (see Subscribing a Customer ("Testing Applications with Upsell Services" on page 22)). Adding License Resources, configuring Licenses and Features A service plan requires at least two resources: a License Resource and a Feature Resource. 1 Go to Product Director > Resource Manager > Resources. A list of available Resources will display. 2 Click Add New Resource button to add a new License Resource. 3 Define the settings as follows: Enter the resource name in Name field. Enter description in Description field. Click magnifier icon next to Resource Category and select Additional Resources in the list of available Resource categories. Click magnifier icon next to Units of measure field and select Items in the list of available Resources. Select License Management in Service Gate drop-down box. Check External System option. Enter the license class of your application in Command field. 4 Click Save button to confirm changes. A new license resource will appear in the list of Resources. 5 Click Add New Resource button to add a new Feature Resource. 6 Define the settings as follows: Enter the resource name in Name field. Enter description in Description field. Click magnifier icon next to Units of measure field and select Boolean in the list of available Resources. Select License Management in Service Gate drop-down box. Check External System option.

27 Application Testing 27 In Command field enter the License Class defined for your Feature. 7 Click Save button to confirm changes. A new feature resource will appear in the list of Resources. 8 Select the Feature Resource created on step 7 above by clicking the respective link. 9 Open Depends on tab and click Add New Dependent Resource button. 10 Click magnifier icon next to Resource field and select the License Resource created on step 4 above. 11 Click Save button to confirm settings. 12 Go to External Systems Director > License Manager > License Classes. A list of available license classes will display. 13 Open the license class of your application by clicking the respective link and click Edit button to change settings. 14 Enter the APS license type defined license requirements of your package. 15 In POA PCP go to Product Director > Plan Manager > Service Plans. 16 Select the service plan created above by clicking the respective link and open Resource Rates tab. 17 Click Configure Licences/Features button. A list of resources is displayed. 18 Select the license resource created above by clicking the respective link (use filter bar above to search by the license resource properties). The list of licenses and features included in the selected resource class is displayed. 19 Check license and feature resources that you want to add to the service plan. 20 Click Add Resource Rate(s) button to confirm. Installing the Application 1. Install the Application as described in Installing the Application ("Testing in Parallels Automation" on page 6). 2. Go to POA CCP and on the General tab of the application check that entry points are substituted by License required, which means that you have to install a license to make the entry points available.

28 28 APS Package Certification Guide Application Packaging Standard Purchasing a New License and Installing It into the Application At this point you have all set to buy a license. To do so, perform the following steps. 1 In PBA go to Product Director > Plan Manager > Service Plans. A list of available service plans will display. 2 Open Subscription tab and select the required subscription by clicking respective link. 3 Open Licenses tab and click Buy New License button. 4 Select a service plan and click Next button. 5 Review the order details and click Place Order to confirm. Important: Make sure that the order has Complete status (it may take a few minutes). Otherwise, contact APS Support for assistance. 6 Login to POA CCP by following steps 1-4 in Installing the Application above. 7 Click Applications in the navigation bar on the left and then select the Application by clicking the respective link. 8 Go to POA PCP and on the General tab of the application check that the entry points are displayed. Then login to the Application to verify that the license key has been actually installed. Monitoring Application Resource Usage POA offers monitoring facilities making it possible to view the current use of resources for each application. To make this information available for customers, you will have to define appropriate Application resource, its limiting setting and configure POA respectfully. To enable monitoring of application resources, perform the following steps (it is assumed that you have created a Subscription and installed an application under it). Creating Resource Types for Application Resources Create Resource Types based on 'Application Resource' Class. 1. Go to Service Director > Application Manager > Applications. 2. Click the Application for which you wish to monitor Resources. 3. Open Resource Types tab and click Create button. 4. In the list of Resource Classes select one of Application Resource classes. 5. Enter Name and Description for new Resource Type, click Next. List of Application Resources available for selected Resource Class will display. 6. Click the Resource which you want to Create a Resource Type for. Resource Type summary will display. 7. Click Finish button to confirm.

29 Application Testing 29 Repeat steps 3-7 for each Resource included in the Application. Adding the Application Resources to the Subscription Add Application Resources to the Service Template. To do so, perform the following steps: 1. Go to Service Director > Provisioning Manager > Service Templates. 2. Locate the Service Template on which your Subscription is based and click the respective link. 3. Click Deactivate link. 4. Open Resources tab to view the list of Resources already included in the Service Template. 5. Click Add resources button to add new Resources. 6. Select resources you created above and check Unlimited option against each one. 7. Click Submit button to confirm. 8. Go to General tab and reactivate the Service Template by clicking Activate link. 9. Click Apply Template limits link to force update of Resources in Subscriptions. Verifying Resource Counters In POA CCP open the subscription with the application, go to Hosting > Configuration & Administration > Statistics & Analysis > Resource Usage. The initial values in Usage and Available fields will change for each time when Resource usage is gathered or resource limit is changed. Limit value is updated when new amount of resource is purchased. Usage value is updated asynchronously by running a periodic task. To update usage values instantly, you have to run this task manually: 1. In POA PCP go to System Director > Task Manager and open Periodic tab to view a list of available periodic tasks. 2. In the filter bar above enter *APS* in the Name field to locate the required task and in the displayed sampling click Synchronize resource usage for instances of APS applications task. 3. Click Run Task button. You will be prompted to select the time for the task execution. 4. Leave Now option checked and click Submit button to confirm. 5. When the task is executed successfully, return to POA CCP and view Resource Usage as described above.

30 30 APS Package Certification Guide Application Packaging Standard Verifying Reset of Additive Resource If resource has one of additive resource classes Application Resource (*-hours), its usage is reset at the end of subscription period. Application should report usage from the date of its installation, regardless of the reset fact, thus you can omit testing of resource reset in PA. However, if you want to check reset of additive resource, you should wait for PBA to charge customer for subscription resources and to reset them. It's impossible to force this procedure, but you can configure a service plan for PBA to charge customer in next 24 hours. You have to do the next steps for it: 1. In PBA PCP, create new Statement Cycle which would charge customer on Fixed Day of Month and select Day of Statement as next day from today. 2. Create new Customer Class and select the Statement Cycle at its one. 3. Change Customer Class of your Service Plan on the created one. 4. Create subscription of the Service Plan and run task to gather resources in POA (to get non-zero value in usage). 5. Wait until next day (defined in Statement Cycle you have created at step1). 6. Check the usage of resource is reset and order for its last usage has been created in PBA.

31 Application Testing 31 Testing Usage Limits of Service Resources Some applications may include sub-services with countable resources (such as disk space for mailboxes). These resources are defined in the APS Package and each may be parameterized to set up a usage limit for per each instance of sub-service. It means that the total amount of the resource used by all instances of sub-service cannot exceed resource limit defined in subscription. Usage of such resource is collected per each instance of sub-service and summarized in usage of correspondent POA resource (see Statistic&Usage in POA CCP). The following scenario showcases an application with a 2nd level sub-service with a resource and visible setting which defines usage limit for the resource. 1 Prepare an APS Package for an application with at least one child service, a resource included into it and its limiting setting (see APS Cloud Mail application as an example). 2 In POA PCP import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 3 Create a Resource Type based on Application Resource Class for the application. Name this Resource Type as Mail Application. 4 Create a Resource Type based on Application Resource Resource Class for the child service. Name this Resource Type as Mailbox Disk Space. 5 Include both Resource Types into a new Service Template, see Creating a Service Template ("Testing in Parallels Automation" on page 6), and set the following usage limits: Mail Application: 1 (or more) Mailbox Disk Space: Kb 6 Subscribe a Customer to your application, see Creating a Subscription ("Testing in Parallels Automation" on page 6). 7 Go to POA CCP and install the application. 8 Create 1st instance of sub-service (mailbox) and with 7000 Kb size limit. 9 Try to create 2nd instance of sub-service (mailbox) and with 5000 Kb size limit. 10 Check that you get error message that the resource limit has been reached for Mailbox Disk Space resource. That is the aggregated size of both mailboxes (12000 Kb) exceeds limits that specified in the subscription (see step 5). Note: currently resources can be defined for APS services of 2nd level only.

32 32 APS Package Certification Guide Application Packaging Standard Testing of Table Settings To test the table settings, perform the following actions: 1 Prepare an APS Package for an application with setting group with class= table (see Integrating Applications with Parallels Panels via APS /index.htm?filename=58169.htm). 2 In POA PCP import the Application as described in Importing an Application ("Testing in Parallels Automation" on page 6). 3 Create a Resource Type based on 'Application' Resource Class (see Adding a Resource Type ("Testing in Parallels Automation" on page 6)) for the application. Give this Resource Type a meaningful name, e.g. PBX Application. 4 Subscribe a Customer to your application (see Creating a Subscription ("Testing in Parallels Automation" on page 6)). 5 Go to POA CCP and install the application. 6 Check that the setting group is displayed as table with min-items (and max-items ) number of rows and setting names are captions of table columns. Also check that the default settings are set correctly.

33 Application Testing 33 Cross-Service Integration Testing Some Applications may feature integration between services defined in the APS Package. It allows an application service to use settings of another one which is not its direct parent but a service from different branch of service hierarchy of application. To be certain, we will refer to first service, which needs another one, as a dependent service and to the second service, which settings are needed, as a required service. APS Service Aspect describes this type of integration. It's assumed what there's an APS package which declares such integration between dependent and required services. To test it, the following steps have to be done: 1 Create at least one instance of required service (1st) in subscription with application in CCP, see Installing the Application ("Testing in Parallels Automation" on page 6). 2 Open tab with dependent service, click Add New button to create new instance. 3 Select resource type and sub-services (if required) for the instance, click Next. 4 Screen with selection of required service instance is displayed. 5 Check that a bullet list with at least two options is displayed: a) use existing <required service name>, b) add new <required service name>. 6 If application declares name of relation in metadata (see APS Service Aspect), check that this name is displayed in both options above instead of <required service name>. 7 Choose option b) to create new required service instance. 8 Screen for creation of new instance is displayed for required service. 9 Choose resource type, enter settings for the required service and click Next. 10 Screen for configuration (settings) of dependent service instance is displayed. 11 Enter settings for dependent service and click Next, then click Finish. 12 POA schedules tasks for creation of both dependent and required service (2nd) instances. Check that they have been created successfully. 13 Open dependent service instance and check that it has link to the required one (see a <required service name> label). 14 Click on the link and check that proper required service (the 2nd one) instance is opened.

34 34 APS Package Certification Guide Application Packaging Standard Troubleshooting If you encounter any errors upon import of an APS package or during provisioning, this chapter will help you to find a suitable solution. Importing of APS Packages The application shows no details on General tab, the icon associated with the application is missing in the list of installed applications in POA PCP (Service Director > Application Manager > Applications) and either message displays: Importing error or Application importing is in progress. Solution 1 In PCP go to Service Director > Task Manager. 2 Use the filter bar above to search for the task by the Application ID or Failed status (if the task has been failed due to an error in metadata, you may search the task using a wildcards e.g. *NNNN*, where NNNN is the instance ID). 3 Click the task link to view the error cause. 4 Click Cancel Task button, if the APS package shows as invalid in the task description, then fix the APS package and import it again. Otherwise, if the error is caused by a failed network connection, click Run Task button to rerun the task, once the connection is established or recovered. Note: Take caution when cancelling tasks. Cancel Failed tasks only. Any other related tasks, such as Finalizing operation..., are required to complete the operation with system database records and file system (e.g. to clear application record from DB on application removal). These tasks will be processed as soon as the blocking task that blocks them is cancelled.

35 Application Testing 35 Provisioning of an Application An application instance displays with a status marked yellow in POA PCP (e.g. Provisioning, Configuring Service, etc.) Solution 1 Login to CCP and click the link associated with your application to make record of the instance ID. 2 In POA PCP Go to System Director > Task Manager. A list of unfinished tasks will display. Select the failed task to view its details by clicking respective link. To locate the task, use filtering by instance ID found in step 1 above. Wildcards are accepted, e.g. *NNNN* in Name field, where NNNN is the instance ID. 1 View the script output in Last execution output to find the error. 2 Click Cancel task button to cancel the task. Note: Take caution when cancelling tasks. Cancel Failed tasks only. Any other related tasks, such as Finalizing operation..., are required to complete the operation with system database records and file system. These tasks will be processed as soon as the blocking task that blocks them is cancelled. 3 Uninstall the application in CCP. Note: In some cases an application may fail to uninstall. To proceed with uninstallation, you will have to cancel the failed task again.

36 36 APS Package Certification Guide Application Packaging Standard 4 Fix the errors inside the script holding the application from being successfully provisioned and import the revised APS package with an increased release number. 5 Install the application. Debugging of APS Configuration Scripts An application instance provisioning resulted in failed task with a non-descriptive or empty error message. Solution To debug a task associated with an application which has External System provisioning type, perform the following steps: 1 Go to Service Director > Application Manager > Applications. A list of imported applications will display. 2 Select the required application by clicking the respective link. 3 Open Instances tab and make record of the provisioning gateway in Hardware Host field for the required instance. 4 Login to provisioning gateway of the application instance with SSH (contact APS Support to request credentials). 5 Execute cd /usr/local/pem/aps/instances/<instance ID> (where instance ID is the ID of the application instance). 6 Modify and execute runner.sh to debug the task. 7 Once done with debugging, follow the steps suggested in Provisioning of an Application above. To debug a task associated with an application which has Shared Web Server provisioning type, perform the following steps: 1 In CCP find the Instance ID of the failed application. 2 Go to POA PCP go to System Director > Task Manager and cancel the failed task associated with your application by checking it and clicking Cancel Tasks button. Note: Take caution when cancelling tasks. Cancel Failed tasks only. Any other related tasks, such as Finalizing operation..., are required to complete the operation with DB records and file system. These tasks will be processed as soon as the blocking task that blocks them is cancelled.

37 Application Testing 37 3 In PCP go to Service Director > Applications Manager > Applications. 4 Go to Instances tab to get the Webspace ID. 5 Click Hosting CP icon at the top right of the page to go to CPP. 6 In CCP click Webspace > Webspaces. 7 Use the Webspace ID to find the webspace of the application instance. 8 Click Select to change settings of this specific Webspace. 9 Go to Webspaces > WebSite Configuration. 10 Click Edit button. 11 Under SSH Access Configuration check Enable SSH connections to this webspace. 12 Provide SSH credentials by entering user name in Login field and password in Password and Confirm Password fields. 13 Click Submit to confirm settings. 14 Login with SSH. Execute cd /webspace/siteapps/<instance ID> (where instance ID is the ID of the application instance). 15 Once done with debugging, rebuild the APS package with an increased release number. 16 Follow the steps suggested in Provisioning of an Application above. Debugging of APS Resource Scripts Usage of APS resource is not updated or not collected at all. Solution 1 Check that subscription has resource type of class Application Resource. If not, resource script is not called. 2 Go to POA PCP go to System Director > Task Manager and check that 'Synchronize resource usage for instances of APS applications' task has finished successfully. 3 Check that resource script prints out only XML and no plain text debug output goes to stdout. To execute resource script, do the following: 1 Login to provisioning gateway of the application instance with SSH (see Debugging of APS Configuration Scripts above), 2 Go to /usr/local/pem/aps/scripts/<application ID>/<APS package version>/ folder, where application ID is ID of application from Service Director > Application Manager > Applications. 3 You will see r*.sh files which were executed by previous run of 'Synchronize resource usage for instances of APS applications' task. 4 Execute necessary file, for example bash r24063_ sh.

38 38 APS Package Certification Guide Application Packaging Standard Testing in Parallels Plesk Panel Importing an Application To test APS package in Parallels Plesk Panel (PPP) you need to do: 1 Download PPP from Parallels website 2 Download development license from Parallels Technology Network 3 Install APS package from Applications & Scripts. To facilitate license delivery for an application, the 4 Check that all application entry points work properly. To do so, log in to the application management interface by clicking the associated icon that will appear in the user's Panel (on My Services tab) or by visiting the URL shown on the same page. 5 Uninstall APS application from Applications & Scripts. Note: For applications requiring a user to accept a license, add a respective license type in the APS package (see Plesk-specific classes in Integrating Applications with Parallels Panels via APS). Otherwise a license will not be issued to a user. For an application requiring a license, the APS package must contain a specific license attribute containing information on the product and version. For more information see License Integration Testing (on page 25). For more details on working with APS applications in PPP, use online help or Parallels Plesk Panel Administrator's Guide Debug Tips Parallels Plesk can log valuable information during the installation process of an APS package. The following steps can enable this logging. Create /usr/local/psa/admin/conf/panel.ini file if it does not exist with the following two lines: [log] priority=7 Check log messages in /usr/local/psa/admin/logs/panel.log. This log file can be examined to view the calls being made to the APS package and variables being used. If the package is integrated with Parallels Key Administrator, the calls to the license provisioning script will also execute with debug output during testing. To alter the buy now links inside Plesk: [marketplace]

39 Application Testing 39 buynow = " " To change the APS catalog a Parallels Plesk box queries: [aps] catalogurl = "

40 C H A P T E R 3 APS Package Certification In addition to tests in PPP and POA, an APS package may be certified in APS Certification System which offers automated testing of multiple integration scenarios: Compliance with APS Package Specification. Compliance with APS Application Certification Criteria Access to application controls and components. These tests are performed for each entry point to make sure that they refer to relevant parts of the application. APS Package certification is required to have the application published in APS Catalog. To get access to APS Certification System, please, contact APS Support.

41 APS Package Certification 41 Certification Workflow From the ISV's perspective, APS certification workflow comprises the following steps: 1 Contact APS to get credentials to APS Certification System. Select Testing and Certification as the topic subject. In a few hours you will receive an containing credentials. 2 Use credentials obtained from APS to login to APS Certification System and upload an APS Package. The package will be submitted to certification test automatically. Once the test is finished, you will receive an message containing test results. 3 In case of errors, examine log/screenshots and return to step 2 above to re-upload the fixed APS package. 4 Submit a certification request Make sure to provide detailed information on the package. In response to your request, you will receive an containing a ticket ID. Refer to this ID in all communications regarding this request. 5 APS experts manually verify the APS package to comply with specific certification criteria (see APS Certification Criteria). When an APS package meets certification criteria, it will be granted a respective certification level. You may also request to have the APS package published in the APS Catalog to make it available for HSP's. If either required criterion is not satisfied or missing, you will be notified on that. These above steps are summarized in the following diagram.

42 42 APS Package Certification Guide Application Packaging Standard

43 APS Package Certification 43 An APS certificate is valid only for a specific version of the APS package. Each time a newer version is released, the APS package must pass steps 2-6 of the certification again. Uploading and Testing APS Packages Prior to running tests over an APS Package it has to be uploaded. To upload an APS package, it has to include the name of the Packager you are allowed to represent (see Software Packager Information in APS Package Specification Note: APS Certification System performs automatic application testing in POA panel with Apache and IIS hosting. Automatic tests are incomplete without application's own Selenium IDE test script. Information on how to create such a script see in article To test an APS Package, perform the following steps: 1 Login into APS Certification System. 2 Click Upload new package button. 3 Select APS package file, leave empty Commercial name field, then click Upload button. If the APS package is valid, certification tests will be scheduled. If the APS Package is not valid, an error message will display and the package will not be uploaded. Note: You cannot upload an APS package with the same name, version and release twice. To certify newer version of package it s recommended a version/release number has to be increased. 4 When the test is complete, you will see Finished in the Status field, and the page will display the detailed results for each test (see Viewing Test Results (on page 44)). Note: Depending on the APS package size and system load, it may take up to 2 hours to finish all tests. You will be notified with upon completion.

44 44 APS Package Certification Guide Application Packaging Standard Viewing Test Results Application test results are presented in different sections, which will be described in details below. The information in the left part of the page refers to APS package properties and remains static, except the APS package status which is set by the administrator based on the test results. Test results are displayed in the right part of the page under Validation Report and Test Report. Validation Report This section shows how the APS Package meets APS Certification Criteria. Based on these results, the application receives a certification level. This is the highest level which may be decreased after automatic or, optionally, manual tests.