Zimlet Developers Guide:Zimlet Configuration File Reference
 Article Information |
|---|
| This article applies to the following ZCS versions. |
This document provides a reference for the elements in the Zimlet Configuration File.
Elements
<zimletConfig>
The <zimletConfig> element is the enclosing element in the Configuration File. The <zimletConfig> element has the following attributes:
| Attribute | Required / Optional | Range of Values | Default Value | Description |
| name | Required | A valid zimlet name | N/A | The name attribute is the zimlet's name and is a required attribute. This must be the same name as is used to prefix the Zimlet ZIP Package. The zimlet name is required to be unique within a deployment. |
| version | Required | A valid zimlet version | N/A | This required attribute specifies the zimlet’s version number. For example, version="1.0" |
The following table describes the elements you can define within a <zimletConfig> element.
| Order | Element | Required / Optional | Description |
| 1 | global | Optional (0 or * allowed) | Describes the global zimlet properties. See <global> for more information. |
| 2 | host | Optional (0 or * allowed) | Describes the host-specific zimlet properties. See <host> for more information. |
<global>
The <global> element describes the global zimlet configuration properties.
The following table describes the elements you can define within a <global> element.
| Order | Element | Required / Optional | Description |
| 1 | property | Optional (0 or * allowed) | Defines the properties. See <property> for more information. |
Example:
<global>
<property name="allowedDomains">*.yahoo</property>
</global>
<host>
The <host> element describes the host-specific zimlet configuration properties.
The <host> element has the following attributes:
| Attribute | Required / Optional | Range of Values | Default Value | Description |
| name | Required | A valid zimbra host name | N/A | Designates the zimbra host name for the properties. |
The following table describes the elements you can define within a <host> element.
| Order | Element | Required / Optional | Description |
| 1 | property | Optional (0 or * allowed) | Defines the properties. See <property> for more information. |
Example:
<host name="myzimbrahost.com">
<property name="myPropertyUrl">http://myprops.com</property>
<property name="myPropertyCode">123422</property>
<property name="myPropertyId">zman</property>
</host>
<property>
The <property> element is used to define properties. The content of the element is the value of the property.
The <property> element has the following attributes:
| Attribute | Required / Optional | Range of Values | Default Value | Description |
| name | Required | The property name | N/A | Specifies the property name. |
Example:
<property name="myPropertyUrl">http://myprops.com</property> <property name="myPropertyCode">123422</property>
