Dashboard Reports Session II. Vikram Shanmugasundaram Sourcing CLM Center of Excellence Feb 2012

Size: px

Start display at page:

Download "Dashboard Reports Session II. Vikram Shanmugasundaram Sourcing CLM Center of Excellence Feb 2012"

Theresa Cunningham
5 years ago
Views:

1 Dashboard Reports Session II Vikram Shanmugasundaram Sourcing CLM Center of Excellence Feb 2012

2 Disclaimer The information in this document is confidential and proprietary to SAP and may not be disclosed without the permission of SAP. This presentation is not subject to your license agreement or any other service or subscription agreement with SAP. SAP has no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation and SAP's strategy and possible future developments, products and or platforms directions and functionality are all subject to change and may be changed by SAP at any time for any reason without notice. The information on this document is not a commitment, promise or legal obligation to deliver any material, code or functionality. This document is provided without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or noninfringement. This document is for informational purposes and may not be incorporated into a contract. SAP assumes no responsibility for errors or omissions in this document, except if such damages were caused by SAP intentionally or grossly negligent. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, which speak only as of their dates, and they should not be relied upon in making purchasing decisions SAP AG. All rights reserved. 2

3 Agenda Session 2 Feb 17 th 2012 Review of Session I Dashboard Definition What is a Dashboard Definition How to create Dashboard Definition Demo Building a Dashboard Report End to End process Query Filters & Result Output Best Practices Troubleshooting Tips & Tricks 2011 SAP AG. All rights reserved. 3

4 Dashboard Reports Session I Review

6 Dashboard Reports Overview Relationship between Key Components Desktop Channel Refers to 1 or more Workbench Page Refers to 1 Reports Page Refers to 1 or more Dashboard Definition Has 1 or more Report Refers to 1 or more Document Report Has 1 or more Query Definition 2011 SAP AG. All rights reserved. 6

Xcelsius Dashboard Getting to Know the User Interface Key Areas 1. Component Browser 2.

8 Xcelsius Dashboard Xcelsius Data Binding Data Binding Binding of UI components with the data in the embedded excel spreadsheet is a key step in developing Dashboard Reports SAP Sourcing provides a Xcelsius Dashboard template that contains the basic framework to build a Dashboard Report Excel spreadsheet embedded in the Xcelsius template contains the following sheets: Configuration UI Query 1 through 3 (more can be added as needed) Texts Messages SystemInfo Template Legend 2011 SAP AG. All rights reserved. 8

9 Xcelsius Dashboard Data Connections Data Connections An XML Data Connection connects to Sourcing through HTTP. Typically a dashboard will contain multiple XML Data Connections. One is minimum. Each data connection can send values for one or more query parameters and receive results of one or more queries During runtime, XML Data Connection can send live data such as query names, parameter to Sourcing to request specific information back from the server 2011 SAP AG. All rights reserved. 9

10 Dashboard Definition

11 Dashboard Definition What is Dashboard Definition? What is Dashboard Definition? Dashboard Definition combines the data extracted from Sourcing with the Flash model developed using Xcelsius to provide a rich flash based reporting experience One or more Query Definitions can be added to a Dashboard Definition Dashboard Definition is added to Reports which can be used in all the areas of the Sourcing where ever regular reports are used 2011 SAP AG. All rights reserved. 11

button on the List Page Access to Dashboard Definition is controlled through Security Profiles By default in new systems

12 Dashboard Definition Creating a Custom Dashboard Definition Creating a Custom Dashboard Definition Dashboard Definitions can be accessed from the Setup page System Setup Dashboard Definitions New Dashboard Definition can be created using the Create button on the List Page Access to Dashboard Definition is controlled through Security Profiles By default in new systems Dashboard Definitions are turned on. However in upgraded systems it is turned off by default 2011 SAP AG. All rights reserved. 12

13 Dashboard Definition Creating a Custom Dashboard Definition Dashboard Definition tab Xcelsius Flash File (swf) flash file generated from Xcelsius that contains data presentation information Xcelsius Source File (xlf) Source file created in Xcelsius. This file is not used during runtime, but it is there, so the flash file generated is in sync with the source file For a full page dashboard report set the canvas size to 900 (width) and 600 (height) which works with most browsers and screen resolutions 2011 SAP AG. All rights reserved. 13

