9. Using Widgets and Plugins in WebApp

9.1. Widgets and Plugins Overview

The functionality of the WebApp can be extended by using plugins and widgets.

Widgets are best described as miniature applications running inside the WebApp. There are two designated areas in the WebApp where widgets can be used:

  • The widget sidebar (“The widget sidebar, expanded”)
  • The Zarafa “Today” application (“The Zarafa “Today” application”)
Widget sidebar

The widget sidebar, expanded

Zarafa Today application

The Zarafa “Today” application

After installing and enabling the widget on the Zarafa system (can only be done by the local system administrator), a widget can be added to, moved around in or removed from these two areas. Depending on the functionality offered by the widget, it is also possible to interact with the widget itself and or change its settings. While from a technical standpoint a widget is also a plugin to WebApp, we will differentiate between the two in this manual. The main reason is that a plugin is not necessarily a widget (but a widget can be part of a plugin) and a user will clearly notice it when this is the case.

A few examples of widgets that are shipped with every Zarafa system are:

  • Appointments
  • Clock
  • Quick Appointment
  • Quick Contact
  • Quick Mail
  • Quick Note
  • Quick Task
  • Shell Game
  • Tasks
  • Unread Mail

When refering to plugins in this manual, we are talking about extra functionality added to the WebApp, which is integrated more deeply into the user interface. While a plugin in most case will allow you to use it and interact with it, you will not be able to add, move around or remove it as you see fit.

A few examples of plugins for Zarafa WebApp are:

  • Google Maps plugin
  • Spreed plugin
  • Presence plugin (which contains the Chat widget as well)
  • SugarCRM plugin
  • Alfresco plugin
  • Twitter plugin

Note

Widgets and plugins can only be installed and removed by an administrator of the Zarafa system.

9.2. Working with the widget sidebar

9.2.1. Showing the widget sidebar

The widget sidebar is located on the right side in all views. By default, it is collapsed. To show the widget sidebar, click on it.

Widget sidebar

The widget sidebar in its default collapsed state.

Clicking on the clear area of the widget sidebar will quickly reveal the widget area as an overlay on top of the rest of the WebApp. This overly will close again itself as soon as the mousepointer moves to another area. This allows to have the widgets available when needed, but at the same time keeping a clear view when not. Which is ideal for small (or non-wide) screens.

Upon clicking on the double arrow icon at the top of the widget sidebar, the widget area will be shown permanently until clicking it again. This allows to have a permanent overview on all enabled widgets all the time.

Widget sidebar, double arrow button

The widget sidebar’s double arrow button.

9.2.2. Adding widgets to the widget sidebar

By default the widget sidebar will be empty. To add widgets:

  1. Make sure the widget sidebar is shown, as described above.
  2. Click the + icon next to the double arrow. A popup will appear as shown in “The widget chooser popup window”.
  3. Double-click on the widget that should be added to the widget sidebar. The widget will now be added.
  4. If there are already widgets on the sidebar, the new widget will be added to the bottom. Widgets can be rearranged by clicking on its title bar and moving it to the desired position.
Widget chooser popup

The widget chooser popup window

9.2.3. Minimizing widgets

When not using a specific widget very often, it can also be minimized by clicking the up arrow button at the upper right side of the widget. The button will change into a down arrow once the widget is minized. Clicking this down arrow restores the widget’s full view.

9.2.4. Configuring widgets

If the widget supports it, a gear button will be shown at the upper right side of the widget. Clicking it will reveal the configuration options for the widget.

9.2.5. Removing widgets

To remove a widget, click the X button in the upper right corner of the widget. Widgets can be restored at any time following the steps in “Adding widgets to the widget sidebar”.

9.3. Working with the Zarafa “Today” application

The Zarafa “Today” application is a dedicated view for widgets. This enables to have many widgets combined into a single view. To get to the Zarafa “Today” application, click on the Zarafa link in the Shortcut Bar.

The Zarafa “Today” application will appear, as shown in “The Zarafa “Today” application”. From there the same procedure as with the widget sidebar can be used to add, minimize, configure and remove widgets. The only difference is that here it is possible to have multiple columns to place widgets on.

By default the Zarafa “Today” application is populated with the Appointments and Tasks widgets.

9.4. Plugins

When installed, plugins can be enabled via the plugin tab in the settings dialogue.

Plugins overview

The plugin overview.

9.4.1. Plugin versions

In the plugin overview you can check the version number of the plugins.

Plugin version

The Versions of the plugins.