Deploying and Managing Zimlets

Zimbra Confidential. Content subject to change. Nothing herein represents a commitment by Zimbra or VMware
 Admin Console

Deploying/undeploying Zimlets using Admin Console

Login to Admin Console > Zimlets > Deploy

Remember to select “Flush Zimlet cache checkbox” if you are upgrading

Best practice: Always uninstall Zimlet before upgrading

2 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Command Line
zmzimletctl deploy /path/to/zimlet-name.zip

Registers zimlet information in LDAP, installs the zimlet, adds

the zimlet to default COS and turns on the zimlet

Copies zimlet files to:

/opt/zimbra/zimlets-deployed/{zimlet-name}

If the Zimlet has external JAR files, copies JAR files to:

/opt/zimbra/jetty/webapps/zimlet/WEB-INF

Specify “–l” to deploy to “localhost” only. And when not

deploying local, you can optionally specify a specific server
using “-a and –u” for “adminURL and uploadURL” respectively

Otherwise, if not local and no adminURL/uploadURL specified,

zmzimletctl will check provisioning, get a list of all servers
running mailbox service, loop through and deploy zimlet on
each -- defaulting the upload URL for each server to
URLUtil.getAdminURL(server, "/service/upload?fmt=raw").

3 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Command Line

zmzimletctl undeploy <zimlet-name>

This undeploys the Zimlet

zmzimletctl listZimlets

Lists all available Zimlets: Host, LDAP and COS

Host: indicates all those Zimlets that are installed (not necessarily
deployed (in ldap)) and basically means, they are physically present in
zimlets-deployed folder.

LDAP: Shows the list of Zimlets that actually registered in LDAP

COS <cosname>: Shows the list of Zimlets that are turned ON

Notes:

For Zimlet to work, it must be listed on all three areas.

In multimode environment, you will see these three sections for each
node.

You can further control Zimlet availability for individual accounts.

4 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Command Line
Example:

Installed Zimlet files on this host:

com_zimbra_date
com_zimbra_email
com_zimbra_emailreminder
com_zimbra_oldzimlet

Installed Zimlets in LDAP:

com_zimbra_date
com_zimbra_email
com_zimbra_emailreminder
Available Zimlets in COS:
default:
com_zimbra_date
com_zimbra_email

In the above example, users on ‘default’ COS:

- Have access to com_zimbra_date and com_zimbra_email.
- Don’t have access to com_zimbra_emailreminder zimlet (its deployed but is turned
OFF)
- com_zimbra_oldzimlet is somehow left over (may be undeploy didn’t remove it) – you
can safely remove such stale zimlets

5 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Command Line

zmzimletctl listPriority

List the priorities of all Zimlets.

zmzimletctl setPrority

Set a Priority to a Zimlet. Priorities can be set to Zimlets to ensure that a
particular Zimlet to be used over another similar zimlet. Like: You might have two
different phone zimlets using two different services. You can use priority to make
sure which one should be used.

zmzimletctl acl <zimletname> <cos2name> grant

Add Zimlets COS other than default cos

zmzimletctl acl <zimletname> <cos2name> grant <cos3name> grant

Add Zimlets to multiple COSes

zmzimletctl acl <zimletname> <cosname> deny

Disable Zimlet on a COS

For all other zmzimletctl commands:

zmzimletctl help

6 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Command Line

zmprov fc zimlet

Flushes Zimlet cache. Use this whenever you want to make sure to
clear stale zimlet information.

zmprov gc <COSname> | grep zimbraZimletAvailableZimlets

Returns all the Zimlets that are actually ON at the COS level. Every
account under this COS will have access to this Zimlet (unless its
disabled at the account level)

zmprov ga <accountEmail> | grep zimbraZimletAvailableZimlets

This will return all the Zimlets that are actually ON for an individual
account. If for example the zimlet isn’t present here but present at
COS level, the Zimlet is turned off for this individual user.

zmprov ga <accountEmail> | grep zimbraPrefZimlets

This returns the list of zimlets that the user has enabled from front-
end Preferences. (new for 6.x)

7 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Tips & Common Errors

Zimlet is not installing:

Check if the Zimlet is zipped in such a way that all its files are directly
within the zip file and NOT within another folder. i.e. When you zip
the Zimlet, do not right-click on the Zimlet folder and zip the entire
folder from outside, instead open Zimlet’s folder and select all files
and then zip just the files.

Check If you are installing a Zimlet whose version is older than the one
that’s currently installed. If so, uninstall the old one first.

Check if Zimlet’s Zip file name matches Zimlet’s description
file(<zimlet-name>.xml) name (case sensitive).

Also run zmprov fc zimlet command as Zimbra user to clear cache,
just to be sure.

Cannot upgrade Zimlet or latest changes are not shown:

Always Uninstall the old version of the Zimlet first.

Make sure the new Zimlet’s version number is higher than older
Zimlet’s, if not just increment it in config_template.xml and <zimlet-
name>.xml files

Also run zmprov fc zimlet command as Zimbra user to clear cache,
just to be sure.

Ask the end user to clear their Browser Cache.

8 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Tips & Common Errors

Zimlet is installed but not showing up in the client:

You can use Firefox’s Error console ( Tools > Error Console
> Errors Button) to see JS errors.

Firebug: (covered in detail in later section)

Check for JavaScript error in the Zimlet by Enabling Firebug.

Make sure there is no debugger; statements in any of your JS
files. In production mode, Zimbra shrinks the code and if it hits
debugger; statement, it can’t compile and throws exception.

In Firebug> Net tab you will see http 500 error when
Zimbra requests Zimlet JavaScript file (Zimlets-
nodev_all.js)

Zimlets-nodev_all.js is a merged and obfuscated file that
contains ALL zimlet JS in one file

No “debugger;” statements in your JavaScript.
“debugger;” is OK as long as you are in _dev mode or
when you are using ?dev=1

9 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Tips & Common Errors

Zimlet is installed but not showing up in the client:

Make sure to check if the Zimlet is properly deployed by

running zmzimletctl listZimlets command. It must be
displayed in Host, LDAP and COS

Make sure Zimlet is turned ON at account level by running

zmprov ga <accountEmail> | grep
zimbraZimletAvailableZimlets

Make sure its not disabled by the user in their
preferences by running

zmprov ga <accountEmail> | grep zimbraPrefZimlets

Disable all other Zimlets and see if error in some other
Zimlet that happened to be loading before this is
preventing your Zimlet.

Some Zimlets have built-in ON/OFF switches. Try
clicking/right-clicking on that Zimlet in the overview
panel.

10 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 JXplorer for LDAP on Windows

11 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010
 Zimlets Registered in LDAP

12 Zimbra, Zimlets, and the Zimbra logos are registered trademarks of Zimbra – A division of VMware. All other trademarks are property of their respective owners. Copyright © 2010