Zimlet Configuration File

You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide.

1. Zimbra Tech Center
2. Community Sandbox
3. Zimlet Configuration File

Zimlet Configuration File

 - This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.

 - This article is a Work in Progress, and may be unfinished or missing sections.

The Zimlet configuration file specifies a template for Zimlet configuration. It's name is should be hard-coded to config_template.xml. There are two sections to this file: a section for global configuration, and a section for per host configuration.

The configuration properties may be accessed within the Zimlet definition file as follows:

<zimletConfig name=”com_acme_Maps” version=”1.0”>
         <global>
             <property name=”defaultToGoogle”></property>
             <property name="allowedDomains">*.google.com</property>
        </global>
        <host name="">         
             <property name=”googleApi”></property>
             <property name=”geocodeUser”></property>
             <property name=”geocodePass”></property>
        </host>
</zimletConfig>

The properties defined in the configuration file may be accessed within the Zimlet definition file as follows:

• ${config.global.propertyName} - Accesses a global property. For example, the global property defaultToGoogle would be accessed as: ${config.global.defaultToGoogle}
• ${config.host.propertyName} - Access a host specific property. For example, the host property googleApi would be accessed by ${config.host.googleApi}

Configuration properties are also available to Zimlet JavaScript code via Zimlet classes getConfigProperty method.