Difference between revisions of "Zimlet Developers Guide:Zimlet Configuration File Reference"

(Adding Article Infobox)
Line 29: Line 29:
  
  
This document provides a reference for the elements in the Zimlet Configuration File.
+
 
 +
{{Article Infobox|{{devel}}|{{ZCS 6.0}}||}}This document provides a reference for the elements in the Zimlet Configuration File.
  
 
== Elements ==
 
== Elements ==

Revision as of 22:39, 14 April 2010

Zdg-6-menu-icon-zimbra.jpg Introduction Zdg-6-menu-icon-green-flag.png Getting Started Zdg-6-menu-icon-terminal.png Dev Environment Setup Zdg-6-menu-icon-gear.png Developing Zimlets Zdg-6-menu-icon-advanced.jpg Advanced Concepts Zdg-6-menu-icon-library.jpg
API Specifications
Zimlet Definition File Reference
Zimlet Configuration File Reference
Zimlet JavaScript API Reference
Zimbra REST API Reference
Zdg-6-menu-icon-checkbox.jpg Example Zimlets


Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 6.0 Article ZCS 6.0

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>


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 12/22/2009
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Developers_Guide:Zimlet_Configuration_File_Reference Date Modified: 2010-04-14



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search