Dashboards WebSphere Portlet User Guide SAP BusinessObjects 4.

0 Feature Pack 3

2012-03-16

Copyright

2011 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. 2012-03-16

Contents

Chapter 1

Document History...................................................................................................................5

Chapter 2

About this Guide.....................................................................................................................7

Chapter 3

Getting Started........................................................................................................................9 Key concepts...........................................................................................................................9 Dashboards WebSphere Portlet...............................................................................................9 Dashboards Data Connections..............................................................................................10 Dashboards data in the Dashboards WebSphere Portlet........................................................12 Key tools................................................................................................................................13 Dashboards Portlet Generation Utility....................................................................................13 Naming conventions...............................................................................................................14 Variables................................................................................................................................14 Creating a Dashboards WebSphere Portlet..........................................................................15 To create a Dashboards WebSphere Portlet..........................................................................15 To configure the Dashboards Portlet Generation Utility..........................................................15 Using Dashboards WebSphere Portlets...............................................................................19 Modifying Dashboards WebSphere Portlet parameters..........................................................19 To configure communication between Dashboards WebSphere Portlets................................19 More Information...................................................................................................................21 23

3.1 3.1.1 3.1.2 3.1.3 3.2 3.2.1 3.3 3.3.1

Chapter 4

4.1 4.2
Chapter 5

5.1 5.2
Appendix A Index

2012-03-16

Contents

2012-03-16

Document History

Document History

The following table provides an overview of the most important document changes.
Version Date Description

SAP BusinessObjects 4.0

November 2010

Initial release. No changes.

SAP BusinessObjects 4.0 Feature Pack 3 March 2012

2012-03-16

Document History

2012-03-16

About this Guide

About this Guide

This guide is intended for business intelligence users who need to create Dashboards WebSphere Portlets from a variety of Dashboards models in a corporate environment. For more information about features and capabilities, see the Dashboards and Presentation Design User Guide.

2012-03-16

About this Guide

2012-03-16

Getting Started

Getting Started

3.1 Key concepts

3.1.1 Dashboards WebSphere Portlet

A Dashboards WebSphere Portlet allows you to integrate a Dashboards model (in .swf format) with a portal server. You can modify the default parameters of the portlet, and allow multiple portlets to communicate with each other. You must create a new portlet for each model that you publish on a portal. Then, you can use an account with Administrator credentials to install your portlet. Note: The portlet discussed in this guide is a template that you can use to build new portlets.

3.1.1.1 Integration
The Dashboards WebSphere Portlet complies with the JSR 168 standard. However, while it can be deployed on any portal server, only IBM WebSphere Portals support communication between portlets. Note: For best performance, deploy the portlet on IBM WebSphere Portal 5.1. For more information, see the following documentation: WebSphere Portal information and product documentation on the IBM Support Portal Portal Integration Kits documentation on the SAP Support Portal (Click Release & Upgrade Info > Installation & Upgrade Guides > SAP BusinessObjects > SAP BusinessObjects Business Intelligence (BI) > Portal Integration Kits) Java Authentication and Authorization Service (JAAS) Reference Guide for the Java 2 SDK, Standard Edition, v 1.4

2012-03-16

Getting Started

3.1.2 Dashboards Data Connections

When you create a Dashboards model, you can establish a Portal Data Connection or a Web Service Connection. You can access these connections in the Dashboards Data Manager. There are three Portal Data Connection types: Provider, Consumer, and None (Parameter). Note: A single model can contain an unlimited number of None (Parameter) and Web Service Connections, because these connections are independent from consumers and providers. However, a model can contain one Provider Data Connection, one Consumer Data Connection, or neither. In addition, a model must have at least one Portal Data Connection.

3.1.2.1 Portal Data Connections

3.1.2.1.1 Provider Data Connections

There are three Provider Data Connections: Cell Providers transmit the values of a single cell. Row Providers transmit the values of a one-dimensional group of cells. Table Providers transmit the values of a two-dimensional group of cells.