Dashboard Definition Creating a Custom Dashboard Definition Dashboard Elements tab Dashboard Elements tab contains 2 parts 1) Adding 1 or more Query Definitions to the Dashboard Definition, 2)

14 Dashboard Definition Creating a Custom Dashboard Definition Dashboard Elements tab Dashboard Elements tab contains 2 parts 1) Adding 1 or more Query Definitions to the Dashboard Definition, 2) Filters Parameters associated with the Query Definitions Enable Global Parameter is selected by default. If it is selected, if there are identical parameter names, the dashboard will consider the first parameter value as the global parameter 2011 SAP AG. All rights reserved. 14

Dashboard Definition Creating a Custom Dashboard Definition Access

17 Exercise 3 Objective o Get familiarized with Dashboard Definitions Exercise o Create a new Dashboard Definition o Upload XLF file o Upload SWF file o Add Query Definition (CUSTOM-DashboardReport-Ex1) to the Dashboard Elements tab o Save and Preview Dashboard Definition 2011 SAP AG. All rights reserved. 17

19 Creating a Dashboard Report

20 Creating a Dashboard Report How to get started Design the UI layout Create the model (UI) in Xcelsius using the Sourcing Template Get the design approved Determine the Query Definitions to be developed Develop the Query Definitions Bind Xcelsius UI components and configure XML Data Connections Export to Flash file (SWF file) Create Dashboard Definition in Sourcing Test the Dashboard Definition Add Dashboard Definition to Report 2011 SAP AG. All rights reserved. 20

21 Creating a Dashboard Report How to get started Step 1: Design UI layout Start with pencil and paper Design layout based on how users need to view the data With free-form design capabilities of Xcelsius, there is line between what you can do versus what you should do Keep the visualization simple and easy to use so business users can quickly analyze their KPIs and drive action from analysis Finalize the layout 2011 SAP AG. All rights reserved. 21

22 Creating a Dashboard Report How to get started Step 2: Create the model (UI) in Xcelsius Use Sourcing provided Xcelsius template as a starting point. To download the template go to Setup Dashboard Definitions User Activity Dashboard Attachments Create the model (UI) in Xcelsius by adding the UI components to the canvas 2011 SAP AG. All rights reserved. 22

Creating a Dashboard Report How to get started Step 2 Contd : Create the model (UI) in Xcelsius Make sure to name the UI components appropriately in the Object Browser.

23 Creating a Dashboard Report How to get started Step 2 Contd : Create the model (UI) in Xcelsius Make sure to name the UI components appropriately in the Object Browser. With complex design, if UI components are not named, it could be time consuming to find the UI component in the Object Browser At this stage it is not necessary to perform data binding, but for demo purpose if it makes sense go ahead and bind UI components with the Excel spreadsheet 2011 SAP AG. All rights reserved. 23

Creating a Dashboard Report How to get started Step 3: Get Design Approved Before developing the query, share the design with the customer and get the design approved Making changes to the UI once

24 Creating a Dashboard Report How to get started Step 3: Get Design Approved Before developing the query, share the design with the customer and get the design approved Making changes to the UI once the Dashboard is built could be time consuming. For example, adding additional column in the query would result in redo of binding of UI components. So avoid it if possible 2011 SAP AG. All rights reserved. 24

25 Creating a Dashboard Report How to get started Step 4: Determine Query Definitions to be developed Dashboard Reports typically require several query definitions to be developed It is critical that the list of query definitions required for Dashboard Report is determined along with the filters for each query definition Sometimes, there may be a need to initialize some data when the Dashboard Report is run and this might require specific Query Definitions to be executed as part of the initial load. Example: A report might have dropdown filter parameters and the values of the dropdown may be driven by a Query Definition 2011 SAP AG. All rights reserved. 25

