Dashboards LiveCycle Data Services Gateway Installation Guide SAP BusinessObjects 4.0 Support Package 4
Copyright 2011 SAP AG. All rights reserved.sap, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.sybase and Adaptive Server, ianywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.these materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
Contents Chapter 1 Document History...5 Chapter 2 About this Guide...7 Chapter 3 3.1 3.1.1 3.2 3.2.1 Planning Installations...9 Getting started...9 Overview of the Dashboards LiveCycle Data Services Gateway...9 Naming conventions...9 Variables...9 Chapter 4 4.1 4.2 Performing Installations...11 To install the Dashboards LiveCycle Data Services Gateway...11 To configure the Dashboards LiveCycle Data Services Gateway...12 Chapter 5 5.1 5.2 Post Installation...13 To test the Dashboards LiveCycle Data Services Gateway installation...13 To uninstall the Dashboards LiveCycle Data Services Gateway...14 Appendix A More Information...15 Index 17 3
Contents 4
Document History Document History The following table provides an overview of the most important document changes. Version SAP BusinessObjects 4.0 SAP BusinessObjects 4.0 Feature Pack 3 Date November 2010 March 2012 Description Initial release. No changes. 5
Document History 6
About this Guide About this Guide This guide is intended for business intelligence users who need to establish LiveCycle Data Services connections while working with Dashboards in corporate environments. For more information about features and capabilities, see the Dashboards and Presentation Design User Guide. 7
About this Guide 8
Planning Installations Planning Installations 3.1 Getting started 3.1.1 Overview of the Dashboards LiveCycle Data Services Gateway Dashboards is a data visualization tool that allows you to create dynamic, interactive dashboards. These dashboards access live data, and you can add them to web-based dashboards. Adobe LiveCycle Data Services is a development framework that allows you to create rich Internet applications (RIA), establish communication interfaces, and share data sources between applications in real time. You must install the Dashboards LiveCycle Data Services Gateway (XLCDS) on an Adobe LiveCycle Data Services (LCDS) server to establish LCDS connections within Dashboards. 3.2 Naming conventions 3.2.1 Variables This guide uses the following variables. 9
Planning Installations Variable <MEDIADIR> <LCDSDIR> Description The directory where required files are located on the Dashboards media. D:\AddOns\LiveCycle Data Services\Adobe The directory where configuration files are located on your Adobe LiveCycle Data Services (LCDS) server by default. C:\lcds\WEB-INF\ If you use LCDS with integrated JRun, the configuration files are located in the following directory: C:\lcds\jrun4\servers\default\flex\WEB-INF 10
Performing Installations Performing Installations 4.1 To install the Dashboards LiveCycle Data Services Gateway Before you install the Dashboards LiveCycle Data Services Gateway, ensure that your Adobe LiveCycle Data Services (LCDS) server is installed and configured. For more information, see the documentation in <MEDIADIR> on your installation media. 1. Copy XLCDSServlet.class from <MEDIADIR>/classes/xcelsius/servlet to <LCDS DIR>/classes/xcelsius/servlet 2. Copy Xcelsius-config.xml (the destination list) and Xcelsius-config.xsd (the destination list schema) from <MEDIADIR> to <LCDSDIR> 3. Add <servlet> and <servlet-mapping> entries to <LCDSDIR>/web.xml Note: A sample web.xml file is included in <MEDIADIR> Your LCDS Gateway is installed. Before you begin using the gateway, you must configure it. Example: Adding an entry to web.xml <servlet> <servlet-name>xcelsiusservlet</servlet-name> <servlet-class>xcelsius.servlet.xlcdsservlet</servlet-class> <init-param> <param-name>configuration.file</param-name> <param-value>/web-inf/xcelsius-config.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>xcelsiusservlet</servlet-name> <url-pattern>/xcelsius/*</url-pattern> </servlet-mapping> <destination> <id>randomnumbers</id> <description>sample LCDS Feed</description> <metadata> <field datatype="string" shape="singleton">time</field> <field datatype="short[]" shape="1d">column/row</field> <field datatype="short[]" shape="2d">table</field> </metadata> </destination> Related Topics Variables 11
Performing Installations 4.2 To configure the Dashboards LiveCycle Data Services Gateway Before you begin to use the Dashboards LiveCycle Data Services Gateway, you must configure it by creating data destinations in your Adobe LiveCycle Data Services (LCDS) server. For more information, see the documentation in <MEDIADIR> on your installation media. 1. Open Xcelsius-config.xml in a text editor. 2. Add a <destination> entry for each LCDS destination that you want to expose to the Dashboards LCDS connection. Include the following elements for each entry: <id> Corresponds to a valid LCDS destination defined in messaging-config.xml (the LCDS Message Service configuration file). <description> Provides details about the available data fields for the LCDS destination. <metadata> Describes the type of field and how the field should be mapped when bound to a Dashboards range. Note: Xcelsius-config.xsd (the XLCDS destination list schema) defines the exact structure of the XML in the file. 3. Save your changes to Xcelsius-config.xml Your LCDS Gateway is now configured. Example: Adding an entry to Xcelsius-config.xml <destination> <id>randomnumbers</id> <description>sample LCDS Feed</description> <metadata> <field datatype="string" shape="singleton">time</field> <field datatype="short[]" shape="1d">column/row</field> <field datatype="short[]" shape="2d">table</field> </metadata> </destination> You can now start your destinations and connect to them from Dashboards. Related Topics Variables 12
Post Installation Post Installation 5.1 To test the Dashboards LiveCycle Data Services Gateway installation You can use a random number generator to test your Dashboards LiveCycle Data Services Gateway installation. A sample generator is located in<mediadir> on your installation media. 1. Open Xcelsius-config.xml in a text editor. 2. Add the following entry to the file: <destination> <id>randomnumbers</id> <description>sample LCDS Feed</description> <metadata> <field datatype="string" shape="singleton">time</field> <field datatype="short[]" shape="1d">column/row</field> <field datatype="short[]" shape="2d">table</field> </metadata> </destination> 3. Save your changes to Xcelsius-config.xml 4. Copy RandomNumberDataService.class and RandomNumberFeed.class from <MEDI ADIR>/classes/com/bobj/samples/lcds to <LCDSDIR>/classes/com/bobj/sam ples/lcds 5. Open <LCDSDIR>/flex/services-config.xml in a text editor. 6. Add the following string into the <services> entry: <service class="com.bobj.samples.lcds.randomnumberdataservice" id="random-number-ds" /> 7. Save your changes to services-config.xml You can now use the random number generator on your LCDS server. To test the random number generator service, start your LCDS server (For example, if you use LCDS with integrated JRun, you can run C:\lcds\jrun4\bin\startJRun.bat) When the LCDS server finishes initializing the server command prompt, it will begin to output strings similar to the following: {table=[[i@18b9a72, column/row=[i@48bc64, time=07:07:35} {table=[[i@18b9a72, column/row=[i@48bc64, time=07:07:37} Related Topics Variables 13
Post Installation 5.2 To uninstall the Dashboards LiveCycle Data Services Gateway To uninstall the Dashboards LiveCycle Data Services Gateway, you must delete the files that you have copied to Adobe LiveCycle Data Services (LCDS) server. 1. Stop your LCDS server. 2. Delete XLCDSServlet.class from <LCDSDIR>/classes/xcelsius/servlet 3. Delete Xcelsius-config.xml (the destination list) and Xcelsius-config.xsd (the destination list schema) from <LCDSDIR> 4. Delete the <servlet> and <servlet-mapping> entries from <LCDSDIR>/web.xml Your LCDS Gateway is uninstalled. You can now start your LCDS server. Related Topics Variables To install the Dashboards LiveCycle Data Services Gateway 14
More Information More Information Information Resource Location SAP product information http://www.sap.com http://help.sap.com/businessobjects SAP Help Portal Access the most up-to-date English documentation covering all SAP BusinessObjects products at the SAP Help Portal: http://help.sap.com/bobi (Business Intelligence) http://help.sap.com/boepm (Enterprise Performance Management) http://help.sap.com/boeim (Enterprise Information Management) Certain guides linked to from the SAP Help Portal are stored on the SAP Service Marketplace. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. To find a comprehensive list of product documentation in all supported languages, visit:http://help.sap.com/boall. http://service.sap.com/bosap-support SAP Support Portal The SAP Support Portal contains information about Customer Support programs and services. It also has links to a wide range of technical information and downloads. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. Developer resources http://www.sdn.sap.com/irj/sdn/bi-sdk-dev https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary SAP BusinessObjects articles on the SAP Community Network http://www.sdn.sap.com/irj/boc/articles These articles were formerly known as technical papers. 15
More Information Information Resource Location Notes Forums on the SAP Community Network https://service.sap.com/notes These notes were formerly known as Knowledge Base articles. https://www.sdn.sap.com/irj/scn/forums http://www.sap.com/services/education Training From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. http://www.sap.com/services/bysubject/businessobjectsconsulting Consulting Consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in topics such as relational and multidimensional databases, connectivity, database design tools, and customized embedding technology. 16
Index C configuration 12 D Dashboards 9 I installation 11 L LCDS server directory, location 9 LiveCycle Data Services Gateway 9 M media directory, location 9 R random number generator 13 U uninstallation 14 V variables LCDS server directory 9 media directory 9 17
Index 18