Hyperion Interactive Reporting – Object Model and Dashboard Development Services Developer's Guide, Volume 5: Dashboard Studio
Total Page:16
File Type:pdf, Size:1020Kb
HYPERION® INTERACTIVE REPORTING RELEASE 11.1.1 OBJECT MODEL AND DASHBOARD DEVELOPMENT SERVICES DEVELOPER’S GUIDE VOLUME VII: COMPONENT REFERENCE GUIDE Interactive Reporting Object Model and Dashboard Development Services Developer’s Guide, 11.1.1 Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. Authors: EPM Information Development Team This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS: Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services. Contents Chapter 1. Dashboard Development Services Components ....................................... 9 About Components .................................................... 9 About Dashboard Studio Runtime Releases ................................... 9 Creating Runtime Releases ............................................... 9 Self-Optimizing Runtime Dashboards ...................................... 10 Merging Components .................................................. 10 Applying and Configuring Component Buttons ............................... 12 Component Buttons ................................................ 12 Toolbar Buttons ................................................... 14 Configuration Frame Buttons ......................................... 15 Adding and Configuring Buttons to Dashboards or Templates .................. 16 Chapter 2. Customizing Plug-and-Play Components (Programmers Only) ............................ 21 About Plug-and-Play Components ......................................... 21 Component Fingerprints ................................................ 22 Functions and Method Prototypes ......................................... 23 Standard Component Methods ........................................... 24 Reverting to a Template ................................................ 24 Creating Plug-and-Play Components ....................................... 24 Chapter 3. Dashboard Studio Chart Shade Component ........................................ 27 Chart Shade Component ................................................ 27 Using a Runtime Release of the Chart Shade Component ........................ 27 Configuring the Chart Shade Component .................................... 29 Configuring Chart Shade Buttons ...................................... 29 Setting Color Palettes in the Chart Shade Component ........................ 30 Notes on Performance .................................................. 31 Test Cases ....................................................... 31 Test Results ...................................................... 32 Setting Filters ..................................................... 32 Updating Interactive Reporting Documents that Contain the Chart Shade Component ...................................................... 32 Contents iii Chapter 4. Dashboard Studio Conditional Navigation Properties Frame ............................. 33 Conditional Navigation Properties Frame .................................... 33 Configuring with the Conditional Navigation Properties Frame .................... 33 Chapter 5. Dashboard Studio Conditional Sub-Queries Component ................................ 37 Conditional Sub-Queries Component ...................................... 37 Conditional Sub-Queries Component Example ............................... 38 Activating Sub-Queries with the Conditional Sub-Queries Component in a Runtime Release ............................................................. 39 Configuring the Conditional Sub-Queries Component .......................... 40 Building Conditional Sub-Queries Component Entries ....................... 40 Creating Primary Queries that Execute Sub-Queries ......................... 40 Creating Custom Events that Execute Sub-Queries .......................... 42 Scheduling Conditional Sub-Queries Component Documents on the Server ........ 43 Chapter 6. Dashboard Studio Copy Scale Component ......................................... 45 Copy Scale Component ................................................. 45 Using a Runtime Release of the Copy Scale Component ......................... 45 Configuring Charts for use in the Copy Scale Component ........................ 47 Chapter 7. Dashboard Studio Drill Across Component ......................................... 49 Drill Across Component ................................................ 49 Using a Runtime Release of the Drill Across Component ......................... 50 Example Using Sales and Costs Dashboards ............................... 50 Using Source and Target Dashboards .................................... 50 Drilling Operations ................................................. 51 Configuring the Drill Across Component .................................... 52 Building Dashboards ................................................ 52 Creating an Excel Spreadsheet ......................................... 53 Using the Drill Across Properties Frame .................................. 54 Drilling to Separate Tables within the Same Query Structure ................... 55 Using Pivot Trees Component as a Drill Across Source ....................... 55 Chapter 8. Dashboard Studio Drill and Slice Component ....................................... 57 Drill and Slice Component .............................................. 57 Using a Runtime Release of the Drill and Slice Component ....................... 57 Configuring the Drill and Slice Component .................................. 58 Configuring Drill and Slice Buttons ..................................... 58 Creating and Displaying Charts and Pivots on Drill and Slice Frames ............. 59 Renaming the Marker Column ........................................ 60 Using the Drill and Slice Properties Frame ................................ 61 iv Contents Chapter 9. Dashboard Studio Workspace Alert Component ..................................... 63 About the Workspace Alert Component ..................................... 63 Using the Workspace Alert Component with the Conditional Sub-Queries Component . 64 Displaying Exceptions or Alerts ........................................... 64 Configuring the Workspace Alert Component ................................ 66 Orcl_Exception.txt Table and Output.properties ............................ 68 Using the OnPostProcess() Method Call .................................. 69 Chapter 10. Dashboard Studio Format Header Component ..................................... 71 Format Header Component ............................................. 71 Using a Runtime Release of the Format Header Component ...................... 71 Configuring the Format Header Component ................................. 73 Adding Format Header Text Labels ..................................... 73 Configuring the Header Rule .......................................... 74 Adding Format Header Specifications to Reports ........................... 76 Chapter 11. Dashboard Studio Graphic Gauges Component ..................................... 77 Graphic Gauges Component ............................................