ZCS Administrator's Guide, Network Edition 5.0 (Rev 5.0.19 September 2009)
Table of Contents Previous Next Index


Working with Zimlets

Working with Zimlets
Zimbra Collaboration Suite created Zimlets™ as a mechanism to integrate ZCS with different third-party applications to enhance the user experience from the Zimbra Web Client. When Zimlets are added to the ZCS, users can look at information and interact with the third-party applications from within their email messages. With Zimlets, arbitrary message content can be made live by linking it with Web content and services on intranets or the Internet.
Mousing over actionable content gives the user a real-time preview (subject to security constraints) that can be factored in decision making. For example, various Zimlets can be enabled to let users preview the following:
Several pre-defined Zimlets are included with ZCS, and you can create other Zimlets so that users can interact with your company resources or other defined applications from the Zimbra Web Client. For more information about creating Zimlets, see the Zimlets - A Mechanism for Integrating Disparate Information Systems and Content with the Zimbra Collaboration Suite specification. A copy is available on the Zimbra website, www.Zimbra.com.
This chapter describes how to deploy, configure, and manage Zimlets on the Zimbra server. The Zimlets that are included with Zimbra Collaborating Suite are described at the end of this chapter.
Setting Up Zimlets in ZCS
Zimlets are delivered as a zip file that includes all the files necessary to run the Zimlet. The zip file is copied to the Zimbra servers and the administrator can use the Zimlet Management Tools from either the administration console or from the command line interface (CLI)) to deploy the Zimlet to users. You can configure Zimlets only from the command line interface.
You can see a list of Zimlets that are installed on the Zimbra server, and which are enabled or disabled on the LDAP server from the administration console Zimlets pane or by entering the following CLI command.
Type zmzimletctl listZimlets to view the status of installed Zimlet files.
When you view the information from the command line, you also view which COS make the Zimlets available.
Managing Zimlets from the Administration Console
You can manage the following Zimlet management tasks from the Zimbra administration console
Deploy a Zimlet, which creates the Zimlet entry in the LDAP server, installs the Zimlet files on the server, enables the Zimlet and makes it available to the members of the default COS.
Undeploy a Zimlet, which removes it from the COS listings and the Zimlets list but does not uninstall the Zimlet from the server.
You cannot uninstall the Zimlet from the administration console.
See the administration console Help for more information about managing Zimlets on the administration console.
Managing Zimlets from the Command Line
The Zimlet zip file should be copied to each Zimbra server where it will be deployed. You should copy your Zimlets to /opt/zimbra/zimlets-extra
To deploy a Zimlet to the default COS
1.
Zimlets to deploy are found in the /opt/zimbra/zimlets-extra directory. If you are deploying your zimlet, copy the zip file to that directory.
2.
zmzimletctl deploy <zimlet.zip file name>
Deploying the Zimlet creates the Zimlet entry in the LDAP server, installs the Zimlet files on the server, grants access to the members of the default COS, and turns on the Zimlet. The Zimlet is displayed on the administration console Zimlets page.
Running zmzimletctl deploy is equivalent to running the following four commands.
To deploy a Zimlet to a COS other than default
To deploy a Zimlet to one or more COSs other than default, first install the Zimlet, then adjust the ACL on the COSs.
1.
Zimlets to deploy are found in the /opt/zimbra/zimlets-extra directory. If you are deploying your zimlet, copy the zip file to that directory.
2.
zmzimletctl deploy <zimlet.zip file name>
This creates the Zimlet entry in the LDAP server, installs the Zimlet files on the server, grants access to the members of the default COS, and turns on the Zimlet.
3.
zmzimletctl acl <zimletname> <cosname1> grant
You can grant access to more than one COS on the same command line. Enter as zmzimletctl acl <zimletname> <cosname1> grant <cosname2> grant
Note: To turn off access to Zimlets in the default COS, type
                zmzimletctl acl <zimletname> default deny