3.1.2.1.2 Consumer Data Connections

There are three Consumer Data Connections: Cell Consumers map data to a single cell. Row Consumers map data to a one-dimensional (horizontal or vertical) group of cells. Table Consumers map data to a two-dimensional group of cells. This is an example of ranges for a Cell Consumer (a), a Row Consumer (b), and a Table Consumer (c). Note: For Row Consumers, the range can be horizontal (b) or vertical (d).

10

2012-03-16

Getting Started

Figure 3-1: Ranges for Consumer Data Connections

3.1.2.1.3 None (Parameter) Data Connections

To modify the values of your Dashboards model, you can enter "Edit Mode" in the Dashboards WebSphere Portlet and enter parameters. Note: The parameters must be linked to a cell in a spreadsheet. When you link a parameter to a cell, the parameter receives a default value. If the cell is empty, the default value of the parameter is zero. There are different types of parameters: text number check box date list box

The expected value for check box is (-1) for "checked" and (null) for "unchecked". Although each parameter has an expected value, you can assign different values to the parameters. Related Topics Modifying Dashboards WebSphere Portlet parameters

User information in None (Parameter) Data Connections

If a text parameter includes a special value, the parameter is replaced with information about the portal user who uses the Dashboards WebSphere Portlet. This functionality allows you to personalize a Dashboards model (for example, by inserting a user name into a welcome message). Note: Parameters with names that begin with USER_INFO do not appear when the Dashboards WebSphere Portlet is in "Edit Mode". To avoid replacing a parameter with user data, avoid including USER_INFO in the parameter's name. The portlet supports the following special values:

11

2012-03-16

Getting Started

USER_INFO.user.name.given USER_INFO.user.name.family USER_INFO.user.name.prefix USER_INFO.user.name.middle USER_INFO.user.name.employer USER_INFO.user.name.department

Restriction: Some portals have fields that do not contain special values. For more information on the special values supported by the user registry of your portal, contact your portal administrator.

3.1.2.2 Web Service Connections

Your Dashboards model can receive data from web services. If the web service is a web service query (Query as a Web Service) connection, your model will connect to the SAP BusinessObjects Business Intelligence platform server specified in the URL of the web service query connection.

3.1.3 Dashboards data in the Dashboards WebSphere Portlet

The data in your Dashboards model comes in contact with the Dashboards WebSphere Portlet in the following ways: It is transmitted between physically-connected portlets. Note: The portlet does not modify transmitted data. The user sets data for parameters in the portlet's "Edit Mode".

Portal Data Providers and Portal Data Consumers exchange data in XML format.

12

2012-03-16

Getting Started

Example: XML-formatted data

<data> <row> <column> DATA </column> </row> </data> <data> <row> <column> DATA </column> <column> DATA </column> <column> DATA </column> </row> </data> <data> <row> <column> DATA </column> <column> DATA </column> </row> <row> <column> DATA </column> </row> </data>

The data that your model receives is set as a .swf variable. For Consumers, the portlet does not impose restrictions on the data sender. However, to transmit data between a Dashboards WebSphere Portlet and another type of portlet, you must wrap your data in the same XML format. Communication between different portlet types must be set similarly to communication between Dashboards WebSphere Portlets. Related Topics None (Parameter) Data Connections To configure communication between Dashboards WebSphere Portlets

3.2 Key tools

3.2.1 Dashboards Portlet Generation Utility

The Dashboards Portlet Generation Utility can create Dashboards WebSphere Portlets for your Dashboards model. The utility packages the portlets into web application archive (.war) files. You can install the .war files on a portal server. The utility is located in <PIKPORTALDIR>\XCelsiusPortletGenerationUtility_win32.zip Note: You need Java Runtime Environment 1.4.2 (or later) to run the utility.

13

2012-03-16

Getting Started