Creating a Dashboard Report How to get started Step 5: Develop Query Definitions At this point we are ready to create the Query Definitions in Sourcing When developing query definitions, it is key to

26 Creating a Dashboard Report How to get started Step 5: Develop Query Definitions At this point we are ready to create the Query Definitions in Sourcing When developing query definitions, it is key to keep in mind, certain query syntax will not work with Dashboard Reports. For example, if you have a complex column type object id, class id, display name combination, it would not be rendered as a link to the business document on the Dashboard Certain filter types such as object pickers, value list values are not natively supported, so the report developer should take that into account. Note: more details on this later in the presentation 2011 SAP AG. All rights reserved. 26

27 Creating a Dashboard Report How to get started Step 6: Bind Xcelsius UI components and configure Data Connections On the configuration sheet List the Data Connections and the query definition for each data connection list the filter parameters for each query definition Add the query source and destination columns for each query sheet Bind the UI components to the Excel sheet Add conditional visibility logic if any in the UI sheet Bind the error messages to the Messages sheet 2011 SAP AG. All rights reserved. 27

28 Creating a Dashboard Report How to get started Step 6: Bind Xcelsius UI components and configure Data Connections.contd Add the localized resources to the Text sheet Create Data Connections Configure Enable Load parameters for each Data Connection Configure Enable Send parameters for each Data Connection 2011 SAP AG. All rights reserved. 28

29 Creating a Dashboard Report How to get started Step 7: Export to Flash File (.swf file) Once the data binding and data connections are configured, preview the Xcelsius Dashboard in Xcelsius If everything looks good, export it to SWF file by going to File menu Export Flash (SWF) Save the SWF file on to your PC 2011 SAP AG. All rights reserved. 29

Creating a Dashboard Report How to get started Step 8: Create Dashboard Definition in Sourcing Create a new Dashboard Definition in Sourcing Give it a

30 Creating a Dashboard Report How to get started Step 8: Create Dashboard Definition in Sourcing Create a new Dashboard Definition in Sourcing Give it a Internal Name and Display Name Upload the xlf and swf file Add the Query Definitions associated with the Dashboard 2011 SAP AG. All rights reserved. 30

31 Creating a Dashboard Report How to get started Step 9: Test Dashboard Definition in Sourcing If updates are made in Xcelsius, a new SWF file should be exported from Xcelsius and uploaded to the Dashboard Definition If updates are made make sure to upload the updated xlf file as well for future maintenance 2011 SAP AG. All rights reserved. 31

32 Creating a Dashboard Report How to get started Step 10: Add Dashboard to Report Create a new Report in Sourcing and add the Dashboard Definition Add the Report to the appropriate place in Sourcing for end user access 2011 SAP AG. All rights reserved. 32

34 Filters and Result Output

Filters & Result Output Filter Parameters Filter Parameters Filters values can be defaulted in 3 different places 1) Query Definition, 2) Dashboard Definition, 3) Xcelsius Dashboard Filter values

35 Filters & Result Output Filter Parameters Filter Parameters Filters values can be defaulted in 3 different places 1) Query Definition, 2) Dashboard Definition, 3) Xcelsius Dashboard Filter values in Xcelsius Dashboard overrides the filter values in Dashboard Definitions and filter values in Dashboard Definitions overrides filter values in Query Definitions 2011 SAP AG. All rights reserved. 35

36 Filters & Result Output Filter Parameters Recommended Filter Parameters Mapping Desired filter Parameter Query Definition Parameter type Xcelsius UI Component Object Picker Date Text Radio Button Drop Down Checkbox Enumeration String Integer String String String Integer Boolean Integer 2011 SAP AG. All rights reserved. 36

will be represented as Strings, but not a object reference for example) Object ID, Class ID, Display Name internal and external URLs

37 Filters & Result Output Output Columns Output Columns The following complex column types are supported Monetary Amount and Monetary Currency Quantity Amount, Quantity Unit Object ID, Quantity Unit Display Name The following column types are NOT supported (they will be represented as Strings, but not a object reference for example) Object ID, Class ID, Display Name internal and external URLs (Note: internal external URLs can be used to create links manually using URL button) Xcelsius mapping 2011 SAP AG. All rights reserved. 37

