Hyperion SQR Production Reporting Developer's Guide Volume 3
Total Page：16
File Type：pdf, Size：1020Kb
HYPERION® SQR® PRODUCTION REPORTING RELEASE 11.1.1 DEVELOPER’S GUIDE VOLUME 3: ACCESSING DATA WITH SQR PRODUCTION REPORTING DDO Production Reporting Developer’s Guide, 11.1.1 Copyright © 1996, 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 Part I. Understanding Production Reporting ................................................. 9 Chapter 1. Production Reporting Basics .................................................. 11 About Production Reporting DDO ........................................ 11 Production Reporting DDO Software Development Kit .......................... 11 Advantages of Production Reporting DDO Interfaces ........................... 12 Production Reporting DDO Architecture .................................... 12 Establishing a Data Source Connection .................................. 13 Supporting Transactions ............................................. 14 Obtaining Metadata ................................................ 14 Obtaining Data .................................................... 15 Processing Results .................................................. 15 Implementing Production Reporting DDO Interfaces with Drivers .............. 16 Data Access Strategies .................................................. 17 Chapter 2. Creating Production Reporting DDO Applications .................................... 19 About the Production Reporting DDO API .................................. 19 A Simple Code Example ................................................ 19 Managing Data Sources ................................................. 20 Registry Files ..................................................... 21 The DataSourceManagerAdmin Class ................................... 21 Defining a New Data Source .......................................... 22 Establishing a Connection .............................................. 25 Processing Logon Properties .......................................... 25 Discovering Capabilities ................................................ 28 Checking for a Capability ............................................ 29 Obtaining Metadata ................................................... 30 Obtaining Schema Information ........................................ 31 Listing Data Objects in a Schema ....................................... 32 Obtaining Information about Data Objects ................................ 33 Retrieving Column Metadata ......................................... 34 Obtaining Metadata About Procedures ................................... 35 Contents iii Determining the Return Value ......................................... 36 Requesting Data ...................................................... 38 Retrieving Data with getData .......................................... 39 Executing Commands .............................................. 42 Calling Procedures and Processing Call Results ............................. 44 Performing Transactions ............................................. 46 Obtaining Hierarchical and Multidimensional Data ......................... 47 Retrieving Multidimensional Data Using a Regular Selector .................... 50 Retrieving Multidimensional Data Using MDSelector ........................ 51 Chapter 3. Writing a Production Reporting DDO Driver ........................................ 55 About Writing a Driver ................................................. 55 Summary of Steps ..................................................... 55 Step 1: Create the Properties, Capabilities, and Message Files ...................... 56 Creating the Properties Files .......................................... 56 Creating the Capabilities Files ......................................... 56 Creating the Messages File ............................................ 57 The CSV Interface .................................................. 58 Step 2: Implement the DataSource Interface .................................. 59 Step 3: Implement the Connection Interface .................................. 60 Providing Column Metadata .......................................... 62 Implementing getData .............................................. 66 Implementing getData with Selector ..................................... 66 CSVFile Class ..................................................... 67 Step 4: Implementing Rowset ............................................ 69 Chapter 4. Programming Considerations .................................................. 73 Production Reporting DDO Adapters ...................................... 73 Driver Organization Tips ................................................ 73 Registy Editor ..................................................... 74 Messages and Exceptions ................................................ 75 CSV Example ..................................................... 76 Message Forms .................................................... 76 Properties and Capabilities .............................................. 77 Descriptions ...................................................... 78 Localization ...................................................... 78 Hierarchical Structure ............................................... 78 Internationalization ................................................... 80 Message Editor ....................................................... 80 Loading Messages .................................................. 81 iv Contents Adding Messages .................................................. 82 Editing Message Contents ............................................ 82 Property Editor ....................................................... 83 Loading Properties ................................................. 83 Testing and Debugging Drivers ........................................... 84 Using the Query Editor to Test and Debug Drivers .......................... 84 Chapter 5. Managing Data Sources ..................................................... 87 Data Source Specifications ............................................... 87 Adding a Data Source Specification in the Registry Editor ........................ 88 Data Source Descriptions and Templates .................................... 88 Hyperion Essbase .................................................. 89 SAP R/3 and SAP BW ............................................... 90 Microsoft OLEDB for OLAP .......................................... 94 Microsoft OLEDB .................................................. 94 JDBC ........................................................... 95 XML .......................................................... 102 Delimiter Separated Values .......................................... 103 OMG Corba Sample ............................................... 103 Microsoft DCOM Sample ........................................... 104