You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

You are here: Zend Server User Guide > Tasks > Working with Deployment > Example Codes > The XML Descriptor File

The XML Descriptor File

The XML skeleton script is made up of the following:

name - (Required) The application's name.
summary - The application's short description.
description - The application's long description.
version - (Required) The application's version number.
eula - The EULA file.
appdir - (Required) The applications directory. By default, this is the data folder of your package.
docroot - The alias will point to the directory you specify.
scriptsdir - The directory in which your scripts are located. By default, this is the scripts folder of your package.
healthcheck - Add the relative URLl you would like Zend Server to check against for Application Health Check. This checks if the URL returns a 200 (OK) response or an error response.
dependencies - The dependencies that must be met (and will be validated) during the deployment process.
parameters - The parameters for the deployment process. These, along with the values you define, will appear in the User Parameters dialog during deployment. For more information see Deploying an Application.
variables - Define environment variables for the deployment scripts.
persistent resources - Any files or directories you do not want removed from the server after removing or updating the application.

The descriptor file is validated by an XSD file in the server. For an example of the file see The XSD File.

Usage Example

Example:

<?xml version="1.0" encoding="utf-8"?>
<package version="1.4.11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <name>MyApplication</name>
  <summary>MyApplication short description</summary>
  <description>MyApplication long description</description>
  <version>
    <release>RELEASE VERSION</release>
  </version>
  <eula>data/LICENSE.txt</eula>
  <appdir></appdir>
  <docroot></docroot>
  <scriptsdir>scripts</scriptsdir>
  <healthcheck>index.php</healthcheck>
  <dependencies>
    <required>
        <php>
            <min>5.2.13</min>
        </php>
        <extension>
            <name>pdo_mysql</name>
        </extension>
        <directive>
            <name>safe_mode</name>
            <equals>off</equals>
        </directive>
        <directive>
            <name>error_reporting</name>
            <equals><![CDATA[E_ALL & ~E_NOTICE]]></equals>
        </directive>
    </required>
  </dependencies>
  <parameters>
    <parameter id="locale"
    display="Localization.Locale Settings.Locale"
    required="true" type="choice">
      <description></description>
    </parameter>
    <parameter id="timezone"
    display="Localization.Locale Settings.Time Zone"
    required="true" type="choice">
      <description></description>
    </parameter>
    <parameter id="currency"
    display="Localization.Locale Settings.Default Currency"
    required="true" type="choice">
      <description></description>
    </parameter>
    <parameter id="db_host"
    display="Configuration.Database Connection.Host"
    required="true" type="string">
      <description>
        You can specify server port, ex.: localhost:3307 If
        you are not using default UNIX socket, you can specify it
        here instead of host, ex.:
        /var/run/mysqld/mysqld.sock
     </description>
    </parameter>
    <parameter id="db_name"
    display="Configuration.Database Connection.Database Name"
    required="true" type="string">
      <defaultvalue>magento</defaultvalue>
      <description>

     </description>
    </parameter>
    <parameter id="db_username"
    display="Configuration.Database Connection.User Name"
    required="true" type="string">
      <defaultvalue>root</defaultvalue>
      <description>

     </description>
    </parameter>
    <parameter id="db_password"
    display="Configuration.Database Connection.User Password"
    required="false" type="password">
      <defaultvalue></defaultvalue>
      <description>

     </description>
    </parameter>
    <parameter id="db_tables_prefix"
    display="Configuration.Database Connection.Tables Prefix"
    required="false" type="string">
      <defaultvalue></defaultvalue>
      <description>
        (Optional. Leave blank for no prefix)
      </description>
    </parameter>
    <parameter id="base_url"
    display="Configuration.Web access options.Base URL"
    required="true" type="string">
      <defaultvalue>
      $(WEBSERVER_SCHEMA)://$(WEBSERVER_HOSTNAME)/$(WEBSERVER_PATH)</defaultvalue>
      <description>
        <short></short>
        <long></long>
      </description>
    </parameter>
    <parameter id="admin_path"
    display="Configuration.Web access options.Admin Path"
    required="true" type="string">
      <defaultvalue>admin</defaultvalue>
      <description>
        Additional path added after Base URL to access your
        Administrative Panel (e.g. admin, backend, control
        etc.)
      </description>
   </parameter>
   <parameter id="skip_base"
   display="Configuration.Web access options.Skip Base URL Validation Before the Next Step"
   required="false" type="checkbox">
     <defaultvalue>false</defaultvalue>
     <description>
       Check this box only if it is not possible to
       automatically validate the Base URL.
     </description>
   </parameter>
   <parameter id="use_apache_rewrites"
   display="Configuration.Web access options.Skip Base URL Validation Before the Next Step"
   required="false" type="checkbox">
     <defaultvalue>false</defaultvalue>
     <description>
       <short></short>
       <long>You could enable this option to use web server
       rewrites functionality for improved search engines
       optimization. Please make sure that mod_rewrite is enabled
       in Apache configuration.</long>
     </description>
   </parameter>
   <parameter id="use_ssl"
   display="Configuration.Web access options.Use Secure URLs (SSL)"
   required="false" type="checkbox">
     <defaultvalue>false</defaultvalue>
     <description>
       Enable this option only if you have SSL
       available.
     </description>
   </parameter>
   <parameter id="session_save_data"
   display="Configuration.Session Storage Options.Save Session Data In"
   required="true" type="choice">
     <validation>
       <enums>
         <enum>File System</enum>
         <enum>Database</enum>
       </enums>
     </validation>
     <defaultvalue>File System</defaultvalue>
     <description>

    </description>
   </parameter>
   <parameter id="first_name"
   display="Create Admin Account.Personal Information.First Name"
   required="true" type="string">
     <description>

    </description>
   </parameter>
   <parameter id="last_name"
   display="Create Admin Account.Personal Information.Last Name"
   required="true" type="string">
     <description>

    </description>
   </parameter>
   <parameter id="email"
   display="Create Admin Account.Personal Information.Email"
   required="true" type="email">
     <description>

    </description>
   </parameter>
   <parameter id="login_username"
   display="Create Admin Account.Login Information.Username"
   required="true" type="string">
     <description>

    </description>
   </parameter>
   <parameter id="login_password"
   display="Create Admin Account.Login Information.Password"
   required="true" type="password">
     <description>

    </description>
   </parameter>
   <parameter id="login_confirm_password"
   display="Create Admin Account.Login Information.Confirm Password"
   required="true" type="password">
     <description>

    </description>
   </parameter>
   <parameter id="encription_key"
   display="Create Admin Account.Encription Key"
   required="false" type="string">
     <description>

    </description>
   </parameter>
</parameters>
/package>