aps format 1.2 packaging guide

7/22/2019 Aps Format 1.2 Packaging Guide

1/62

pplication Packaging Standard

Application Packaging

Developer's Guide

Revision 1.0.19

Copyright 1999-2011 by Parallels Holdings Ltd. and its affiliates. All rightsreserved.


2/62

2

Contents

Introduction 4About Application Packaging Standard ........................................................... ............................................. 4About This Guide ................................................................................. ........................................................ 4Useful Links .................................................................................................... ............................................. 5Typographical Conventions .................................................................. ........................................................ 6Feedback .............................................................. .................................................................. ....................... 6

Packaging Instruction 7Instruction ............................................................ ................................................................... ...................... 7

1. Define type of an environment where the application is to be provisioned................................... 72. Define a model of service provisioning....................... ................................................................. . 83. Define application structure. ................................................. ........................................................ 84. Define application services hierarchy. ............ ................................................................. ............. 85. Define an application licensing procedure. ...................................... ............................................. 96. Define technologies used by your application. ................................................................. ............. 97. Define presentation details and settings for application and its services. ...................................... 98. Define application content delivery method. ........................................................... .................... 109. Create a draft of metadata file. ......................................................... ........................................... 1010. Prepare scripts. ............................................................................... ........................................... 1011. Prepare package contents listing. ........................................................................ ...................... 1212. Create an application package structure. ................................................................................... 1213. Archive the application package files. ................................................................. ...................... 1214. Validate the application package. ............................................................... ............................... 13

Packaging Scenarios 14Packaging WordPress Application ......................................................................................... .................... 15Packaging SugarCRM Application ............................................................................. ............................... 18Packaging Open-Xchange Application........................................................................ ............................... 22Packaging German Translation Add-on for WordPress ............................................................................ 26Packaging SpamExperts Incoming Email Security Firewall Application .................................................. 28Packaging Applications with Upsell Services ............................................................. ............................... 30

Validating Application Package 31

APSLint Utility ............................................................... ................................................................. ........... 32Managing APSLint for Windows ......................................................... ........................................... 32Managing APSLint for Linux/Unix .......................................... ...................................................... 33

Controller Operations on Packages ............................................................................................................ 34Creating Application Instance ..................................................................................... .................... 35Updating Application Instance ........................................................................................................ 35Removing Application Instance .............................................................................................. ........ 36


3/62

Introduction 3

WordPress Translation Sample Metadata File 37Sample Environment Variables .............................................................................................. .................... 39

SugarCRM Sample Metadata File 41Sample Environment Variables .............................................................................................. .................... 47

Open-Xchange Sample Metadata File 49Sample Environment Variables .............................................................................................. .................... 53

WordPress German Translation Add-on Sample Metadata File 55Sample Environment Variables .............................................................................................. .................... 56

SpamExperts Incoming Email Security Firewall Sample Metadata File 57Sample Environment Variables .............................................................................................. .................... 60

APS Application Categories 61


4/62

4

This guide is aimed to help you implement Software-as-a-Service (SaaS) business model foryour applications. Here in this manual you will find scenarios showcasing structure andmethods of handling typical applications according to Application Packaging Standard.

About Application Packaging Standard

With the increased in development and the need to comply with integration requirements,hosting providers tend to offer a limited variety of hosted applications. As a result,independent software vendors have little incentive to create hosted applications that theycannot sell, and customers suffer from limited application choices.

In response to this, Application Packaging Standard (APS) was developed. It is an openformat of packaging and managing web applications that will make it easier for the wholehosting industry to take advantage of the expanding Software-as-a-Service(SaaS) market.

By defining such open format, APS increases business opportunities for the entire hostingecosystem bringing together application vendors and hosting service providers. Byimplementing APS, application vendors take advantage of sales and marketing channels

available through APS-enabled hosting providers. Hosting service providers, in turn, gainaccess to a great variety of APS applications and render added value for their subscribers.

About This Guide

The purpose of this document is to provide web application developers and applicationdistributors with recommendations for creating application packages in accordance with theApplication Packaging Standard. The guide includes:

Packaging Instruction section provides step-by-step packaging instruction.

Packaging Scenarios section ("Packaging Scenarios" on page 14) contains examples ofpackaging real applications.

Validating Application Package section ("Validating Application Package"on page31)providesinformation on validation tool (APSLint utility) and possible operations performed overapplication package by Controller.

Appendices ("Open-Xchange Sample Metadata File" on page 49) with metadata files ofapplication described in Packaging Scenariossection.

CH A P T E R 1

Introduction


5/62

Introduction 5

Abbreviations, Definitions and Conventions

APS is used instead of Application Packaging Standard in some long sentences whereusing it will not change the meaning of the sentence.

Web siteis a collection of web pages, typically common to a particular domain name or

sub-domain on the World Wide Web on the Internet.

Control panel or CP is hosting provider software designed for managing user accounts,web sites and site applications.

Site application or application is a Web application that can be hosted on a web site.

Application Package or Package is a site application in its distribution format whichincludes all application and application-related files created, structured and packedaccording to the APS.

Application Instance is a site application installed from application package on aparticular web site and accessible via a unique URL.

Controller is APS engine, a control panel part responsible for processing applicationpackages and instances.

Aspect is an additional specification that declares how to describe in the applicationpackage metadata: file technologies used by an application, application managementscripts, and how these descriptions must be processed by Controllers. The technologiesinclude any software or executable code.

Qualified technology means any software or executable code described in an aspectincluded in theAPS: Package Format Specification.

XPathnotation is used to describe the structure of XML documents, and to refer to XMLelements and attributes in the text.

APS: Package Format Specificationis referred to as the Specification.

Useful Links

Official APS site. Latest news and relevant information on Application Packaging Standarddevelopment.

APS: Package Format Specification

XML Technologies:

XPath Homepage

RELAX NG Compact Syntax Tutorial
http://www.apsstandard.com/http://www.apsstandard.com/http://www.apsstandard.com/r/doc/package-format-specification/index.htmlhttp://www.apsstandard.com/r/doc/package-format-specification/index.htmlhttp://www.w3schools.com/xpath/default.asphttp://www.w3schools.com/xpath/default.asphttp://www.relaxng.org/compact-tutorial-20030326.htmlhttp://www.relaxng.org/compact-tutorial-20030326.htmlhttp://www.relaxng.org/compact-tutorial-20030326.htmlhttp://www.w3schools.com/xpath/default.asphttp://www.apsstandard.com/r/doc/package-format-specification/index.htmlhttp://www.apsstandard.com/


6/62

Introduction 6

Typographical Conventions

Before you start using this guide, it is important to understand the documentationconventions used in it.

The following kinds of formatting in the text identify special information.

Formatting convention Type of Information Example

Special Bold Items you must select, such asmenu options, command buttons,or items in a list.

Go to the Systemtab.

Titles of chapters, sections, andsubsections.

Read the Basic Administration

chapter.

Italics Used to emphasize theimportance of a point, tointroduce a term or to designate acommand line placeholder, whichis to be replaced with a real nameor value.

The system supports the socalled wildcard charactersearch.

Monospace The names of commands, files,and directories.

The license file is located inthehttp://docs/common/li

censesdirectory.

Preformatted On-screen computer output inyour command-line sessions;source code in XML, C++, orother programming languages.

# lsal /filestotal 14470

Preformatted BoldWhat you type, contrasted withon-screen computer output.

# cd /root/rpms/php

CAPITALS Names of keys on the keyboard. SHIFT, CTRL, ALT

KEY+KEY Key combinations for which theuser must press and hold downone key and then press another.

CTRL+P, ALT+F4

Feedback

If you have found a mistake in this guide, or if you have suggestions or ideas on how toimprove this guide, please send your feedback using theonline form.Please include in yourreport the guide's title, chapter and section titles, and the fragment of text in which you havefound an error.
http://docs/common/licenseshttp://docs/common/licenseshttp://docs/common/licenseshttp://www.parallels.com/en/support/usersdoc/http://www.parallels.com/en/support/usersdoc/http://www.parallels.com/en/support/usersdoc/http://www.parallels.com/en/support/usersdoc/http://docs/common/licenseshttp://docs/common/licenses


