HYPERION® APPLICATION BUILDER FOR - Oracle · Application Builder for .NET Developer ... Install...

H Y P E R I O N ® A P P L I C A T I O N B U I L D E R F O R . N E T

R E L E A S E 1 1 . 1 . 1

D E V E L O P E R ’ S G U I D E

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 anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed 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 decompilationof 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 findany 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 relateddocumentation 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 supplementalregulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions andlicense terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Governmentcontract, 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 orintended for use in any inherently dangerous applications, including applications which may create a risk of personalinjury. 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 disclaimany 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 thirdparties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind withrespect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for anyloss, 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-downList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 DataGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Creating a Sample Application using Grid Adapter OWC11, List Box, Combo Box, andTree 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 ApplicationBuilder 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

1Getting Started with

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

Managing the Embedded JAPI Feature ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Running the Embedded JAPI Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

This chapter introduces Oracle's Hyperion® Application Builder for .NET. It describes how tocreate a basic application within the .NET environment that will access Oracle Essbase data.

OverviewApplication Builder for .NET provides a comprehensive set of OLAP-aware classes for datanavigation, selection, reporting, and visualization to assist you in building custom analyticalapplications. These controls provide you with the tools to quickly create and deploy applicationsin stand-alone, client-server, Web, or distributed processing environments.

Application Builder for .NET is a component of the Oracle Enterprise Performance Managementsystem that provides an application development workbench for companies wanting to use theMicrosoft .NET Framework to create tailored business performance management solutions.Application Builder for .NET includes the following key features:

● Drag and Drop components for creating OLAP aware applications for Web and Windowsusing MS Visual Studio.Net

● .NET Framework compatibility

● Web Service -based architecture (SOAP)

Application Builder for .NET provides the following functionality:

● Base classes. These classes contain basic OLAP functionality and encapsulate functionalitynecessary to connect to and perform operations on Essbase applications and databases.

● Dialog components. These classes encapsulate the functionality of Essbase dialog boxes,including the sign-on and member selection dialog boxes.

Overview 7

● Grid classes: These classes encapsulate functionality enabling data grid controls to displayEssbase data.

● Application Builder for .NET Drag and Drop OLAP aware components utilize thefunctionality listed preceding and bind the Microsoft .Net application controls to Essbase.These components use this technique to expose all Essbase functionality to enable creationof OLAP aware Web based and Desktop applications utilizing the Microsoft .Net framework.

Setting Up the Development EnvironmentTo develop Application Builder for .NET applications within Visual Studio for .NET, performthe following steps:

● Install and configure Microsoft Visual Studio for .NET.

● Install Application Builder for .NET and note which directory contains theApplicationBuilder for .NET assemblies.

● If you are developing an ASP .NET (Active Server Pages) application, install or ensure accessto an instance of Microsoft Internet Information Server (IIS).

● If you are developing applications using Microsoft Office Web Components (OWC11), youmay need to add Microsoft Office Primary Interop Assemblies and install additionalassemblies available from www.microsoft.com.

● Install or ensure access to an Essbase server and application.

This guide assumes that you will be using the Sample application and Basic database installedwith Essbase.

● Ensure that the Application Builder for .NET .WAR file has been applied to your Webapplication server. For information on how to deploy the .WAR file, see the Oracle HyperionEnterprise Performance Management System Installation and Configuration Guide.

● Ensure that Oracle Hyperion Provider Services™ is running, and that your application servercan access it.

Programming Environment RequirementsThe examples and graphics in the Application Builder for .NET Release 11.1.1.0 Developer'sGuide are built in Microsoft Visual Studio .NET 2003, using Microsoft Visual Basic for .NETand Microsoft C# for .NET.

● Microsoft VB.NET

● C#.NET 2003

Any design-time work that involves actual data from the database requires an active connectionto an Essbase server. Design work such as layout and inter-object communication can be donewithout a live connection.

8 Getting Started with Application Builder for .NET

About Embedded Java Application Programming InterfaceThe Embedded Java Application Programming Interface (JAPI) feature is a simple deploymentof the JAPI solution. Enabling this feature will provide the Application Builder for .NETapplications to establish connection with the Essbase servers even when Provider Services is notinstalled, see Figure. The connection protocol between the Application Builder for .NETapplications and the Essbase servers is TCP/IP or HTTPS.

Figure 1 Embedded JAPI Connectivity

The embedded JAPI deployment for Application Builder for .NET includes .jar files andproperty files. When you enable the embedded JAPI feature, the Application ProgrammingInterface (API) client will include these .jar files and property files in the Application Builderfor .NET application.

PrerequisitesSome of the current Java API customers may require only Java API functionality, and will notrequire a full installation of the Provider Services product with the extended functionality suchas Clustering, High Availability, Connection Pooling, and XMLA provider.

Complete these prerequisites to enable this feature:

● %APS_HOME% should contain both \bin and \data folders

● %APS_HOME%\bin should contain essbase.properties file

● Update the Habnet.properties file.

In \HABNET_HOME\products\Essbase\habnet\Server\lib\, InHabnet.properties file include value EDSUrl=Embedded.

About Embedded Java Application Programming Interface 9

● From Essbase server installation location: HABNET_HOME\products\Essbase\habnet\server\lib copy the Essbase.properties file to %APS_HOME%\bin.

Enabling Embedded JAPIThe embedded JAPI feature is available when you install this release of Application Builderfor .NET. However, to enable this feature, you must do some updates to theHabnet.properties file. With this feature update to the Application Builder for .NET release,to establish connection between Application Builder for .NET applications and Essbase has aoption of using either Provider Services or embedded JAPI depending on the requirement.

This utility is run based on the following assumptions:

● The password information of the Essbase servers are read without any encryption.

● The user ID and password information is used for authentication and this utility will updateonly the server name information in the domain.db file.

● The utility will read the environment variables APS_HOME and HABNET_HOME to get thelocation information of the files domain.db and essbase_servers.xml.

➤ To enable the embedded JAPI utility:

1 In the Habnet.properties file, for EDSUrl provide the value Embedded.

2 Save and close the Habnet.properties file.

➤ To revert to Provider Services:

1 In the Habnet.properties file, for EDSUrl provide the value EDSUrl = http://<servername>:<port number>/aps/JAPI.

2 Save and close the Habnet.properties file.

Managing the Embedded JAPI FeatureThis feature offers a utility that gathers the Essbase server information (server name, user ID,and password) from the XML template file essbase_servers.xml and updates thedomain.db file. The user has a privilege to add the server information inessbase_servers.xml to "add","delete" and "None" actions to update thedomain.db file.

The essbase_servers.xml file must include these server information:

<?Xml version=“1.0” encoding="UTF-8”?>

<essbaseservers>

<server action="add" name = "10.66.12.123" user = "admin" password =

"password"></server>


<server action="none" name = "10.66.12.123" user = "admin" password =

"password"></server>

</essbaseservers>

In essbase_servers.xml file the action attribute can have one of the following values:Add, Delete and None. Add value adds the specified server information to domain.db file.Delete value deletes the specified server information from the domain.db file. None valuemeans no action performed on the domain.db file.

The Application Builder for .NET applications will use this information that is present in thedomain.db file to communicate with the Essbase servers. The domain.db file is present in thefolder APS_HOME\data.

Running the Embedded JAPI UtilityAs prerequisite, the essbase_servers.xml file must be present in the location\HABNET_HOME\products\Essbase\habnet\Server\lib. Once this utility is run, thedomain.db file is created in the location APS_HOME\data.

You can run the embedded JAPI utility from the Application Builder for .NET installationdirectories. The embedded JAPI utilty will update the server information in the domain.db file.

➤ To run the embedded JAPI utility and update the XML template file:

1 For Windows: from %HABNET_HOME%\products\Essbase\habnet\Server\bin\, run commandESSJapiUtil.bat.

2 For Unix: from $HABNET_HOME/products/Essbase/habnet/Server/bin/, run commandESSJapiUtil.sh.

You can register or deregister the Essbase servers with or without resetting the password orexporting the Essbase server information.

➤ To register the Essbase servers and reset the Essbase server passwords:

1 For Windows: from %HABNET_HOME%\products\Essbase\habnet\Server\bin\, run commandESSJapiUtil.bat register.

2 For Unix: from $HABNET_HOME/products/Essbase/habnet/Server/bin/, run commandESSJapiUtil.sh register.

➤ To export the Essbase server information (This command will not record the passwordinformation):

1 In \HABNET_HOME\products\Essbase\habnet\Server\lib create theessbase_servers_export.xml file.

2 For Windows: from %HABNET_HOME%\products\Essbase\habnet\Server\bin\, run commandESSJapiUtil.bat export.

Running the Embedded JAPI Utility 11

3 For Unix: from $HABNET_HOME/products/Essbase/habnet/Server/bin/, run commandESSJapiUtil.sh export.

➤ To register Essbase servers without passwords reset:

1 For Windows: from %HABNET_HOME%\products\Essbase\habnet\Server\bin\, run commandESSJapiUtil.bat registernoreset.

2 For Unix: from $HABNET_HOME/products/Essbase/habnet/Server/bin/, run commandESSJapiUtil.sh registernoreset.


2Creating OLAP Aware Web

Application with ApplicationBuilder for .NET

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Prerequisites.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Creating a Basic ASP.NET Application ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

This chapter guides you through developing advancedApplication Builder for .NETapplications. It introduces ASP.NET programming with frequently-used Application Builderfor .NET classes.

OverviewCreating an application with Application Builder for .NET provides the flexibility of creatingOLAP aware applications in any .NET language and leverages Essbase functionality. This sectionshows how to create an ASP.NET based OLAP aware application.

PrerequisitesThe following are the prerequisites for creating a sample application:

1. Install Application Builder for .NET. Refer Oracle Hyperion Enterprise PerformanceManagement System Installation and Configuration Guide and the readme for ApplicationBuilder for .NET.

2. “Setting Up Dependencies” on page 14.

Creating a Basic ASP.NET ApplicationFollow the procedures in this topic to create a .NET application to navigate, retrieve, and displaydata from an Essbase sample application and database.

➤ To set up a sample application:

1 Launch Microsoft Visual Studio for .NET.

2 Click New Project.

Overview 13

3 Select the Visual C# Projects or Visual Basic Projects folder and the ASP.NET Web Application template.

4 Optionally, rename the project file.

5 Click OK.

Setting Up DependenciesTo use Application Builder for .NET methods and properties, you must add references to theApplication Builder for .NET assemblies in your program.

➤ To add Application Builder for .NET adapter components to the Toolbox:

1 Right-click on the Toolbox and choose Add/Remove Items.

The Customize Toolbox dialog box opens.

2 Click Browse and navigate to the directory containing the Application Builder for .NETassemblies. The defaultdirectory is <Hyperion_Home>\products\Essbase\habnet\Client\bin.

3 Select the Hyperion.Objects.Essbase.Components.Web.dll file and click Open.

4 Click OK.

➤ To add Microsoft Office Spreadsheet 11.0 to the Toolbox:



2 Click the COM Components tab and select Microsoft Office Spreadsheet 11.0.

3 Click OK.

Creating a Sample Application using List box, Drop-Down List,and Data GridThis sample application demonstrates the use of List box, Drop-down list, and Data Grid toselect and display data.

Note:

Make sure you have installed all the prerequisites before creating a sample application.

➤ To create a Sample Application using List box, Drop-Down List, and Data Grid in ApplicationBuilder for .NET :

1 Launch Visual Studio .NET 2003 and start a new project.

2 Choose ASP.NET Web Application and select Visual Basic or C# as the programming language.

3 Drag-and-drop the Microsoft Drop-down List into the form in the designer window.

14 Creating OLAP Aware Web Application with Application Builder for .NET

4 Drag-and-drop the Microsoft List Box and Button into the form in the designer window.

5 Drag-and-drop a Microsoft Data Grid into the form in the designer window.

After you have dragged and dropped all the required components in the designer window, thedesigner window should look as shown below:

6 Drag-and-drop the DataServer component from the Toolbox to add it to the component tray.

Note:

There is a 1:1 relationship between the Microsoft components and the Application Builderfor .NET components except for the Data Server. For Example: If you have dragged and droppedfive Drop-down List into the designer form, you must drag-and-drop fiveDropDownListAdapter components into the component tray.

7 Drag-and-drop the DropDownListAdapter component from the Toolbox to add it to the component tray.

8 Drag-and-drop the ListBoxAdapter component from the Toolbox to add it to the component tray.

After you have dragged and dropped all the required components into the component tray, thecomponent tray should look as shown below:

Creating a Basic ASP.NET Application 15

9 Select the DataServer in the component tray and invoke the property container for this component.

10 Click the Sign On link in the designer verb collection area within the property container.

The Essbase Sign On dialog box is displayed.

a. Enter Essbase login credentials in the Sign-on dialog box.

b. If the Server default information is different from the current value, click Options.

c. Clear Use Server Default checkbox to enter new information.

For more information on adding server information, contact your Essbase SystemAdministrator.

d. Click OK.

The Select Cube dialog box is displayed.


11 Select the required cube and click OK.

12 Select the DropDownListAdapter component in the component tray and invoke the property container forthis component.

13 In the Properties window, select values for ControlToBind and DataServer properties.

14 Click SelectMembers in the designer verb collection area within the property container.

The Member Selection dialog box is displayed.


a. Select the required members.

b. Click Add to add the members.

c. Click OK.

Note:

Similarly, follow steps 12–14 for all the DropDownListAdapter components.

15 Select the ListBoxAdapter component in the component tray and invoke the property container for thiscomponent.

16 In the Properties window, select values for ControlToBind, DataServer and Button properties.

Note:

When you are using more than four ListBoxAdapters to retrieve data fromEssbase, you must setthe Layout property of atleast one ListBoxAdapter to Column. To know more about this rule,see Row/Column Rules section in the Oracle Essbase Spreadsheet Add-in User's Guide.

17 Click SelectMembers in the designer verb collection area within the property container and select themembers form the Member Selection dialog box.

Note:

Similarly, follow steps 15–17 for all the ListBoxAdapter components.


18 Double-click on the form to open the code window and add the following lines before the namespacedeclaration:

● If you are programming in C#:

using Hyperion.Objects.Essbase.Common.Grid.WebDataGrid;

● If you are programming in Visual Basic for .NET:

Imports Hyperion.Objects.Essbase.Common.Grid.WebDataGrid

After you have added the code, the screen should look as shown below:

19 Create the following variables in the class declaration section of your form:


private GridWebDataGrid EssbaseGrid = new GridWebDataGrid();


private GridWebDataGrid EssbaseGrid = new GridWebDataGrid()

After you have created the variables, the screen should look as shown below:


20 Add code to the Page_Load method that will enable your application to connect to Essbase and to performoperations on a cube.


///plug the physical grid into the essbase grid object

EssbaseGrid.DataGrid = this.DataGrid1;

this.dataServer1.EssOperations.Grid = EssbaseGrid;


EssbaseGrid.DataGrid = Me.DataGrid1

Me.DataServer1.EssOperations.Grid = EssbaseGrid



21 Run the application.

Once you run the application, the screen should look as follows:


Note:

The number of records retrieved depends on the System Memory and Application Memorysettings. For more information, see Appendix C, “Performance Tuning ”.

Creating a Sample Application using Grid Adapter OWC11,List Box, and Drop-down ListThis sample application demonstrates the use of Grid Adapter OWC11, List box, and Drop-down list. You can use the list box or the drop-down list to generate the output in the GridAdapter OWC11.

Note:



➤ To create a Sample Application using Grid Adapter OWC11, List Box, and Drop-down ListinApplication Builder for .NET :




4 Drag-and-drop the Microsoft Drop-down List into the form in the designer window.

5 Drag-and-drop Microsoft Office Spreadsheet into the form in the designer window.



Note:



8 Drag-and-drop the DropDownListAdapter component from the Toolbox to add it to the component tray.

9 Drag-and-drop the GridAdapterOWC11 component from the Toolbox to add it to the component tray.

After you have dragged and dropped all the required components into the component tray, thecomponent tray should look as shown below:


10 Select the DataServer component in the component tray and invoke the property container for thiscomponent.


The Sign-On dialog box is displayed.



c. Clear the Use Server Default checkbox to enter new information.


d. Click OK.





14 In the Properties window, select values for ControlToBind, DataServer, and Button properties.

Note:

When you are using more than four ListBoxAdapters to retrieve data fromEssbase, you must setthe Layout property of atleast one ListBoxAdapter to Column. To know more about this rule,see Row/Column Rules section in the Oracle Essbase Spreadsheet Add-in User's Guide.






c. Click OK.

Note:

Similarly, follow steps 13–15 for all the ListBoxAdapter components.

16 Select the DropDownListAdapter component in the component tray and invoke the property container forthis component.


18 Click SelectMembers in the designer verb collection area within the property container and select theMembers from the Member Selection dialog box.

Note:

Similarly, follow steps 16–18 for all the DropDownListAdapter components.

19 Select the GridAdapterOWC11 component in the component tray and invoke the property container for thiscomponent.

20 In the Properties window, select a value for the DataServer property.


Note:

Similarly, follow steps 19–20 for all the GridAdapterOWC11 components.



using Hyperion.Objects.Essbase.Common.Grid.OWC11;


Imports Hyperion.Objects.Essbase.Common.Grid.OWC11





GridAdapterOWC11.intializespreadsheet();

GridAdapterOWC11.clientOWC11spreadsheetname=”form1.spreadsheetname”;


GridAdapterOWC11.intializespreadsheet()

GridAdapterOWC11.clientOWC11spreadsheetname=”form1.spreadsheetname”



23 Double-click the Button to open the code window and add the following line in the button click event:


gridAdapterOWC111.ZoomIn();


gridAdapterOWC111.ZoomIn()


Note:

Similarly, follow the same process for all the Buttons.


Once you run the application, the screen should look as shown below.


Note:



3Creating OLAP Aware Windows

Application with ApplicationBuilder for .NET

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Prerequisites.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Creating a Basic Windows Application... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

This chapter guides you through preparing the environment and creating an OLAP awareWindows application utilizing MS Visual Studio and Application Builder for .NET WindowsComponents.

OverviewCreating an application with Application Builder for .NET for Windows provides the flexibilityof creating OLAP aware applications in any .NET language and leverages Essbase functionality.This section shows how to create an Windows based OLAP aware application.

PrerequisitesThe following are the prerequisites for creating a sample application:

1. Install Application Builder for .NET. Refer Oracle Hyperion Enterprise PerformanceManagement System Installation and Configuration Guide and the readme for ApplicationBuilder for .NET

2. “Setting Up Dependencies” on page 32

Creating a Basic Windows ApplicationFollow the procedures in this topic to create a Windows application to navigate, retrieve anddisplay data from an Essbase sample application and database.

➤ To set up a sample application:

1 Launch Microsoft Visual Studio for .NET.

2 Click New Project.

Overview 31

3 Select the Visual C# Projects or Visual Basic Projects folder and the Windows Application template.

4 Optionally, rename the project file.

5 Click OK.

Setting Up DependenciesTo use Application Builder for .NET methods and properties, you must add references to theApplication Builder for .NET assemblies in your program.

➤ To add Application Builder for .NET adapter components to the Toolbox:



2 Click Browse and navigate to the directory containing the Application Builder for .NET assemblies. The defaultdirectory is <Hyperion_Home>\products\Essbase\habnet\Client\bin.

3 Select the Hyperion.Objects.Essbase.Components.Windows.dll file and click Open.

4 Click OK.

➤ To add Microsoft Office Spreadsheet 11.0 to the Toolbox:



2 Click the COM Components tab and select Microsoft Office Spreadsheet 11.0.

3 Click OK.

Creating a Sample Application using List Box, Combo Box,Tree View, and Data GridThis sample application demonstrates the use of List box, Combo box, Tree View, and DataGrid. You can use the List box or the Combo box to generate the output in the Data Grid. Youcan select any dimension and members in the Tree View to retrieve and display data in the DataGrid.

Note:


➤ To create a Sample Application using List Box, Combo Box, Tree View, and Data GridinApplication Builder for .NET :



32 Creating OLAP Aware Windows Application with Application Builder for .NET

3 Drag-and-drop the Microsoft Tree View and Button into the form in the designer window.

4 Drag-and-drop the Microsoft Combo Box into the form in the designer window.


6 Drag-and-drop a Microsoft Data Grid into the form in the designer window.



Note:


8 Drag-and-drop the ComboBoxAdapter component from the Toolbox to add it to the component tray.

9 Drag-and-drop the TreeViewAdapter component from the Toolbox to add it to the component tray.


After you have dragged and dropped all the required components into the component tray, thecomponent tray should look as follows:

Creating a Basic Windows Application 33

11 Select the DataServer in the component tray and invoke the property container for this component.


The Essbase Sign On dialog box is displayed.



c. Clear Use Server Default checkbox to enter new information.


d. Click OK.




14 Select the ComboBoxAdapter component in the component tray and invoke the property container for thiscomponent.







c. Click OK.

Note:

Similarly, in case of more that one ComboBoxAdapter, follow steps 14–16 for all theComboBoxAdapter components.


18 In the Properties window, select values for ControlToBind, DataServer and Button properties.

Note:

When you are using more than four ListBoxAdapters to retrieve data from Essbase, you mustset the Layout property of atleast one ListBoxAdapter to Column. To know more about this rule,see Row/Column Rules section in the Oracle Essbase Spreadsheet Add-in User's Guide.

19 Click SelectMembers in the designer verb collection area within the property container and select themembers form the Member Selection dialog box.


Note:

Similarly, in case of more that one ListBoxAdapter, follow steps 17–19 for all the ListBoxAdaptercomponents.

20 Select the TreeViewAdapter component in the component tray and invoke the property container for thiscomponent.

21 In the Properties window, select values for ControlToBind, DataServer and Button properties



a. Select any Dimension from the Dimension list.

b. Select the required members.

c. Click OK.



using Hyperion.Objects.Essbase.Common.Grid.WindowsDataGrid;


Imports Hyperion.Objects.Essbase.Common.Grid.WindowsDataGrid

After you have added the code, the screen should look as follows:


24 Create the following variables in the class declaration section of your form:


private GridWindowsDataGrid EssbaseGrid= new GridWindowsDataGrid ();


private EssbaseGrid as new GridWindowsDataGrid()

After you have created the variables, the screen should look as follows:





EssbaseGrid.DataGrid = this.DataGrid1;

this.dataServer1.EssOperations.Grid = EssbaseGrid;


EssbaseGrid.DataGrid = Me.DataGrid1

Me.DataServer1.EssOperations.Grid = EssbaseGrid




Once you run the application, the screen should look as shown below.


Note:


Creating a Sample Application using Grid Adapter OWC11,List Box, Combo Box, and Tree ViewThis sample application demonstrates the use of Grid Adapter OWC11, List box, Combo box,and Tree View. You can use the list box or the Combo box to generate the output in the GridAdapter OWC11. You can select any dimension and members in the Tree View to retrieve anddisplay data in the Grid Adapter OWC11.

Note:


➤ To create a Sample Application using Grid Adapter OWC11, List Box, Combo Box, and TreeView in Application Builder for .NET:



3 Drag-and-drop the Microsoft Tree View and Button into the form in the designer window.


5 Drag-and-drop the Microsoft Combo Box into the form in the designer window.

6 Drag-and-drop Microsoft Office Spreadsheet into the form in the designer window.

After you have dragged and dropped all the required components in the designer window, thedesigner window should look as follows:



Note:

There is a 1:1 relationship between the Microsoft components and the Application Builderfor .NET components except for the Data Server. For Example: If you have dragged and droppedfive List Box into the designer form, you must drag-and-drop five ListBoxAdapter componentsinto the component tray.


9 Drag-and-drop the ComboBoxAdapter component from the Toolbox to add it to the component tray.

10 Drag-and-drop the TreeViewAdapter component from the Toolbox to add it to the component tray.

11 Drag-and-drop the GridAdapterOWC11 component from the Toolbox to add it to the component tray.

After you have dragged and dropped all the required components into the component tray, thecomponent tray should look as follows:

12 Select the DataServer component in the component tray and invoke the property container for thiscomponent.



The Sign-On dialog box is displayed.



c. Clear the Use Server Default checkbox to enter new information.


d. Click OK.






Note:

When you are using more than four ListBoxAdapters to retrieve data from Essbase, you mustset the Layout property of atleast one ListBoxAdapter to Column. To know more about this rule,see Row/Column Rules section in the Oracle Essbase Spreadsheet Add-in User's Guide.






c. Click OK.

Note:

Similarly, in case of more than one ListBoxAdapter, follow steps 15–17 for all the ListBoxAdaptercomponents.

18 Select the ComboBoxAdapter component in the component tray and invoke the property container for thiscomponent.


20 Click SelectMembers in the designer verb collection area within the property container and select theMembers from the Member Selection dialog box.

Note:

Similarly, in case of more then one ComboBoxAdapter, follow steps 18–20 for all theComboBoxAdapter components.

21 Select the GridAdapterOWC11 component in the component tray and invoke the property container for thiscomponent.

22 In the Properties window, select a value for the DataServer property.


Note:

Similarly, in case of more then one GridAdapterOWC11, follow steps 21–22 for all theGridAdapterOWC11 components.

23 Select the TreeViewAdapter component in the component tray and invoke the property container for thiscomponent.




a. Select any Dimension from the Dimension list.

b. Select the required members.

c. Click OK.



using Hyperion.Objects.Essbase.Common.Grid.OWC11;


Imports Hyperion.Objects.Essbase.Common.Grid.OWC11






GridAdapterOWC111.Spreadsheet =

(Microsoft.Office.Interop.Owc11.Spreadsheet)axspreadsheet1.GetOcx();


GridAdapterOWC111.Spreadsheet =

(Microsoft.Office.Interop.Owc11.Spreadsheet)axspreadsheet1.GetOcx()

After you have added the code, the screen will should look as follows:


28 Double-click the Button to open the code window and add the following line in the button click event:


gridAdapterOWC111.ZoomIn();


gridAdapterOWC111.ZoomIn()


Note:

Similarly, follow the same process for all the Buttons.


Once you run the application, the screen should look as follows:


Note:



4Programming with Base Classes

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

EssOperations ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

EssConnection... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

EssDomain... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

EssProperties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

This chapter explains the most frequently-usedApplication Builder for .NET base classes. Itdiscusses many of the most important properties and methods within the classes.

OverviewApplication Builder for .NET includes many object classes encapsulating the functionality of theEssbase API. These object classes, plus the dialog classes, enable you to create applications thataccess Essbase functionality with fewer lines of code than in previous releases of ApplicationBuilder for .NET, or in the Essbase API.

Figure 2 shows base Application Builder for .NET classes and how they relate to one another.

Overview 51

Figure 2 Base Object Classes

The topics in this section describe the most commonly-used base classes. For more informationabout all base classes, refer to the online help and the Visual Studio Object Explorer.

EssOperationsThe EssOperations class encapsulates the functionality of common Essbase operations,including Pivot, Zoom In, Zoom Out, Keep Only, Lock Cells, and Unlock Cells. TheEssOperations class is contained in the Hyperion.Objects.Essbase.Common.Grid assembly.

Some of the key properties and methods of this class are listed in the following table:

Table 1 Key Properties and Methods of EssOperations

Property or Method Description

EssConnection property Sets or returns the essConnection object used by the current essOperations object toencapsulate connection information for an Essbase databases and applications currentlybeing used.

EssProperties property Sets or returns the essProperties object used by the current essOperations object to specifyproperties for an Essbase operations.

EssReports property Sets or returns the essReport object used by the current essOperations object for generatingreports.

Grid property Sets or returns the Grid object (which has implemented IEssGrid) used by the currentEssOperations object.

KeepOnly method Performs a KeepOnly operation on the active cell range in the Grid object associated withthe current essOperations object.

52 Programming with Base Classes


Pivot method Performs a Pivot operation on the currently active cell in the Grid object associated withthe current essOperations object.

Retrieve method Performs a Retrieve operation to retrieve all data from the connected Essbase databasecorresponding to the contents of the Grid object associated with the current essOperationsobject.

ZoomIn method Performs a ZoomIn operation to zoom-in on data contained in the Grid object associatedwith this essOperations object.

EssConnectionThe EssConnection class encapsulates the information and actions used to connect to an Essbaseapplication and database via Provider Services. The EssConnection class is contained in theHyperion.Objects.Essbase.Common assembly.


Table 2 Key Properties and Methods of EssConnection


Application property Sets or returns the name of the Essbase application.

Connected method Returns TRUE if the application is connected to an Essbase database; otherwise FALSE.

CubeViewName property Sets or returns the server cube that will be used.

Database property Sets or returns the name of the Essbase database.

OLAPServer property Sets or returns the Essbase name.

EssApplication property Sets or returns the EssApplication object associated with the current connection.

EssDomain property Sets or returns the EssDomain object associated with the current connection.

Connect method Connects to theEssbase database using the values of the Application, Database, andEssDomain properties.

EssDomainThe EssDomain class encapsulates the information and actions used to sign on to the ProviderServices and access the server, application, and database hierarchy. The EssDomain class iscontained in the Hyperion.Objects.Essbase.Common assembly.

The following table lists some of the key properties and methods of the EssDomain class.

EssConnection 53

Table 3 Key Properties and Methods of EssDomain


APSServer property Sets or returns the Provider Services server network address.

Domain property Sets or returns the Provider Services domain name.

EncryptedLogin property Sets or returns the flag that determines whether the connection username and passwordare encrypted before being sent to the server.

Password property Sets or returns the login password.

Username property Sets or returns the username used to log onto Essbase.

SignOn method Signs on to Essbase.

EssPropertiesThe EssProperties class encapsulates properties associated with the current Essbase session. TheEssProperties class is contained in the Hyperion.Objects.Essbase.Common.Grid assembly.

The following table lists some of the key properties of the EssProperties class.

Table 4 Key Properties of essProperties


DrillLevel property Sets or returns the default drill level to be applied to the ZoomIn andConditionalZoomIn methods of an essOperations object.

HybridAnalysisEnabled property Sets or returns a flag that indicates if Hybrid Analysis is to be enabled for anyEssbase operation.

IndentStyle property Sets or returns the indentation style to be applied to data obtained from theEssbase server when it is added to the Grid object associated with an essOperationsobject.

MissingTextString property Sets or returns the Essbase missing text string to use on the Grid object associatedwith an essOperations object in data retrieved from an Essbase database.

SendZerosAsMissing property Sets or returns TRUE if the Grid object associated with an essOperations objectshould treat data that is zero as missing data in retrieves from an Essbase database;otherwise FALSE.

SuppressMissing property Sets or returns TRUE if the Grid object associated with an essOperations objectshould suppress the retrieval of rows from an Essbase server when the rows containall #Missing values; otherwise FALSE.

UpdateMode property Sets or returns TRUE if an essOperations object automatically locks thecorresponding database area when it retrieves data; otherwise FALSE.

54 Programming with Base Classes

5Programming with Dialog

Classes

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

SignOnDialog ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

MemberSelectionDialog ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

EssTreeview... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

This chapter describes the most commonly used dialog classes in Application Builder for .NET.

OverviewApplication Builder for .NET dialog classes encapsulate the functionality of Essbase dialog boxes,including the sign-on and member selection dialog boxes. Dialog boxes can be displayed withinan application by using the ShowDialog() method of the specific class.

In order to add a dialog box component to an application, add it to the Toolbox and double-click the component. This will add the component to the component tray.

SignOnDialogThe SignOnDialog class encapsulates the functionality necessary to display the Sign On dialogbox. It uses an EssConnection object to connect to a Essbase application.

Some of the more useful properties and methods of this class are summarized in the followingtable:

Table 5 Selected Properties and Methods of the SignOnDialog class


EssConnection property Sets or returns the name of the associated EssConnection object used to connectto an Essbase database.

ShowSelectCubeDialog property Sets or returns the flag that indicates whether the SelectCubeDialog should bedisplayed automatically when the user clicks the Sign On button and successfullysigns on.

ShowDialog method Displays the Sign On dialog .

Overview 55

MemberSelectionDialogThe MemberSelectionDialog class encapsulates the functionality of the Essbase Member Selectdialog box. You can add this functionality to your .NET application by using this class in yourprograms. The MemberSelectionDialog class is part of the Hyperion.Objects.Essbase.Windows.Forms assembly.


Table 6 Selected Properties and Methods of the MemberSelectionDialog class


MaxGenExpandable property Sets or returns the maximum generation number expandable in the Members tree.

AllowChangeDimension property Sets or returns the flag that enables or disables the Dimension combo box.

AllowLevelNames property Sets or returns the flag that enables or disables the "By Level Name" View Optionbutton.

DefaultDimension property Sets or returns the name of the dimension represented in the Members tree whenthe Member Selection dialog is displayed.

ListCount property Returns the number of members selected from the last call toGenerateMemberList.

GetMemberList method Generates and returns a collection of members using the selection rules definedfor the dimension.

GenerateMemberList method Generates an internal list of members using the selection rules defined for thedimension.

EssTreeviewThe EssTreeview class encapsulates information and actions necessary to display Essbasemembers in a tree view control.


Table 7 Selected Properties and Methods of the EssTreeview class


EssConnection property Sets or returns the name of the associated EssConnection object used to connect toan Essbase database.

UseAliases property Sets or returns the flag that indicates if member names or Aliases are displayed in thetreeview.

PreFillDescendants property Sets or returns the flag that signifies if the descendants should be pre-filled in thetreeview.

56 Programming with Dialog Classes


AddMembers method Adds a list of members as root nodes to the treeview.

Add method Adds a member as a root node to the treeview. The PreFillDescendants andMaxGenExpandable properties determine the members represented in the treeview.

EssTreeview 57

58 Programming with Dialog Classes

6Application Builder for .NET

ASP.Net Components Reference

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Data Server Component .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Web Grid Adapters.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Web Metadata Adapters .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

TreeviewAdapter.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

This chapter explains theApplication Builder for .NET drag-and-drop controls: data servercomponent, Web grid adapter, and metadata adapters. It also defines the key properties andmethods within each of the controls.

OverviewApplication Builder for .NET uses the DataServer component to maintain the current state ofan application and performs all communication with an Essbase server. Web grid adapters andWeb metadata adapters contain metadata and data. The adapters synchronize their metadataand data with the Data Server and populate the associated control with the information.

To add the DataServer component, Web grid adapters, and Web metadata adapters to anapplication, add them to the Toolbox and double-click or drag-and-drop the component intothe component tray.

Data Server ComponentThe Data Server component for the Web (ASP.NET) is a central component in the developmentof .NET applications. It consists of all the .NET properties, such as the sign-on dialog, serverconnection, and so on.


Table 8 Key Properties and Methods of DataServer Component


Name Sets or returns the name of the data server component.

Overview 59


AutoConnect property Set to TRUE to connect if not currently connected.

ClearPasswordOnRun property Clears the password required to connect to the data server. By default, the flag isset to TRUE.

EssConnection property Sets or returns the essConnection object used by the current DataServer object toencapsulate connection information for Essbase Server databases and applicationscurrently being used.

EssDatapoint property Returns the EssDataPoint object defined.

EssOperations property Sets the Essbase operations, such as retrieving, zooming, pivoting, and updatingdata.

EssProperties property Sets or returns the essProperties object used by the current dataServer object tospecify properties for Essbase operations.

ID Sets or returns the ID for this DataServer object.

OlapMode property Sets to TRUE to connect to the Essbase Server in the OLAP mode.

ReportLocal property Sets to TRUE if local reporting is required; otherwise, FALSE.

ReportObject property Sets the reporting object.

ShowLoginForm property Sets to TRUE to display the login form; otherwise, FALSE.

Caller Set to the object making a request to the Data Server to execute an operation (e.g.Retrieve). By default this is set to the Data Server control itself. Should be used onlyby the controls attaching themselves to the Data Server.

OlapState property Sets the OLAP state.

KeepOnly method Performs a WebServices KeepOnly Operation on the active cell range in the Gridobject associated with this EssOperations object.

LockCells Locks the selected cells in the Essbase database.

Pivot Overloaded. Pivots data in the attached grid object from the Essbase Serverdatabase defined in the EssConnection object, based on properties defined in theEssProperties object and the currently active cell in the attached grid object.

RemoveOnly Performs a WebServices RemoveOnly Operation on the active cell range in the Gridobject associated with this EssOperations object.

Report Overloaded. Runs an Essbase report script represented in an EssReport object andplaces the results into a grid.

ReportFile Overloaded. Runs an Essbase report script represented in an EssReport object andplaces the results into a file.

Retrieve Overloaded. Retrieves data into the attached grid object from theEssbase databasedefined in the EssConnection object, based on properties defined in theEssProperties object.

RetrieveForState Performs a Retrieve for State operation (the internal grid is changed to match theOlap State).

60 Application Builder for .NET ASP.Net Components Reference


Update Overloaded. Performs a WebServices Update Operation to update the contents ofthe connected Essbase database with values corresponding to the contents of theGrid object associated with this EssOperations object.

ZoomIn Overloaded. Zooms in on data in the attached grid object from the Essbase Serverdatabase defined in the EssConnection object, based on properties defined in theEssProperties object.

ZoomOut Zooms out on data in the attached grid object from the Essbase database definedin the EssConnection object based, on properties defined in the EssProperties object.

Web Grid AdaptersThe Web grid adapters enables you to select the data server controls and exchange data fromdifferent data grid types and controls the information exchanged between them.

Grid Adapter GenericThe GridAdapterGeneric class is used to pass information between grids that have a data sourceproperty supporting a dataset.


Table 9 Key Properties and Methods of DropDownListAdapter


Name Sets or returns the name of the gird adapter component.

DataServer property Sets or returns the name of the Data Server control used by the current control.

InitializeGrid method Initialized to retrieve grid information into a dataset.

Grid Adapter OWC11The Office Web Components (OWC) 11 class is used to pass information between grids thathave a data source property supporting a dataset.


Table 10 Key Properties and Methods of OWC 11 Grid Adapter Component


InitializeSpreadSheet Initializes the internal DataGrid to hold the Metadata information.

ClientOWC11SpreadsheetName Gets or Sets the name of the client side OWC11 object. This name is used topopulate the spreadsheet with the retrieved data. Case sensitive and must bepreceded with the form name.

Web Grid Adapters 61


DataServer The Data Server control to which this adapter is attached.

UseStyles Sets or returns True if the grid control displays the font styles for linked objects,linked partitions, and Integration Server Drill-Through. Set the property to True touse font styles.

StyleFontLinkedURL Sets or returns the font assigned to grid cells that contain data that is linked to aURL. Set the ‘UseStyles’ to true as a Pre requisite.

Retrieve Performs a basic Retrieve Operation.

ZoomIn Performs a Zoom In Operation. Displays the Zoomed in data for the selectedDimension in the grid.

ZoomOut Performs a Zoom Out Operation. Displays the Zoomed out data for the selectedDimension in the grid.

KeepOnly Performs a KeepOnly Operation. Keeps the selected Dimensions and removes allthe others from the grid.

RemoveOnly Performs a RemoveOnly Operation. Removes only the selected dimensions fromthe grid.

LockCells Performs a LockCells operation on the current active cell range.

UnlockCells Performs an UnlockCells operation on the current active cell range.

Pivot Executes a Pivot Operation on the currently active cell. You use the pivot methodto change the orientation of data like Move a row group to a column group, Movea column group to a row group, Transpose the order of row groups and Transposethe order of column groups.

Update Performs an Update Operation. You can change the value in the grid cells andupdate them in the database.

AllowFlashback Returns a flag that indicates whether flashback to the previous state of the grid isenabled.

When set to true, the user can call the Flashback method of GridAdapterOWC11to go back to the previous state of the grid.

Web Metadata AdaptersThe Web metadata adapter components enables you to exchange metadata between Data Serversand the list.

Drop-Down List AdapterThe DropDownListAdapter class is used to access the Data Server controls using the drop-downlist. The DropDownListAdapter class encapsulates the information and actions used to add andremove Essbase members to or from a drop-down list.



Table 11 Key Properties and Methods of DropDownListAdapter


ControlToBind property Sets the ID of Control to Bind.


Dimension property Sets or returns the name of the database dimension.

DisplayMode property Sets or returns the type of members in the list.

EventEnabled property Set to TRUE if the SelectedIndexChanged event is handled by DropDownListAdapter;otherwise, FALSE.

Layout property Sets or returns the layout of the dimension described by the DimState object.

MaxItem property Sets or returns the maximum number of items to be displayed in the list.

Add method Adds a member to the member list collection.

Clear method Clears the data from the member list collection.

Contains method Determines whether the specified member is in the member list collection.

CopyTo Copies the elements of the collection to an array, starting at a particular array index.

IndexOf Returns the index of the member.

Insert Inserts a member into the collection at the specified index.

Remove Removes a member from the member list collection.

RemoveAt Removes the member at the specified index.

List Box AdapterThe ListBoxAdapter class is used to access the Data Server controls using the list box. TheListBoxAdapter class encapsulates the information and actions used to add and remove Essbasemembers to or from a list box.


Table 12 Key Properties and Methods of ListBoxAdapter




Button Button to be bound to the adapter to submit the page after the selection is made to the listbox.

Web Metadata Adapters 63



DisplayMode property Sets or returns the type of members in the list.

EventEnabled property Set to TRUE if the SelectedIndexChanged event is handled by ListBoxAdapter; otherwise,FALSE.

Layout property Sets or returns the layout of the dimension described by the DimState object.

MaxItem property Sets or returns the maximum number of items to be displayed in the list box.

Add method Adds a member to the list box collection.

Clear method Clears the data from the list box collection.

Contains method Determines whether the specified member is in the list box collection.

CopyTo Copies the elements of the collection to an array, starting at a particular array index.

IndexOf Returns the index of the member.

Insert Inserts a member into the collection at the specified index.

Remove Removes a member from the list box.

RemoveAt Removes the member at the specified index.

TreeviewAdapterThe TreeviewAdapter manages transfer of OLAP Data between the data server component anda standard Microsoft.Net Treeview control.

Table 13 Key Properties and Methods of TreeviewAdapter


Button Button to be bound to the Adapter to make the page submit after the selection is made in theTreeview.

ControlToBind Treeview to be bound to the Adapter.


Dimension The name of the dimension to which the control is tied to.

Displaymode Determines the type of members displayed in the Member Select dialog displayed from theProperty Page when the user clicks the Select Members button to select the members to bedisplayed in the control. (Design mode only.)

EventEnabled Enable or disable event handling for the attached control.

Layout Describes the position of the dimension in the grid as row, column, or page.



Layouts List of Layouts corresponding to the Dimensions.

OlapState The OlapState object representing the selected members. This OlapState object is sent to theDataServer control to specify the Essbase data to retrieve into the internal grid of the DataServercontrol.

SyncState Flag to make the Treeview's state to be in Sync with the Dataserver state.

TreeViewControl Treeview control which is attached to the Adapter.

TreeviewAdapter 65

7Application Builder for .NET

Windows Components Reference

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

ComboBoxAdapter .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

DataServer .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

GridAdapterOWC11 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

ListBoxAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

TreeViewAdapter .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

This chapter explains the Application Builder for .NET Windows controls: Combo Box adapter,Data Server, Grid Adapter OWC11, ListBox adapter and TreeView adapter. It also defines thekey properties and methods within each of the controls.

OverviewApplication Builder for .NET uses the DataServer component to maintain the current state ofan application and performs all communication with an Essbase server.

To add the DataServer component, Combo Box adapter, Grid Adapter OWC11, ListBox adapter,and TreeView adapter to an application, add them to the Toolbox and double-click or drag-and-drop the component into the component tray.

ComboBoxAdapterThe ComboBoxAdapter class encapsulates the informations and actions used to add and removeEssbase to or from a Combo Box.

Table 14 Key Properties and Methods of ComboBoxAdapter



Content Sets and returns the OlapState object representing the current content of the control.

Count Returns the Count of Members in the associated ListControl.

Overview 67



Dimension Sets or returns the name of the database dimension.

Displaymode Sets or returns the type of members in the list.

EventEnabled Enables or disables the event handling for the attached control.


OlapState Sets the OLAP state.

UpdateDataServerState Overloaded. Updates DataServer State for the selected Dimension.

DataServerThe DataServer component provides a middle-tier layer between application objects (buttons,listboxes, and so on) and Essbase. The DataServer component maintains an internal grid ofinstance data that is accessed by the application controls.

Table 15 Key Properties and Methods of DataServer


EssConnection Sets or returns the essConnection object used by the current essOperations object toencapsulate connection information for Essbase Server databases and applications currentlybeing used.

EssDatapoint Returns the EssDataPoint object defined.

EssOperations Sets the Essbase operations, such as retrieving, zooming, pivoting, and updating data.

EssProperties Sets or returns the essProperties object used by the current dataServer object to specifyproperties for Essbase operations.


ReportObject Sets the reporting object.

KeepOnly Performs a WebServices KeepOnly Operation on the active cell range in the Grid objectassociated with this EssOperations object.

LockCells Locks the selected cells in the Essbase Server database.

Pivot Overloaded. Pivots data in the attached grid object from the Essbase Server database definedin the EssConnection object, based on properties defined in the EssProperties object and thecurrently active cell in the attached grid object.

RemoveOnly Performs a WebServices RemoveOnly Operation on the active cell range in the Grid objectassociated with this EssOperations object.

Report Overloaded. Runs an Essbase report script represented in an EssReport object and places theresults into a grid.

68 Application Builder for .NET Windows Components Reference


ReportFile Overloaded. Runs an Essbase report script represented in an EssReport object and places theresults into a file.

Retrieve Overloaded. Retrieves data into the attached grid object from the Essbase Server databasedefined in the EssConnection object, based on properties defined in the EssProperties object.

RetrieveForState Performs a Retrieve for state operation (the internal grid is changed to match the Olap State).

UnlockCells Unlocks the selected cells in the Essbase Server database.

Update Overloaded. Performs a WebServices Update Operation to update the contents of theconnected Essbase Server database with values corresponding to the contents of the Gridobject associated with this EssOperations object.

ZoomIn Overloaded. Zooms in on data in the attached grid object from the Essbase Server databasedefined in the EssConnection object, based on properties defined in the EssProperties object..

ZoomOut Zooms out on data in the attached grid object from the Essbase Server database defined inthe EssConnection object based, on properties defined in the EssProperties object.

GridAdapterOWC11GridAdapterOWC11 control enables communication between Essbase-related functionalityand a Microsoft Office Web Components (OWC11) Spreadsheet.

Table 16 Key Properties and Methods of GridAdapterOWC11



InternalGrid Returns the InternalGrid for the active sheet.

Spreadsheet Sets or returns the Office Web Components 11.0 Spreadsheet object to be handled by thisGridOWC11 object. The Spreadsheet object reference can be obtained by callingAxSpreadsheet.GetOcx().

UseStyles Sets or returns True if the grid control displays the font styles for linked objects, linkedpartitions, and Integration Server Drill-Through. Set the property to True to use font styles.

ConditionalRetrieve Performs a Conditional Retrieve.

KeepOnly Performs a KeepOnly Operation. Keeps the selected Dimensions and removes all the othersfrom the grid.

LaunchDrillthrough Displays the EIS Drill-through report data in the grid.

LaunchLinkedPartition Displays Linked Partition data in the grid.

LockCells Performs a LockCells operation on the current active cell range.

GridAdapterOWC11 69


Pivot Executes a Pivot Operation on the currently active cell. You use the pivot method to changethe orientation of data like Move a row group to a column group, Move a column group to arow group, Transpose the order of row groups and Transpose the order of column groups.

RemoveOnly Performs a RemoveOnly Operation. Removes only the selected dimensions from the grid.

Retrieve Performs a basic Retrieve Operation

UnLockCells Performs an UnlockCells operation on the current active cell range.

Update Performs an Update Operation. You can change the value in the grid cells and update themin the database.

ZoomIn Performs a Zoom In Operation. Displays the Zoomed in data for the selected Dimension inthe grid.

ZoomOut Performs a Zoom Out Operation. Displays the Zoomed out data for the selected Dimensionin the grid.

AllowFlashback Returns a flag that indicates whether flashback to the previous state of the grid is enabled.

When set to true, the user can call the Flashback method of GridAdapterOWC11 to go backto the previous state of the grid.

ListBoxAdapterThe ListBoxAdapter class encapsulates the informations and actions used to add and removeEssbase to or from a ListBox.

Table 17 Key Properties and Methods of ListBoxAdapter


Button Button to be bound to the Adapter to make the page submit after the selection is made inthe ListBox

Content Sets or returns the OlapState object representing the current content of the control.




Displaymode property Sets or returns the type of members in the list.

EventEnabled property Enables or disables the event handling for the attached control.

Layout Sets or returns the layout of the dimension described by the DimState object.

OlapState property Sets the OLAP state.


TreeViewAdapterThe TreeviewAdapter class encapsulates the informations and actions used to add and removeEssbase to or from a Treeview.

Table 18 Key Properties and Methods of TreeViewAdapter


Button Button to be bound to the Adapter to make the page submit after the selection is made inthe Treeview


Count Returns the Count of Members in the associated ListControl.



Displaymode property Sets or returns the type of members in the list.

EventEnabled Enables or disables event handling for the attached control.



SyncState Flag to make the Treeview's state to be in Sync with the Dataserver state

TreeViewAdapter 71

AApplication Builder for .NET

APIs

In This Appendix

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

Hyperion.Objects.Essbase.Windows.Forms... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82

OverviewThis appendix provides information on the changes to the API in this release of ApplicationBuilder for .NET. There is information on the newly added, modified, and removed API’s andthe presentation of information is divided based on the namespaces. This appendix containsinformation on the new Windows components that are included in this release, it also documentschanges or additions made to the existing Windows components.

The APIs are organized on the basis of namespaces and under each namespace the affected Class(s)/Interface(s) are listed and under each Class/Interface the affected Properties/Methods arelisted. The Properties/Methods contain information on their accessibility and components thatgets affected with the change.

Note:

This appendix is a snapshot of changes to the APIs; for detailed information on the APIs affectedfor this release, see the online help.

Overview 73

Hyperion.Objects.Essbase.Common

Class Properties Methods

EssCube NonUniqueMemberSupport

● New property

● This property enables you to ascertain whether the cube supports non unique membernames or not. This method returns value as true if the cube supports non unique membernames

● Accessibility : Public

● Affected Components : All

None


EssDomain Domain

● Modified property

● This property is now accessible in the property window at the design time



None

APSServer


● This property is renamed, the former name was EDSServer. This property is nowaccessible in the property window at the design time



encPassword

● New property

● This property enables you to set or return the encrypted password information to theData Server



Pwd

● New property

● This property enables you to set or return the masked (*) password for the server



Port


● This property is now accessible in the property window at design time



74 Application Builder for .NET APIs


EssMember UniqueName

● New property

● This property enables you to set/return an unique name, that is, fully qualified nameof the member


● Affected Components : None

None

Interface Properties Methods

ITransport None SendAndReturnRequest

● Modified method

● This method enables you to provide additional parameter HTTPSConfigPath of typestring



Hyperion.Objects.Essbase.Common.Grid


GridBase InternalGridCache

● New property

● This property enables you to set/return the cached Internal Grid object reference member


● Affected Components : GridWindowsDataGrid, GridWebDataGrid

None

FlashbackStatus

● New property

● This property enables you to confirm that the flashback occurs only once. If it is set tofalse, then the flashback is allowed

● Accessibility : Protected

● Affected Components : None

Interface

None

Hyperion.Objects.Essbase.Common.Grid 75

Hyperion.Objects.Essbase.Common.Transports


HttpTransporter None SendAndReturnRequest

● Modified method

● This method enables you to provide the additional parameter HTTPSConfigPathof type string



Interface

None

Hyperion.Objects.Essbase.Common.Grid.OWC11


GridOWC11 InternalGrid


● This method enables you to provide anadditional setter


● Affected Components : gridAdapterOWC11(both Windows and Web)

Flashback

● New method

● This method enables you to restore theprevious state of the OWC11 grid. The cachedgrid is assigned back to the Internal Grid andthe OWC11 grid is redrawn



StyleFontDefault

● Removed property


IsNumeric

● New method


● Affected Components: None

Interface

None


Hyperion.Objects.Essbase.Components.Design

Class Properties Methods Verbs

DataServerBaseDesigner None None HTTPSConfig

● New verb

● This verb item is included in the Verbs Collection

● Affected Components: DataServer (both Windows andWeb)

Interface

None

Hyperion.Objects.Essbase.Components.Metadata


GridAdapterOWC11Base GridOWC11

● New property

● This method enables you to return information of the GridOWC11member of the class



None

AllowFlashback

● New property

● This method enables you to set or return a flag that indicates whetherflashback to the previous state of the grid is allowed


● Affected Components: GridAdapterOWC11 (both Windows and Web)

StyleFontDefault



StyleFontDefaultColor



Class

GridAdapterWindowsOWC11Base

Hyperion.Objects.Essbase.Components.Design 77

Class

● New class

● Accessibility: Public

● Affected Components: GridAdapterOWC11 (Windows)


ListControlAdapterBase ListControlWindows

● New property

● This property enables you to set/return the associated Windows ListControl to the adapter



None

ListItems

● New property

● This property is used to load the client control (Combo box/List box)elements



ListItemValues

● New property

● This property enables you to retain the values of the list elements, in caseof Windows controls


● Affected Components: ListBoxAdapter (both Windows and Web)

Class

MSTreeViewAdapterBase

● New class

● This abstract class acts as the base class for the Tree view adapter. This class will enable data binding to theassociated Microsoft Tree view control for Web


● Affected Components: TreeViewAdapter (Web)

Class

TreeViewAdapterBase

● New class

● This abstract class acts as the base class for the Tree view adapter. This class will enable data binding to theassociated Tree view control for Windows


● Affected Components : TreeViewAdapter (Windows)


Interface

None

Hyperion.Objects.Essbase.Components.Web.Design

Class

TreeviewAdapterDesigner

● New class

● This designer class is included for the Tree view Adapter component


● Affected Components : TreeViewAdapter (Windows and Web)

Interface

None

Hyperion.Objects.Essbase.Components.Web


DropDownListAdapter ListItemscollection

● New property

● This property enables you to set the list items for the adapter


● Affected Components: DropDownListAdapter (Web)

None


GridAdapterOWC11 None Flashback

● New method

● This method enables you to restore the previous state of the OWC11 grid


● Affected Components: GridAdapterOWC11 (Web)


ListBoxAdapter ListItemscollection

● New property

● This property enables you to set the list items for the adapter

None

Hyperion.Objects.Essbase.Components.Web.Design 79



● Affected Components: ListBoxAdapter (Web)

Class

TreeViewAdapter

● New class

● This class encapsulates the information and actions used to add and remove Essbase to or from a Tree view


● Affected Components: TreeViewAdapter (Web)

Interface

None

Hyperion.Objects.Essbase.Components.Windows.Design

Class

ComboBoxDesigner

● New class

● This designer class is included for the Combo Box Adapter component


● Affected Components: ComboBoxAdapter (Windows)

Class

ListBoxAdapterDesigner

● New class

● This designer class is included for the List Box Adapter component


● Affected Components : ListBoxAdapter (Windows)

Class

DataServerDesigner

● New class

● This designer class is included for the Data Server Base component


● Affected Components : DataServer (Windows)


Class

TreeviewAdapterDesigner

● New class

● This designer class is included for the Tree view Adapter component


● Affected Components: TreeViewAdapter (Windows)

Interface

None

Hyperion.Objects.Essbase.Components.Windows

Class

ComboBoxAdapter

● New class

● This class encapsulates the information and actions used to add and removeEssbase to or from a Combo Box


● Affected Components: ComboBoxAdapter (Windows)

Class

DataServer

● New class

● This class provides a middle-tier layer between application objects (buttons, list boxes, and so on) and Essbase


● Affected Components : DataServer (Windows)

Class

EssResourceManager

● New class

● This class manages string resources for localization

● Accessibility : Internal


Class

GridAdapterOWC11

● New class

Hyperion.Objects.Essbase.Components.Windows 81

Class

● This class enables communication between Essbase-related functionality and a Microsoft Office (OWC11)Spreadsheet


● Affected Components: GridAdapterOWC11 (Windows)

Class

ListBoxAdapter

● New class

● This class encapsulates the information and actions used to add and remove Essbase to or from a List Box


● Affected Components: ListBoxAdapter (Windows)

Class

TreeViewAdapter

● New class

● This class encapsulates the information and actions used to add and remove Essbase to or from a Tree view


● Affected Components: TreeViewAdapter (Windows)

Interface

None

Hyperion.Objects.Essbase.Windows.Forms


frmFindMember ShowAttributeDimensions

● New property

● This property sets/returns the flag that indicates whether the attribute dimensionsmust be used for search or not


● Affected Components: TreeViewAdapter (Windows and Web), ListBoxAdapter(Windows and Web), ComboBoxAdapter (Windows), and DropDownListAdapter(Web)

None

Class

frmTreeviewMemberSelection


Class

● New class

● This class represents the Member Selection dialog encapsulated by the TreeviewMemberSelectionDialog class

● Accessibility: Internal

● Affected Components: TreeViewAdapter (Windows and Web)


LinkRules UniqueName

● New property

● This property returns/sets the Unique name of the member for which the link rules aredefined


● Affected Components: TreeViewAdapter (Windows and Web), ListBoxAdapter (Windowsand Web), ComboBoxAdapter (Windows), and DropDownListAdapter (Web)

None


MemberSelectionDialog None GetMemberList

● New overload Method


● Affected Components: TreeViewAdapter (Windows and Web),ListBoxAdapter (Windows and Web), ComboBoxAdapter (Windows),and DropDownListAdapter (Web)


RuleLine UniqueName

● New property


● Affected Components: TreeViewAdapter (Windows and Web), ListBoxAdapter (Windowsand Web), ComboBoxAdapter (Windows), and DropDownListAdapter (Web)

None

Class

TreeviewMemberSelectionDialog

● Newly added class which encapsulates information and actions for displaying the Member Selection dialog


● Affected Components: TreeViewAdapter (Windows and Web)

Interface

None

Hyperion.Objects.Essbase.Windows.Forms 83

BMigrating Application Builder

for .NET Applications

In This Appendix

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

OverviewThis appendix provides information on migrating an application that utilizes the ApplicationBuilder for .NET Release 9.2 components to use the Application Builder for .NET Release11.1.1.0 components. The steps provided here are applicable for both Windows and Webapplications; where as the illustrations are provided for the Web application only.

Comparing the Components of Application Builder for .NETRelease 9.2 with Application Builder for .NET Release 11.1.1.0

When compared with the 9.2 release of Application Builder for .NET components, the 11.1.1.0release of Application Builder for .NET components have many additions in terms of newcomponents such as Combo Box Adapter, List Box Adapter, and so on for Windows applicationand the enhancement for the existing components like HTTPS support, Non Unique Membersupport, and so on. For information on changes made to the components, see Appendix A,“Application Builder for .NET APIs”.

In comparison with 9.2, the 11.1.1.0 components are included in a different folder hierarchy.When installed, the. Application Builder for .NET release 9.2 components are installed in thefolder %HYPERION_HOME%/habnet/bin, see Figure 3.

Overview 85

Figure 3 Folder structure of Application Builder for .NET 9.2 Components

In the 11.1.1.0 release of Application Builder for .NET, the components are installed in thefollowing location: %HYPERION_HOME%\products\Essbase\habnet\Client\bin seeFigure 4.

Figure 4 Folder structure of Application Builder for .NET 11.1.1.0 components

86 Migrating Application Builder for .NET Applications

Apart from the changes in the folder structure, the access to Application Builder for .NET fromthe start menu is changed.

For the 9.2 release, the Application Builder for .NET Server service can be found under Start >Programs > Hyperion System 9 BI+ > Application Builder.NET, see figure.

Figure 5 Startup tree for Application Builder for .NET 9.2 server service

For the 11.1.1.0 release, the Application Builder for .NET Server service can be found under Start> Programs > Oracle EPM System > Essbase > Habnet see figure.

Figure 6 Startup tree for Application Builder for .NET 11.1.1.0 server service

Comparing the Components of Application Builder for .NET Release 9.2 with Application Builder for .NET Release 11.1.1.0 87

Migrating to Application Builder for .NET Release 11.1.1Using the Application Builder for .NET components, applications can be built either by draggingand dropping the required components at the design time and configuring them or creating theobjects of required components and using them at the runtime. The following sections provideinformation on the migration options.

Drag-Drop OptionThis section provides information on using the drag-drag approach to migrate ApplicationBuilder for .NET Release 9.2 applications to release 11.1.1. This migration will enableapplications to utilize the Application Builder for .NET release 11.1.1 components.

To migrate, open the 9.2 applications in the dot NET IDE after installing the 11.1.1 release ofApplication Builder for .NET. A design design time error appears.

Figure 7 Application using 9.2 Application Builder for .NET components


Figure 8 Design time error for Application Builder for .NET 9.2 application after 11.1.1.0 upgrade

The design time error shown in the preceding figure is due to the change in the folder structurein the 11.1.1.0 release of Application Builder for .NET. To correct this error, for the componentsthat contain this error, reference path to the correct location, as shown in the following figure.However, To point to a new location, open the Project Properties and change the reference pathto point to 11.1.1.0 release of Application Builder for .NET components as in Figure 10,Figure 11, and Figure 12 respectively.

Figure 9 Missed out components

Migrating to Application Builder for .NET Release 11.1.1 89

Figure 10 Changing the reference path

Figure 11 Changing the reference path (continued...)


Figure 12 Changing the reference path (continued...)

After you complete the preceding steps, if the components in the components tray are not visible,then close and re-open the dot NET IDE. After re-opening the application, make sure that thecomponents are visible in the components tray. Configure and populate the components, seeFigure 13.

Figure 13 Reconfigure the components

After compiling, the application is now ready to run components of the 11.1.1.0 release ofApplication Builder for .NET.

Migrating to Application Builder for .NET Release 11.1.1 91

Run timeYou can build applications that use the Application Builder for .NET component objects createdat runtime. You can migrate such applications to use the Application Builder for .NET Release11.1.1 components. Before migrating run-time applications, see Appendix A, “ApplicationBuilder for .NET APIs”.

To migrate runtime applications, point reference paths to the new location of ApplicationBuilder for .NET Release 11.1.1 components, see “Drag-Drop Option” on page 88. After pointingto the new reference path, compiling the application may output compilation errors dependingon modifications done to the the included classes' properties and methods.

The following figure displays an example of a compilation error.

Figure 14 Compilation error

To correct the preceding compilation error, change name of the property EDSServer toAPSServer. For more information on the list of changes, see Appendix A, “Application Builderfor .NET APIs”.


CPerformance Tuning

In This Appendix

Performance Tuning to Retrieve Records ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

Performance Tuning to Retrieve RecordsFollowing table lists the performance tuning settings to be done on System Memory andApplication Memory for Application Builder for .NET Client, Application Builder for .NETServlet, Provider Services, and Essbase to increase the number of records retrieved in Web andWindows applications:

Table 19 Performance Tuning Settings

Server/Application

ApplicationBuilderfor .NETClient

ApplicationBuilderfor .NETServlet

ProviderServices

OracleEssbase

Description

No ofRecords

SystemMemory

Database:EntBUD•Budsum

1GB

ApplicationMemory Setting

Default 812M Default Default

74201 No Error No Error No Error No Error NA

84801 Error No Error No Error No Error ApplicationBuilder for .NETapplicationbrowser showsan error “serverunavailable”

The followingerror is shown inthe Event Viewer“aspnet_wp.exe (PID: 6420)was recycledbecausememory

Performance Tuning to Retrieve Records 93

Server/Application

ApplicationBuilderfor .NETClient

ApplicationBuilderfor .NETServlet

ProviderServices

OracleEssbase

Description

consumptionexceeded the613 MB (60percent ofavailableRAM).”

90101 No Error No Error Error No Error Oracle HyperionProviderServices throwsan error“Unable toperform cubeview operation-out of memory”back toApplicationBuilder for .NETServlet and toApplicationBuilder for .NETClient

Database :EntBUD•Budsum

2GB


Default 1200M 1024M


151051 Error No Error No Error No Error ApplicationBuilder for .NETfails, throws anerror“System.OutOfMemory”

Database :EntBUD•Budsum

2GB


Default 1200M 1024M


120456 Error No Error No Error No Error Oracle'sHyperion®ApplicationBuilder for .NETfails, throws anerror“System.OutOfMemory”

94 Performance Tuning

Index

Aaliases, 56Application property, 53APSServer property, 54ASP.NET

creating a basic application, 13, 31

BBase classes

EssConnection, 53EssDomain, 53EssOperations, 52EssProperties, 54Overview, 51

CConnect method, 53Connected method, 53CubeViewName property, 53

DDatabase property, 53Dialog boxes, creating

member selection, 56sign-on, 55

Domain property, 54

EEncryptedLogin property, 54EssApplication property, 53Essbase

KeepOnly operation, 52Pivot operation, 53Retrieve operation, 53ZoomIn operation, 53

EssConnection class

Application property, 53Connect method, 53Connected method, 53CubeViewName property, 53Database property, 53EssApplication property, 53EssDomain property, 53OLAPServer property, 53

EssConnection property, 55, 56EssDomain class

APSServer property, 54Domain property, 54EncryptedLogin property, 54Password property, 54SignOn method, 54Username property, 54

EssDomain property, 53EssOperations class

about, 52EssConnection property, 52EssProperties property, 52EssReports property, 52Grid property, 52KeepOnly method, 52Pivot method, 53Retrieve method, 53ZoomIn method, 53

EssTreeview classAdd method, 57AddMembers method, 57EssConnection property, 56overview, 56PreFillDescendants property, 56UseAliases property, 56

FForms

A B C D E F H K M O P R S U W Z

Index 95

creating a Web grid form, 14, 32

HHyperion.Objects.Essbase.Windows.Forms assembly,

56

KKeepOnly operation, 52

Mmembers, 57MemberSelectionDialog class

AllowChangeDimension property, 56AllowLevelNames property, 56DefaultDimension property, 56GenerateMemberList method, 56GetMemberList method, 56ListCount property, 56MaxGenExpandable property, 56overview, 56

OOLAPServer property, 53

PPassword property, 54Pivot operation, 53

RRetrieve operation, 53

SSignOn method, 54SignOnDialog class

EssConnection property, 55ShowDialog method, 55ShowSelectCubeDialog property, 55

UUsername property, 54

WWeb form, creating, 14, 32

ZZoomIn operation, 53

A B C D E F H K M O P R S U W Z

96 Index

HYPERION® APPLICATION BUILDER FOR - Oracle · Application Builder for .NET Developer ... Install...

Documents

Transcript of HYPERION® APPLICATION BUILDER FOR - Oracle · Application Builder for .NET Developer ... Install...