Zimlet Configuration File

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

Zimlet Configuration File

   KB 2973        Last updated on 2021-07-17  

(0 votes)

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”>
             <property name=”defaultToGoogle”></property>
             <property name="allowedDomains">*.google.com</property>
        <host name="">         
             <property name=”googleApi”></property>
             <property name=”geocodeUser”></property>
             <property name=”geocodePass”></property>

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.

Verified Against: Date Created: 7/28/2009
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Configuration_File Date Modified: 2021-07-17

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