7/62

7

Application Packaging Standard defines the packages structure and rules of packagesprocessing. Package is a file that contains an application files and metadata required tocreate and manage instances of the application.

Package contains essential information that uniquely identifies each package among othersof the same application. Namely, it is application version, package release and packager'ssignature. For example, if packager changes something in application metadata or inapplication files, it must be reflected in metadata and signing data. This ensures packageconsistency and integrity.

Instruction

To create and test an application package in compliance with APS, perform the followingsteps:

Note:it is intended that you already have a working application.

1. Define type of an environment where the application is to beprovisioned.

Application may dictate type of environment the Controller should provision it to in clear. Onthe other hand, the Controller may select an environment basing on application serviceshardware and software requirements. One may single out the following types of hostingenvironment:

Shared environment - hosting environment is shared by instances of an application(multi-instance application);

Dedicated environment- application states that only one instance can be ran in a hosting

environment (single-instance application);

External environment - hosting environment that is not managed by Controller, andapplication provisioning, in this case, is delegated to configuration script.

CH A P T E R 2

Packaging Instruction


8/62

Packaging Instruction 8

2. Define a model of service provisioning.

Selecting the provisioning model application vendor should consider the level of application

management by Controller and application services hierarchy. Namely, one should correctlymap application services on application. One may single out the following models of serviceprovisioning:

Multi-tenant- this model implies that a single instance of the application runs on hostingvendor servers, serving multiple client organizations (tenants). Tenants data andapplication configuration are stored separately. When a tenant logs in, an applicationinstance respective configuration (customization) is applied and each tenant sees andmanages only his data as if he is an application single user. So, in this model, applicationcontext is already exists in hosting environment and customers' data is stored within itseparately.

Single-tenant - this model implies that an application instance run on hosting vendor

servers, serving only one tenant. In other words, a separate application instance isprovisioned for each customer. Application files are simply copied to location dedicated tocustomer and data of all customer applications is stored within customer.

Note:both models can be implemented for shared environment and for dedicated one aswell.

3. Define application structure.

An application may comprise main module and additional ones. The main module representscore functions, whereas additional modules provide extra services. For example, a contentmanagement application may come as a main module, and the skins or localizations may beoffered as add-ons.

If your application has such additional modules, consider packaging them individually like ageneral package with dependency to their main module. In other words, metadata ofpackaged add-ons must reference to their master package, so the Controller could checkwhether the package is really an additional module to an application installed in hostingenvironment and its version meets condition (if any) in add-on's metadata file.

For details on packaging add-ons, refer to the 5.1.5. Master package reference section of theSpecification.

4. Define application services hierarchy.

In general, an application purpose is to provide services to end-users. Application serviceshierarchy should reflect order of application services provisioning and level of applicationservices management by Controller.

For example, let's consider multi-tenant application. The top-level application servicerepresents a tenant. Under top-level service an application context is declared (second-levelservice) that is provisioned inside of the tenant. Then one may declare a number ofapplication features (third-level services). Another way is to declare users and specify

features for a user.


9/62


5. Define an application licensing procedure.

APS supports licensing applications by means of license keys. Each application instance or

service may require license keys. To get keys, a well-formed license request should be sendto respective authority. After the license is issued it is installed to the application.

If your application requires license to be installed, you should specify this in its metadata file.A special script should perform all involved operations, like querying application, installingand removing license.

For details on license requirement declaration, refer to the APS Licensing Aspectdocument.

6. Define technologies used by your application.

Your application may utilize various scripting languages, specific server modules, databases,mailboxes, DNS records in application domain and the like. Application technologies form thelist of requirements to be satisfied to provision application. In general, requirements usuallyrequest some resource to be allocated or specific configuration to be performed.

A Controller can handle these requirements as qualified technologiessoftware, resources(e.g. databases, mailboxes or DNS records) or executable code described in the aspectincluded in the Specification. For details on aspects that describe qualified technologies,refer to the 8. Common aspectssection of the Specification.

Note: If the application uses non-qualified technologies, write an aspect for each suchtechnology and make it public. You may then submit a request to extend the Specification(recommended scenario), or otherwise include the information into the package releasenotes. This will help control panel developers to configure Controllers to provision thepackage properly. For details on what data should be included in an aspect, refer to the7.Points of Extensibilitysection of the Specification.

Tip: For common understanding, please, use the terms given in the Specification.

7. Define presentation details and settings for application and itsservices.

Your package metadata may include details and settings of the application interface. If anapplication is multi-tenant, for example, it should meet requirements of a number of tenantsthat use this application for absolutely different purposes. In other words, the more settingsyou declare for an application, the more flexible it becomes. This way you may set upautomated generation of setting values ensuring their uniqueness within the required scope.Some settings may be prefilled automatically with a Customer's login, password, email ordomain of the application without requesting the data from end-user. For details, refer to the5.1 Common Application Properties, 5.2 Services and 5.2.5 Service Settings sections of theSpecification.

Tip: For common understanding, please, use the terms given in the Specification.
http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/feedback/http://www.apsstandard.org/feedback/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/feedback/http://www.apsstandard.org/isv/documentation/


10/62


8. Define application content delivery method.

Content delivery method defines the way application files are deployed to hosting

environment. For now APS allows using the following methods:

Inside package- the method implies that package content does not require any specialprocessing prior to its deployment. The Controller simply copying the very application filesand directories from the package to a hosting environment specific location, according toURL mapping rules (if any specified).

Inside PVC template - the method implies that application files are packed in PVCtemplate that regulates application files deployment. For details on PVC templates, referto theParallels Virtuozzo Containers: Templates Management guide.

Delivery is not required- the method implies that hosting environment already contains allnecessary content and do not require any configuration. This method suits forprovisioning external service.

9. Create a draft of metadata file.

Each package must contain a well-formed XML file (called APP-META.xml) that includes all

the metadata required to manage the application. Metadata file includes application commonproperties like name, version, description as well as list of application services and resourcesrequired. The XML presentation of the metadata is described by the RELAX NG schema.Some schema elements are defined by aspects. It means that you must use aspects whenadding the elements. For details on metadata file and its elements, refer to the 4.3. MetadataFileand 5. Metadata Descriptor sections of the Specification.

10. Prepare scripts.

The Specification defines the following provisioning methods: URL mapping andconfiguration script. These methods are not mutually exclusive and are not interdependent.Thus, both of them can be declared for a service provisioning. URL mapping configuresaccess to service through web, and configuration script performs service installation. Theselection of method is determined by the hosting environment which is required for theApplication. APS Package may contain multiple sets of requirements to meet theenvironment in case either set of requirements may not be satisfied. For details onprovisioning methods, refer to the5.3. Service Provision Methodssection of the Specification.

You may develop a number of scripts that serve different purposes:

Configuration script. It serves as method of service provisioning. Also, it is invoked byController on application instances configuration, removal, upgrade and enabling ordisabling service. If an application has more then one service, separate configurationscripts may be implemented for each service. All resources required by a service must beallocated, instance files unpacked and placed to the file system before configuration scriptinvocation. For details on configuration script invocation, its arguments and environmentvariables, refer to the 5.3.2. Configuration Scriptsection of the Specification.
http://download.swsoft.com/virtuozzo/virtuozzo4.0/docs/en/lin/VzLinuxTmplMgmt/index.htmhttp://download.swsoft.com/virtuozzo/virtuozzo4.0/docs/en/lin/VzLinuxTmplMgmt/index.htmhttp://download.swsoft.com/virtuozzo/virtuozzo4.0/docs/en/lin/VzLinuxTmplMgmt/index.htmhttp://apsstandard.com/r/doc/package-format-specification-1.0/basic.rnchttp://apsstandard.com/r/doc/package-format-specification-1.0/basic.rnchttp://apsstandard.com/r/doc/package-format-specification-1.0/basic.rnchttp://download.swsoft.com/virtuozzo/virtuozzo4.0/docs/en/lin/VzLinuxTmplMgmt/index.htm


