Building a Real-time Dashboard using Xcelsius and Data Integrator

Transcription

1 Building a Real-time Dashboard using Xcelsius and Data Integrator Applies to: BusinessObjects Data Integrator XI (11.7) Summary This white paper shows how to use certain features of Data Integrator (DI) and Xcelsius to build a specific sample solution. It is not a DI or Xcelsius tutorial. Knowledge of DI is required, however limited or no knowledge of Xcelsius is expected. The files referred to in this document may be downloaded from the SAP Community Network. Author: Michael Eaton Company: SAP Created on: 15 February 2009 Author Bio A short biography is required for the publication of your SDN contribution. Submissions must include (a) your name, (b) your company name, and (c) a description of your field of work. Photo should be in 65 pixels in width and 85 pixels in height SAP AG 1

2 Table of Contents Introduction...3 Setup and Configuration...3 Sample Application Overview...4 Building the Real-time Job...4 Testing the Real-time Job...7 Exposing the Real-time Job as a Web Service...8 Building the Xcelsius Visualization...12 Completing the Xcelsius Visualization...13 Deploying the Dashboard...17 Related Content...19 Copyright SAP AG 2

3 Introduction Data Integrator allows real-time services to be exposed as web service operations so that they can be invoked by external processes. Xcelsius can refresh its data model using data returned from a web service operation. This document describes how to use Xcelsius Designer 4.5 and Data Integrator 11.7 to build a simple real-time dashboard using these features. Setup and Configuration DI and a repository on SQL Server 2005 were used to build and run the DI part of the example. Xcelsius Designer 4.5 was used to build the visualization/dashboard. To ensure real-time jobs and adapters operate fully, the following minor setup/configuration tasks must be completed. 1. The repository must be added to the web administrator. (I used Windows authentication with my 2005 repository and noticed that it would not connect until I turned on TCP/IP in SQL Server.) 2. A job server must be present with adapter communication enabled. Figure 1 shows the check box that must be ticked. (While this step is not actually needed for this example, calling web services from DI does require this.) 3. An access server must be configured. Figure 1 Job Server Properties Figure 2 shows what you might see on the administrator home page with a correctly configured repository, access server, and job server. Figure 2 Administrator home page 2009 SAP AG 3

4 If you installed DI with a typical installation a web service adapter is automatically configured, as shown in Figure 3. If not, add one using the configuration tab. (Not needed for this example, but worth doing anyway.) Figure 3 Default web service adapter Sample Application Overview The sample application that this document describes how to build consists of two parts: A web service operation that accepts a stock code and returns the stock price (in reality, a random value) An interactive dashboard that allows a user to specify a stock code and displays the stock price every 5 seconds. Building the Real-time Job The stock price lookup is done using a real-time job. Real-time jobs require a message source and message target and these are created using XML schemas or DTDs. 1. Create two new XML Schemas (stock_price_request and stock_price_reply) using the supplied input and output schemas (stock_price_request.xsd and stock_price_reply.xsd). 2. Next create a new real-time job and add a single dataflow SAP AG 4

5 Within the dataflow use the previously created stock_price_request and stock_price_reply schemas to create an XML message source and XML message target. (Drag them from the repository onto the dataflow.) 3. Connect the message source and message target with a query SAP AG 5

6 4. Within the query create two column mappings as shown below for the output message structure SAP AG 6

7 As you can see, the price is randomly generated and the description uses the input stock code. With the mappings specified, the real-time job is complete. Testing the Real-time Job Testing real-time jobs can be performed by supplying a test xml file as the message source and executing them as batch jobs. Use the supplied file (stock_test_in.xml) as the test file for the message source. 1. You will need to specify a name for a target xml file as well (this will be generated at runtime). 2. Execute the job and check the output file. Try changing the source file SAP AG 7

8 Exposing the Real-time Job as a Web Service The first step is to create a real-time service using the web administrator under the Real-Time Services node. 1. Click Real-Time Services Configuration, and then click Add to add a new service. 2. Call the new service stock_price and specify the previously created real-time job as the job name. 3. Click Apply. 4. Click the Real-time Service node again, and then select and start the service SAP AG 8

9 5. Click the Real-time service node again to start the service (Note that it could now be called as a normal real-time service that s all it is.). 6. Click the Web Services node. 7. Click Web Services Configuration and then click Add Real-time Service SAP AG 9

10 8. Select the service stock_price and then click add. 9. Click the Web Services node again to display the stock_price as a published operation. The real-time service is now ready to be invoked as a web service operation SAP AG 10

11 At this point we do not have any way to call the operation. The next section will build an Xcelsius dashboard to call the web service SAP AG 11

12 Building the Xcelsius Visualization As stated earlier, this is not a tutorial on Xcelsius; therefore, the major portion of the dashboard has been completed. However, if you are new to Xcelsius, the following steps briefly describe the steps performed to get the visualization into the version distributed in the ZIP file (DI and Xcelsius white paper.xlf). 1. Create a spreadsheet to be used within Xcelsius. The color highlighted fields will be dynamic; they will be updated via the dashboard and the web service invocation. 2. Create a new visualization and import the spreadsheet (known as the model within Xcelsius). 3. Add various components to the canvas. Note: The button labeled Get Stock Price is not visible at runtime (it is actually a Web Service connector) SAP AG 12

13 Completing the Xcelsius Visualization 1. Open the supplied Xcelsius file (DI and Xcelsius white paper.xlf). 2. Click the Get Stock Price component and view the properties. At this stage it has not been configured. 3. Click the Select Web Service button and enter the WSDL URL. The URL refers to a location where Xcelsius can read a document that contains metadata for a web service. In this case, the URL should be for the instance of DI that is being used for the real-time service. For example: Normally all you should have to change is michael-vm to your DI server name. 4. Click Submit. Xcelsius reads the WSDL and displays a list of available methods SAP AG 13

14 5. Select the method that corresponds to the real-time service operation we published earlier (for example, stock_price) and then click OK. We now need to specify from where Xcelsius reads the stock code input value. 6. Click STOCK_CODE and then the range button (square with red arrow) SAP AG 14

15 7. Select the cell C1 and then click OK. (When a user enters a stock code in the dashboard, this cell is set with the value.) 8. To specify where the output values are written, click STOCK_PRICE and select C3, and then click DESCRIPTION and select C5. (The dial displays these values.) 2009 SAP AG 15

16 9. Click the Preview button to test the dashboard. You see the dashboard below with the value changing every 5 seconds. Try changing the stock code. 10. Click the Preview button to return to design mode SAP AG 16

17 Deploying the Dashboard So far we have only run the dashboard through the designer. For a business user to use the dashboard we must deploy it. 1. Export the dashboard to a Flash file and save it as dashboard.swf. 2. Assuming you have Macromedia Flash installed, run the file you have just created. The flash animation is executed within a browser but the stock price never changes due to the security built into Flash (it will not call the web service). There are various ways to ensure the dashboard will operate correctly within Flash s security model. The easiest way is to deploy it to the same domain as the web service it is calling. 3. Copy the file dashboard.swf to a location that is accessible using the DI supplied web server. For example, C:\Program Files\Business Objects\Data Integrator 11.7\Doc\dashboard.swf. 4. To accessed the deployed dashboard, type the URL to the file. For example: SAP AG 17

18 2009 SAP AG 18

19 Related Content BusinessObjects Information Management Community Supplemental Files for this Article 2009 SAP AG 19

20 Copyright Copyright 2009 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, 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 S.A. in the United States and in other countries. Business Objects 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 SAP AG 20