Business Objects Web Services Portal Sample Guide
Business Objects Web Services Portal Sample Guide Business Objects Web Services Portal Sample Guide Copyright If you find any problems with this documentation, please report them to Business Objects SA in writing at [email protected]. Copyright © 2006 Business Objects. All rights reserved. Trademarks Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are trademarks or registered trademarks of Business Objects SA or its affiliated companies in the United States and other countries. All other names mentioned herein may be trademarks of their respective owners. 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. Third-party contributors Business Objects products in this release may contain redistributions of software licensed from third-party contributors. Some of these individual components may also be available under alternative licenses. A partial listing of third-party contributors that have requested or permitted acknowledgments, as well as required notices, can be found at: http://www.businessobjects.com/thirdparty Contents Chapter 1 Start Here 3 Chapter 2 Deploying the Business Objects web services Portal Sample 5 Deploying the Portal Sample web application using Business Objects web services in a .NET environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Deploying the Portal Sample using Business Objects web services on IIS 7 Enabling parent path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Deploying the Business Objects web services Portal sample in a J2EE environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Deploying the Business Objects web services Portal sample on Tomcat 8 Configuring the web services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Generate the Business Objects web services Portal WAR file . . . 11 Deploying the Business Objects web services Portal web application 11 Deploying the Business Objects web services Portal sample with Tomcat on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Deploying Business Objects web services Portal sample on WebLogic 12 Deploying Business Objects web services Portal sample on WebSphere 15 Chapter 3 Using the Business Objects web services Portal Sample 19 Accessing the sample through a web browser . . . . . . . . . . . . . . . . . . . . . . 20 Viewing document lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Viewing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Refreshing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Viewing documents in different modes . . . . . . . . . . . . . . . . . . . . . . . . 23 Viewing Multiple documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Drilling on documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Business Objects web services Portal Sample Guide 1 Contents Disconnecting from a web service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Accessing the sample through Visual Studio . . . . . . . . . . . . . . . . . . . . . . . 27 Accessing the sample through a JSP editor . . . . . . . . . . . . . . . . . . . . . . . . 27 Chapter 4 Business Objects web services Portal Sample Architecture 29 The Business Objects web services Portal sample classes . . . . . . . . . . . . 30 The Business Objects web services Portal frameset . . . . . . . . . . . . . . . . . 34 Handling actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Structure of the sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Folder structure of sample in J2EE environment . . . . . . . . . . . . . . . . . 40 Supported services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Folder structure of sample in .NET environment . . . . . . . . . . . . . . . . . . 41 Referencing of supported services DLLs in the DSWSPortal.dll . . 41 Supported services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Appendix A 2 Get More Help 43 Index 47 Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Guide chapter Start Here 1 Start Here This guide describes how to install and configure the Business Objects web services portal sample. It outlines how to prepare your system environment and steps through the procedure for installing and configuring the Business Objects web services portal sample. The sample serves as a starting point to develop a portal web application using Business Objects web services. Who should use this guide The Business Objects Web Services Portal Sample Guide is intended for use by anyone developing Business Objects Web Services consumer application. Installing and deploying the Business Objects web services portal sample in a .NET and J2EE environment requires knowledge of: • • Operating System administration (such as Windows 2003 or UNIX) Application Server administration (such as WebLogic/WebSphere or IIS) Start using the portal sample Deploying the Business Objects web services Portal Sample Deploy the Business Objects web services Portal sample in a .NET and J2EE environment. Using the Business Objects web services Portal Sample Configure and use the Business Objects web services Portal sample. Business Objects web services Portal Sample Architecture Learn the architecture of the Business Objects web services Portal sample. Get More Help Access links to technical support and additional developer resources. 4 Business Objects web services Portal Sample Guide chapter Deploying the Business Objects web services Portal Sample 2 Deploying the Business Objects web services Portal Sample Deploying the Portal Sample web application using Business Objects web services in a .NET This chapter explains how to deploy the Business Objects web services Portal sample in a .NET and J2EE environment. Deploying the Portal Sample web application using Business Objects web services in a .NET environment Download the Business Objects web services Portal sample from the following location: http://devlibrary.businessobjects.com/BusinessObjectsXIR2/en/devsuite.htm Prerequisites Before deploying the Business Objects web services Portal sample, the Internet Information Services (IIS) 6.X and the .NET Framework 1.1, must be installed on your server machine. Note that the IIS must be installed before you install the .NET framework. If you do not see Microsoft .NET Framework 1.1 in the list of currently installed programs, you can install it using the Windows Update. 1. To install the Microsoft .NET Framework 1.1: Go to the Microsoft web site at: http://windowsupdate.microsoft.com 2. Click Scan for updates. 3. Click Windows on the left panel of Windows Update. 4. Scroll down in the list of Windows updates and find Microsoft .NET Framework 1.1. 5. Click Add. 6. Click Review and Install Updates. 7. Click Install Now. 8. Reboot your machine. Note: Installing the .NET Framework requires you to reboot your machine. After your machine has rebooted, look in the Add/Remove Programs section of the Windows Control Panel to validate that the .NET Framework is installed. 6 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Portal Sample web application using Business Objects web services in a .NET Deploying the Portal Sample using Business Objects web services on IIS This section describes how to deploy the Business Objects web services Portal Sample on IIS. 1. To deploy the Portal Sample on IIS: Download the wssdk_net_portal_sample_115_en.zip from http://devlibrary.businessobjects.com/BusinessObjectsXIR2/en/ devsuite.htm and extract it to a folder on your machine. 2. Select the Windows Start menu, select Programs > Administrative Tools > Computer Management. 3. In the Computer Management window, expand the Services and Applications node. 4. Expand the Internet Information Services. 5. Right-click on Default Web Site and select New > Virtual Directory. 6. Click Next on the Virtual Directory Creation Wizard. 7. Enter dswsportal in the Alias field in the Virtual Directory Alias window and click Next. 8. Browse to the folder where you have extracted the wssdk_net_portal_sample_115_en.zip. 9. In the web site Content Directory window, click Next. 10. Select Read and Run scripts (such as ASP) options in the Access Permissions window and click Next 11. Click Finish. Type http://localhost/dswsportal in a web browser where the sample is deployed. Once the Business Objects web services Portal sample is deployed you need to configure the dsws.config file to enable the sample to access one or more Business Objects web services. For information on configuring dsws.config and using the Business Objects web services Portal sample, refer to the “Configuring the web services” on page 9. The configuration process is same for both IIS and Tomcat. Business Objects web services Portal Sample Guide 7 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment Enabling parent path In the Portal Sample code, the relative paths are used to refer a particular file. Hence, to work on Portal Sample with IIS, you must enable parent path. 1. To enable parent path: Right-click on Default Web Site and select Properties. 2. In the Default Web Site Properties dialog box, select Home Directory tab. 3. In the Application Settings frame, click Configuration button. 4. In the Application Configuration dialog box, select Options tab. 5. Select Enable Parent Paths check box. 6. Click OK. Deploying the Business Objects web services Portal sample in a J2EE environment Download the Business Objects web services Portal sample from the following location: http://devlibrary.businessobjects.com/BusinessObjectsXIR2/en/devsuite.htm The sample must be deployed on an application server. The following section describes how to deploy the Business Objects web services Portal sample on the Tomcat 5.X application server. This guide assumes you have Tomcat installed and running on your server. The machine on which Business Objects web services Portal sample is deployed must have network access to an application server running the Business Objects web services provider. For more information on installing Business Objects web services, see the Business Objects web services Administrator’s Guide at the following location: http://devlibrary.businessobjects.com/BusinessObjectsXIR2/en/devsuite.htm Deploying the Business Objects web services Portal sample on Tomcat To deploy the Business Objects web services Portal sample on Tomcat, you must generate and deploy the dswsportal.war file. To do this, download the Business Objects web services Portal sample ZIP file (wssdk_java_portal_sample_115_en.zip) from the online Developer Library (http://devlibrary.businessobjects.com/BusinessObjectsXIR2/en/ 8 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment devsuite.htm) and extract the content in your machine. The wssdkJ2EEPortal directory is created with ant_scripts and src folders and dsws.config and WSPortalAssemblyScripts.bat files. Configuring the web services The configuration file dsws.config file contains the XML code needed to connect to a Business Objects 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. The dsws.config contains URL of the Session consumer. The Session consumer allows to use Connection object. This object is used to link all consumers together. Open the dsws.config file and you can see the following code: <configuration version="1.0"> <WebService Name="BusinessObjects Enterprise XI R2" 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 contains information about the BusinessObjects Enterprise service and a proxy connection. Each WebService tag contains a Connection tag. You need to edit the dsws.config file if you want to change the server and port in the URL. You can connect to more than one web services by providing the corresponding connection URL and all the connected web services are listed on the home page of Portal sample. 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> Business Objects web services Portal Sample Guide 9 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment The WebService tag includes the following parameters: Parameter Description Web Service Description A description of the web service that is displayed in the connection page of the sample. Connection The Connection parameter defines the web service location. The WebService tag includes the following attributes: 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. The Connection tag includes the following attributes: Attribute Description 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. The Proxy tag includes the following attributes: Attribute Description 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. You need to modify the Web Service Description Parameter, Connection, and Proxy tags to match your Business Objects web services deployment. For example, if your proxy tag is 1, you can change the dsws.config file as follows: <Connection URL="http://localhost:8080/dswsbobje/services/ session" Proxy="1"/> <Proxy Name="Outside" URL="http://http-cache.mycompany.com:80" /> 10 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment Generate the Business Objects web services Portal WAR file After you have configured dsws.config file, run the WSPortalAssemblyScripts.bat script using one of the following methods: • double-clicking WSPortalAssemblyScripts.bat in Windows Explorer OR • run the WSPortalAssemblyScripts.bat from the command line You get the BUILD SUCCESSFUL message in the command prompt and dswsportal.war is created in the same directory that contains WSPortalAssemblyScripts.bat. Deploying the Business Objects web services Portal web application 1. To deploy the dswsportal.war archive on the application server: Stop Tomcat. 2. Copy the dswsportal.war to the $TOMCAT_HOME/webapps directory. 3. Start Tomcat. To check that the Business Objects web services Portal sample is deployed, type the following URL the web browser: http://hostname:Port/dswsportal where hostname is the name of the server on which you deployed the Business Objects 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 dswsportal.war has been deployed. To check if the dswsportal.war is deployed, browse to $TOMCAT_HOME\webapps and verify that the dswsportal directory containing the Business Objects 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. It leads you to the Available Web Services Status page. In this page you can see name of the web services where the Business Objects web services Portal deployment is connected. By default, the following message is displayed: Available Web Services Status Web Service BusinessObjects Enterprise XI R2: OK. Version 11.5.8 Deploying the Business Objects web services Portal sample with Tomcat on UNIX Business Objects web services Portal Sample Guide 11 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment To deploy the Business Objects web services Portal sample with Tomcat on UNIX: 1. Copy the extracted Web Services Portal Sample folder in your machine. 2. Open the WSPortalAssemblyScripts.bat file. 3. Delete all the lines except “call %ANT HOME%...” line. 4. Replace “call %ANT HOME%” section with your ANT path location. 5. Save the .bat file as the WSPortalAssemblyScripts.sh file. 6. Run the .sh file. A dswsportal.war is created. 7. Copy the .war file to Tomcat/webapps folder. Deploying Business Objects web services Portal sample on WebLogic To deploy the Business Objects web services Portal sample with WebLogic on Windows or UNIX, you must deploy the dswsportal.war file. This section describes how to deploy the Business Objects web services Portal sample with WebLogic 6.1 SP2 on Windows and UNIX. 1. To deploy the Portal Sample with WebLogic 6.1 SP2: Copy the dswsportal directory to the WebLogic Installation\wlserver6.1\config\mydomain\applications directory. 2. In the WebLogic Installation\wlserver6.1\config\mydomain directory, open the Config.xml file. 3. Add an application definition for dswsportal as shown below: <Domain Name=”mydomain"> <CustomRealm ... /> <Application Deployed="true" Name="dswsportal" Path=".\config\mydomain\applications"> <WebAppComponent Name="dswsportal" Targets= "myserver" URI="dswsportal"/> </Application> ... 12 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment The Application tag defines the web application and the WebAppComponent tag defines the application’s components. The table below describes the attributes in each tag: Tag Attribute Description Application Deployed Specifies whether the web application is deployed. If true the web application is deployed. Name The name of the web application. Path The path to the web application. WebAppComponent Name The name of the web application component. Targets The server to be used with the web application. URI The name of the web application root directory. 4. Save the Config.xml. 5. Start WebLogic. To check that the Business Objects web services Portal sample is deployed, type the following URL in the web browser: http://ServerName:Port/dswsportal/Connection.jsp ServerName is the name of the server on which you deployed the Business Objects web services Portal and Port is the port number for which the installed application server is configured. The default port number for WebLogic is 7001. You can also deploy the Portal sample with WebLogic 6.1 SP2 on Windows and UNIX with the following way: 1. Generate the dswsportal.war on Windows/UNIX platform. For information on generating the dswsportal.war, see “Generate the Business Objects web services Portal WAR file” on page 11 2. Log in to Portal Sample through the Administration Console. 3. Click on the Web Application Module. Business Objects web services Portal Sample Guide 13 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment 4. Click on Deploy a Web Application Module and dswsportal.war is added in the folder structure of the location where you have installed WebLogic, as shown in the following image: . 5. Select dswsportal.war and click Target Module button. The Business Objects web services Portal sample is deployed on your machine. 14 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment Once the Business Objects web services Portal sample is deployed, you need to configure the dsws.config file to enable the sample to access one or more Business Objects web services Portal. For information on configuring dsws.config and using the Business Objects web services Portal sample, see Using the Business Objects web services Portal Sample. Deploying Business Objects web services Portal sample on WebSphere To deploy the Business Objects web services Portal sample with WebSphere on Windows or UNIX, you must deploy the dswsportal.war file. 1. 2. To deploy the Portal Sample with WebSphere: Open the WebSphere Advanced Administrative Console. Right-click Enterprise Applications and select Install Enterprise Application. The Install Enterprise Application Wizard is displayed. 3. On the Install Enterprise Application Wizard, select Install stand-alone module (*.war, *.jar). 4. Click Browse and navigate to the dswsportal.war file. 5. In the Application name box, specify dswsportal. Business Objects web services Portal Sample Guide 15 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment 6. In the Context Root for web module box, specify /dswsportal and click Next. 7. Click Next on each of the following pages until you reach the last page of the Wizard and then click Finish. The message Command “EnterpriseApp.install” completed successfully is displayed when the installation is complete. After you get the message, you must restart the Business Objects web services Portal Sample. 1. To restart the Portal Sample: Right-click Enterprise Application > dswsportal and click Stop. The message Command “dswsportal.stop” completed successfully is displayed when the Business Objects web services Portal sample is stopped. 2. When dswsportal is stopped, right-click Enterprise Application > dswsportal and click Start to restart the enterprise application. The message Command “dswsportal.start” completed successfully is displayed when the Business Objects web services Portal sample is started. To check that the Business Objects web services Portal sample is deployed, type the following URL in the web browser: http://ServerName:Port/dswsportal/Connection.jsp ServerName is the name of the server where you have deployed the Business Objects web services Portal, and Port is the port number for which the installed application server is configured. The default port number for WebSphere is 9080. 16 Business Objects web services Portal Sample Guide Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment Once the Business Objects web services Portal sample is deployed, you need to configure the dsws.config file to enable the sample to access one or more Business Objects web services Portals. For information on configuring dsws.config and using the Business Objects web services Portal Sample, see Using the Business Objects web services Portal Sample. Business Objects web services Portal Sample Guide 17 2 2 Deploying the Business Objects web services Portal Sample Deploying the Business Objects web services Portal sample in a J2EE environment 18 Business Objects web services Portal Sample Guide chapter Using the Business Objects web services Portal Sample 3 Using the Business Objects web services Portal Sample Accessing the sample through a web browser This chapter explains how to use the Business Objects web services Portal sample. The sample has been created using Business Objects web services Portal functions. It enables you to view BusinessObjects Enterprise documents through a portal. You can use the sample to access any Business Objects 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 browser 1. To access the sample from your web browser: 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/dswsportal The following page, which lists the available web services providers, is displayed: 20 Business Objects web services Portal Sample Guide Using the Business Objects web services Portal Sample Accessing the sample through a web browser To check the status of the provided web services, click Check Web Services. If a web service is accessible, a message providing the name of the web service, the status, and version of the web service is displayed. If you encounter an error message, you should contact the Business Objects web services Portal administrator. 2. Select the check box for the web service you want to access. 3. Enter your BusinessObjects Enterprise login and password, then click Login. The following page is displayed: Business Objects web services Portal Sample Guide 21 3 3 Using the Business Objects web services Portal Sample Viewing document lists Viewing document lists The list of documents, which you are allowed access according to the rights of your user profile, are displayed in the left panel. You can change the order of the web service document lists as well as minimize or maximize a list, using the Minimize and Maximize buttons. You can also hide the document list by using the Hide button in the sample top bar. 22 Business Objects web services Portal Sample Guide Using the Business Objects web services Portal Sample Viewing documents Viewing documents To view a document, click its name in the left panel. The document is displayed in the right panel. By default, the documents are opened in HTML format. Refreshing documents To refresh a document, click the Refresh button in the top bar of the document. The prompts that are associated with the document are also displayed with the corresponding lists of values. Viewing documents in different modes You can view the documents in the following two modes: Draft Mode: Draft Mode displays entire report in one page. You can use draft mode to analyze results, to add calculations/formulas/breaks, and sorting tables. Page Mode: Page Mode displays the report in different pages, with page numbers, header, and footers. You can use page mode to format tables and charts. Business Objects web services Portal Sample Guide 23 3 3 Using the Business Objects web services Portal Sample Viewing documents Viewing Multiple documents You can view up to four documents simaltaneously in the sample. When you open more than one document, the documents appear as tabs in the top bar. You can also view documents horizontally or vertically using the Align Horizontal or Align Vertical buttons in the sample top bar. The following image shows vertically aligned four documents: To return to a tabbed view, click the Tabbed View button. 24 Business Objects web services Portal Sample Guide Using the Business Objects web services Portal Sample Viewing documents When you open four documents, the Dashboard button appears in the sample top bar. Click the Dashboard button to display the documents in the Dashboard view. The following image shows four documents opened in the Dashboard view: Business Objects web services Portal Sample Guide 25 3 3 Using the Business Objects web services Portal Sample Disconnecting from a web service Drilling on documents Portal sample also allows you to open a drillable document. You can drill down to analyze the data from different angles and on different levels. You can drill down/drill up in a document using the drill bar or the hyperlinks on the data. Disconnecting from a web service 1. 2. 26 To disconnect from web service: Click Connection in the sample top bar. Select the web service(s) from which you want to disconnect and click Logout. Business Objects web services Portal Sample Guide Using the Business Objects web services Portal Sample Accessing the sample through Visual Studio Accessing the sample through Visual Studio 1. To access the sample in Visual Studio: Double click on the DSWSPortal.csproj. The Visual Studio is launched displaying the project. 2. In the Web Reference panel, right click dswsportal and select Update Web Reference. 3. Compile the sample. Once it has compiled, you can run the sample and examine how it is built. Accessing the sample through a JSP editor To examine how the Business Objects web services Portal sample is built, you can open any JSP file from the dswsportal directory in any JSP editor. Business Objects web services Portal Sample Guide 27 3 3 Using the Business Objects web services Portal Sample Accessing the sample through a JSP editor 28 Business Objects web services Portal Sample Guide chapter Business Objects web services Portal Sample Architecture 4 Business Objects web services Portal Sample Architecture The Business Objects web services Portal sample classes This chapter explains the architecture of the Business Objects web services Portal sample. The Business Objects web services Portal sample is a demonstration web site used in conjunction with the consumer API to access several WebIntelligence and CrystalReports servers via Business Objects web services providers. This chapter also describes the portal sample folder structure in the .Net and J2EE environments. For more information on Business Objects Platform Web Services SDKs, see http://devlibrary.businessobjects.com The Business Objects web services Portal sample classes The Business Objects web services Portal sample contains classes that maintain the sample’s state. The classes are contained in the 30 • dswsportal assembly in the Business Objects web services Portal sample for .NET • dswsportal package in the Business Objects web services Portal sample for J2EE. Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture The Business Objects web services Portal sample classes The following figure illustrates the relationship between the Business Objects web services Portal sample classes: Business Objects web services Portal Sample Guide 31 4 4 Business Objects web services Portal Sample Architecture The Business Objects web services Portal sample classes The following table provides description of each class: Class Description AbstractFramework This is the base class for FrameworkManager and Manager 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. DocManagerStanda Manages documents in a standalone context (using lone the viewer outside of the portal). 32 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. Some tasks such as displaying a report and actions in a report are done using Viewer.DocumentAdapter object defined in the DocumentAdapter.cs. DocumentAdapter offers a simplified interface to ReportEngine consumer. FramedPortlets Defines a set of inherited Portlet objects. A FramedPortlets object creates its own frameset. Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture The Business Objects web services Portal sample classes Class Description 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 Business Objects 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. FrameworkManager The FrameworkManagerStandalone is the main Standalone 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 behavior 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 contains 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. 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. Business Objects web services Portal Sample Guide 33 4 4 Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset The Business Objects web services Portal frameset This section describes all the pages in the Business Objects web services Portal sample and illustrates how they are implemented. The following table lists the pages in the Business Objects 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 These pages are located in the Business Objects web services Portal sample root directory. 34 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 Business Objects web services Portal sample from a browser, a user first displays the default page. This page connects the user to a Business Objects 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 Business Objects 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. Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset Page Name Description MainFrm Defines the Business Objects 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. Business Objects web services Portal Sample Guide 35 4 4 Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset The following figures illustrate where each part of the sample is implemented in tabular and dashboard mode. Business Objects web services Portal sample frameset in tabular mode You can open a document in tabular mode as shown in the following image: Business Objects web services Portal sample frameset in dashboard mode If you open four documents, the Dashboard button appears in the sample top bar. Click the Dashboard button to display the documents in the dashboard view. To see how documents can be opened/viewed in dashboard mode, see “Viewing Multiple documents” on page 24 36 Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset Handling actions Most of the actions in the Business Objects web services Portal are treated as messages that are included in the requested URL. For example, the following URL 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 Fired by Caught by Result Minimize LeftBar MainFrm Minimizes the left-hand frame. Maximize LeftBar MainFrm Maximizes the left-hand frame. DocList DocsFrm Displays a document in the right-hand frame. ViewDoc Param1 WebSearcviceI nfo 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 WebServiceInf o index of 0, the second one receives 1 and so on. Other parameters Document’s unique ID, document's type, document's name Business Objects web services Portal Sample Guide 37 4 4 Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset Action Param1 ActiveTab ActiveDocume nt index This 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 ActiveDocume nt index of 0, the second document receives 1 and so on. In dashboard mode the document on the: top left receives 0 top right receives 1 bottom left receives 2 bottom right receives 3 38 Other parameters Fired by Caught by Result TabBar DocsFrm Activates the selected document Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture The Business Objects web services Portal frameset Action Param1 Arrange A view mode. The possible values are: • Hor = Horizontal mode • Ver = Vertical mode • Dashboard = Dashboard mode • Tabs = Tabular mode • Connections = The connection page Other parameters Fired by Caught by Result TopBar DocsFrm Changes to the selected view mode. Close ActiveDocume nt index TabBar DocsFrm Closes the selected document Minimize ActiveDocume nt index TopDocBar DocsFrm Minimizes the selected document ToRight ActiveDocume nt index TopDocBar DocsFrm Moves the selected document to the right. Business Objects web services Portal Sample Guide 39 4 4 Business Objects web services Portal Sample Architecture Structure of the sample Action Param1 ToLeft Other parameters Fired by Caught by Result ActiveDocume nt index TopDocBar DocsFrm Moves the selected document to the left. ToTop ActiveDocume nt index TopDocBar DocsFrm Moves the selected document up. ToBottom ActiveDocume nt index TopDocBar DocsFrm Moves the selected document down. Structure of the sample This section describes the folder structure of the sample for J2EE and .NET environment. • • “Folder structure of sample in J2EE environment” on page 40 “Folder structure of sample in .NET environment” on page 41 Folder structure of sample in J2EE environment The following table explains the folder structure of dsws_portal_java and corresponding files: 40 Name of the folder Corresponding files Image Contains all the images META-INF Contains manifest.mf file viewer Contains all Java source code viewer>images Contains all the images viewer>includes Contains all the JScripts files viewer>language Contains Outlook resource files viewer>style Contains all the Cascading Style Sheet files WEB-INF Contains web.xml and .tld file WEB-INF>classes Contains Class files and properties files WEB-INF>lib Contains the Java Archive files Business Objects web services Portal Sample Guide Business Objects web services Portal Sample Architecture Structure of the sample Supported services In J2EE environment, the DSWSPortal sample supports the following services: • • • BIPlatform ReportEngine Session Folder structure of sample in .NET environment The following table explains the folder structure of dsws_portal_net and corresponding files: Name of the folder Corresponding files bin Contains all the DLLs Image Contains all the images viewer Contains all the source code files such as .cs, .resx, .aspx, and JScript file viewer>images Contains all the images viewer>includes Contains all the JScripts files viewer>language Contains the JScript file viewer>style Contains all the Cascading Style Sheet files Referencing of supported services DLLs in the DSWSPortal.dll The following table explains the supported services and location of corresponding DLLs: Service Location of DLL BICatalog BICatalog/bin/Debug/ BusinessObjects.DSWS.BICatalog.dll BIPlatform BIPlatform/bin/Debug/ BusinessObjects.DSWS.BIPlatform.dll LiveOffice LiveOffice/bin/Debug/ BusinessObjects.DSWS.LiveOffice.dll Publish Publish/bin/Debug/ BusinessObjects.DSWS.Publish.dll Query Query/bin/Debug/ BusinessObjects.DSWS.QueryService.dll Business Objects web services Portal Sample Guide 41 4 4 Business Objects web services Portal Sample Architecture Structure of the sample Service Location of DLL ReportEngine ReportEngine/bin/Debug/ BusinessObjects.DSWS.ReportEngine.dll SaveService SaveService/bin/Debug/ BusinessObjects.DSWS.SaveService.dll Session Session/bin/Debug/ BusinessObjects.DSWS.Session.dll Supported services In .NET environment, the DSWSPortal sample supports the following services: • • • 42 BIPlatform ReportEngine Session Business Objects web services Portal Sample Guide appendix Get More Help 5 Additional developer resources • • • • http://devlibrary.businessobjects.com http://www.businessobjects.com/products/dev_zone/web_services/ default.asp http://www.businessobjects.com/products/dev_zone/java/default.asp http://www.businessobjects.com/products/dev_zone/net/default.asp Online customer support The 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/ 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 Send us your feedback Do 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] 44 5 45 5 46 Index B Business Objects consulting services 44 support services 44 training services 44 Business Objects web services framework accessing from Visual Studio 27 align horizontal 24 align vertical 24 classes 30–?? dashboard view 25 disconnectiong 26 drilling on documents 26 frameset 34–36 handling actions 37–40 installing with J2EE 8–?? installing with .NET 6–7 refreshing document 23 tabbed view 24 viewing document lists 22 viewing document s 23 viewing multiple documents 24–25 files dsws_framework.war 12, 15 H http //devlibrary.businessobjects.com/ 30 O Online Customer Support 44 R resources 43 S support customer 44 technical 44 web site 44 T C technical support 44 training, on Business Objects products 44 consultants, Business Objects 44 customer support 44 W web D developer resources 43 Developer Suite Web Services framework deploying with Tomcat on UNIX 12–?? deploying with WebLogic 12–15 documentation feedback on 44 customer support 44 web sites support 44 training 44 F feedback, on documentation 44 Business Objects web services Portal Sample Guide 47 Index 48 Business Objects web services Portal Sample Guide
© Copyright 2025