11/62


Verification script. It serves to verify service settings for consistency, but it should neverchange state of application or its instances. Verification script has the same callingconventions as a configuration script, but does not support enable and disable

arguments. Verification script is invoked twice: during installation and reconfiguration of

an application. Initially, it is executed prior to prompting a user for setting values. At thisstage the application settings receive auto-generated and default values. Second time itis invoked to validate the submitted settings values. If the return value is not zero, thescript is invoked again. For details on verification script invocation, its arguments andenvironment variables, refer to the 5.3.3. Verification Scriptsection of the Specification.

Resource script. It serves to report application current resources usage to a Controller.The script utilizes the same calling conventions as configuration one, but its outputstream should match XML scheme defined on the Specification. For details on resourcescript invocation, its arguments, output and environment variables, refer to the 5.3.4.Resource Scriptsection of the Specification.

Backup script. It serves to preserve and restore users' data. It is invoked by Controller onapplication instance backing up and restoration. Also, an operation of migration isperformed with this script as sequential execution of backup and restore operations. Fordetails on backup script invocation, its arguments and environment variables, refer to the5.3.5. Backup/Restore Scriptsection of the Specification.

The script should be able to back up all sensitive application data to file specified and allinvolved resources, if required; restore backed up data to location specified.


12/62


License script. It serves to install application license, if any. It is invoked when newlicense is issued for the application, existing license is updated or removed. The scriptshould be able to get instance-specific license information, install issued license andremove installed one. For details on license script invocation, its arguments andenvironment variables, refer to the APS Licensing Aspectdocument.

Script-writing language must be a qualified technology defined in the Specification and mustbe declared in the metadata file. Application data is passed to scripts by means ofenvironment variables. The variables contain all information about resources and settings ofapplication instance you defined on the 7th step of the instruction.

Scripts execution is not always going without a hitch. Consider making script output structurematching XML schema defined in the Specification. A Controller catches such structuredoutput, reads instructions and quickly reacts, in case some errors occur. These instructionsmay include identifiers of settings with erroneous values accompanied by localized errormessages or problems detailed descriptions as well as warnings and errors related to therequirements. For details on forming structure of script output, refer to the 5.3.2.3Configurationscript outputsection of the Specification.

After necessary scripts are implemented, update metadata file with scripts declarations,according to the Specification. For details, refer to the 5.3. Service Provision Methods and 8.Common Aspectssections of the Specification.

11. Prepare package contents listing.

Each package must contain a well-formed XML file named APP-LIST.xml in the package rootdirectory. The file must contain the list of all files in the package, but itself. Size in bytes and

SHA256 digest value must be specified for each file in the list. This file may be digitallysigned by a packager or certification authority.

Presence of packager signature assures package integrity and helps to prevent counterfeit. Ifa package is signed by certification authority, for example APS organization, the packagecontains a certificate as well.

For details on listing structure, refer to the 4.4 Package contents listing and6. Package contentslistingsections of the Specification

12. Create an application package structure.

Package structure must comply with the content organization requirements declared in theSpecification. Check your package structure before archiving and update the applicationcontent if needed. Make sure, that APP-META.xml andAPP-LIST.xml files are well-formedand contain all necessary information about an application.

For details on the requirements, refer to the 1. Introduction, 4. Basic Package Format and 6.5.Additional scriptssections of the Specification.

13. Archive the application package files.

The package should be a ZIP archive with the.app.zipextension, according to the 4.1. Fileformatsection of the Specification.


13/62


14. Validate the application package.

The package validation may comprise two steps: checking whether package structure

conforms to APS and then checking whether package is properly managed by Controllers.Package structure can be validated using APSLint command-line utility. If the applicationpackage is APS-compatible, then you can check how it is managed by Controllers. To dothis, examine the Controller operations that require application package data. For details,refer to theValidating Application Package chapter("Validating Application Package"on page31)further in this guide.


14/62

14

This chapter will guide you through real-life scenarios of packaging applications. Each oneshows how to define settings for applications of a certain type.

Packaging Wordpress Application (on page 15). This is the simplest scenario showinghow to define basic settings for a blogging application.

Packaging SugarCRM Application (on page18). This scenario shows how to package anapplication offering multiple services.

Packaging Open-Xchange Application. This scenario shows how to package an external

