< Previous | Next >

Overview of the WebSphere Business Monitor sample gadgets

Desktop gadgets are small applications that can be placed on your desktop or added to a Sidebar. These gadgets that can be installed and placed on a computer desktop are becoming popular. Examples of programs that provide this capability include Google Gadgets on Google Desktop, Windows® Vista Sidebar and Yahoo Widget Engine.

The download file contains three sample Google gadgets that show how WebSphere Business Monitor data can be accessed by calling REST APIs. The gadgets contained in the sample are the Alerts Notification gadget, KPI Subscriber gadget, and KPI Search gadget. These gadgets show how WebSphere Business Monitor data can be displayed in different ways other than a dashboard.

The following topics are descriptions of the sample gadgets. These descriptions provide the context in which the WebSphere Business Monitor data can be consumed and rendered in a useful manner.

An explanation of how to programmatically access WebSphere Business Monitor data through REST APIs is detailed in the Code Review. The code review steps you through two of the three sample gadgets contained in the downloaded .zip file. The third example (KPI Search gadget) is an example of an elaborate gadget that uses the same REST APIs that the other two gadgets use, therefore a code review is not provided that sample.

Note: For copyright and trademark information, see http://www.ibm.com/legal/copytrade.shtml#section-special.

Alerts Notification gadget overview

The Alerts Notification gadget is used for displaying dashboard alerts created from the Business Monitor server. Alerts are events containing messages regarding situations that were detected in the monitored applications. Alerts are especially useful when certain actions are required from a user to correct a situation. In some cases, they are used as a warning message about a problem or a potential problem. A user can choose which alerts he needs to be notified.

With this gadget, the user can browse through his alert messages which are ordered from the most recent to the least recent. The gadget also allows the users to sort the alerts using other criteria such as the subject or status. This gadget only displays alerts that are of the type Dashboard. The following figure shows an example of the Alerts Notification gadget.

Figure 1. The Alerts Notification gadget showing a list of alerts
Alerts notification gadget

The most basic action that you can do to an alert is to read its contents. This is done by double-clicking on the alert and the details appear in a separate window. The following figure shows an example the details for an alert. Unread alerts are displayed in back with a black dot to the left of the alert. When read, the alert automatically turns to gray and the dot is removed as can be seen in the following figure.

Figure 2. Showing the details of an alert
Alert details

You can revert the status of a read alert to unread by choosing the alert from the list and clicking Mark Unread. You can also delete an alert from the list or forwarded the alert to another user with the Forward button. The following figure shows multiple alerts being forwarded to another user. That user sees these forwarded alerts the next time the alerts list is viewed.

Figure 3. Forwarding alerts to another user
Alert forwarding

The Alerts Notification gadget refreshes the list periodically so you can be notified about any new alerts. Finally, you can modify the settings for your alert subscriptions by using the Alert Subscriptions button. The following figure shows the current alert subscription settings for a user. For each type of alert, you can choose your preferred methods for receiving the notifications. The example below shows one alert type to which a user subscribes. Had there been a number of them, they are all listed, separated by a horizontal line, so that the user can choose the notification methods for each alert type.

Figure 4. Updating the user's subscription options for alerts.
Alert subscriptions

KPI Subscriber gadget overview

The KPI Subscriber gadget is a very simple tool that allows a user to keep track of the current value of a Key Performance Indicator (KPI) of interest. The user can create an instance of the gadget on his desktop which displays in graphical format the current status of the KPI.

In the figure below, the white line indicates the target value that is acceptable for this KPI while the black arrow indicates the actual value. In this example, the user can see at a glance that the average credit check duration is above the target value.

Figure 5. A KPI Subscriber gadget that shows the average duration of a credit check task
KPI Gauge for Average Credit Check Duration

The gadget can be configured to refresh periodically. A refresh involves retrieving the current value of the KPI from the Business Monitor server using REST APIs and then repainting the graph.

The gadget has an Options panel so you can specify which Business Monitor server to connect, which KPI from which monitor model to watch, as well as the refresh interval. If the Business Monitor server is a secured, you will be prompted for you user ID and password. Finally, you can open several instances of the KPI Subscriber gadget so that you can track multiple KPIs simultaneously from your desktop.

Figure 6. An Options panel allows the user to choose which KPI to watch
KPI Options

KPI Search gadget overview

The KPI Search gadget leverages the Google Desktop. You can create an instance of the gadget on your desktop to search for KPIs and their current status in your WebSphere Business Monitor. It also searches for documents in your local storage that contain the search string you specified. To use this gadget you must run the KPI Search Index Utility to index the information in WebSphere Business Monitor. This utility is included in the samples download .zip file.

< Previous | Next >