Parallels H-Sphere Documentation Developer Guide

 

Using EasyApp SDK

(version 2.4.3 and higher)
 
 

Related Docs:   Building Packages

Last modified: 28 Dec 2007

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

EasyApp SDK is a standard development kit for easy integration of PHP/MySQL applications to H-Sphere. The goal of SDK is to provide the developer with the ability to generate H-Sphere package without programming any java or html UI code. It should be useful to integrate applications like phpBB2, Mambo, phpMyChat, b2evolution, PHPnuke, etc.

The user gets a web installer which collects application installation data (db username, db password, email, etc.), then writes it to config files and populates app database with the specified dump.

Positive Software offers its own collection of over 30 popular PHP/MySQL applications. They are available for download from our website.

 

Building Application Packages


Control Panel, Linux&FreeBSD part Windows
  1. Download and install:
    1. Java 1.3 or higher
    2. Apache Ant 1.6.1 or higher - a Java-based build tool.
    3. JUnit - a framework to write repeatable tests. It is recommended but optional.
  2. Log in as the cpanel user.
  3. Download EasyApp SDK zip.
  4. Unzip generated SDK from the dist directory to the server (or under the user) where you will build the package.
  5. Create the collection directory. The contents of the original collection directory with only one application as an example is available for reference. You can also download the entire directory with all applications from our own collection (~50 MB).
  6. Setup a separate directory inside the collections directory for each application that you want to include into the package.
  7. Create main.xml descriptor in the application directory for each application you want in the package.
  8. Place application tarball in the application directory (.tar.gz, .tgz, .zip extensions are supported)
  9. Place application configs, sql templates, and logo into the application directory.
  10. Inside the collections directory create collection.xml file.
  11. Inside the collections directory, create menu & hsphere_lang language files with all the labels used.
  12. Place icons for different h-sphere designs into the collections directory. The icons must represent your package on the home page of the user control panel.
  13. Setup yafv file for the collection file.
  14. Type
    ant
    As the result, you should get h-sphere package in the pkg/ directory.

Now you can install the package according to our documentation on package installation.

(H-Sphere Winbox 2.4.3 Patch 2 and up)

  1. Download the latest version of WiX and install it.
  2. Download NAnt 0.85RC3 or older and install it.
  3. Register paths to WiX and NAnt tools in the PATH environment variable.
  4. Register path to the currently used .NET Framework in the DOTNETDIR environment variable (for instance, C:\WINNT\Microsoft.NET\Framework\v1.1.4322).
  5. Download the EasyApp_MSI_SDK_<hs_version_code>_<build>.zip file from the EasyApp MSI SDK download directory, where hs_version_code is your H-Sphere Winbox version code (for example, 243p7, 250b4, 250rc1), and build is the latest available build number for this EasyApp MSI SDK version. Then, unzip the downloaded archive to any appropriate location.
  6. Create EasyApp directory for EasyApp MSI SDK.
  7. Create easyapp-col directory inside the EasyApp directory.
  8. Setup a separate directory inside the easyapp-col directory for each application that you want to include into the package.
  9. Create main.xml descriptor in the application directory for each application you want in the package.
  10. Place application tarball in the application directory (.tar.gz, .tgz, .zip extensions are supported)
  11. Place application configs, sql templates, and logo into the application directory.
  12. Inside the easyapp-col directory create collection.xml file.
  13. Inside the easyapp-col directory, create menu & hsphere_lang language files with all the labels used.
  14. From the EasyApp MSI SDK directory type
    nant
    An MSI package should be created in this directory.

Now you can install the package according to our documentation on EasyApp MSI installation.


Related Docs:   Building Packages



© Copyright 2017. Parallels Holdings. All rights reserved.