application bound to a mail service. Packaging a Wordpress Translation Add-On ("Packaging German Translation Add-on for

WordPress"on page26). This scenario extends the first one by showing how to packageapplication add-ons: translations, themes and other enhancements adding extra valueand enabling users to customize the core packaged application.

Packaging SpamExperts Incoming Email Security Firewall ("Packaging SpamExpertsIncoming Email Security Firewall Application"on page28). This chapter explains how topackage a spam filtering application and point it to domains which it will service.

Packaging Applications With Upsell Services (on page30). This scenario shows how todefine applications with different editions. If you want to package, for example, an emailapplication offering collaboration options at an extra fee, this is your case.

CH A P T E R 3

Packaging Scenarios


15/62

Packaging Scenarios 15

Packaging WordPress Application

WordPress is a personal publishing platform designed to ease web blog management. Theapplication is built on PHP and MySQL and licensed under the GPL. It is designed to beinstalled on dedicated web server or shared hosting account and desktop. The most up-to-date version of Wordpress is 3.0, and the approximate package size is 7Mb. Web blog canbe localized and delivered in a language at customer choice. Every installation of WordPresscomes with a file editor one can use to edit templates and other WordPress related files, rightin a browser without having to worry about downloading and uploading the files in order toedit them.

Note: above information is taken from application vendor home page.

Listed below are the sections of an APP-META.xml file supplied with your package:

1 Type of environment. The application vendor states that WordPress can be installed onshared hosting. So, we can draw a conclusion that WordPress is a multi-instanceapplication.

2 Model of service provisioning. The application is managed by one user 'admin' with allprivileges. It is not possible to create more then one user 'admin' within one applicationinstance. A number of users with restricted set of privileges can be added under the'admin'. All data is shared between users and web blog appearance depends only on'admin' user preferences. So, WordPress is a single-tenant or simple application andapplication files are simply copied to location dedicated to customer.

3 Services hierarchy. WordPress provides only one service - web blog management. Let'swrite down it in the Specification terms:

4 Used technologies. WordPress requires PHP version 4.3. or greater and MySQL version4.0 or greater. Let's write down it in the Specification terms:

mysqlfalsemainwordpress

falsemysql4.0.0

5 Presentation details and settings. We defined earlier that WordPress provides one service -web blog management. Application requires the following settings on installation: 'admin'user login, password and e-mail address, web blog title and language choice. Let's groupthese settings for better presentation, and write down it in the Specification terms:

Administrator's preferences

Administrator's login
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/php


16/62


Please make sure the text you entered startswith a letter and continues with either numbers,

letters, underscores or hyphens.

PasswordAdministrator's email

Weblog's preferencesWeblog title

Other preferencesInterface languageEnglishGerman

6 Content delivery method.WordPress is a simple application and should be accessible viaInternet. So, delivery method is Inside package and URL mapping rules should bedeclared. Let's write down URL mapping rules and specify required amount of disk space

in the Specification terms:wordpress6696960php

7 Draft of metadata file. Now, it is time to make a draft of the application metadata file.Describe application general information in the Specification terms. For details, refer tothe 5.1 Common Application Properties section of the Specification. Begin with addinggeneral information:

http://wordpress.org/

WordPress3.05
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://wordpress.org/%3c/idhttp://wordpress.org/%3c/idhttp://apstandard.com/ns/1/php


17/62


And then add information written down on previous steps and replenish it with details.

8 Configuration script. Write configuration script that performs application installation,configuration and removal, using environment variable defined on the previous steps.Configuration script should perform all actions required for application configuration. For

the list of environment variables, refer to the Sample Environment Variablessection("SampleEnvironment Variables"on page39)further in this guide.

Add information about script to the provisionsection of the metadata file. For example,

php

9 Archiving application.Form application package according URL mapping rules defined andrequirements in the 4. Basic Package Formatsection of the Specification and archive it. Inour case, the structure is the following:

APP-META.xml # Metadata container. XML file.

scripts/

configure # This script will be invoked whenapplication instance is to be setup.

images/

icon.png

admin_page.jpg

# Icon and screenshots of theapplication

htdocs/

blogs/

...

index.php

...

# WordPress files


18/62


Packaging SugarCRM Application

Suga CRM Community Edition enables organizations to efficiently organize, populate, andmaintain information on all aspects of their customer relationships. It is a bit more complexapplication then WordPress one. It consists of modules, each of which represents a specificfunctional aspect of CRM such as Accounts, Activities, Leads and Opportunities. Thesemodules are designed to help managing customer accounts through each step of theirlifecycle, starting with generating and qualifying leads to customer support and resolvingreported bugs. The application is managed by administrator, who has power to regulateaccess for the application modules, customize the look and feel of the application across anorganization. The application is accessed by users through Internet, so it requires a networkaccess to be configured to a server that is running the Sugar software. SugarCRM uses GNUGeneral Public License version 3 for the Sugar Community Edition. It requires the following

components to be installed on server: PHP with memory limit 40Mb or higher, Apache andMySQL.



1 Type of environment. The application vendor states that Sugar CRM can be installed onshared hosting. So, we can draw a conclusion that the application is a multi-instance one.

2 Model of service provisioning.The application is managed by administrator (top-level user)with access to each application module. It is possible to create more than one such userwithin one application instance. Administrator enables users and regulates their accessrights. Still, all data is shared between users and stored within the application instance.So, Sugar Pro is a single-tenant or simple application and application files are simplycopied to location dedicated to customer.

3 Services hierarchy. Sugar CRM allows creating more than one top-level user within theapplication instance. Let's write down it in the Specification terms:

4 Used technologies. Sugar CRM requires PHP 5.1. or higher with memory limit 40Mb orhigher, and MySQL. Let's write down it in the Specification terms:

41943040mysqlmbstringmainsugarcetruemysql4.1.2
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/apachehttp://apstandard.com/ns/1/apachehttp://apstandard.com/ns/1/apachehttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/php


19/62


5 Presentation details and settings. We defined earlier that SugarCRM provides two services -instance and account. Application requires the following settings on installation: 'admin'user login and password, system name to be displayed in the browser title bar, whetherapplication sends usage statistics and how checks for upgrade are performed. The

second-level service - account - requires user login and password and profile information.APS allows assigning the classattribute to setting or setting group. This attribute inform

Controller about the setting meaning. The Controller may decide whether to promptcustomer or use some pre-defined values, basing on attribute meaning. Let's group thesesettings for better presentation, and write down it in the Specification terms. Here, wedemonstrate only instance settings, to view the whole set, refer to the Appendix B. SugarCRM Sample Metadatasection ("SugarCRM Sample Metadata File"on page41).

Administrator's AccountAdministrator's LoginPlease make sure the text

you entered starts with a letter andcontinues with either numbers, letters,underscores or hyphens.

Administrator's Password

System NameThis name will be displayed

in the browser title bar when usersvisit the Sugar application.

Send Anonymous Usage StatisticsIf selected 'Yes', Sugar will

send anonymous statistics about yourinstallation to SugarCRM Inc. everyyour system checks for new versions.

Yes

No

Check For UpdatesHow the system will check

for updated versions of the application.

Automatic


20/62


Manual

6 Content delivery method. Sugar CRM is a simple application and should be accessible viaInternet. So, delivery method is Inside package and URL mapping rules should bedeclared. URL mapping rules declaration is needed only for instance service. Let's writedown URL mapping rules and specify required amount of disk space in the Specificationterms:

sugarcrm53547008php

7 Draft of metadata file. Now, it is time to make a draft of the application metadata file.Describe application general information in the Specification terms. For details, refer tothe 5.1 Common Application Propertiessection of the Specification. Add information writtendown on previous steps and replenish it with details.

8 Configuration script. Sugar CRM provides two services, consider possibility to write

separate configuration scripts for each service as in our example. Configuration scriptshould perform all actions required for application configuration using environmentvariables defined on previous steps. For the list of environment variables, refer to theSample Environment Variablessection("Sample Environment Variables"on page47)further inthis guide.

The application vendor states that any user could not be deleted, the only way to restrictaccess at all is to disable user. Considering this information, we added element to the "usermanager" script.

Add information about scripts to the respective provisionsections of the metadata file.

For example,
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/php


21/62


php

php

9 Archiving application.Form application package according URL mapping rules defined andrequirements in the 4. Basic Package Formatsection of the Specification and archive it. Inour case, the structure is the following:


scripts/

configure

usermanager

# This script will be invoked whenapplication instance is to be setup.

images/

icon.png

...

screen_admin.png

# Icon and screenshots of theapplication

htdocs/

cache/

...

modules/

index.php

...

# SugarCRM files


22/62


Packaging Open-Xchange Application

The Open-Xchange Hosting Edition is built in a completely modular way that allows serviceproviders to offer a variety of Smart Collaboration solutions - from business e-mail overpersonal information management (PIM) to a comprehensive collaboration solution. Thearchitecture of the Open-Xchange Hosting Edition enables seamless integration into existinginfrastructures with existing tools for authentication, user setup, system administration,accounting and e-mail storage. The Open-Xchange Hosting Edition offers a complete clientcapability that makes it possible to operate many thousands of customers simultaneously ina virtual server environment. This guarantees customers consistently good efficiency andperformance and utilizes hardware resources in the best possible way.



1 Type of environment. The application vendor states that Open-Xchange can seamlesslyintegrate to any environment. So, we can draw a conclusion that the application is a multi-instance one and may be provisioned to external environment that is not managed by aController.

2 Model of service provisioning. The application may serve to some number of customerssimultaneously in a virtual server environment. Each customer can work in his ownenvironment within this instancecompletely separated from each other customer.

3 Services hierarchy.Open-Xchange supports multi-tenancy and this means that customers

(tenants) are enabled within one application instance. Within each tenant (organization) anumber of end-users (staff members) is created. In order to inform the Controller about

service destination we assign classattribute to each service. Let's write down it in the

Specification terms:

4 Used technologies. There is no need to provision application itself, so the only requirementswe should declare are script language support and mail box for end-users. Let's writedown it in the Specification terms:

soap

account
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/mailhttp://apstandard.com/ns/1/mailhttp://apstandard.com/ns/1/mailhttp://apstandard.com/ns/1/php


23/62


5 Presentation details and settings. We defined earlier that there are two services - tenantenvironment and end-user account. Tenant environment requires the following settingson installation: 'administrator login and password, and profile information. The second-level service - account - requires user login, password and profile information. When end-user logs in application it is necessary to provide tenant credentials along with user ones.Therefore, we have to hide tenant's credentials from the user. APS allows assigning theclassattribute to a setting or a setting group. This attribute informs Controller about the

setting purpose. The Controller may decide whether to prompt customer or use some pre-defined values, basing on attribute meaning. Let's group these settings for betterpresentation, and write down it in the Specification terms. Here, we demonstrate onlytenant settings. to view the whole set, refer to the Appendix C. Open-Xchange SampleMetadatasection ("Open-Xchange Sample Metadata File"on page49).

Administrator login

Administrator password

Administrator primary email address

Administrator given name

Administrator surname

Organization

Open-Xchange context wide filestore quota (in MB)


24/62


Open-Xchange comes in three editions - each with a specific set of features. Having aprovisioned application, a tenant may select either edition for any specific user, whereas

the user must not have such option. To make this possible, the service of account class

must have a special hidden setting. The setting value will determine the edition of Open-

Xchange enabled for a specific user.

Open-Xchange administrator access levelThis is access level of Open-Xchange context administrator account.Valid values are 'webmail_plus', 'pim_plus', 'groupware',or any other defined in ModuleAccessDefinitions.properties file.

6 Content delivery method. Open-Xchange integrates into existing infrastructures by itself. So,it is provisioned like external service. When Controller provisions external services, it

need to know service installation host, DNS name or IP address and login credentials.These settings affects for all instances of services and should be set prior to any serviceprovisioning. Such settings are application global settings. Let's write down it in theSpecification terms:

Open-Xchange installation hostThis is DNS name or IP address of

Open-Xchange installation, used forprovisioning access.

Open-Xchange public site addressThis is DNS name or IP address of

Open-Xchange public site address.

Master Administrator LoginPlease make sure the text you entered

starts with a letter and continueswith either numbers, letters,underscores or hyphens.

Master Administrator Password

Note the ox_master_admin has a uniq attribute which indicates that the unicity of thisvalue is ensured by the Controller. This attribute may have the following values definingthe scope of unicity:

global - the setting value should be unique for all application instances provisioned

in all global contexts.

application - the setting value should be unique for all application instances

provisioned in the global context.


25/62


owner - the setting value should be unique for all application instances of thecustomer.

service - the setting value should be unique for all service instances provisioned in theapplication instance.

7 Draft of metadata file. Now, it is time to make a draft of the application metadata file.Describe application general information in the Specification terms. For details, refer tothe 5.1 Common Application Propertiessection of the Specification. Add information writtendown on previous steps and replenish it with details.

8 Configuration script. Consider possibility to write separate configuration scripts for eachservice as in our example. Configuration script should perform all actions required forapplication configuration using environment variables defined on previous steps. Scriptfor second-level service should configure user mailbox additionally. For the list ofenvironment variables, refer to the Sample Environment Variables section ("SampleEnvironment Variables"on page53)further in this guide.

The application vendor states that any tenant/user could not be deleted, the only way torestrict access at all is to disable tenant/user. Considering this information, we added

element to both scripts.

Add information about scripts to the respective provisionsections of the metadata file.

For example,php

php

9 Archiving application.Form application package requirements in the 4. Basic Package Formatsection of the Specification and archive it. The application is provisioned as externalservice, so application files themselves are not required. In our case, the structure is thefollowing:

APP-META.xml # Metadata container XML-file.sctipts/

configure

configure-mbox.php

elogin.php

# The scripts will be invoked whenupon service setup.

images/

ox_calendar.jpg # Screenshots of the application


26/62


Packaging German Translation Add-on

for WordPressThis chapter describes creation of an APS package containing a German translation forWordpress. Here we will refer to a translation as an add-onan APS package adding extrafunctionality to another (master) APS package. You may also use this brief guide to createadd-ons for any other applications. Before you create your first APS package, you arerecommended to familiarize with the packaging procedure for a master package (seePackaging WordPress Application (on page15)):

Listed below are the sections of APP-META.xml file supplied with the add-on package:

1 Type of Environment. A translation is attached to all instances of Wordpress, therefore itbelongs to shared type.

2 Model of Service Provisioning. A translation should be provisioned as a single-tenantapplication, because Wordpress add-ons are configured for each Customer according tohis specific demands.

3 Services hierarchy. A translation is represented as a single service and appears in thefollowing way:

4 Used technologies. The add-on does not impose any requirements for any specifictechnologies, rather relying on the master application (Wordpress).

5 Presentation details and settings. The representation details include the supported add-on

version, changelog, application category ("Removing Application Instance" on page 36)and the language.

German translation for WordPress

German translation for WordPress is packaged.

Theme

de

To switch Wordpress to German, add the following setting:


27/62


Activate language

6 Content delivery. German translation comprises a number of files which are placed to thesame path where WordPress resides. This means that the WordPress add-on belongs to

the Inside Package content delivery type.

1794048

7 Metadata file. Now it is time to make a draft of the add-on application metadata file.Describe application general information in the Specification terms, and also the id of themaster package ("http://www.wordpress.org") to which this translation should be applied.

Create an APP-META.xml file and begin with adding general details as follows:

http://de.wordpress.org/German Translation3.0.51http://de.wordpress.org/

wordpresshttp://de.wordpress.org/

Parallelshttp://parallels.com/uuid:714f0a7b-85d6-4eb8-b68e-40f9acbb3103

8 Editing configuration script. Create a configuration script that performs configuration andremoval of the add-on. Configuration script should perform registration of the translationfile in Wordpress. For list of environment variables, refer to the Sample EnvironmentVariables(on page39)section further in this guide.

9 Archiving application.Form application package pursuant to the requirements stated in the4. Basic Package Formatsection of the Specification and archive it.


scripts/

configure # This script will be invoked when theadd-on is instantiated.

images/

icon.png # Add-on Icon

htdocs/ # Translation files
http://www.wordpress.org/http://www.wordpress.org/http://www.wordpress.org/http://de.wordpress.org/%3c/idhttp://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://wordpress.org/http://wordpress.org/http://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://parallels.com/%3c/homepagehttp://parallels.com/%3c/homepagehttp://parallels.com/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://wordpress.org/http://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/idhttp://www.wordpress.org/


28/62


Packaging SpamExperts Incoming

Email Security Firewall ApplicationSpamExperts Incoming Email Security Firewall is an ISP level malware filtering solution usedto protect provide a clean pipe for end Customers. SpamExperts Incoming Email SecurityFirewall comes as an integration module which redirects all incoming mail traffic to anexternal server. This chapter will guide you through the process of packaging SpamExpertsIncoming Email Security Firewall.

Packaging procedure:

1 Type of environment.SpamExperts Incoming Email Security Firewall is not managed by theController and is provisioned by the configuration script. Therefore, SpamExpertsIncoming Email Security Firewall belongs to the External Environment provisioning type.

2 Service provisioning. SpamExperts Incoming Email Security Firewall operates undermultiple tenants, and therefore it is a multi-tenant application.

3 Services hierarchy.All functions of SpamExperts integration module are represented as asingle service:

4 Used technologies. SpamExperts Incoming Email Security Firewall redirects all incomingmail traffic to an intermediate mail service for examination and then returns it back to thesource domain. To make it possible, a DNS substitute has to be specified for the currentDNS record. The latter one will obtain the value of the global setting thus making it

possible for the hosting provider to define host of the external mail service.

Virtual MX record

Primary MX

opensslcurl

MX1

10
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/dnshttp://apstandard.com/ns/1/dnshttp://apstandard.com/ns/1/php


29/62


5 Presentation details and settings. Among common presentation settings SpamExpertsIncoming Email Security Firewall should prompt for domains where mail traffic will befiltered by the application. To make this possible, you will have to define a setting with a

domain-name class and a list type. The following is an example of a setting which

holds multiple domain names:List of domains

6 Content Delivery Method. SpamExperts Incoming Email Security Firewall belongs to 'InsidePackage' type and requires no processing prior to application provisioning. To provisionan external service, the Controller requires an installation host, a DNS name (or IPaddress) and login credentials. These settings are used across all instances of theapplication and should be defined prior to any service provisioning. The following showshow to define such global settings.

API Settings

API hostname

This is DNS name or IP address of SpamExperts productinstallation, used for API access.

API username

Please make sure the text you entered starts with a letter andcontinues with either numbers, letters, underscores or hyphens.

API password

7 Draft of metadata file. Now, it is time to make a draft of the application metadata file.Describe application general information in the Specification terms. For details, refer tothe 5.1 Common Application Properties section of the Specification. Add informationwritten down on previous steps and replenish it with details.

8 Preparing scripts. To pass the values to the SpamExperts Incoming Email Security

Firewall, a configuration script is used which, among other things, must start and stop theservice and ensure that all filtered mail traffic is returned back to the initial mail service.The hostname of the initial mail service may be taken from DNS__SUBSTITUTEenvironment variable, where is the id of the original DNS record.

9 Archiving application.Form application package according to the requirements stated in the4. Basic Package Formatsection of theSpecificationand archive it.


scripts/

configure.php # This script will be invoked when Application

is instantiated or reconfigured.
http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/http://www.apsstandard.org/isv/documentation/


30/62


images/

prospamfilter2.png # Application Icon

screenshot.png # Application screenshot

Packaging Applications with UpsellServices

Many applications have different editions where additional features may be provided as an

up-sell for the features provisioned initially. Likewise, a hosting provider may offer upgradesof, for example, Standard edition on Premium one for existing application instance. Thischapter will outline a way for packaging an application with the feature up-sell capability. It isassumed here that you already have a valid APS package to add upsell features to.

Changing of application feature set is done by performing reconfiguration procedure ofapplication service. Controller delivers the new feature set in value of special setting whichcannot be modified by application user directly. Hosting provider defines editions (featuresets) of application service with different values of the setting and a workflow, followingwhich, a user is able to purchase a configuration and to assign it to a service instance.

Packaging procedure:

1 Add Upsell setting in Metadata. Declare a singular service with hidden setting for feature set.Here's how it's done.

Service PackageTypes of available services

Feature set

Basic Edition

Gold EditionPremium Edition

2 Modify configuration script. Edit the configuration script so that it would switch theapplication edition according to the value of SETTING_EDITION environment value.


31/62

31

This chapter provides instructions on validating application package. The package validationmay comprise two steps:

Checking package physical structure using APSLint utility.

Checking whether package is properly managed by Controllers.

CH A P T E R 4

Validating Application Package


32/62


APSLint Utility

After you created an application package, you can determine whether the package conforms

to the APS using a command-line utility called APSlint. The utility also enables you to

check whether the application package can attain a certain APS certification level. Forinformation on certification levels and requirements a package must satisfy to attain aspecific level, refer to the APS: Application Certification Criteria document located on theofficial APS site.

APSlint utility validates the following:

Application package file format;

Application package physical structure;

Application package metadata file.

As a result, the utility outputs the following data:

Errors indicating why a package fails to conform to the APS;

Errors indicating requirements that a package must satisfy to attain a certain certificationlevel;

Total number of errors. If 0 errors occur, the package is successfully validated.

The APSlint utility can be downloaded from the APS Standard web site (Windows and

Linux/Unix versions are available).

Managing APSLint for Windows

To install the APSlint utility:

1 Download the utility.

2 Install Microsoft .NET Framework version 2.0/3.0/3.5. In case you already have it, justskip this step.

3 Extract the utility to your preferred location. We recommend it to be a folder where yourapplication package file is located.

To validate an application package:1 Run APSlint from the directory where the application package is located using the

following command:> apslint.exe .app.zip

Note: if you run APSlint from another directory, you must provide the absolute or

relative path to the application package that you want to validate.
http://home.parallels.com/docs/pa/APS/Public%20Documents/Guides/APSv1.2/:%20http:/www.apsstandard.org/r/doc/apslint.ziphttp://home.parallels.com/docs/pa/APS/Public%20Documents/Guides/APSv1.2/:%20http:/www.apsstandard.org/r/doc/apslint.ziphttp://home.parallels.com/docs/pa/APS/Public%20Documents/Guides/APSv1.2/:%20http:/www.apsstandard.org/r/doc/apslint.zip


33/62


Managing APSLint for Linux/Unix

APSLint requires mono 2.0emulator and libgdipluspackage to be installed on server before

running APSLint.

To install the APSlint utility:

1 Download the utility.

2 Install Mono version 1.2.x (2.0 runtime) and libgdiplus. In case you already have them,just skip this step.

3 Extract the utility to your preferred location.

To validate an application package:

1 Run APSlint from the directory where the application package is located using the

following command:

If the binfmtmodule is installed in your system:

# ./apslint.exe .app.zip

If the binfmtmodule is not installed in your system:

# mono ./apslint.exe .app.zip

Note: if you run APSlint from another directory, you must provide the absolute or

relative path to the application package that you want to validate.
http://www.apsstandard.org/r/doc/apslint.tar.gzhttp://www.apsstandard.org/r/doc/apslint.tar.gzhttp://www.apsstandard.org/r/doc/apslint.tar.gz


34/62

34

Controller Operations on Packages

This section explains how Controller performs management operations that requireapplication package data. Examine your package, considering Controller operationsexecution. These operations are as follows:

Creating application instance from application package;

Updating application instances using application package;

Removing application instance created from application package.


35/62

35

Creating Application Instance

Controller performs the following actions when it is instantiating an application package:

1 Prepares all the data and conditions necessary for instantiating:

Presents an application-usage license text (if any is provided in the package) to a userand provides tools necessary for accepting the license if it is required. For details,refer to the5.2.2 License Agreementsection in the Specification.

Determines and satisfies the application requirements. For details, refer to the 5.2.6.Requirements, 5.3.2.2.3. Aspect-defined Environment Variablessections in the Specification.

Prompts the user to configure the application installation settings and processes thesubmitted settings. For details, refer to the 5.3.2.2. Environment Variables, 5.2.4. Entrypoints,5.2.5. Service Settingssections in the Specification.

Retrieves the application's global configuration and prepares to apply it to theinstance. For details, refer to 5.2.5. Service Settings, 5.3.2.2.2. Settings sections in theSpecification.

Note: The order of these preparatory sub-stages depends on the Controllerimplementation.

2 Deploys the application files to a site. For details, refer to the 5.3.1. URL mapping, 5.3.2.2.3.Aspect-defined Environment Variablessections in the Specification.

3 Runs the application configuration script passing to it all the available information aboutthe application in the form of environment variables created on the previous stages. Fordetails, refer to the 6.6. Configuration Script Language, 5.3.2. Configuration script, 6.4.

Environment Variablessections in the Specification.

Updating Application Instance

Controller can update an application instance in case a suitable update package is available.Updating application instance supposes that the application of older version is replaced withthe one of newer version, and the user settings and files of the old application are picked upby the new one.

APS supports two types of application updates:patchand upgrade. Generally speaking, thedifference is that patching supposes unattended instance update, while upgrading brings

more serious changes to the instance and may require the user attendance. Applicationpatch and upgrade are defined in detail by the Specification in section 5.1.13. Updates.Depending on what kind of update is required - patch or upgrade - a Controller behaviorslightly differs:

When patching, the Controller skips reading new requirements, and preserves allresources allocated to the old version so that the new version could painlessly pick themall up, as defined by the Specification in section 5.2.6. Requirements.

When upgrading, the Controller analyzes new requirements and provides a mechanismof satisfying them together with migrating the application vitally-important data. (Forexample, when a new application version requires using a database of another version,the Controller provides mechanism of allocating the new database and migrating to it the

old data.)


36/62

36 Application Packaging Application Packaging Standard

Removing Application Instance

When removing an application instance, a Controller invokes the application configuration

script with removeargument. It removes the application files and deallocates resources usedby it, as defined by the Specification in section 5.3.2.1. Configuration script actions. TheController passes to the configuration script all application settings declared in metadata,

except marked as installation-only, with the SETTINGS_ environment variables,

as defined by the Specification in section 5.3.2.2.2. Settings.


37/62

This appendix demonstrates the metadata file of theWordPress application package.The following metadata file is extended with delimiters that separate file fragmentsadded on different steps of the metadata file creation described in the PackagingWordPress Applicationsection ("Packaging WordPress Application"on page15)earlier inthis guide.

http://wordpress.org/WordPress2.7.11http://wordpress.org/WordPress.orghttp://wordpress.org/

ParallelsError! Hyperlink reference not valid.>uuid:714f0a7b-85d6-4eb8-b68e-40f9acbb3103

WordPress is a state-of-the-art semantic personal

publishing platform with a focus on aesthetics, webstandards, and usability.

WordPress is a state-of-the-art semantic personalpublishing platform with a focus on aesthetics,web standards, and usability. What a mouthful.WordPress is both free and priceless at the same time.More simply, WordPress is what you use when you wantto work with your blogging software, not fight it.

Admin page.

'PHP safe mode off' requirement is added.

Web/BlogPersonal/Blog

en

AP P E N D I X A

WordPress Translation Sample Metadata

File
http://apstandard.com/ns/1http://apstandard.com/ns/1http://wordpress.org/%3c/idhttp://wordpress.org/%3c/idhttp://wordpress.org/%3c/idhttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/homepagehttp://wordpress.org/%3c/idhttp://apstandard.com/ns/1


38/62

GPLv2htdocs/license.txt

Blog

Administrative InterfaceApplication entry point

Administrator's preferences

Administrator's loginPlease make sure the text you entered

starts with a letter and continues with either numbers,letters, underscores or hyphens.

PasswordAdministrator's email

Weblog's preferencesWeblog title

Other preferences

Interface languageEnglish

German

mysqlfalse
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/dbhttp://apstandard.com/ns/1/php


39/62

mainwordpressfalsemysql4.0.0

wordpress6696960php

php

Sample Environment Variables

The types of environment variables that are passed to the WordPress configurationscript by a Controller are as follows:

Variables defined by URL-mappings (see 5.3.2.2.1. URL Mapping Variables section ofthe Specification).

BASE_URL_SCHEME

BASE_URL_HOST

BASE_URL_PORT

BASE_URL_PATH

WEB___DIR

WEB__blogs_media_DIR

WEB__wp-content_DIR

WEB__tmp_DIR

Variables defined by application settings (see the 5.3.2.2.2. Settings section of the

Specification).SETTINGS_admin_name


40/62

SETTINGS_admin_password

SETTINGS_admin_email

SETTINGS_title

SETTINGS_locale

Aspects-defined (see the7.4. Environment Variablessection of the Specification).

PHP aspect

PHP_VERSION

Database aspect

DB_main_TYPE

DB_main_NAME

DB_main_LOGIN

DB_main_PASSWORD

DB_main_HOST

DB_main_PORT

DB_main_VERSION

DB_main_PREFIX


41/62

This appendix demonstrates the metadata file of theSugarCRM application package.The following metadata file is extended with delimiters that separate file fragmentsadded on different steps of the metadata file creation described in the PackagingSugarCRM Applicationsection ("Packaging SugarCRM Application"on page18)earlier inthis guide.

http://www.sugarcrm.com/crm/

SugarCRM5.2.0a1http://www.sugarcrm.com/crm/SugarCRM Inc.

http://www.sugarcrm.com/crm/about/about-sugarcrm.html

ParallelsError! Hyperlink reference not valid.>uuid:714f0a7b-85d6-4eb8-b68e-40f9acbb3103

SugarCRM Community Edition

SugarCRM Community Edition enables organizations toefficiently organize, populate, and maintaininformation on all aspects of their customerrelationships. It provides integrated management ofcorporate information on customer accounts and contacts,sales leads and opportunities, plus activities such ascalls, meetings, and assigned tasks. The systemseamlessly blends all of the functionality required tomanage information on many aspects of your businessinto an intuitive and user-friendly graphical interface.

Home Screen

Admin Screen

Dashboard View

Account Details

Marketing Campaigns

AP P E N D I X B

SugarCRM Sample Metadata File
http://apstandard.com/ns/1http://apstandard.com/ns/1http://www.sugarcrm.com/crm/%3c/idhttp://www.sugarcrm.com/crm/%3c/idhttp://www.sugarcrm.com/crm/%3c/idhttp://www.sugarcrm.com/crm/%3c/homepagehttp://www.sugarcrm.com/crm/%3c/homepagehttp://www.sugarcrm.com/crm/about/about-sugarcrm.htmlhttp://www.sugarcrm.com/crm/about/about-sugarcrm.htmlhttp://www.sugarcrm.com/crm/about/about-sugarcrm.htmlhttp://www.sugarcrm.com/crm/%3c/homepagehttp://www.sugarcrm.com/crm/%3c/idhttp://apstandard.com/ns/1


42/62

Bug TrackerCalendar

Documents

Packaged as APS 1.1

Back office/Customer Relationship Management

en

GPLv3htdocs/LICENSE.txt

SugarCRM InstanceBasic services

Application entry pointUsersAuthenticateUsersLoginSugar

en_us++Login++

Administrator's Account

Administrator's Login

Please make sure the textyou entered starts with a letter andcontinues with either numbers, letters,


43/62

underscores or hyphens.

Administrator's Password

System NameThis name will be displayed

in the browser title bar when users visitthe Sugar application.

Send Anonymous Usage StatisticsIf selected 'Yes', Sugar

will send anonymous statistics aboutyour installation to SugarCRM Inc.

every time your system checks for new versions.Yes

No

Check For UpdatesHow the system will check

for updated versions of the application.

Automatic

Manual

mysqlmbstringmainsugarcetruemysql4.1.2

sugarcrm53547008


44/62

xmlns:php="http://apstandard.com/ns/1/php">php

php

SugarCRM Account

Account entry pointUsersAuthenticateUsersLoginSugaren_us

++Login++

Account Preferences

Account's Login


45/62

Account's Password

First Name

Last Name

Email

Title

DepartmentworkWork Phone Number

cellMobile Phone Number

faxFax Number

homeHome Phone Number

StreetCityRegionCountryPostal Code


46/62

Description

php


47/62


The types of environment variables that are passed to the SugarCRM configurationscripts by a Controller are as follows:

Variables are defined by application settings (see the 5.3.2.2.2. Settingssection of theSpecification).


The full list of SugarCRMenvironment variables list is as follows:


48/62

'Root' service variables:

Pre-defined variables representing theinstance: URL:

BASE_URL_SCHEME

BASE_URL_HOST

BASE_URL_PORT

BASE_URL_PATH

Variables defined by service settingsdeclarations:

SETTINGS_admin_name


SETTINGS_title

SETTINGS_send_usage_statisticsSETTINGS_check_for_updates

Variables defined by service requirementsdeclarations:

PHP_VERSION

DB_main_NAME

DB_main_LOGIN

DB_main_PASSWORD

DB_main_HOST

DB_main_PORT

DB_main_VERSION

DB_main_PREFIX

Variables defined by service URL mappingdeclarations:

WEB___DIR

WEB__cache_DIR

WEB__custom_DIR

WEB__data_DIRWEB__modules_DIR

WEB__tmp_DIR

WEB__config.php_DIR

Child service variables:

Pre-defined variables representing theinstance URL:

BASE_URL_SCHEME

BASE_URL_HOST

BASE_URL_PORT

BASE_URL_PATH

Variables defined by service settingsdeclarations:

SETTINGS_user_login

OLDSETTINGS_user_login

SETTINGS_user_password

SETTINGS_first_nameSETTINGS_last_name

SETTINGS_user_email

SETTINGS_title

SETTINGS_department

SETTINGS_phone_work

SETTINGS_phone_mobile

SETTINGS_phone_fax

SETTINGS_phone_homeSETTINGS_address_street

SETTINGS_address_city

SETTINGS_address_state

SETTINGS_address_country

SETTINGS_address_postalcode

SETTINGS_description

Variables defined by parent servicerequirements declarations:

PHP_VERSION

DB_main_NAME

DB_main_LOGIN

DB_main_PASSWORD

DB_main_HOST

DB_main_PORT

DB_main_VERSION

DB_main_PREFIX


49/62

This appendix demonstrates the metadata file of the Open-Xchange applicationpackage. The following metadata file is extended with delimiters that separate filefragments added on different steps of the metadata file creation described in thePackaging Open-Xchange Applicationsection earlier in this guide.

http://www.open-xchange.com/

Open-Xchange6.717http://www.open-xchange.com/en/products/open-xchange-

hosting-edition-enOpen-Xchange Inc.Error! Hyperlink reference not valid.>

ParallelsError! Hyperlink reference not valid.>uuid:c9fa49b2-ba47-11dd-9fed-00155882361a

Open-Xchange Hosting Edition is a highly advancedbusiness-class email and collaboration solutionfor competitive success.

Open-Xchange Hosting Edition is a highly advancedbusiness-class email and collaboration solutionfor competitive success. It provides a highlyadvanced, improved and intuitive browser basedinterface that meets all their email, calendaring,tasking, contacts and document sharing requirements.Each of the functions simplifies the daily work andit is the unique linking and integration of thedifferent modules that makes organizing and managingwithin the company even smoother, faster, and moretransparent.

Open-Xchange portal page

Open-Xchange E-Mail page

Open-Xchange calendar page

Open-Xchange contact page

AP P E N D I X C

Open-Xchange Sample Metadata File
http://www.w3.org/2001/XMLSchema-instancehttp://www.w3.org/2001/XMLSchema-instancehttp://apstandard.com/ns/1http://apstandard.com/ns/1http://www.open-xchange.com/%3c/idhttp://www.open-xchange.com/%3c/idhttp://www.open-xchange.com/%3c/idhttp://www.open-xchange.com/en/products/open-xchange-http://www.open-xchange.com/en/products/open-xchange-http://www.open-xchange.com/en/products/open-xchange-http://www.open-xchange.com/%3c/idhttp://apstandard.com/ns/1http://www.w3.org/2001/XMLSchema-instance


50/62

Open-Xchange task page

Open-Xchange infostore page

Initial package version

Collaboration/Email

ende

Open-Xchange installation hostThis is DNS name or IP address of

Open-Xchange installation, used forprovisioning access.

Open-Xchange public site addressThis is DNS name or IP address of

Open-Xchange public site address.

Master Administrator LoginPlease make sure the text you entered

starts with a letter and continueswith either numbers, letters,underscores or hyphens.

Master Administrator Password

End User License Agreementhttp://software.open-xchange.com/

OX6/doc/OXHE-Provisioning/ar02.html

Open-Xchange context administration
http://software.open-xchange.com/http://software.open-xchange.com/http://software.open-xchange.com/http://software.open-xchange.com/


51/62

Administrator login

Administrator password

Administrator primary email address

Administrator given name

Administrator surname

Organization

Open-Xchange context wide filestore quota (in MB)

soap

php

Open-Xchange account


52/62

Login

Password

Primary email address

Given nameSurname

account

php
http://apstandard.com/ns/1/mailhttp://apstandard.com/ns/1/mailhttp://apstandard.com/ns/1/mail


53/62

53


The types of environment variables that are passed to the Open-Xchange configurationscripts by a Controller are as follows:

Variables are defined by application settings (see the 5.3.2.2.2. Settings section of theSpecification).

SETTINGS_ox_host

SETTINGS_ox_site

SETTINGS_ox_master_admin

SETTINGS_ox_master_password

SETTINGS_admin_login


SETTINGS_admin_email

SETTINGS_admin_given_name

SETTINGS_admin_surname

SETTINGS_organization_name

SETTINGS_filestore_quota

OLDSETTINGS_admin_password

SETTINGS_user_login

SETTINGS_user_password

SETTINGS_user_email

SETTINGS_user_given_name

SETTINGS_user_surname


PHP aspect

PHP_VERSION

Mail aspect

MAIL_account_EMAIL

MAIL_account_IMAP_HOST

MAIL_account_IMAP_MAILBOX

MAIL_account_IMAP_PORT

MAIL_account_IMAP_PORT_SSL

MAIL_account_PASSWORD

MAIL_account_POP3_HOST

MAIL_account_POP3_PORT

MAIL_account_POP3_PORT_SSL


54/62

54 Application Packaging Application Packaging Standard

MAIL_account_SMTP_HOST

MAIL_account_SMTP_PORT

MAIL_account_SMTP_PORT_SSL

MAIL_account_USER


55/62

This appendix demonstrates the metadata file of theWordPress translation package.The following metadata file is extended with delimiters that separate file fragmentsadded on different steps of the metadata file creation described in the Packaging Add-onsearlier in this guide.

http://de.wordpress.org/German Translation3.0.51http://de.wordpress.org/

wordpresshttp://de.wordpress.org/

Parallels

http://parallels.com/uuid:714f0a7b-85d6-4eb8-b68e-40f9acbb3103

German translation for WordPress

German translation for WordPress is

packaged.

Web/Blog

de

German translationGerman localization package for

Wordpress

Activate language

AP P E N D I X D

WordPress German Translation Add-on

Sample Metadata File
http://apstandard.com/ns/1http://apstandard.com/ns/1http://de.wordpress.org/%3c/idhttp://de.wordpress.org/%3c/idhttp://de.wordpress.org/%3c/idhttp://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://wordpress.org/http://wordpress.org/http://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://parallels.com/%3c/homepagehttp://parallels.com/%3c/homepagehttp://parallels.com/%3c/homepagehttp://de.wordpress.org/%3c/homepagehttp://wordpress.org/http://de.wordpress.org/%3c/homepagehttp://de.wordpress.org/%3c/idhttp://apstandard.com/ns/1


56/62

php

1794048


The types of environment variables that are passed to a WordPress add-on

configuration script by a Controller are as follows:

Variables defined by URL-mappings (see 5.3.2.2.1. URL Mapping Variables section ofthe Specification).

WEB___DIR

Variables defined by application settings (see 5.3.2.2.2. Settings section of theSpecification).

SETTINGS_replace_current_lang
http://apstandard.com/ns/1/phphttp://apstandard.com/ns/1/php


57/62

This appendix includes metadata file of the SpamExperts Incoming Email SecurityFirewall application package. The following metadata contains comments withreferences to specific steps in Packaging SpamExperts Incoming Email SecurityFirewall Application (on page28).

spamexperts-psfProfessional Spam Filter2186http://www.spamexperts.com/

SpamExperts B.V.http://www.spamexperts.com/

SpamExperts B.V.

http://www.spamexperts.com/uuid:7d652dbc-f2e9-463a-a658-b8a8369112ad

The addon automatically adds new domains to the Incoming

Email Security Firewall from SpamExperts, changes the MX records and offersthe enduser a one-click login option. Usage of this addon requires theSpamExperts Incoming Email Security Firewall.

Server-side anti-spam filter for all users of yourdomain; Proven, trusted, and secure; Best price/ quality anti-spam gateway onthe market; Over 99.99% filtering accuracy; Easy to implement; Fully managedservice; Friendly multilevel support with 24/7/365 monitoring; No email evergets lost

Main application view

Package revision 1.0, release 174, built at 05-01-2011

09:08

Collaboration/Email

en

AP P E N D I X E

SpamExperts Incoming Email Security

Firewall Sample Metadata File
http://www.w3.org/2001/XMLSchema-instancehttp://www.w3.org/2001/XMLSchema-instancehttp://apstandard.com/ns/1http://apstandard.com/ns/1http://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://www.spamexperts.com/%3c/homepagehttp://apstandard.com/ns/1http://www.w3.org/2001/XMLSchema-instance


58/62

SpamPanel SettingsSpampanel URL

This is an URL in format'http://www.spampanel.com/' showing where spampanel is installed.Unless you use a custom CNAME, this is the primary hostname of your firstserver.

Please make sure the text you entered starts

with either http:// or Error! Hyperlink reference not valid.>

API SettingsAPI hostname

This is DNS name or IP address of SpamExperts productinstallation, used for API access.

API username

Please make sure the text you entered starts with a letterand continues with either numbers, letters, underscores or hyphens.

API passwordEnable SSL

If you want to communicate with the spamcluster over SSL,tick this box

Virtual MX record

Primary MX

General Terms & Conditions and License Terms

http://www.spamexperts.com/fileadmin/documentation/EN/SpamExperts_General_Terms_an