unified web services portal sample guide

Unified Web Services Portal Sample Guide

Unified Web Services

Windows

2 Unified Web Services Portal Sample Guide

1Copyright Copyright © 2004 Business Objects. All rights reserved.

Trademarks The Business Objects logo, WebIntelligence, BusinessQuery, the Business Objects tagline, BusinessObjects, BusinessObjects Broadcast Agent, Rapid Mart, Set Analyzer, Personal Trainer, and Rapid Deployment Template are trademarks or registered trademarks of Business Objects S.A. in the United States and/or other countries.Contains IBM Runtime Environment for AIX(R), Java(TM) 2 Technology Edition Runtime Modules (c) Copyright IBM Corporation 1999, 2000. All Rights Reserved.This product includes code licensed from RSA Security, Inc. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j.All other company, product, or brand names mentioned herein, may be the trademarks of their respective owners.

Use restrictions This software and documentation is commercial computer software under Federal Acquisition regulations, and is provided only under the Restricted Rights of the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. The use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in subdivision (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at 252.227-7013.

Patents Business Objects owns the following U.S. patents, which may cover products that are offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352.

Part Number 3H6-50-700-01

Unified Web Services Portal Sample Guide 3

ContentsChapter 1 Introduction 5

About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Who should read this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Business Objects information resources . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2 Installing the Unified Web Services Portal Sample 7Installing the Unified Web Services Portal sample in a .NET environment . 8

Preinstallation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Deploying the Unified Web Services Portal sample on IIS . . . . . . . . . . 8

Installing the Unified Web Services Portal sample in a J2EE environment . 9Deploying the Unified Web Services Portal sample with Tomcat . . . . 10

Configuring the web services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Generate the Unified Web Services Portal WAR file . . . . . . . . . . 11Deploying the Unified Web Services Portal web application . . . . . 12

Chapter 3 Using the Unified Web Services Portal Sample 13Accessing the sample through a web browser . . . . . . . . . . . . . . . . . . . . . . 14Viewing document lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Viewing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Refreshing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Viewing Multiple documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Drilling on documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Disconnecting from a web service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Accessing the sample through Visual Studio . . . . . . . . . . . . . . . . . . . . . . . 20Accessing the sample through a JSP editor . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 4 Unified Web Services Portal Sample Architecture 21The Unified Web Services Portal sample classes . . . . . . . . . . . . . . . . . . . 22

Document workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Contents


setContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25ProcessActiveDocumentFromRequest . . . . . . . . . . . . . . . . . . . . . 26ExtractInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

The Unified Web Services Portal frameset . . . . . . . . . . . . . . . . . . . . . . . . . 27Unified Web Services Portal sample frameset in tabular mode . . . 29Unified Web Services Portal sample frameset in dashboard mode 29Handling actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Appendix A Business Objects Information Resources 35Documentation and information services . . . . . . . . . . . . . . . . . . . . . . . . . . 36Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

What’s in the documentation set? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Where is the documentation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Documentation from the products . . . . . . . . . . . . . . . . . . . . . . . . . 36Documentation on the web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Documentation on the product CD . . . . . . . . . . . . . . . . . . . . . . . . . 36

Send us your feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Customer support, consulting and training . . . . . . . . . . . . . . . . . . . . . . . . . 37

How can we support you? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Online Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Looking for the best deployment solution for your company? . . . . . . . . 38Looking for training options? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Index 41

chapter

Unified Web Services Portal Sample Guide

Introduction

IntroductionAbout this guide1


About this guideThis guide describes how to install and configure the Unified Web Services portal sample. It outlines how to prepare your system environment and steps through the procedure for installing and configuring the Unified Web Services portal sample. This guide also provides information about the features of the sample as well as usage information.

Who should read this guideThe Unified Web Services Portal Sample Guide is intended for use by anyone developing Unified Web Services consumer applications. This guide assumes familiarity with BusinessObjects Enterprise.Installing and deploying the Unified Web Services portal sample in a J2EE or .NET environment requires knowledge of:• Operating System administration (such as Windows 2000 or UNIX)• Application Server administration (such as a Java application server or

IIS)

Business Objects information resourcesFor more information and assistance, see Appendix A: Business Objects Information Resources. This appendix describes the Business Objects documentation, customer support, training, and consulting services, with links to online resources.

chapter

Installing the Unified Web Services Portal Sample


Installing the Unified Web Services Portal SampleInstalling the Unified Web Services Portal sample in a .NET environment2

This chapter explains how to install the Unified Web Services Portal sample in a .NET or J2EE environment.

Installing the Unified Web Services Portal sample in a .NET environment

You can find the Unified Web Services Portal sample in the wssdk_portal\data\ folder.

Preinstallation requirementsBefore installing the Unified Web Services Portal sample, IIS and the .NET Framework 1.1, must be installed on your server machine. IIS must be installed before you install the .NET framework. You can check to see if you already have the and .NET Framework 1.1 by looking in the Add/Remove Programs section of the Windows Control Panel. If you do not see Microsoft .NET Framework 1.1 in the list of currently installed programs, you can install it using Windows Update. To do this.1. Use your web browser connect to http://windowsupdate.microsoft.com.2. Click Scan for updates.3. When the update scan is completed, click Windows in the left hand

Windows Update panel. 4. Sroll down in the list of Windows updates till you find the entry marked

Microsoft .NET Framework 1.1. 5. Click Add. 6. Click Review and Install updates. 7. Click Install Now. Note: Installing the .NET Framework requires you to reboot your machine. After your machine has rebooted, look in Add/Remove Programs section of the Windows Control Panel to validate that the .NET Framework is installed.

Deploying the Unified Web Services Portal sample on IISThis section describes how to install the Unified Web Services Portal Sample on IIS. To do so:1. Unzip wssdkdotNETPortal_110_EN.zip from the

wssdk_portal\data folder to a directory on your machine.

http://windowsupdate.microsoft.com/


Installing the Unified Web Services Portal SampleInstalling the Unified Web Services Portal sample in a J2EE environment 2

The DSWSPortal directory is created. 2. From the Windows Start menu, select Programs > Administrative Tools >

Computer Management.The Computer Management window is displayed.

3. Under Services and Applications > Internet Information Services, right-click Default Web Site and select New > Virtual Directory.The Virtual Directory Creation Wizard appears.

4. Click Next.The Virtual Directory Alias window is displayed.

5. Enter dswsportal in the Alias field and click Next.The Web Site Content Directory window is displayed.

6. Click Browse, then navigate to the DSWSPortal directory created in step 1.

7. Click Next.The Access Permissions window is displayed.

8. Select the following options:• Read• Run scripts (such as ASP)

9. Click Next, and then Finish.To check that the Unified Web Services Portal sample is installed, open the sample in a web browser on the machine where you have installed it, using the following URL:http://localhost/dswsportalOnce the Unified Web Services Portal sample is installed you need to configure the dsws.config file to enable the sample to access one or more Unified Web Services Portal. For information on configuring dsws.config and using the Unified Web Services Portal sample, refer to the “Configuring the web services” on page 10. The configuration process is the same for both IIS and Tomcat.

Installing the Unified Web Services Portal sample in a J2EE environment

You can find the Unified Web Services Portal sample in the wssdk_portal\data\ folder.


Installing the Unified Web Services Portal SampleInstalling the Unified Web Services Portal sample in a J2EE environment2

To work correctly the sample must be deployed on an application server. The following section describes how to deploy the Unified Web Services Portal sample on the Tomcat application server. This guide assumes you have Tomcat installed and running on your server. The machine on which Unified Web Services Portal sample is installed must have network access to an application server running the Unified Web Services provider. For more information on installing Unified Web Services, see the Unified Web Services Administrators Guide.

Deploying the Unified Web Services Portal sample with Tomcat

To install the Unified Web Services Portal sample with Tomcat, you must generate and deploy the dswsportal.war file. To do so:1. Unzip the wssdkJ2EEPortal_110_EN.zip file from the

wssdk_portal\data folder to a temporary directory.2. Navigate to the wssdkJ2EEPortal directory.

Configuring the web servicesThe dsws.config file contains the XML code needed to connect to a Unified Web Services provider. The dsws.config file defines the list of web services you can access from the sample as well as the proxy server if necessary. To define a provider, edit the parameters according to the settings of the provider(s) that you want to make available in the sample. Open dsws.config and you will see:

<configuration version="1.0"><WebService Name="BusinessObjects Enterprise XI" Icon="image/java.gif">XI Web Services<Connection

URL="http://localhost:8080/dswsbobje/services/session"

Proxy="0" /></WebService><Proxy Name="Outside"

URL="http://http-cache.mycompany.com:3667" /></configuration>

The configuration file holds information about the BusinessObjects Enterprise service and a proxy connection. Each WebService tag contains a Connection tag.


Installing the Unified Web Services Portal SampleInstalling the Unified Web Services Portal sample in a J2EE environment 2

The dsws.config file has the following structure<WebService Name="Web Service Name" Icon="image/

filename.gif">Web Service Description<Connection URL="URL of Web Service" Proxy="0" />

</WebService>The WebService tag includes the following parameters:

The WebService tag contains the following attributes:

The Connection tag contains the following attributes

The Proxy tag contains the following attributes

Modify the Web Service Description Parameter, Connection and Proxy tags to match your Unified Web Services deployment.

Generate the Unified Web Services Portal WAR fileWhen the dsws.config file has been configured correctly, run the WSPortalAssemblyScripts.bat script, either by

Parameter Description

Web Service Description

A description of the web service that is displayed in the connection page of the sample.

Connection The Connection tag defines the web service location.

Attribute Description

Name The name of the web service.Icon The path and name of the image for the icon that appears next to

the web service name in the sample connection page.


URL The URL of the web service.Proxy Specifies whether the web service uses a proxy server. If it uses a

proxy server, set the value to 1. If it does not require a proxy, set the value to 0.


Name The name of the proxy.URL The URL of the proxy server.Login User name for the proxy server.Password Password for the proxy server.


Installing the Unified Web Services Portal SampleInstalling the Unified Web Services Portal sample in a J2EE environment2

• double clicking WSPortalAssemblyScripts.bat in Windows Explorer• running WSPortalAssemblyScripts.bat from the command line. The dswsportal.war archive is generated in the same directory that contains WSPortalAssemblyScripts.bat.

Deploying the Unified Web Services Portal web applicationThe dswsportal.war archive has to be deployed on the application server where it will be automatically unwarred and deployed in a directory that has the same name as the war archive. To do this:1. Stop Tomcat. 2. Copy dswsportal.war to the $TOMCAT_HOME/webapps directory.3. Start Tomcat. To check that the Unified Web Services Portal sample is installed, open the sample in a web browser on the machine where you have installed it, using the following URL:http://hostname:Port/dswsportalwhere hostname is the name of the server on which you installed the Unified Web Services Portal and Port is the port number for which the installed application server is configured. The default port number for Tomcat is 8080. If the sample connection page is not displayed, check that dsws_portal.war has been deployed. To do so, browse to $TOMCAT_HOME\webapps and verify that the dswsportal directory containing the Unified Web Services Portal sample files has been created.If the sample page is displayed, click the Check Web Services URL at the bottom of the page. This will direct you to the Available Web Services Status page. In this page you will see a list of the web services your Unified Web Services Portal deployment is connected to. By default you will see:Available Web Services Status Web Service BusinessObjects Enterprise 11: OK. Version 11.0

Click the “Back to connection page” URL. Go to Chapter 3: Using the Unified Web Services Portal Sample to see how to navigate Unified Web Services Portal.

chapter

Using the Unified Web Services Portal Sample


Using the Unified Web Services Portal SampleAccessing the sample through a web browser3

This chapter explains how to configure and use the Unified Web Services Portal sample. The sample has been created using Unified Web Services Portal functions. It enables you to view BusinessObjects Enterprise documents through a portal. You can use this sample to access any Unified Web Services provider. You can also use it as the basis for your own development. This chapter describes how to:• access the sample from a web browser and through Visual Basic .NET or

a JSP editor.

Accessing the sample through a web browserTo start the sample from your web browser:1. Enter one of the following URLs in the address bar of your browser:

If the sample is installed in a .NET environment:http://ServerName/dswsportal/If the sample is installed in a J2EE environment:http://ServerName:Port/dswsportalThe following page, which lists the available web services, is displayed:

To check the web services, click Check Web Services. A page containing the status of each web service is displayed. If a web service is accessible a message providing the name of the web service, the status OK, and the


Using the Unified Web Services Portal SampleViewing document lists 3

version of the web service is displayed. If you encounter an error message you should contact the Unified Web Services Portal administrator.

2. Select the check box for the web service you want to access.3. Enter your BusinessObjects and BusinessObjects Enterprise login and

password, then click Login.The following page is displayed:

Viewing document listsOn the left, the sample displays a list of the BusinessObjects and Crystal Enterprise documents to which you are allowed access according to the rights of your user profile. You can change the order of the web service document lists as well as minimize or maximize a list, using the Move and Minimize/Maximize buttons.


Using the Unified Web Services Portal SampleViewing documents3Viewing documents

To display a document, click its name in the left panel. The document is displayed on the right. Reports are opened in HTML format by default.

Refreshing documentsTo refresh a document, click the Refresh button in the top bar of the document. Any prompts associated with the document will appear, with their corresponding lists of values if appropriate.


Using the Unified Web Services Portal SampleViewing documents 3

Viewing Multiple documentsYou can view up to four documents at the same time in the sample. When you open more than one document, the documents appear as tabs in the top bar. You can also display them aligned horizontally or vertically using the Align Horizontal or Align Vertical buttons in the sample top bar. To return to a tabbed view, click the Tabbed View button.

Align

Align

Tabbed


Using the Unified Web Services Portal SampleViewing documents3

When you open four documents, the Dashboard button appears in the sample top bar. Click the Dashboard button to display the documents in Dashboard view.

Dashboard


Using the Unified Web Services Portal SampleDisconnecting from a web service 3

Drilling on documentsWhen you open a drillable BusinessObjects document, you can drill down to analyze the data from different angles and on different levels. You can drill down in a report using the drill bar or the hyperlinks in the report.

Disconnecting from a web serviceTo disconnect from web service:1. Click Connection in the sample top bar.

When you select values in the drill

Click the up

Click a hyperlink


Using the Unified Web Services Portal SampleAccessing the sample through Visual Studio3

2. Select the web service(s) from which you want to disconnect and click Logout.

Accessing the sample through Visual StudioTo start the sample in Visual Studio:1. Create a virtual directory for the sample.

Refer to “Installing the Unified Web Services Portal sample in a .NET environment” on page 8 for more information.

2. From the dsws_portal folder, double click on the file dsws_portal.csproj

Visual Studio launches.3. In the Web Reference panel, right click dsws_portal and select Update

Web Reference.4. Compile the sample. Once it has compiled, you can run the sample and examine how it is built.

Accessing the sample through a JSP editorTo examine how the Unified Web Services Portal sample is built, you can open the the JSP files from the dsws_portal directory in any JSP editor.

chapter

Unified Web Services Portal Sample Architecture


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal sample classes4

This chapter explains the architecture of the Unified Web Services Portal sample. The Unified Web Services Portal sample is a demonstration web site used in conjunction with the consumer API to access several WebIntelligence servers via Unified Web Services providers. This chapter describes the architecture for the .Net and J2EE environments.

The Unified Web Services Portal sample classes

The Unified Web Services Portal sample contains classes that maintain the sample’s state. The classes are contained in the • dsws_portal assembly in the Unified Web Services Portal sample for

.NET• dsws_portal package in the Unified Web Services Portal sample for

J2EE.The following table provides a description of each class:

Class Description

AbstractFrameworkManager

This is the base class for FrameworkManager and FrameworkManagerStandalone classes.It serves as a factory for the FrameworkManagerStandalone.Per session, the framework manager is either a FrameworkManager (portal context) or a FrameworkManagerStandalone (standalone context).

ActiveDocument Defines an open document and the document’s status. An ActiveDocument is basically a Portlet containing a document.

DocManager Defines a list of ActiveDocument objects. This list can contain a maximum of four open documents simultaneously. Defines also a list of DocumentAdapter objects. Those are linked to ActiveDocuments with a 1-1 relationship. Manages the layout (view mode) of documents (tab view, dashboard, etc.) in the portal.

DocManagerStandalone

Manages documents in a standalone context (using the viewer outside of the portal).


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal sample classes 4

DocumentAdapter Encapsulates the calls to the consumer (the reportengine web service).Each instance of this class represents a document and is stored in a IDocManager specialized instance (depending on the context). It is used by the viewer pages.

FramedPortlets Defines a set of inherited Portlet objects. A FramedPortlets object creates its own frameset.

FrameworkManager The FrameworkManager is the main container for the application (portal). One FrameworkManager object is instantiated and stored for each web session. It contains two inherited FramedPortlets objects.A FrameworkManager object stores:A list of available web services. The FrameworkManager retrieves this information from the dsws.config file stored at the root level of the Unified Web Services Portal sample.A DocManager instance that contains the list of ActiveDocument objects and a list of associated DocumentAdapter objects.A LeftFrameManager instance that maintains a list of connected web services.

FrameworkManagerStandalone

The FrameworkManagerStandalone is the main container for the application in standalone mode (without the portal).A FrameworkManager object stores a DocManagerStandalone instance that contains the list of DocumentAdapter objects (1 per viewer).

IDocManager An interface which inherit DocManager and DocManagerStandalone. Defines the common behaviour for managing documents (DocumentAdapter objects).

LeftFrameManager Maintains a list of connected web services. Each web service is defined in an OpPortlet object.

OpPortlet Defines a connected web service. Each OpPortlet is associated with one instance of a WebServiceInfo

Portlet Defines a portlet that will contain either a DocsFrame, DocFrame or OpFrame frame. The Portlet representation is a window with a title bar. The HTML representation of a Portlet is contained in a frame.

Class Description


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal sample classes4

The following figure illustrates the relationship between the Unified Web Services Portal sample classes.

Example: Sample management in dashboard view

ProxyInfo Defines the proxy information for accessing web services. The information is retrieved from the dsws.config file.

WebServices Defines a list of WebServicesInfo objects.WebServicesInfo Defines the web service information required to connect

to a web service. The information is retrieved from the dsws.config file.

Class Description


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal sample classes 4

In the example below, a LeftFrameManager object maintains two OpPortlet instances named .Net Local and Axis on ServerName. Each of the OpPortlett is associated with one instance of a WebServiceInfo. On the right-hand side a DocManager contains four ActiveDocument portlets displayed in dashboard mode.

Document workflowsThe DocWorkflow class handles the main workflows when working with a BusinessObjects or WebIntelligence document. The section describes some of the key methods in the DocWorkflow class.

setContextDescription

The setContext method sets the context of a document.

Interfacejava.lang.void setContext(int iDocIdx, ActiveDocument ad,g

com.bo.dsws_portal.Consumer wiws, java.lang.String strSession)


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal sample classes4Parameters

This public method takes the following parameters

ProcessActiveDocumentFromRequestDescription

The ProcessActiveDocumentFromRequest method parses the incoming requests.

Interfaceint ProcessActiveDocumentFromRequest

(javax.servlet.http.HttpServletRequest Request)

ParametersRequest - The incoming request.ProcessActiveDocumentFromRequest handles the following parameters:

These parameters are always used in conjunction with the DocIndex parameter. DocIndex specifies the index of the ActiveDocument instance from the DocManager on which the action is to be carried out.

Parameter Description

iDocIdx The index value of the current ActiveDocument.ad The instance of the current ActiveDocument.wiws The instance of Consumer.strSession The Consumer session ID.

Parameter Action

Refresh The document needs to be refreshed.StorageToken The storage token has changed.ReportName The current report name has changed.PageName The page number has changed.DPName The current data provider has

changed.Display The current display of the document

changed.FromIDDownToIDUpToIdFilterValue

Drill parameters needs to be processed.


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal frameset 4

CommentIf a document contains prompts or requires a password, the ProcessActiveDocumentFromRequest method returns 1. In this case a URL is set that reroutes the DocsFrame to the pages that handles prompts (Prompts.jsp/Prompts.aspx) or passwords (Password.jsp./Password.aspx). The URL for the appropriate page is retrieved by the getRedirectionURL method.

ExtractInformationDescription

The ExtractInformation method retrieves the information about a document required for a workflow, for example, reports, storage tokens or data providers. The information returned depends on the current status of the ActiveDocument instance. For example, if the document requires a password that has not yet been provided the report, drill or data provider information is not returned until the password is set.

Interfaceint ExtractInformation()

The Unified Web Services Portal framesetThis section describes all the pages in the Unified Web Services Portal sample and illustrates where they are implemented.The following table lists the pages in the Unified Web Services Portal sample. Each page is listed without its extension. Depending on your environment, you need to add one of the following extensions.• for J2EE, add .jsp• for .NET, add .aspx


Unified Web Services Portal Sample ArchitectureThe Unified Web Services Portal frameset4

All of these pages can be found in the Unified Web Services Portal sample root directory.

Page Name Description

CheckServices Checks the status of the web services listed in the connection page.

Default Lists the available web services and connects to them.To access the Unified Web Services Portal sample from a browser, a user first displays the default page. This page connects the user to a Unified Web Services Portal. The sample is displayed immediately after a successful connection to a web service is received from the default page.

DocFrame Defines the frame in which a document is displayed in dashboard mode.

DocList Retrieves a list of the available documents from the selected source and category of a Unified Web Services Portal and displays the list within the OpFrm frame.

DocsFrame Defines the frame within the TabsFrm frame, in which documents are displayed in tabular mode.

DocsFrm Defines the right-hand frame, where documents are displayed. This can contain the TabsFrm frame in tabular mode or four DocFrame pages in dashboard mode.

LeftBar Defines the top bar of the left-had frame.LeftFrm Defines the left-hand frame, where a list of web services

and available documents are displayed.MainFrm Defines the Unified Web Services Portal sample interface.

This contains the LeftFrm and DocsFrm pages.OpFrm Defines the frame in which the name and list of

documents of a web service are displayed.TabBar Defines the tab bar from which you can select a document

to display.TabsFrame Defines the frame for viewing documents in tabular mode.ToFrame Redirects HTML query strings to the appropriate page.TopBar Defines the top bar in the right-hand frame.TopDocBar Defines the top bar for a document in dashboard mode.TopLeftPortlet Retrieves and displays the name of the web service within

the OpFrm frame.



The following figures illustrates where each part of the sample is implemented in tabular or dashboard mode. Page names that define a frame are shown in bold.

Unified Web Services Portal sample frameset in tabular mode

Unified Web Services Portal sample frameset in dashboard mode

Handling actionsMost of the actions in the Unified Web Services Portal are treated as messages that are included in the requested URL.



For example, the following URL will close the document whose ActiveDocument index (Param1) is 0.http://localhost:8080/DocsFrm.jsp?Action=close&Param1=0

The following table describes the principle actions and lists their parameters as well as the JSP or ASPX pages that fire and catch them:

Action Param1 Other parameters

Fired by Caught by Result

Minimize LeftBar MainFrm Minimizes the left-hand frame.

Maximize LeftBar MainFrm Maximizes the left-hand frame.

ViewDoc WebSearcviceInfo index.This is assigned according to the position in which the web service is listed in the dsws.config file. The first web service listed receives a WebServiceInfo index of 0, the second one receives 1 and so on.

Document’s unique ID, document's type, document's name

DocList DocsFrm Displays a document in the right-hand frame.



ActiveTab ActiveDocument indexThis is assigned to the document according to the position in which it is displayed. In tabular mode the document on the left-hand side receives an ActiveDocument index of 0, the second document receives 1 and so on. In dashboard mode the document on the:top left receives 0top right receives 1bottom left receives 2bottom right receives 3

TabBar DocsFrm Activates the selected document





Arrange A view mode. The possible values are:• Hor =

Horizontal mode

• Ver = Vertical mode

• Dashboard = Dashboard mode

• Tabs = Tabular mode

• Connections = The connection page

TopBar DocsFrm Changes to the selected view mode.

Close ActiveDocument index

TabBar DocsFrm Closes the selected document

Minimize ActiveDocument index

TopDocBar DocsFrm Minimizes the selected document

ToRight ActiveDocument index

TopDocBar DocsFrm Moves the selected document to the right.





ToLeft ActiveDocument index

TopDocBar DocsFrm Moves the selected document to the left.

ToTop ActiveDocument index

TopDocBar DocsFrm Moves the selected document up.

ToBottom ActiveDocument index

TopDocBar DocsFrm Moves the selected document down.



appendix

Business Objects Information Resources

Documentation and information servicesA


Documentation and information servicesBusiness Objects offers a full documentation set covering its products and their deployment. Additional support and services are also available to help maximize the return on your business intelligence investment. The following sections detail where to get Business Objects documentation and how to use the resources at Business Objects to meet your needs for technical support, education, and consulting.

DocumentationYou can find answers to your questions on how to install, configure, deploy, and use Business Objects products from the documentation.

What’s in the documentation set?View or download the Business Objects Documentation Roadmap, available with the product documentation at http://www.businessobjects.com/support/.The Documentation Roadmap references all Business Objects guides and lets you see at a glance what information is available, from where, and in what format.

Where is the documentation?You can access electronic documentation at any time from the product interface, the web, or from your product CD.

Documentation from the productsOnline help and guides in Adobe PDF format are available from the product Help menus. Where only online help is provided, the online help file contains the entire contents of the PDF version of the guide.

Documentation on the webThe full electronic documentation set is available to customers on the web from support web site at: http://www.businessobjects.com/support/.

Documentation on the product CDLook in the docs directory of your product CD for versions of guides in Adobe PDF format.

http://www.businessobjects.com/support/


Customer support, consulting and training A


Send us your feedbackDo you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: [email protected]: If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: http://www.businessobjects.com/support/.

Customer support, consulting and trainingA global network of Business Objects technology experts provides customer support, education, and consulting to ensure maximum business intelligence benefit to your business.

How can we support you?Business Objects offers customer support plans to best suit the size and requirements of your deployment. We operate customer support centers in the following countries:• USA• Australia• Canada• United Kingdom• Japan

Online Customer SupportThe Business Objects Customer Support web site contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums.http://www.businessobjects.com/support/




Customer support, consulting and trainingA


Looking for the best deployment solution for your company?

Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design tools, customized embedding technology, and more.For more information, contact your local sales office, or contact us at:http://www.businessobjects.com/services/consulting/

Looking for training options?From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education web site:http://www.businessobjects.com/services/training

http://www.businessobjects.com/services/consulting.htm

http://www.businessobjects.com/services/consulting.htm

http://www.businessobjects.com/services/education.htm

http://www.businessobjects.com/services/education.htm

Useful addresses at a glance A


Useful addresses at a glance

Address Content

Business Objects product informationhttp://www.businessobjects.com

Information about the full range of Business Objects products.

Product documentationhttp://www.businessobjects.com/support

Business Objects product documentation, including the Business Objects Documentation Roadmap.

Business Objects Documentation [email protected]

Send us feedback or questions about documentation.

Online Customer Supporthttp://www.businessobjects.com/support/

Information on Customer Support programs, as well as links to technical articles, downloads, and online forums.

Business Objects Consulting Serviceshttp://www.businessobjects.com/services/consulting/

Information on how Business Objects can help maximize your business intelligence investment.

Business Objects Education Serviceshttp://www.businessobjects.com/services/training

Information on Business Objects training options and modules.

http://www.businessobjects.com

http://www.businessobjects.com/support

http://www.businessobjects.com/support



http://www.businessobjects.com/services/consulting/

http://www.businessobjects.com/services/consulting/

http://www.businessobjects.com/forms/tipsandtricks_login.asp

http://www.techsupport.businessobjects.com/

http://www.techsupport.businessobjects.com/

http://www.businessobjects.com/services/training

http://www.businessobjects.com/services/training

Useful addresses at a glanceA



IndexBBusiness Objects

consulting services 38, 39support services 37training services 38, 39, 39

Cconsultants, Business Objects 38customer support 37

Ddocumentation

feedback on 37on product CD 36on the web 36roadmap 36

Eeducation. See training

Ffeedback, on documentation 37

Iinformation resources 36

OOnline Customer Support 37

Rresources 36

Ssupport

customer 37

locations 37technical 37web site 37

Ttechnical support 37training, on Business Objects products 38

UUnified Web Services framework

accessing from Visual Studio 20align horizontal 17align vertical 17classes 22–27dashboard view 18disconnectiong 19drilling on documents 19frameset 27–29handling actions 29–33installing with J2EE 9–??installing with .NET 8–9refreshing document 16tabbed view 17viewing document lists 15viewing document s 16viewing multiple documents 17–18

Wweb

customer support 37getting documentation via 36useful addresses 39

web sitessupport 37training 38

Index