Related Topics Variables To create a Dashboards WebSphere Portlet To configure the Dashboards Portlet Generation Utility

3.3 Naming conventions

3.3.1 Variables
This guide uses the following variables.
Variable Description

<PIKPORTALDIR> The directory where required files are located on the Dashboards media. D:\Portal Integration Kits\WebSphere Portal

14

2012-03-16

Creating a Dashboards WebSphere Portlet

Creating a Dashboards WebSphere Portlet

4.1 To create a Dashboards WebSphere Portlet

1. Extract the contents of <PIKPORTALDIR>XCelsiusPortletGenerationUtility_win32.zip 2. Run XcelsiusPortletCreationUtility.bat. The "Dashboards Portlet Generation Utility - Step 1 of 2" page appears. 3. Click Browse next to the "SWF File" field and select your Dashboards model (.swf). Note: Ensure that your model contains Portal Data Connections. 4. Click Browse next to the "Destination Folder" field and select the location for your web application archive (.war) file, and then click Next. The "Dashboards Portlet Generation Utility - Step 2 of 2" page appears, displaying suggested values for each field. For more information about the fields, see the To configure the Dashboards Portlet Generation Utility section. 5. If necessary, make changes to the values, and click Finish. The utility begins to generate the portlet. When the process is complete, the "Dashboards Portlet Creation Utility - DONE" page appears. 6. Note the location of the new portlet, and click OK. Related Topics Variables Dashboards Data Connections

4.2 To configure the Dashboards Portlet Generation Utility

You can configure the default settings of the Dashboards Portlet Generation Utility. 1. Extract XcelsiusPortletCreationUtility.properties from the .jar file contained in the <PIKPORTALDIR>\XCelsiusPortletGenerationUtility_win32.zip file, and open the .properties file in a text editor.

15

2012-03-16

Creating a Dashboards WebSphere Portlet

2. Edit the values for the fields (these are the same values that appear on the "Dashboards Portlet Generation Utility - Step 2 of 2" page).
Field Description Sample

Portlet Id

The internal identification string used by the IBM WebSphere Portal. You can enter letters, numbers, periods (.), and underscores (_). The portlet's name. This name also determines the name of the web application that the utility generates. You can enter letters, numbers, periods (.), and underscores (_). The name that appears when the portlet is displayed. The title of the portlet is displayed in the portlet's title bar. The short title of the portlet may be used instead of the portlet title. May be used instead of the Portlet Title. The description of the portal is displayed on the "Portal Administration" page.

xcelsiusportlet.Row Provider.1197315029777

Portlet Name

RowProvider

Display Name Portlet Title

RowProvider RowProvider Portlet

Portlet Short Title

RowProvider

Portlet Description

Note: Keep this description as short as possible. The keywords that describe the portlet.

Portlet wrapping Dash boards file Row Provider.swf

Portlet Keywords

swf, Dashboards, Row Provider, Row Provider.swf

Note: Portlet Title, Portlet Short Title, and Portlet Keywords are locale-dependent. 3. (Optional) Edit the value of the template web application file name. Caution: Do not edit the template web application's placeholders for special values. The utility may not be able to create portlets if the template web application becomes corrupted. 4. Save your changes to XcelsiusPortletCreationUtility.properties

16

2012-03-16

Creating a Dashboards WebSphere Portlet