38 Filters & Result Output Output Columns Output Columns The order of the columns defined in the query definition is same as the order of the columns sent to Xcelsius. So binding the query columns to embedded excel sheet should be done appropriately. Columns marked as hidden in the Query Definition will not be honored by Dashboard Report. So those columns should be placed in the start or end so that it does not impact the data mapping in the Xcelsius dashboard The columns mapping should be contiguous Example: Desired columns in the Dashboard Report: A, B, C, D Query Definition columns (Note: E, F not displayed to end user) A, B, C, D, E, F E, F, A, B, C, D A, E, F, B, C, D 2011 SAP AG. All rights reserved. 38

Filters & Result Output Linking Result Data In Dashboard Reports it is possible to link list views. Selecting header data can trigger the detail data to be displayed in an another list view.

39 Filters & Result Output Linking Result Data In Dashboard Reports it is possible to link list views. Selecting header data can trigger the detail data to be displayed in an another list view. For example, the first list view displays list of MA and related header data. When the user clicks on a MA name, a second list view displays line item details Show Contract Performance Dashboard report 2011 SAP AG. All rights reserved. 39

40 Filters & Result Output Dynamic Visibility It is possible to dynamically show or hide UI components on the canvas. In a complex Dashboard Report with several UI components it may be useful to show or hide UI components to maximize the available space on the report Examples Clicking on header data can show a more detailed view of the business document Toggle between different charts based on certain actions by the user Can create pop up effect To create dynamic visibility, use the Status and Key field on the Behavior tab of the Properties view 2011 SAP AG. All rights reserved. 40

41 Best Practices

42 Best Practices General Do not use the same Query Definitions for Dashboard Reports and the regular reports in Sourcing In general, avoid using the same Query Definition on multiple Dashboard Reports Make regular backups of the Xcelsius Dashboard file (.xlf). Append data time stamp to the file name to maintain versions. The xlf file versions can be stored in the attachments area of the Dashboard Report. There is no need to backup swf file SAP AG. All rights reserved. 42

43 Best Practices UI Recommended canvas size is 900 (width) by 600 (height) in pixels In order to change the canvas size, update the Height and Width field on the Dashboard Definition (not the canvas size in Xcelsius) Recommended error messages is of font size 10 with font color red Use Phase theme Follow the recommended color codes in the excel spreadsheet 2011 SAP AG. All rights reserved. 43

44 Best Practices Xcelsius Dashboard Do not hard code values in Xcelsius Dashboard. Bind it to a localized resource in the Texts sheet Name the UI components in the Object Browser appropriately. UI components with default names could be confusing especially when canvas contains large number of UI components Each Query Definition should be in its own sheet When designing Xcelsius Dashboard sample data can be added to embedded excel spreadsheet as visual help. It some cases it may be useful to export the result from the Query Definition to excel and transfer it to Xcelsius Dashboard by doing a copy and paste. It is recommended to remove 2011 SAP AG. All rights reserved. 44

45 Best Practices Performance Aspects Smaller queries are better. Do not exceed maximum rows larger than 2000 rows. By default maximum number of rows that can be referenced by a formula or component is 512. Increasing of this value can cause performance issues Make use of the Data Connections and Connection Refresh button to request the query results during initialization. Avoid loading all the Query Definitions at the same time Perform aggregations and calculations in the Query Definition as much as possible and not in the embedded spreadsheet in Xcelsius Following excel functions are supported in Xcelsius but could have a performance impact. So these functions should be used judiciously SUMIF COUNTIF HLOOKUP VLOOKUP 2011 SAP AG. All rights reserved. 45

46 Troubleshooting

where Sourcing is running, enter http://<server>:<port>/xcelsius?

47 Troubleshooting Common Troubleshooting Techniques How to check what data is sent from Sourcing to Xcelsius Dashboard In same the browser window where Sourcing is running, enter =<Internal Name of Dashboard Definition> 2011 SAP AG. All rights reserved. 47

