Difference between revisions of "Zimlet Configuration File"

Line 1: Line 1:
The ''config_template.xml'' file specifies a template for Zimlet configuration. There are two sections to this
+
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.  
file: a section for global configuration, and a section for per host configuration.  
 
  
 
The configuration properties may be accessed within the [[Zimlet_Definition_File|Zimlet definition file]] as follows:
 
The configuration properties may be accessed within the [[Zimlet_Definition_File|Zimlet definition file]] as follows:
Line 8: Line 7:
 
         <global>
 
         <global>
 
             <property name=”defaultToGoogle”></property>
 
             <property name=”defaultToGoogle”></property>
 +
            <property name="allowedDomains">*.google.com</property>
 
         </global>
 
         </global>
 
         <host name="">         
 
         <host name="">         
Line 17: Line 17:
 
</pre>
 
</pre>
  
The properties defined in ''config_template.xml'' may be accessed within the Zimlet definition file as
+
The properties defined in the configuration file may be accessed within the Zimlet definition file as
 
follows:
 
follows:
  
 
* ${config.global.propertyName} - Accesses a global property. For example, the global property <i>defaultToGoogle</i> would be accessed as: ${config.global.defaultToGoogle}
 
* ${config.global.propertyName} - Accesses a global property. For example, the global property <i>defaultToGoogle</i> 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}
 
* ${config.host.propertyName} - Access a host specific property. For example, the host property googleApi would be accessed by ${config.host.googleApi}
  

Revision as of 08:06, 17 August 2009

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.

Verified Against: Date Created: 7/28/2009
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Configuration_File Date Modified: 2009-08-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