< Previous

Download

Completed samples are available so that you see the gadgets documented in the code review. In addition to the two gadgets discussed in the code review, a third gadget has been included to illustrate how to leverage the Google Desktop search. This section shows you how to add and configure the gadgets. After you add a gadget, proceed to the relevant section in the Run the sample gadgets section.

The sample download file, SampleWBMonitorRESTClients_V62.zip, contains folders with the following gadgets:

Adding the Alerts Notification gadget

You can receive Alerts to your desktop using the Google Desktop. To receive alerts you must add the WebSphere Business Monitor Alerts Notification gadget to your Google desktop.

Before adding the Alerts Notification gadget, you must have Google Desktop V5.7.0802.22438 or later installed.
To add the Alerts Notification gadget, perform the following steps:
  1. Locate the Alerts Notification gadget file (alerts.gg).
  2. Double click the file and then click OK. The gadget is added to the Google Desktop.
  3. In the Google Desktop, right click and select Add Gadget. The Alerts Notification gadget should be listed and available to add.

Setting up the Alerts Notification gadget

Before using the gadget, you must define the connection to the Business Monitor server. The Business Monitor server must be up and running for this gadget to display alerts.

To configure the gadget, perform the following steps:
  1. Right-click on the Alerts Notification gadget and select Options.
  2. Enter the information for the Monitor server, the Username, and Password fields.
    Note: The Monitor server must be specified as hostname:port. For example, localhost:9080. If security is not enabled, the password can be left blank.
  3. Optional: If the server name you specified uses a secure port, select Use SSL for secure server communication.
  4. Optional: To change the number of alerts displayed on a page, enter the number in the Alerts shown per page field. The default is 10.
  5. Click OK.

Adding the KPI Subscriber gadget

You track KPIs on your desktop using the Google Desktop. To track KPIs you must add the KPI Subscriber gadget for WebSphere Business Monitor to your Google desktop.

Before adding the KPI Subscriber gadget, you must have Google Desktop V5.7.0802.22438 or later installed.
To add the KPI Subscriber gadget, perform the following steps:
  1. Locate the KPI Subscriber gadget file (kpi_subscriber.gg).
  2. Double click the file and then click OK. The gadget is added to the Google Desktop.
  3. In the Google Desktop, right click and select Add Gadget. The KPI Subscriber gadget should be listed and available to add.
  4. Repeat step 3 to add a gadget for each KPI you want to monitor

Setting up the KPI Subscriber gadget

Before you can use the KPI Subscriber gadget, you must connect to a Business Monitor server. The Business Monitor server must be up and running for this gadget to display the information for the key performance indicator (KPI) .

To set up the gadget, perform the following steps:
  1. Right-click on a KPI Subscriber gadget and select Options.
  2. Enter the name of the Monitor server you want to access.
    Note: The Server name must be specified as hostname:port. For example, localhost:9080.
  3. Select the Model, Version, and KPI.
  4. Specify the Refresh Interval in minutes.
  5. Click OK.
    Note: The first time the KPI Subscriber gadget connects to the Business Monitor server, you are prompted for your user ID and password. This authentication information is cached and you will not have to supply it again.
  6. Repeat these steps for each KPI Subscriber gadget you added to your desktop.

Adding the KPI Search gadget

You can monitor KPIs from your desktop using the Google Desktop. To receive KPIs you must add the WebSphere Business Monitor KPI Search gadget to your Google desktop.

Before adding the KPI Search gadget, you must have Google Desktop V5.7.0802.22438 or later installed.
To add the KPI Search gadget, perform the following steps:
  1. Locate the KPI Search gadget file (kpi_search.gg).
  2. Double click the file and then click OK. The gadget is added to the Google Desktop.
  3. In the Google Desktop, right click and select Add Gadget. The KPI Search gadget should be listed and available to add.

Setting up the KPI Search gadget

Before using the gadget, you must connect to a Business Monitor server and run the WebSphere Business Monitor KPI Search Index Utility. The KPI Search Index Utility extracts key performance indicators (KPIs) from WebSphere Business Monitor database and assembles them into an alphabetical list to make improve the performance of the KPI Search gadget. The Business Monitor server must be up and running, and the KPI Search Index Utility must be run at lease once before you can search for KPIs.

To set up the gadget and run the KPI Search Index Utility, perform the following steps:
  1. Right-click on a KPI Search gadget and select Options.
  2. Specify Security Token. To locate the Security Token, perform the following steps:
    1. In Windows, go to Start > Run.
    2. Type regedit in the Open field and then click OK.
    3. Expand the registry tree view to HKEY_CURRENT_USER > Software > Google > Google Desktop > API.
    4. Locate the search_url and note the security token. The security token in located after the &s= in the search_url as shown in the following example.
      http://127.0.0.1:4664/search&s=_cb8GOFsjI5t_oBUTVi1wDxKm04?q=
  3. Optional: If you want to see visual indicators of the KPI's status, select Color KPIs according to status. The colors are defined for the KPI ranges in the monitor model. If you want to personalize the colors or ranges of the KPI, use the KPI Manager in the Business Space or the portlet-based dashboards.
  4. Set the refresh interval by selecting Refresh most recent search with interval, and then specify the number of minutes.
  5. Select the KPI Search Index Utility executable (monitor_kpi_crawler.exe) located in the mon.kpicrawler folder you extracted from the samples .zip file. Click Browse to locate and select the executable that was delivered with the KPI Search gadget.
  6. Optional: To have the KPI Search Index Utility run at a specified interval, select Index KPIs every nnn minutes. Change the number of minutes if you want the indexer to run a different interval.
    Note: nnn is the number of minutes between indexing. The default is 120.
  7. Click Index KPIs Now to run the KPI Search Index Utility.
  8. Click OK.
< Previous