Atomia Automation Server

Package description elements

The package description file is an XML file that describes available packages in the system. File:

         <packageDescription>
         <packageList>
         <package name="PackageName">
         <serviceList>
         <service name="ServiceName"/>
         </serviceList>
         <serviceLimitationList/>
         <propertySettings/>
         </package>
         </packageList>
         <packageExtensionList/>
         </packageDescription>

packageDescription is the root element of the file and has no attributes. packageDescription has two elements:

• packageList – list of packages available in system.
• packageExtensionList – for each package, extensions could be defined.

packageList is an element with no attributes and contains one or more package elements.

         <packageList>
         <package name="PackageName">
         <serviceList>
         <service name="ServiceName"/>
         </serviceList>
         <serviceLimitationList/>
         <propertySettings/>
         </package>
         </packageList>

package defines the package itself. Attributes of this element are:

• name  defines the package name. Is required.
• friendlyName  defines a friendly package name. Is optional.

The value of the element is of type complex: packageType which is defined as:

         <serviceList>
         <service name="ServiceName"/>
         </serviceList>
         <serviceLimitationList/>
         <propertySettings/>

serviceList has not attributes. It could contain one or more service elements.

<service name="ServiceName" />

service has an attribute name which is required.

serviceLimitationList could contain zero or more limitation or globalLimitation elements.

         <serviceLimitationList>
         <limitation serviceNamePath="/path/to/service" maxCount="50">
         <globalLimitation>
         <group maxCount="0">
         <service name="FirstService" />
         </group>
         <group maxCount="5">
         <service name="SecondService" />
         </group>
         </globalLimitation>
         </serviceLimitationList>

For the  limitation element two attributes are defined. A value is not allowed for this element. Attributes are:

• serviceNamePath – required attribute,
• maxCount – required attribute.

For globalLimitation element has no attributes. globalLimitation element can contain one or more group elements.

         <globalLimitation>
         <group maxCount="0">
         <service name="FirstService" />
         </group>
         <group maxCount="5">
         <service name="SecondService" />
         </group>
         </globalLimitation>

group element has one attribute:

• maxCount – required attribute

group element contains one on more service elements(described above).

The propertySettings element can contain zero or more set elements.

         <propertySettings>
         <set servicePath="ServicePath" propertyName="" propertyValue ="" />
         <propertySettings>

For the set element three attributes are defined. A value is not allowed for this element. Attributes are:

• servicePath – required attribute,
• propertyName – required attribute,
• propertyValue – required attribute.

packageExtensionList  has no attributes and contains a list of zero or more packageExtension elements.

         <packageExtensionList>
         <packageExtension>
         <serviceList>
         <service name="ServiceName"/>
         </serviceList>
         <serviceLimitationList/>
         <propertySettings/>
         <extendsList>
         <extends name="extendsName">
         </extendsList>
         </packageExtension>
         </packageExtensionList>

The packageExtension element value is of type  packageType described above.

extendsList is a list of zero or more extends elements.

<extends name="extendsName" />

extends has an attribute name and no value could be assigned.

Example of package description

           <packageDescription>
           <packageList>
           <package name="BasicWebHosting">
           <serviceList>
           <service name="Hosting"/>
           </serviceList>
           <serviceLimitationList/>
           <propertySettings/>
           </package>
           </packageList>
           <packageExtensionList />
           </packageDescription>