Difference between revisions of "What is a Zimlet"
(Zimlets Whitepaper conversion 2)
Revision as of 18:11, 15 July 2009
What is a Zimlet?
A Zimlet is a “zipped” bundle of content that is deployed to the ZCS server by the Zimlet management tool. The files comprising the Zimlet bundle enable the integration of the ZCS platform with disparate information systems and content. These files are enumerated below. Note that the “<zimlet>” label in descriptions below would be replaced with the name of the actual Zimlet. The naming convention is the reversed domain name of the author’s company where the “.”s in the domain name are replaced by “_”s. For example, if the author’s company is acme.com and the Zimlet name is Maps, then the fully qualified name would be com_acme_Maps.
- <zimlet>.jsp [optional] – This file contains optional JSP code to implement connectivity, data retrieval, or additional server-side data functionality. Only Zimlets requiring custom server side implementations need provide a JSP implementation. The Zimlet infrastructure comes with a generic proxy servlet rooted at “/service/proxy” for making arbitrary calls to external systems or services. See section 6 for more information.
- <zimlet>.properties [optional] - This is the fallback Zimlet message property file. By using Java property files, Zimlets are easily Localizable.
- config_template.xml [optional] - This a template file for the Zimlet’s configuration properties for the Zimlet. See section 8 for more information
In addition, the Zimlet bundle may also include:
- A Java class that implements the com.zimbra.cs.zimlet.ZimletHandler interface to help match Zimlet content objects for server-side indexing (see section for more information)
- Additional properties files for the locales for which the Zimlet has been localized.
- Additional supporting files such as CSS, HTML, image files, etc.