ibm.com/redbooks Redpaper

Front cover

Building Composite, Role-Based Dashboards with WebSphere Dashboard Framework

Philip MonsonSam Alexander

Lea MedhurstChristine Miner

Introduction to WebSphere Dashboard Framework

In-depth look at WebSphere Dashboard Framework builders

Leverage key features, such as Annotations and Alerts

http://www.redbooks.ibm.com/ http://www.redbooks.ibm.com/

International Technical Support Organization

Building Composite, Role-Based Dashboards with WebSphere Dashboard Framework

August 2007

REDP-4313-00

Copyright International Business Machines Corporation 2007. All rights reserved.Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP ScheduleContract with IBM Corp.

First Edition (August 2007)

This edition applies to WebSphere Dashboard Framework Version 6.0.

Note: Before using this information and the product it supports, read the information in Notices on page vii.

Contents

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiTrademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixThe team that wrote this paper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixBecome a published author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xComments welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .x

Chapter 1. Introduction to IBM WebSphere Dashboard Framework . . . . . . . . . . . . . . . 11.1 What is WebSphere Dashboard Framework. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Features of WebSphere Dashboard Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.3 How WebSphere Dashboard Framework fits into the IBM WebSphere Portlet Factory

architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3.1 IBM WebSphere Portlet Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.3.2 WebSphere Dashboard Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.3.3 Lotus ActiveInsight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.4 The benefit to the business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.4.1 Why a dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.4.2 IBM Dashboard Accelerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.4.3 Why WebSphere Dashboard Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.5 The example application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.5.1 Technology used. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.6 Audience and goals of this IBM Redpaper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141.6.1 Skills required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 2. Overview of portlet creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.1 Installing WebSphere Dashboard Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2.1.1 Planning the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.1.2 Installing WebSphere Dashboard Framework with Eclipse . . . . . . . . . . . . . . . . . 162.1.3 Notes about installing into Rational Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2.2 WebSphere Dashboard Frameworks concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.2.1 Accessing Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.2.2 WebSphere Portlet Factory concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.3 Creating a WebSphere Dashboard Framework project . . . . . . . . . . . . . . . . . . . . . . . . 222.3.1 Step one: Setting the project name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.3.2 Step two: Selecting the feature set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.3.3 Step three: Java settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.3.4 Step four: Deployment configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.3.5 Step five: Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.4 Developing your first portlet using the framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312.4.1 Step one: Add a model to the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312.4.2 Step two: Exploring your model and the tooling . . . . . . . . . . . . . . . . . . . . . . . . . . 322.4.3 Project Explorer View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332.4.4 Step three: Adding the Excel data source to the builder . . . . . . . . . . . . . . . . . . . . 352.4.5 Step four: Displaying data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382.4.6 Step five: Running the model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392.4.7 Step six: Enhancing the model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432.4.8 Step seven: Adding the status indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452.4.9 Changing WebSphere Portlet Factory properties . . . . . . . . . . . . . . . . . . . . . . . . . 47

Copyright IBM Corp. 2007. All rights reserved. iii

2.4.10 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472.5 Deploying to other environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

2.5.1 Deploying the simple application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482.5.2 Deploying more complex applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

2.6 Moving forward with best practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492.6.1 WebSphere Portlet Factory best practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492.6.2 WebSphere Dashboard Framework best practices . . . . . . . . . . . . . . . . . . . . . . . 50

Chapter 3. Retrieving data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533.1 Retrieving data from relational databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

3.1.1 Creating and configuring the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543.1.2 Configuring the JDBC provider and data source. . . . . . . . . . . . . . . . . . . . . . . . . . 543.1.3 SQL DataSource builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593.1.4 SQL Call builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

3.2 OfficeSalesKPIS service definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633.2.1 getKPIByOffice service operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

3.3 Retrieving data from Lotus Domino. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643.3.1 Domino database for customer orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653.3.2 Configuring your Domino server and Domino database . . . . . . . . . . . . . . . . . . . . 653.3.3 Domino Data Access builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

3.4 getSearchString method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673.4.1 getOrdersByCustomerID action list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683.4.2 OrdersService service definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693.4.3 getOrdersByCustomerId service operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

3.5 Retrieving data from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723.5.1 Excel Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

3.6 Provider model best practices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743.6.1 Testing provider models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743.6.2 Caching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .