HYPERION® APPLICATION BUILDER FOR .NET RELEASE 11.1.1 DEVELOPER’S GUIDE Application Builder for .NET Developer’s Guide, 11.1.1 Copyright © 2004,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. Getting Started with Application Builder for .NET ..................................... 7 Overview ............................................................ 7 Setting Up the Development Environment .................................... 8 Programming Environment Requirements .................................... 8 About Embedded Java Application Programming Interface ........................ 9 Prerequisites ...................................................... 9 Enabling Embedded JAPI ............................................... 10 Managing the Embedded JAPI Feature ...................................... 10 Running the Embedded JAPI Utility ........................................ 11 Chapter 2. Creating OLAP Aware Web Application with Application Builder for .NET .................... 13 Overview ........................................................... 13 Prerequisites ......................................................... 13 Creating a Basic ASP.NET Application ...................................... 13 Setting Up Dependencies ............................................. 14 Creating a Sample Application using List box, Drop-Down List, and Data Grid ...... 14 Creating a Sample Application using Grid Adapter OWC11, List Box, and Drop-down List ............................................................ 22 Chapter 3. Creating OLAP Aware Windows Application with Application Builder for .NET ................. 31 Overview ........................................................... 31 Prerequisites ......................................................... 31 Creating a Basic Windows Application ...................................... 31 Setting Up Dependencies ............................................. 32 Creating a Sample Application using List Box, Combo Box, Tree View, and Data Grid ............................................................ 32 Creating a Sample Application using Grid Adapter OWC11, List Box, Combo Box, and Tree View ........................................................ 41 Chapter 4. Programming with Base Classes ................................................ 51 Overview ........................................................... 51 EssOperations ........................................................ 52 EssConnection ....................................................... 53 Contents iii EssDomain .......................................................... 53 EssProperties ........................................................ 54 Chapter 5. Programming with Dialog Classes ............................................... 55 Overview ........................................................... 55 SignOnDialog ........................................................ 55 MemberSelectionDialog ................................................ 56 EssTreeview ......................................................... 56 Chapter 6. Application Builder for .NET ASP.Net Components Reference ............................ 59 Overview ........................................................... 59 Data Server Component ................................................ 59 Web Grid Adapters .................................................... 61 Grid Adapter Generic ............................................... 61 Grid Adapter OWC11 ............................................... 61 Web Metadata Adapters ................................................ 62 Drop-Down List Adapter ............................................. 62 List Box Adapter ................................................... 63 TreeviewAdapter ..................................................... 64 Chapter 7. Application Builder for .NET Windows Components Reference ........................... 67 Overview ........................................................... 67 ComboBoxAdapter .................................................... 67 DataServer .......................................................... 68 GridAdapterOWC11 .................................................. 69 ListBoxAdapter ...................................................... 70 TreeViewAdapter ..................................................... 71 Appendix A. Application Builder for .NET APIs .............................................. 73 Overview ........................................................... 73 Hyperion.Objects.Essbase.Common ........................................ 74 Hyperion.Objects.Essbase.Common.Grid .................................... 75 Hyperion.Objects.Essbase.Common.Transports ............................... 76 Hyperion.Objects.Essbase.Common.Grid.OWC11 ............................. 76 Hyperion.Objects.Essbase.Components.Design ................................ 77 Hyperion.Objects.Essbase.Components.Metadata .............................. 77 Hyperion.Objects.Essbase.Components.Web.Design ............................ 79 Hyperion.Objects.Essbase.Components.Web ................................. 79 Hyperion.Objects.Essbase.Components.Windows.Design ........................ 80 Hyperion.Objects.Essbase.Components.Windows .............................. 81 iv Contents Hyperion.Objects.Essbase.Windows.Forms .................................. 82 Appendix B. Migrating Application Builder for .NET Applications ................................. 85 Overview ........................................................... 85 Comparing the Components of Application Builder for .NET Release 9.2 with Application Builder for .NET Release 11.1.1.0 .......................................... 85 Migrating to Application Builder for .NET Release 11.1.1 ........................ 88 Drag-Drop Option ................................................. 88 Run time ........................................................ 92 Appendix C. Performance Tuning ....................................................... 93 Performance Tuning to Retrieve Records .................................... 93 Index .............................................................. 95 Contents v vi Contents Getting Started with 1 Application Builder for .NET In This Chapter Overview .............................................................................................................................7 Setting Up the Development Environment........................................................................................8 Programming Environment Requirements ........................................................................................8 About Embedded Java Application Programming Interface.....................................................................9 Enabling Embedded JAPI..........................................................................................................10