DTD Structure Of Reseller XML Migration File

Last modified: 02 Aug 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.

• Data Type Definitions
• DTD Chart
• Attribute Description

Data Type Definitions

Here is the DTD structure defined in resellers.dtd:

<?xml version="1.0" encoding="UTF-8"?>

<!ELEMENT resellers (reseller*, users?)>
<!ELEMENT reseller (info+,administrator,zone*,users?)>
<!ELEMENT zone (instantalias*)>
<!ELEMENT instantalias (#PCDATA)>
<!ELEMENT administrator (#PCDATA)>

<!ATTLIST reseller login CDATA #REQUIRED>
<!ATTLIST reseller password CDATA #REQUIRED>
<!ATTLIST reseller plan CDATA #REQUIRED>
<!ATTLIST administrator login CDATA #REQUIRED>
<!ATTLIST administrator password CDATA #REQUIRED>
<!ATTLIST administrator email CDATA #REQUIRED>
<!ATTLIST zone name CDATA #REQUIRED>
<!ATTLIST zone email CDATA #REQUIRED>
<!ATTLIST instantalias prefix CDATA #REQUIRED>
<!ATTLIST instantalias tag CDATA #REQUIRED>

<!ENTITY % users_rules SYSTEM "users.dtd">
%users_rules;

DTD Chart

The above structure may be represented graphically in the following chart:

                                  resellers
                                   / ...  \
                             reseller    users (users for reseller admin - outdated since HS 2.5)
                                |         ...
                   ____________/|\
                  /             | \_____
                 /             / \      \
                /             /   \      \
              info           /     \      \
               |   administrator  zone    users (outdated since HS 2.5)
               |                    |      ...
              item              instantalias

Attributes Description

• reseller:
  • login - reseller login
  • password - reseller password
  • plan - the plan the reseller is signed up for
• info (contact/billing signup information): (see signup fields description.)
  • type="_ci_" (contact info) or type="_bi_" (billing info)
• administrator:
  • login - reseller admin cp login
  • password - reseller admin cp password
  • email - reseller admin email address
• zone:
  • name - the name of the reseller service zone
  • email - email for the reseller service zone (for example, if it is reseller@example.com, it must be set as reseller.example.com)
• instantalias:
  • prefix - prefix to be added to instant aliases for this zone (for example, u)
  • tag - shared IP tag for the instant alias (usually, 2)

XML example with reseller data
XML example with reseller and end user data (HS before 2.5)