48 Troubleshooting Common Troubleshooting Techniques Debugging during run time Using any web debugging proxy tools such as Fiddler, the http request and response can be used to debug during report run time 2011 SAP AG. All rights reserved. 48

49 Troubleshooting Issue: Xcelsius crashes Solution: Open task manager and kill the Excel process. Restart Xcelsius Note: Sometimes when Xcelsius crashes the xlf file could get corrupt and you may not be able to open it. Make sure to save XLF file often 2011 SAP AG. All rights reserved. 49

50 Troubleshooting Issue: Error thrown by the Query Definition is not displayed on the Dashboard report Solution: If query error is not displayed developer should ensure that corresponding mapping is provided between the dashboard UI and Messages worksheet 2011 SAP AG. All rights reserved. 50

Troubleshooting Issue: Report contains test data from embedded excel Solution: This typically means the Data Connections in Xcelsius Data Manger is not

51 Troubleshooting Issue: Report contains test data from embedded excel Solution: This typically means the Data Connections in Xcelsius Data Manger is not configured correctly Make sure the Enable Load data is bound to the cells to which the UI component s source data is mapped to 2011 SAP AG. All rights reserved. 51

Troubleshooting Error Cannot Access External Data Issue How to troubleshoot when you

53 Troubleshooting In the Fiddler trace above, notice that there is an unresolved excel cell mapping in the url. This is indication that the XML Data URL is not configured correctly. Solution: In Xcelsius Data Manager, select the XML Data Connection and check if the XML Data URL is mapped correctly 2011 SAP AG. All rights reserved. 53

54 Tips & Tricks

Tips & Tricks Freezing Result Column(s) Freezing Result Column(s) With result set containing lot of columns, the user would have to scroll to the right view the rest of the columns.

56 Tips & Tricks Freezing Result Column(s) Freezing Result Column(s) With result set containing lot of columns, the user would have to scroll to the right view the rest of the columns. to view the columns. It might be useful to freeze key columns, similar to freeze pane functionality in MS Excel Xcelsius does not natively support freezing of columns, however using UI components the functionality can be mimicked if such a requirement is desired Demonstrate Freezing Result Column(s) 2011 SAP AG. All rights reserved. 56

57 Appendix

59 Xcelsius 2008 Learning Materials Xcelsius 2008 elearning Courses Xcelsius 2008 elearning Courses Business Objects Xcelsius 2008 Enterprise: Core s/t-xc083503/html/xc html Implementing Crystal Xcelsius Dashboards with SAP s/t-ot3501/html/ot3501.html BusinessObjects Xcelsius 2008 Enterprise: Core & Connectivity _Guides/PDC/T-XC zip 2011 SAP AG. All rights reserved. 59

61 Thank You! Vikram Shanmugasundaram Sourcing / CLM Center of Excellence

62 2012 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 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. The information in this document is proprietary to SAP. No part of this document may be reproduced, copied, or transmitted in any form or for any purpose without the express prior written permission of SAP AG. This document is a preliminary version and not subject to your license agreement or any other agreement with SAP. This document contains only intended strategies, developments, and functionalities of the SAP product and is not intended to be binding upon SAP to any particular course of business, product strategy, and/or development. Please note that this document is subject to change and may be changed by SAP at any time without notice. SAP assumes no responsibility for errors or omissions in this document. SAP does not warrant the accuracy or completeness of the information, text, graphics, links, or other items contained within this material. This document is provided without a warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. SAP shall have no liability for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials. This limitation shall not apply in cases of intent or gross negligence. The statutory liability for personal injury and defective products is not affected. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third-party Web pages nor provide any warranty whatsoever relating to third-party Web pages SAP AG. All rights reserved. This presentation and SAP s strategy and possible future developments are subject to change and may be changed by SAP at any time for any reason without notice. This document is provided without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement 36

Business Objects Integration Scenario 2

Business Objects Integration Scenario 2 SAP AG May 2010 - Prerequisites Abstract This presentation provides a step by step description how to create an Xcelsius dashboard based on a BI Query (using the SAP NetWeaver BW connection). Prerequisites