Viewing Zimlet List
To view a list of Zimlets that are on the server and their status type
zmzimletctl listZimlets all
Configuring a Zimlet
Some Zimlets may require additional configuration after they are deployed to configure additional information. Your developer will let you know if this is necessary.
The Zimlet Management Tool provides the means for setting up a special Zimlet configuration. You make the configuration changes on the configuration template and then install the new configuration file on the Zimbra server.
How to Change Zimlet Configurations
1.
zmzimletctl getConfigTemplate <zimlet.zip>
The config_template.xml is extracted from the Zimlet. zip file.
2.
Note: If you have more than one custom Zimlet, you should rename the config_template.xml file before updating the configuration in LDAP so that files are not overwritten.
3.
Type the following command to update the configuration in the LDAP. If you changed the name of the configuration template, replace config_template.xml with the new name.
zmzimletctl configure config_template.xml
Disabling or Removing a Zimlet
You can turn off access to a Zimlet from a COS, disable the Zimlet, or remove the Zimlet from the server.
To turn off access from a COS
Type zmzimletctl acl <zimletname> <cosname> deny
To disable a Zimlet on the Zimbra server
Type zmzimletctl disable <zimletname>
Note: To enable a disabled Zimlet, type zmzimletctl enable <zimletname>.
To uninstall and remove a Zimlet from the Zimbra server
When a Zimlet is undeployed, it is removed from all COSs and then removed from LDAP.
Type zmzimletctl undeploy <zimletname>
The Zimlet and all associated files are uninstalled.
Remove the Zimlet file from /opt/zimbra/zimlets
Important: Only remove your custom Zimlets. You should not remove Zimlets that are shipped with the Zimbra Collaboration Suite. If you do not want to have the Zimbra Zimlets available, disable them.
Zimlets enabled by default in ZCS
Zimbra Collaboration Suite includes preconfigured Zimlets when ZCS is installed. These Zimlets do not appear in the navigation panel list but come into play by enhancing the user experience when users certain ZWC features.
For email messages, users can click on the following type of text.
Dates, to see their calendar schedule for that date.
Email addresses/names, to see complete contact information, if available in the Address Book.
URLs, to quickly go to the website specified in an email message..
Phone numbers, to quickly place a call. VOIP software such as Skype or Cisco VOIP phone must be installed on the user’s computer. The user can click the phone number in the message to immediately make a call.
Emoticons, to add a textual portrayal of different facial expressions to user’s messages
When users right-click on these Zimlets within their messages, additional actions are available.
The above Zimlets do not require any configuration to work. You can disable these Zimlets but do not remove them from ZCS.
To see the latest documentation about new Zimlets, go to the Zimbra Wiki, Zimbra Community > Zimlet page.
The Zimlets Gallery
A library of Zimlets are available for deployment when you install or upgrade ZCS. You can enable these by COS to give your users access to a particular Zimlet feature.
Deploying relevant Zimlets provides users with features to help them efficiently handle routine tasks as users do not have to leave the ZWC interface.
A description of the following Zimlets can help you determine which ones to use for your organization.These Zimlets are found in /opt/zimbra/zimlets-extra.
Contact Cleaner, to keep Address books organized and up to date
Contact Collector, to quickly add email addresses
Flickr, to attach Flickr pictures to an email
Yahoo! Translator, to translate messages into another language
Google Translator, to translate messages into another language
SMS, to send messages to cell phones from ZWC
Travel Agent, to make air, car, and hotel reservations from ZWC
Yahoo! Currency, to convert the value of money
Yahoo! Finance, to check and monitor stock prices from ZWC
Yahoo! Local, to find local businesses on Yahoo! Maps
Yahoo! Maps, to find a location on a map that displays in ZWC
Contact Cleaner
The Contact Cleaner Zimlet is used to help users clean up their address books. Contact Cleaner works in the address books as follows:
Users access the above dialog box. Single-clicking over the names or clicking on Expand All/Collapse All displays the details of the contacts. Users can choose if they want to keep the merged contact information or leave them as is.
Contact Collector
The Contact Collector Zimlet lets users drag and drop messages to the Zimlet to quickly add email addresses to their address books.
Users drag and drop the email with the contact names to be added to the Contact Collector Zimlet. Only email addresses in the To field are given as options to be added.
They check the boxes beside the contacts to add. A dialog box appears confirming the addition of the email addresses.
Flickr
Flickr is the online photo-sharing and photo management Yahoo! application. The Flickr Zimlet allows users to attach pictures from their Flickr account to emails sent from ZWC.
To use the Flickr Zimlet,
Users must authorize access from their account in ZWC. Once the Zimlet is authorized, users can attach photos from their Flickr account to any email that they compose.
Users attach Flickr photos to an email in the Compose email window by clicking the Add Attachment > Flickr Photos tab. All the photos in the authorized Flickr account are available to attach to the email.
Flight Status
The Flight Status Zimlet gives users flight information, including flight details, departure, and arrival information without having users leave the ZWC. To use the Flight Status Zimlet to get flight status details, you must have an account from FlightExplorer®, http://www.flightexplorer.com/products/flightdirect/flightdirect.aspx. you must change the Flight Status Zimlet configuration template. See “Configuring a Zimlet” .
To check the status of a flight, users click the Flight Status Zimlet and enter the relevant information in the Flight Status dialog box.
When users click Track Flight, the Zimlet provides the requested details about a flight.
Yahoo! Translator
The Yahoo! Translator Zimlet is deployed to translate emails or messages into desired languages from the options presented in the Zimlet.
Content to be translated is typed in the text box or can be copied and pasted. To change the language preference, users click on the drop-down menu and choose the desired language.
To translate, users click Translate and see the translated message in the text box. To translate to other languages, users should open the drop-down menu again, choose a different language option, and click Translate again to see the message in the different language.
To insert the translated message into a new email message, users click Insert Translation into New Message and a compose mail window opens with the translated message appearing in the email body.
Users can also set the default translation language by right-clicking on the Zimlet and choosing Preferences. In the Preferences dialog, choose the default language combination and click OK to set the chosen option.
Google Translator
The Google Translator Zimlet is useful for translating messages and emails into different languages like English to German or Portuguese to English.
To use this Zimlet, users drag the message to be translated to the Google Translator Zimlet. The message need not be open in the reading pane.
The translated result appears in the same text box where users enter the original text, replacing the original text entered. Users can copy and paste the desired output into their emails or documents.
SMS
The SMS Zimlet allows users to send messages or forward existing emails to cell phones directly from ZWC. To use the SMS Zimlet, you need a service with a SMTP to SMS gateway provider, such as ipipi.com or Upperwireless.com. you must change the SMS Zimlet configuration template. See “Configuring a Zimlet” .
SMS Zimlet is used as follows:
In the Send SMS Zimlet dialog box, users enter the cell number that they you want to send the message to, followed by the message text that has to be sent. Users can also drag an email message to the text field. Each SMS message can send up to 160 characters to a mobile device.
They click OK to send the message and receive a brief pop-up confirmation. They can also right-click the Zimlet to save their cell number in the Preferences dialog box.
Travel Agent
The Travel Agent Zimlet is useful for reserving flights, cars, or hotels conveniently without leaving the ZWC. Users can enter details in the search fields and click a search engine to go to the website and get related information.
Users click the Travel Agent Zimlet, select either the Flight, Car, or Hotel tab, and enter the relevant information in the Search travel reservations across multiple engines dialog box.
They click either of the three choices for search engines; Sidestep, Travelocity, and Hotwire are shown in the screen capture. The users are directed to the relevant results in a new browser window.
Users can also right-click on the Travel Agent Zimlet to set preferences for their default airport and the search engine choices to display in the Zimlet.
Yahoo! Currency
The Yahoo! Currency Zimlet is used to convert currencies conveniently from within the ZWC.
To use the Yahoo! Currency Zimlet, users right-click the Zimlet and click Convert. In the Currency Converter dialog box, they type in 1 USD = ? to see the value of $1 in various currencies (or any other amount). The currency list shown is the list supported by Yahoo!
Users can double-click or right click to set preferences for the home currency and tooltip currencies. Tooltip currencies set the default currency used in email content. They can also choose the relevant ex-rate chart to set preference for converting from the home currency or to the home currency.
Yahoo! Finance
Users can check current stock prices using the Yahoo! Finance Zimlet. They can monitor a list of stocks periodically by setting a time interval, search for company stock symbols, and keep track of their expenses using calculators.
Users double-click the Yahoo! Finance Zimlet to set preferences for company stock symbols to be monitored and the time interval at which they alternate with the mini calendar.
Important: To view stock status at the desired time interval, it is important that the mini calendar is enabled in Preferences > Calendar. Stock status appears, alternating at the time interval, with the mini calendar in the same space.
Yahoo! Local
The Yahoo! Local Zimlet lets users search for local businesses and get directions and information.
Simple keywords like ‘movie’ or ‘pizza’ can be typed in the search box that appears within the Zimbra inbox to get a list of results closest to users’ local area.
Users can also right-click on the Y! Local Zimlet to open a menu from where they can choose specific local features such as traffic, an address, or set other preferences.
Yahoo! Maps
The Yahoo! Maps Zimlet allows users to do the following:
Enter a location in the search field and instantly find the location on Yahoo! Maps without being redirected to another site. The map appears as a pop-up within the ZWC inbox.
Hover over an address in an email to see a map in a pop-up window. Clicking on the address opens a new browser window with the location pointed out in Yahoo! Maps.

Working with Zimlets

Table of Contents Previous Next Index
ZCS Administrator's Guide, Network Edition 5.0 (Rev 5.0.19 September 2009)
Copyright © 2009 Zimbra Inc.