If you need a different template web application (to edit the text or layout of your Dashboards WebSphere Portlet's JavaServer Pages (JSP) or add supported languages), you must make a copy of tem plate.war included in the .jar file. Related Topics Variables

17

2012-03-16

Creating a Dashboards WebSphere Portlet

18

2012-03-16

Using Dashboards WebSphere Portlets

Using Dashboards WebSphere Portlets

5.1 Modifying Dashboards WebSphere Portlet parameters

Various parameters of your Dashboards WebSphere portlet appear as HTML input fields when the portlet is in "Edit Mode".
Parameter Type HTML Control

Text Number Date Check Box List Box

Input Field Input Field Input Field Check Box Drop-Down Box

Note: Portlets have the default height and width of the Dashboards models (.swf files) that they contain. The Adobe Flash Player Plug-In allows your web browser to display these files.

5.2 To configure communication between Dashboards WebSphere Portlets

You need to configure your Dashboards WebSphere Portlet only if you need to enable communication between portlets. Note: Ensure that your Provider and Consumer wiring is correct: allow Cell Providers to communicate with Cell Consumers; allow Row Providers to communicate with Row Consumers; allow Table Providers to communicate with Table Consumers. 1. Log onto your IBM WebSphere Portal with an account that has permission to edit pages, and click Administration. The "Manage Pages" page appears. 2. Select the page to which you have published your portlets, and click Edit.

19

2012-03-16

Using Dashboards WebSphere Portlets

The "Edit" page appears. 3. Click Wires, and select wires from the following lists:
Wire Description

"Source portlet" "Sending" "Target page" "Target portlet" "Receiving" "Wire Type"

The portlet that contains the Provider. The field that you want to send. The page where your consumer portlet is published. The portlet that contains the Consumers. The field that you want to receive. The type of wire that you want to use.

Note: Dashboards WebSphere Portlets have only one available option for the "Sending" and "Receiving" wires. 4. Click Add.

The portal creates the wires. Your portals can now communicate with each other. 5. Click Done. Remember: WebSphere does not differentiate between Provider and Consumer portlets. Portlets that contain only consumers may appear in the "Source portlet" list, and portlets that contain only Providers may appear in the "Target portlet" list. Related Topics Dashboards Data Connections Provider Data Connections Consumer Data Connections

20

2012-03-16

More Information

More Information

Information Resource

Location

SAP product information

http://www.sap.com http://help.sap.com/businessobjects Access the most up-to-date English documentation covering all SAP BusinessObjects products at the SAP Help Portal: http://help.sap.com/bobi (Business Intelligence) http://help.sap.com/boepm (Enterprise Performance Management) http://help.sap.com/boeim (Enterprise Information Management) Certain guides linked to from the SAP Help Portal are stored on the SAP Service Marketplace. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. To find a comprehensive list of product documentation in all supported languages, visit:http://help.sap.com/boall. http://service.sap.com/bosap-support

SAP Help Portal

SAP Support Portal

The SAP Support Portal contains information about Customer Support programs and services. It also has links to a wide range of technical information and downloads. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

Developer resources https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary http://www.sdn.sap.com/irj/boc/articles These articles were formerly known as technical papers.

SAP BusinessObjects articles on the SAP Community Network

21

2012-03-16

More Information

Information Resource

Location

https://service.sap.com/notes Notes These notes were formerly known as Knowledge Base articles. Forums on the SAP Community Network https://www.sdn.sap.com/irj/scn/forums http://www.sap.com/services/education Training From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. http://www.sap.com/services/bysubject/businessobjectsconsulting Consulting Consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in topics such as relational and multidimensional databases, connectivity, database design tools, and customized embedding technology.

22

2012-03-16

Index
C
communication between portlets, configuring 19 Dashboards Data Connections (continued) Portal Data Connections (continued) user information 11 Web Service Connections 12 Dashboards Portlet Generation Utility 13 configuring 15 WebSphere portlet, creating 15 Dashboards WebSphere Portlet communication between portlets, configuring 19 default parameters, modifying 19 IBM WebSphere Portal 5.1, integration with 9 overview 9 default parameters, modifying 19

M
media directory, location 14

D
Dashboards Data Connections data, XML format 12 overview 10 Portal Data Connections Consumer Data Connections 10 None (Parameter) Data Connections 11 Provider Data Connections 10

V
variables media directory 14

W
web service query 12 WebSphere portlet, creating 15

23

2012-03-16

Index

24

2012-03-16