Você está na página 1de 96

HYPERION ESSBASE SYSTEM 9

RELEASE 9.2.1.0.0

INSTALLATION GUIDE FOR WINDOWS

Hyperion Essbase System 9 Release 9.2.1 Installation Guide for Windows


Copyright 1996, 2009, Oracle and/or its affiliates. All rights reserved.
Authors: Essbase writing team
The Programs (which include both the software and documentation) contain proprietary information; they are provided
under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and
other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs,
except to the extent required to obtain interoperability with other independently created software or as specified by law, is
prohibited.
The information contained in this document is subject to change without notice. If you find any problems in the
documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be
expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the
United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to
U.S. Government customers are commercial computer software or commercial technical data pursuant to the
applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to
the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional
rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500
Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous
applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other
measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability
for any damages caused by such use of the Programs.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their
respective owners.
The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is
not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with
the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly
between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b)
fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty
obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you
may incur from dealing with any third party.

Contents

CHAPTER 1 Installation Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7


Essbase Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Spreashsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Application Programming Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
License Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
CHAPTER 2 Essbase Installation Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Essbase Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
CHAPTER 3 Planning the Essbase Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Essbase Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
32-Bit and 64-Bit Client and Server Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Port Numbers Used by Hyperion Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Default Port Numbers for Remote Method Invocation (RMI) Servers . . . . . . . . . . . . . . . . . . . 26
Essbase Deployment Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Essbase SQL Interface Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
32-bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
64-bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Integration Services Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ODBC Drivers and Relational Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
JDBC DriversOracle and Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Hybrid Analysis, Advanced Relational Access, and Drill-through Requirements . . . . . . . . . . 31
HYPERION_HOME Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Value Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Management of ESSLANG Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
About the Security File and ESSLANG Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Contents

iii

Disk Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Troubleshooting Connection Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CHAPTER 4 Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Before Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
About Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Running Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Directory Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37
38
38
39

Understanding Installation Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Protocol Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39
40
41
42

Running Silent Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42


Changing the Hyperion Home Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Installing Additional Instances of Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
CHAPTER 5 Configuring and Setting Up Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Hyperion Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Task Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring Product Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Launching the Hyperion Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Registering Products with Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deregistering Products with Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuration Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Updating the Environment Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Starting Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Starting Essbase Server Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Automating Essbase Server Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Automating Application or Database Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Starting Essbase Server from Administration Services Console . . . . . . . . . . . . . . . . . . . . . . . . 52
Running Essbase Server as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing Essbase Server as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting System Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Verifying Essbase Server Is Running as a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Stopping the Essbase Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Removing the Essbase Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

iv

Contents

53
53
53
53
54
54

Setting JVMMODULELOCATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Installing Essbase Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Verifying Startup Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Starting Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Verifying Successful Startup of Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using Essbase Server Agent Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Shutting Down Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
CHAPTER 6 Installing Essbase Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Installing Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Installing the 32-bit Runtime Client on a 64-bit Windows Platform . . . . . . . . . . . . . . . . . 62
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Installing Application Programming Interface (API) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
API Compatibility on 32-Bit and 64-Bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Installing Essbase Spreashsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
(Optional) Registering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
(Optional) Installing the Essbase Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
CHAPTER 7 Setting Up the Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
About Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Loading Sample Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Providing User Access to Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Preparing the Aggregate Storage Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Preparing the Partitioning Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Creating the Partition User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Changing Embedded User Names in Sample Partition Definitions . . . . . . . . . . . . . . . . . . 74
CHAPTER 8 Configuring Essbase for Relational Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Before Configuring Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting Up Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting Up Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Additional Essbase SQL Interface Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Contents

Additional Hybrid Analysis Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77


CHAPTER 9 Uninstalling Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CHAPTER 10 Upgrading Essbase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Upgrade Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Upgrading Essbase to Release 9.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Migration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input/Output Defaults and Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading Databases to Release 9.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

81
81
84
85

Moving Applications and Databases Between Computers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87


Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

vi

Contents

Chapter

Installation Overview

1
This chapter introduces you to Oracles Hyperion Essbase System 9.

In This Chapter

Essbase Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Installation Overview

Essbase Introduction
Essbase provides companies with the ability to deliver critical business information to the right
people at the right time. With Essbase, companies can leverage and integrate data from
multiple existing data sources and distribute filtered information to end-user communities.
Users interact and intuitively explore data in real-time and along familiar business dimensions,
enabling them to perform speed-of-thought analytics.

Essbase Components
Essbase includes these components:

Essbase Server

Sample applications

Runtime Client

Essbase Spreashsheet Add-in for Excel

Application Programming Interface (API)

Essbase Server
Essbase Server is a database for storing data with multiple dimensions such as time, accounts,
regions, channel, or product. It manages analytical data models, data storage, calculations, and
data security.
Essbase Server offers two storage models:

Aggregate storage databasesFor large-scale, sparsely distributed data that is categorized


into many, potentially large dimensions

Block storage databasesFor applications that perform interactive planning, allocations,


and sophisticated analytics, such as sales forecast applications or profitability analysis
applications

Sample Applications
Essbase Server includes sample applications and databases that demonstrate Essbase features.
See Chapter 7, Setting Up the Sample Applications.

Runtime Client
The Runtime Client is the minimal set of program files needed to communicate with a remote
Essbase Server using either a local custom Essbase application or MaxL.

Installation Overview

Essbase Spreashsheet Add-in for Excel


Spreadsheet Add-in integrates with Microsoft Excel. After Essbase is installed, a special menu is
added to the spreadsheet application. The menu provides enhanced commands such as
Connect, Pivot, Drill-down, and Calculate. Users can access and analyze data on Essbase Server
by using simple mouse clicks and drag-and-drop operations. Spreadsheet Add-in enables
multiple users to access and update data on Essbase Server simultaneously.

Application Programming Interface


Essbase API is an application programming interface that enables developers to build custom
Essbase applications using programs such as Visual Basic, C and C++. Essbase API is an
interface between custom client applications and Essbase Server that manages the transfer of
data between client and server over the network.
When a custom Essbase application makes calls to functions within the API, data is returned
from Essbase Server to the application. Essbase API contains the same routines that Essbase
uses internally. The Essbase API Reference provides a complete listing of API functions,
platforms, and supported compilers.

License Compliance
Beginning with this release, Hyperion License Server and standalone license files are not
used for license management. Instead, administrators need to audit product use. To ensure
compliance with your license agreement, you need to edit a properties file to activate or
deactivate features in accordance with what you have purchased.
For more information about license compliance, see the Hyperion License Compliance Readme
(hyp_license_compliance_readme_921.pdf ), which you can find on the Oracle
E-Delivery site.

License Compliance

10

Installation Overview

Essbase Installation Sequence

2
This chapter provides information about installing, configuring, and setting up Essbase:

High-level task flow that identifies basic steps

Installation checklist to guide you through each step in the installation and configuration
process

Step

Instruction

Product Component

Documentation

Install Oracles Hyperion Shared Services


and configure the Shared Services
application server and RDBMS.

Shared Services installer

Hyperion Shared Services Installation


Guide

Configure Shared Services to authenticate


user names that are stored externally in
LDAP, Active Directory, or Windows NT LAN
Manager, enabling single sign-on.

Shared Services External


Authentication Configuration Console

Hyperion Shared Services Installation


Guide

Install Hyperion products.

Hyperion product installers

Product installation guides

Activate and configure Hyperion products


and register them with Shared Services.
You can configure multiple products at
one time, if they are installed on the same
computer.

Hyperion Configuration Utility

Product installation guides

Create projects, add applications to


projects, and provision users for
applications.

Shared Services User Management


Console

Hyperion System 9 Shared Services


User Management Guide

Hyperion Configuration Utility

Essbase Installation Checklist


This checklist contains the detailed steps required for a successful installation of the Essbase
product components:

Essbase (Essbase Server and clients)

Oracles Essbase Administration Services

Oracles Essbase Integration Services

Oracles Hyperion System 9 BI+ Analytic High Availability Services

Essbase Installation Sequence

11

Oracles Hyperion System 9 BI+ Analytic Services Smart View Provider (and Oracles
Hyperion Smart View for Office client)

Note: Smart View Provider does not automatically install the Smart View client, but places SmartView.exe in the
SUP_HOME/redist directory.

This checklist and Chapter 3, Planning the Essbase Installation cover all Essbase product
components. The other chapters in this guide provide installation information specifically for
Essbase (Essbase Server and clients). For installation information for each component, see each
product installation guide. Page numbers in this checklist refer to the Hyperion Essbase
System 9 Installation Guide (this guide), unless otherwise noted.
Before you begin the installation process, ensure the hardware and software system
requirements described in Chapter 3, Planning the Essbase Installation are met.

Install Shared Services and Configure the Shared Services Application Server
and RDBMS

Reference

1. Ensure that the database you are using for Shared Services is installed and
operational before installing Shared Services.

Hyperion Shared Services Installation


Guide

2. Download the Shared Services media pack, which contains software and
documentation, from the Oracle E-Delivery site.
3. Install Shared Services and configure the Shared Services Application server and
RDBMS.
Note: These steps do not apply if you are using Essbase in native security mode and are
not using external authentication.

Configure the Shared Services External Authentication Provider

Reference

1. Ensure that Shared Services server is running.

Hyperion Shared Services Installation


Guide

2. Using Shared Services, configure a supported External Authentication Provider.


Shared Services writes your configuration information to a central XML-based
security configuration file that is generated by Shared Services. Essbase
references the security configuration file for single sign-on of external and remote
users.
3. Set up the environment and user rights for NT LAN Manager support.
4. (Optional) Configure Shared Services to use Single Socket Layers (SSL), and
install the Oracles Hyperion Remote Authentication Module.
Note: These steps do not apply if you are using Essbase in native security mode and are
not using external authentication.

12

Essbase Installation Sequence

Install Essbase

Reference

Step 1. Prepare to install Essbase


Download Essbase components from the Oracle E-Delivery site. Essbase includes the
following components:

Essbase

Administration Services

Integration Services

Analytic High Availability Services

Smart View Provider and Smart View client

Print and review the readme and installation documentation before installing
products.

Readme for:

Essbase

Administration Services

Integration Services

Analytic High Availability Services

Smart View Provider

Smart View client

Installation Guides:

Hyperion Essbase System 9


Installation Guide

Essbase Administration Services


Installation Guide

Essbase Integration Services


Installation Guide

Analytic High Availability Services


Installation and Administration
Guide

Analytic Services Smart View


Provider Installation and
Administration Guide

Step 2. Install Essbase components


Install Essbase components:

Readme for:

Essbase

Essbase

Administration Services

Administration Services

Integration Services

Integration Services

Analytic High Availability Services

Analytic High Availability Services

Smart View Provider and Smart View client

Smart View Provider

Smart View client

Common components shared by Hyperion products are installed in the


Hyperion_Home\Common directory.

Installation Guides:

Hyperion Essbase System 9


Installation Guide

Essbase Administration Services


Installation Guide

Essbase Integration Services


Installation Guide

Analytic High Availability Services


Installation and Administration
Guide

Analytic Services Smart View


Provider Installation and
Administration Guide

Essbase Installation Checklist

13

Configuration Tasks

Reference

Activate and configure Essbase components and register with Shared Services using
the Hyperion Configuration Utility.

Each installation guide for a Essbase


component contains configuration
information.

Specify the Shared Services server location

Configure relational databases and repositories (if applicable)

Auto-deploy products to application servers (if applicable)

Note: For Administration Services and Integration Services, Shared Services Server and
Essbase Server must be running to perform this step. For Analytic High Availability
Services and Smart View Provider, only Shared Services needs to be running.

Additional Configuration Tasks

Perform additional configuration tasks for Essbase and Administration Services,


such as configuring Essbase for relational integration.

No additional tasks are required for Analytic High Availability Services, Integration
Services, or Smart View Provider.

Hyperion Essbase System 9


Installation Guide, Chapter 5,
Configuring and Setting Up
Essbase

Essbase Administration Services


Installation Guide

Essbase Integration Services


Installation Guide

Analytic High Availability Services


Installation and Administration
Guide

Analytic Services Smart View


Provider Installation and
Administration Guide

Reference

For Essbase, see the Hyperion


Essbase System 9 Installation
Guide, Chapter 5, Configuring
and Setting Up Essbase

For Administration Services, see


the Essbase Administration
Services Installation Guide.

Assign Roles for Shared Services User Management and Provision Users

Reference

After migrating users to Shared Services, a Shared Services administrator must


perform the following tasks:

Hyperion System 9 Shared Services


User Management Guide

Assign the Project Manager role to users who are responsible for creating projects
and assigning applications to projects.

For each application, assign the Provisioning Manger role to users who are
responsible for assigning roles and access control permissions to users of the
application.

Assign the Directory Manager role to users who are responsible for managing the
native Shared Services directory.

Project Managers can now create projects and add applications to projects as
necessary. Provisioning Managers for each application can now provision users and
groups (assign roles and access control permissions) for their applications.

14

Essbase Installation Sequence

Chapter*

Planning the Essbase Installation

3
Read this chapter for information on planning the installation of Essbase products and
components on supported platforms.

In This Chapter

Essbase Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
32-Bit and 64-Bit Client and Server Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Port Numbers Used by Hyperion Products. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Default Port Numbers for Remote Method Invocation (RMI) Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Essbase Deployment Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Essbase SQL Interface Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Integration Services Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Hybrid Analysis, Advanced Relational Access, and Drill-through Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
HYPERION_HOME Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Disk Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Troubleshooting Connection Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Planning the Essbase Installation

15

Essbase Requirements
Essbase consists of five separate components:

EssbaseIncludes Essbase Server and Essbase client components (Runtime Client,


Spreadsheet Add-in, and Application Programming Interface)

Administration ServicesIncludes Administration Services Server and Administration


Services Console

Integration Services

Analytic High Availability Services

Smart View Provider and Smart View client

Essbase components may have different requirements. For example, Administration Services
requires deployment of an application server; Essbase does not.
This section describes hardware and software requirements for Essbase, and requirements for a
representative deployment of up to 150 total users (30-40 concurrent users) and one Essbase
Server installation. For larger deployments, we highly recommend that you call Hyperion
Consulting Services to determine the appropriate number of servers for your environment.
Note: Estimated disk space and RAM requirements in this document are approximate. Actual requirements may be
higher. Disk space estimates include documentation files (if applicable) and Hyperion common components.
Documentation is installed automatically with some products. The installation program calculates the amount of
required disk space, based on your installation choices.

Hardware Requirements
Table 1

Essbase Hardware RequirementsMicrosoft Windows

Essbase (Essbase Server)


Disk space
RAM

260 MB Essbase Server and sample applications


32-bit Essbase:

256 MB

64-bit Essbase:

1 GB

Note: The base recommendation for running Essbase Server and its sample applications is approximately
100 MB. Start with this amount and then allocate additional memory to accommodate the Essbase Server
applications. 64-bit Essbase benefits from increased addressability. Typically, 64-bit servers are
configured with a modest amount of RAM. Production servers, however, typically are configured with 4 GB
or higher.

Processor

32-bit Essbase:

Pentium or equivalent, or higher

64-bit Essbase:

Network protocol

16

Planning the Essbase Installation

on Itanium 2

TCP/IP

Table 1

Essbase Hardware RequirementsMicrosoft Windows (Continued)

Essbase clients (Runtime Client, Spreadsheet Add-in, and Application Programming Interface)
Disk space

Runtime Client:

20 MB

Spreadsheet Add-in:

20 MB

Application Programming Interface:

RAM

20 MB

Spreadsheet Add-in:

64 MB

Application Programming Interface:

128 MB (256 MB or higher recommended)

Processor

Same as Essbase.

Network protocol

TCP/IP

Display

Minimum resolution 800 x 600 (1024 x 768 or more recommended)

Administration Services (Administration Services Server)


Disk space

32-bit and 64-bit Windows:

400 MB minimum

Note: This estimate includes documentation files and Hyperion common components. The installation
program calculates the amount of required disk space, based on your installation choices. Allow extra disk
space for data files and outline files that are copied to Administration Services Server during data loads
and outline editing, respectively.

RAM

See the Essbase Administration Services Installation Guide.

Processor

Same as Essbase.

Network protocol

HTTP, HTTPS

Administration Services client (Administration Services Console)


Disk space

150 MB minimum

This estimate includes documentation files and Hyperion common components. The installation
program calculates the amount of required disk space, based on your installation choices.

RAM

See the Essbase Administration Services Installation Guide.

Processor

Same as Essbase

Network protocol

HTTP, HTTPS

Screen resolution

1024 x 768

Essbase Requirements

17

Table 1

Essbase Hardware RequirementsMicrosoft Windows (Continued)

Integration Services (Integration Server)


Disk space

25 MB Integration Server, Integration Services Shell, and common files


OLAP Metadata Catalog:

1 MB (as shipped)

30 MB On the RDBMS server computer containing the catalog database

Sample applications (on the RDBMS server computer containing the sample application database):

20 MB Before Hybrid Analysis or Unicode data is loaded

40 MB After Hybrid Analysis data is loaded

70 MB After Hybrid Analysis and Unicode data is loaded

Java and Jar files:


30 MB

105 MB When set up, without Hybrid Analysis or Unicode sample application

125 MB After Hybrid Analysis sample data is loaded

155 MB After Hybrid Analysis and Unicode sample data is loaded

Optional items:

4 MB Integration Services PDF documentation

11 MB DataDirect ODBC drivers and PDF documentation

Total disk space with optional items:

RAM

120 MB When set up, without Hybrid Analysis or Unicode sample application

140 MB After Hybrid Analysis sample data is loaded

170 MB After Hybrid Analysis and Unicode sample data is loaded

64 MB or higher

Member load memory requirements formula: 10 MB + (700 Bytes x number of members)

Processor

Pentium or equivalent, or higher

Network Protocol

TCP/IP

Integration Services client


Disk space

20 MB Integration Services Console and common files

22 MB Java and Jar files

Optional item:

4 MB Integration Services PDF documentation

Total disk space with optional item:

46 MB

Processor

Pentium or equivalent, or higher

RAM

Integration Services Console:

64 MB or higher

Spreadsheet Add-in:

Network protocol

18

Planning the Essbase Installation

16 MB

TCP/IP

Table 1

Essbase Hardware RequirementsMicrosoft Windows (Continued)

Analytic High Availability Services


Disk space

148 MB

RAM

128 MB

Processor

32-bit Analytic High Availability Services:

Pentium or equivalent, or higher

64-bit Analytic High Availability Services:

Network protocol

On Itanium 2

TCP/IP, HTTP, HTTPS

Smart View Provider


Disk space

32-bit Smart View Provider:

188 MB

64-bit Smart View Provider:

330 MB

RAM

128 MB

Processor

32-bit Smart View Provider:

Pentium or equivalent, or higher

64-bit Smart View Provider:

Network Protocol

On Itanium 2

HTTP, HTTPS

Smart View client


Disk space

Negligible

RAM

Negligible

Processor

Pentium or equivalent

Software Requirements
Verify that these software requirements, which include requirements for supported third-party
products and variances by product, are met.

Essbase Requirements

19

Table 2

Essbase Software RequirementsMicrosoft Windows

Essbase (Essbase Server)


Operating system

32-bit Essbase:

Microsoft Windows 2000 Server (SP4)

Microsoft Windows 2003 (SP1)

Microsoft Windows 2003 R2

64-bit Essbase:

Microsoft Windows 2003 Server Enterprise Edition 64-bit (SP1) on Itanium 2

Note: 64-bit Administration Services Server supports only 64-bit Essbase Server. 32-bit Administration
Services Server supports both 32-bit and 64-bit Essbase Server.

Java Runtime Environment

JRE 1.4.2_15, installed automatically

Authentication sources

IBM Tivoli Directory Server 5.2

Lightweight Directory Access Protocol (LDAP)

Required Hyperion Products

Sun One 5.2 patch 4

Novell eDirectory 8.8

IBM Directory Server 5.1

Domino LDAP 6.0

Microsoft Active Directory 2000, 2003

Microsoft NTLM

Netegrity Siteminder 5.5 (SP2)

OpenLDAP 2.3.37

Shared Services (unless using Essbase in native security mode)

Essbase Clients
Operating system

Spreadsheet Add-in:

Windows XP Professional

Windows 2000 (SP 4)

Windows 2003 (SP1)

Windows Vista

Citrix Metaframe XP on Windows 2000 Server

Runtime client:

Spreadsheets

Same as Essbase

Microsoft Excel 2000

Microsoft Excel 2002 (XP Office)

Microsoft Excel 2003

CAUTION! If you plan to use the install on first use option when installing Microsoft Office products, be
sure to pre-install Visual Basic for Applications (VBA). If you attempt a first-time launch of Spreadsheet
Add-in without pre-installing VBA, the Add-in will fail to launch and Essbase will display an error message.

20

Planning the Essbase Installation

Table 2

Essbase Software RequirementsMicrosoft Windows (Continued)

Administration Services (Administration Services Server)


Operating system

32-bit Administration Services:

Microsoft Windows 2000 Server (SP4)

Microsoft Windows 2003 (SP1)

Microsoft Windows 2003 R2

64-bit Administration Services:

Microsoft Windows 2003 Server Enterprise Edition 64-bit (SP1) on Itanium 2

Note: 64-bit Administration Services Server supports only 64-bit Essbase Server. 32-bit Administration
Services Server supports both 32-bit and 64-bit Essbase Server.

Java application server

Apache Tomcat 5.0.29, installed automatically on all platforms

BEA WebLogic 9.2 (MP1)

BEA WebLogic 8.1.4

IBM WebSphere 6.1

IBM WebSphere 5.1.1.7

Java Enterprise System 8.1.1

Oracle 10g 10.1.3.1.0

IBM DB2 9.1

IBM DB2 8.2

Microsoft SQL Server 2000 (SP3a)

Microsoft SQL Server 2005 (SP1)

MySQL 4.0.12 (32-bit), 4.0.23 (64-bit HP-UX), installed automatically on all platforms

Oracle 11g

Oracle 10g - 10.1.0.5

Oracle 9i - 9.2.0.5

Java Runtime Environment

JRE 1.4.2_15, installed automatically

Authentication sources

IBM Tivoli Directory Server 5.2

Lightweight Directory Access Protocol (LDAP)

Relational database

Required Hyperion Products

Sun One 5.2 patch 4

Novell eDirectory 8.8

IBM Directory Server 5.1

Domino LDAP 6.0

Microsoft Active Directory 2000, 2003

Microsoft NTLM

Netegrity Siteminder 5.5 (SP2)

OpenLDAP 2.3.37

Essbase

Shared Services (unless using Administration Services Server in native security mode.)

Essbase Requirements

21

Table 2

Essbase Software RequirementsMicrosoft Windows (Continued)

Administration Services client (Administration Services Console)


Operating system

32-bit:

Microsoft Windows 2000 (SP4)

Microsoft Windows 2000 Professional

Microsoft Windows 2003 (SP1)

Microsoft Windows XP Professional

64-bit:

Microsoft Windows 2003 Server Enterprise Edition 64-bit (SP1) on Itanium 2

Java Runtime Environment

JRE 1.4.2_15, installed automatically

Required Hyperion Products

Essbase

Integration Services (Integration Server)

Microsoft Windows 2000 (SP4)

Microsoft Windows 2003 (SP1)

Microsoft Windows 2003 R2

Java Runtime Environment

JRE 1.4.2_15, installed automatically

Required Hyperion Products

Essbase

Operating system

Analytic High Availability Services


Operating system

32-bit Analytic High Availability Services:

Microsoft Windows 2000 (SP4)

Microsoft Windows 2003 (SP1)

Microsoft Windows 2003 R2

64-bit Analytic High Availability Services:

Java application server

Java Runtime Environment

22

Planning the Essbase Installation

Microsoft Windows 2003 Server Enterprise Edition 64-bit (SP1) on Itanium 2

Apache Tomcat 5.0.29, installed automatically on all platforms

BEA WebLogic 9.2 (MP1)

BEA WebLogic 8.1.4

IBM WebSphere 6.1

IBM WebSphere 5.1.1.7

Java Enterprise System 8.1.1

Oracle 10g 10.1.3.1.0

JRE 1.4.2_15, installed automatically

Table 2

Essbase Software RequirementsMicrosoft Windows (Continued)

Authentication sources

IBM Tivoli Directory Server 5.2

Lightweight Directory Access Protocol (LDAP)

Sun One 5.2 patch 4

Novell eDirectory 8.8

IBM Directory Server 5.1

Domino LDAP 6.0

Microsoft Active Directory 2000, 2003

Microsoft NTLM

Netegrity Siteminder 5.5 (SP2)

OpenLDAP 2.3.37

Communication Protocol

TCP/IP, HTTP, HTTPS

Required Hyperion Products

Essbase

Shared Services (unless using Analytic High Availability Services in native security mode)

Administration Services

Smart View Provider


Operating system

32-bit Smart View Provider:

Microsoft Windows 2000 (SP4)

Microsoft Windows 2003 (SP1)

Microsoft Windows 2003 R2

64-bit Smart View Provider:

Microsoft Windows 2003 Server Enterprise Edition 64-bit (SP1) on Itanium 2

Apache Tomcat 5.0.29, installed automatically on all platforms

BEA WebLogic 9.2 (MP1)

BEA WebLogic 8.1.4

IBM WebSphere 6.1

IBM WebSphere 5.1.1.7

Java Enterprise System 8.1.1

Oracle 10g 10.1.3.1.0

Java Runtime Environment

JRE 1.4.2_15, installed automatically

Authentication sources

IBM Tivoli Directory Server 5.2

Lightweight Directory Access Protocol (LDAP)

Java application server

Sun One 5.2 patch 4

Novell eDirectory 8.8

IBM Directory Server 5.1

Domino LDAP 6.0

Microsoft Active Directory 2000, 2003

Microsoft NTLM

Netegrity Siteminder 5.5 (SP2)

OpenLDAP 2.3.37

Essbase Requirements

23

Table 2

Essbase Software RequirementsMicrosoft Windows (Continued)

Required Hyperion Products

Essbase

Shared Services

Administration Services

Oracles Hyperion Smart View for Office client


Operating system

32-bit Smart View:

Microsoft Office application

Required Hyperion Products

Microsoft Vista

Microsoft Windows XP Professional (SP1a)

Microsoft Windows 2003 Standard Edition

Microsoft Windows 2003 Enterprise Edition

Microsoft Windows 2000 Server (SP4)

Microsoft Windows 2000 Professional (SP4)

Microsoft Excel, Word, Powerpoint 11 (Office 2003)

Microsoft Excel, Word, Powerpoint 10 (Office 2002/XP)

Microsoft Excel, Word, Powerpoint 9 (Office 2000)

Smart View Provider


Note: See the Smart View client readme for additional information on supported Hyperion products.

32-Bit and 64-Bit Client and Server Compatibility


Various Hyperion products interface with Essbase Server. The following table summarizes the
compatibility of 32-bit and 64-bit Hyperion clients and servers with Essbase Server:

24

Client

Server

Essbase Server: Platform to


which Client Can Connect

32-bit Administration Services Console

32-bit Administration Services Server

32-bit, 64-bit

64-bit Administration Services Console

64-bit Administration Services Server

64-bit

32-bit Integration Services Console

32-bit Integration Server

32-bit

32-bit Smart View

32-bit Smart View Provider Server

32-bit, 64-bit

32-bit Smart View

64-bit Smart View Provider Server

64-bit

32-bit Administration Services Console

32-bit Smart View Provider Server

32-bit, 64-bit

64-bit Administration Services Console

64-bit Smart View Provider Server

64-bit

32-bit Administration Services Console

32-bit Analytic High Availability


Server

32-bit, 64-bit

64-bit Administration Services Console

64-bit Analytic High Availability


Server

64-bit

Planning the Essbase Installation

Essbase Server: Platform to


which Client Can Connect

Client

Server

32-bit JAPI client application

32-bit Analytic High Availability


Server

32-bit, 64-bit

64-bit JAPI client application

64-bit Analytic High Availability


Server

64-bit

For information on the compatibility of client programs developed with Essbase APIs, see API
Compatibility on 32-Bit and 64-Bit Platforms on page 63.

Port Numbers Used by Hyperion Products


During Hyperion product installation, the default port number for application servers is
automatically populated and can be changed during the configuration process. For
instructions to modify default ports after installation, see Chapter 5, Configuring and Setting
Up Essbase.
Each application port number must be unique. If, after modifying the default port number, the
application fails to launch or you encounter port already in use or bind error messages,
there may be a port number conflict.
If you do not change the default port number, the software is configured with these values:
Table 3

Port Numbers Used by Hyperion Products

Hyperion Product

Listen Port

SSL Listen Port

Shutdown Port for


Apache Tomcat

Shared Services

58080

58090

58005

Oracles Hyperion Application Builder J2EE

21080

21090

21005

Oracles Hyperion Application Builder.NET

22080

22082

22081

Administration Services

10080

10090

10005

Analytic High Availability Services

11080

11090

11005

Oracles Hyperion Planning System 9

8300

8300

8301

Oracle's Hyperion Translation Manager

14080

14090

14005

Oracles Hyperion Financial Reporting


System 9

8200

8201

Oracles Hyperion Web Analysis


System 9

16000

16001

Oracles Hyperion Business Modeling

17080

17090

17005

Oracles Hyperion Performance Scorecard


System 9

18080

18090

18005

Port Numbers Used by Hyperion Products

25

Table 3

Port Numbers Used by Hyperion Products (Continued)

Hyperion Product

Listen Port

SSL Listen Port

Shutdown Port for


Apache Tomcat

Oracles Hyperion Performance Scorecard


Alerter System 9

18081

18091

18006

Oracles Hyperion System 9 BI+ Enterprise


Metrics

8180

8280

8105

Smart View Provider

13080

Oracles Hyperion Workspace

19000

Essbase Remote Start Server

9010

8205
13090

13005
45001

Default Port Numbers for Remote Method Invocation (RMI)


Servers
Hyperion Component

RMI Port

Oracles Hyperion Remote Authentication Module

58000

Oracles Hyperion Financial Reporting System 9

1099

Oracles Hyperion Planning System 9

11333

Oracles Hyperion Strategic Finance

1493 and 1495

Oracle's Hyperion Performance Suite Legacy

1494 - 1498

Oracle's Hyperion Performance Suite GSM

1800

Oracles Hyperion Performance Suite

1801-1803

OpenLDAP

58081

Essbase Deployment Example


This section presents requirements for a representative deployment of Essbase for up to 150
users (30-40 concurrent users). Your actual configuration may differ from this example
depending on your companys environment.
Keep the following considerations in mind as they may affect hardware requirements:

26

Concurrent usage may be higher or lower in your environment than in this example. For
instance, your organization may have 150 users total, but concurrent usage may typically be
around 80 (rather than 30-40), increasing hardware requirements.

The frequency of queries and the volume of report generation affect hardware
requirements.

Planning the Essbase Installation

Adequate load & performance testing should be integrated into the testing phase of your
implementation to validate your production environment hardware sizing and assess overall
technical readiness.
Table 4

Essbase Installation for up to 150 UsersHardware Requirements

Hyperion Component

Requirements

Computer 1:

Dual Pentium 4, 2 GHz and higher, 4 GB RAM, 32 GB Disk (After OS


installation 10 GB available)

Shared Services
Computer 2:
Essbase Server
Computer 3:

Administration Services Server

Analytic High Availability Server

Table 5

Dual Pentium 4, 2 GHz and higher, 4 GB RAM, 32 GB Disk (After OS


installation 10 GB available)
Dual Pentium 4, 2 GHz and higher, 4 GB RAM, 32 GB Disk (After OS
installation 10 GB available)

Essbase Installation for up to 150 UsersSoftware Requirements

Hyperion Component

Requirements

Computer 1:

See the Hyperion Shared Services Installation Guide.

Shared Services
Computer 2:

See:

Essbase Server

Essbase Requirements on page 16.

Integration Server

Integration Services Requirements on page 29.

Computer 3:

Administration Services Server

Analytic High Availability Server

See Essbase Requirements on page 16.

Essbase SQL Interface Requirements


This section describes the supported ODBC drivers and relational data sources for Essbase SQL
Interface on 34-bit and 64-bit platforms.

Essbase SQL Interface Requirements

27

32-bit Platforms
Table 6

Supported ODBC Drivers and RDBMS for Essbase SQL Interface 32-bit Windows Platforms
ODBC Drivers by Supported Platform
Windows 2000 (SP4)
Windows XP

Relational Database Server (Relational Data Source)

Windows 2003 (SP1)/R2

IBM DB2 UDB 9.1

DataDirect Wire Protocol Driver 5.2

IBM DB2 UDB 8.1.7a (same as 8.1 FP7a) and 8.2


IBM DB2 v7x for z/OS1

DataDirect Wire Protocol Driver 5.2

Oracle 11g - beta

DataDirect Wire Protocol Driver 5.2

Oracle 10g - 10.1.0.5


Oracle 9i - 9.2.0.5
Microsoft SQL Server 2005 (SP1)

Microsoft SQL Server 3.70 ODBC

Microsoft SQL Server 2000 (SP 3a)


Teradata V2R6.0

TTU 8.0 with Teradata 3.4 ODBC

Teradata V2R5.12
Informix 9.3

DataDirect Wire Protocol Driver 5.2

Informix 9.2
Sybase 12.5 (Adaptive Server)

DataDirect Wire Protocol Driver 5.2

Sybase 12.0
Access 2002

Microsoft Driver

Access 2000
1 Supports data source only; does not support the OLAP catalog.
2 Teradata ODBC drivers must be obtained separately from NCR Corporation.

64-bit Platforms
Table 7

Supported ODBC Drivers and RDBMS Essbase SQL Interface 64-bit Windows Platforms
ODBC Drivers by Supported Platform

Relational Database Client 1

Windows 2003 (64-bit)

IBM DB2 UDB 9.1

DataDirect Wire Protocol Driver 5.2

IBM DB2 UDB 8.1.7a (same as 8.1


FP7a) and 8.2
Informix 9.3
Informix 9.2

28

Planning the Essbase Installation

DataDirect Wire Protocol Driver 5.2

Table 7

Supported ODBC Drivers and RDBMS Essbase SQL Interface 64-bit Windows Platforms (Continued)

Oracle 11g - beta

DataDirect Wire Protocol Driver 5.2

Oracle 10g - 10.1.0.5


Oracle 9i - 9.2.0.5
Sybase 12.5

DataDirect Wire Protocol Driver 5.2

Sybase 12.0
Teradata VR6.0

TTU 8.0 with Teradata 3.4 ODBC 2

Teradata V2R5.0
1 IBM DB2 v7x for z/OS, Access 2000 and 2003 are not supported on 64-bit Microsoft Windows.
2 Teradata ODBC drivers must be obtained separately from NCR Corporation.

Integration Services Requirements


Integration Services requires drivers for open database connectivity (ODBC) and Java database
connectivity (JDBC).
Integration Services supports Oracle Call Interface (OCI) direct connection, and vendorsupplied drivers from Oracle, Microsoft SQL Server, and Teradata.
Note: Unless otherwise noted, client software is not required for the database server.

ODBC Drivers and Relational Data Sources


Table 8

Supported ODBC Drivers and RDBMS Integration Services Windows Platforms


ODBC Drivers by Supported Platform

Relational Database Server (Relational Data Source)

Windows 2000, 2003, and XP4

IBM DB2 UDB 9.1

DataDirect Wire Protocol Driver 5.2

IBM DB2 UDB 8.1.7a (same as 8.1 FP7a) and 8.2


IBM DB2 v7x for z/OS1

DataDirect Wire Protocol Driver 5.2

Informix 9.3

DataDirect Wire Protocol Driver 5.2

Informix 9.2
Microsoft SQL Server 2005 (SP1)
Microsoft SQL Server 2000 (SP 3a)

MS SQL Server 3.7 ODBC (included in MDAC 2.6) or


MS SQL Server 2000 ODBC5

MySQL 4.0.12 Pro (for catalog only; no data source


support)2

MySQL Connector/ODBC 3.51 x

Oracle 11g - beta

DataDirect Wire Protocol Driver 5.2

Oracle 10g - 10.1.0.5


Oracle 9i - 9.2.0.5

Integration Services Requirements

29

Table 8

Supported ODBC Drivers and RDBMS Integration Services Windows Platforms(Continued)


ODBC Drivers by Supported Platform

Relational Database Server (Relational Data Source)

Windows 2000, 2003, and XP4

Sybase 12.5

DataDirect Wire Protocol Driver 5.2

Sybase 12.0
Teradata V2R6.03

TTU 8.0 with Teradata 3.4 ODBC

Teradata V2R5.1

TUF 7.1 with Teradata 3.3 ODBC (not supported on


Windows 2003)

1 Supports data source only; does not support the OLAP catalog.
2 MySQL ODBC drivers must be obtained separately from MySQL.
3 Teradata ODBC drivers must be obtained separately from NCR corporation.
4 On Microsoft Windows 2000, Service Pack 4 is required.
5 Microsoft SQL Server 2000 driver must be obtained separately from Microsoft.

Integration Services provides DataDirect 4.2 ODBC drivers on UNIX for supported databases
running on IBM AIX, HP-UX, and Solaris; and for Microsoft Windows 2000 and Microsoft
Windows XP.

JDBC DriversOracle and Teradata


JDBC drivers are required to support the XML Import/Export functionality in Integration
Services. JDBC Type 1 is installed when you install the Java Runtime Environment (included as
an option in the Windows installation).
JDBC Type 1 is compatible with all RDBMSs supported by Integration Services, with the
following exceptions for Teradata:

The JDBC Type 1 driver is not officially supported by Teradata; however, it works on all
platforms except HP-UX.

When Teradata is run on the HP-UX platform, the JDBC Type 3 driver is required.

The JDBC Type 3 driver is supported by Teradata and works on all platforms. The JDBC Type 4
driver is required by Integration Services if you are using Oracle with OCI. The JDBC Type 4
driver for Oracle works on all platforms.
The following table lists Oracle and Teradata support for JDBC drivers by supported platform:
Table 9

Supported JDBC Drivers Oracle and Teradata


JDBC Driver by Supported Platform

JDBC Type

Windows 2000 (SP4), 2003 (SP1), or XP

Oracle:
JDBC Type 1

30

Planning the Essbase Installation

Supported

Table 9

Supported JDBC Drivers Oracle and Teradata


JDBC Driver by Supported Platform

JDBC Type

Windows 2000 (SP4), 2003 (SP1), or XP

JDBC Type 4 1

Supported

Teradata:
JDBC Type 1 2

Not supported

JDBC Type 3 3

Supported

1 JDBC Type 4 drivers must be implemented when Oracle with OCI is being used.
2 For Teradata, JDBC Type 1 drivers function for all platforms except HP-UX, but are not
supported by NCR Corporation.
3 JDBC Type 3 drivers must be purchased separately for Teradata from NCR
Corporation.

Hybrid Analysis, Advanced Relational Access, and Drill-through


Requirements
Relational database servers that support Hybrid Analysis, Advanced Relational Access, and
drill-through functions are shown in Table 10.
Table 10

Supported Relational Database Servers Hybrid Analysis, Advanced Relational Access, Drill-through

Hybrid Analysis

Advanced Relational
Access

Drill-through

Yes

Yes

Yes

IBM DB2 v7x for z/OS

Yes

No

Yes

Informix 9.3

No

No

Yes

Yes

Yes

Yes

MySQL 4.0.12 Pro (for catalog only;


no data source support)

No

No

No

Oracle 11g

Yes

No

Yes

Oracle 9i - 9.2.0.5

Yes

Yes

Yes

Sybase 12.5

No

No

Yes

Relational Database Server


IBM DB2 UDB 9.1
IBM DB2 UDB 8.2

Informix 9.2
Microsoft SQL Server 2005
Microsoft SQL Server 2000

Oracle 10g - 10.1.0.5

Sybase 12.0

Hybrid Analysis, Advanced Relational Access, and Drill-through Requirements

31

Table 10

Supported Relational Database Servers Hybrid Analysis, Advanced Relational Access, Drill-through

Hybrid Analysis

Advanced Relational
Access

Drill-through

Teradata V2R6.1

Yes

No

Yes

Teradata V2R5.1

Yes

Yes

Yes

Relational Database Server

HYPERION_HOME Variable
The Essbase installation program prompts you to define the location for Hyperion Home,
which is the root directory where Hyperion applications are installed. You must specify a
location for HYPERION_HOME or accept the default location.
The installation program searches for the HYPERION_HOME system variable on the computer
to which you are installing. It uses the Hyperion Home location defined on the computer, if a
previous installation defined a location, or uses a Hyperion Home location that you specify, if a
location was not previously defined. See Changing the Hyperion Home Location on page 43.
Note: You can have only one HYPERION_HOME on a single computer.

The Hyperion Home location is defined in the HYPERION_HOME system variable. The default
location for HYPERION_HOME is:
c:\Hyperion

Some internal components and third-party products used by Hyperion products are installed
in the following shared directory:
HYPERION_HOME\common

ESSLANG Variable
You must choose the correct ESSLANG setting for your Hyperion programs to start successfully.
ESSLANG points to the correct Global C locale (installed in the ARBORPATH\locale
directory). The ESSLANG setting for a computer must agree with the locale setting of the
computers operating system.
On Windows platforms, the Essbase Server installation program prompts you to select a value
for the ESSLANG environment variable.

Caution! The Essbase Server installation program does not default to an ESSLANG value that matches the

locale setting on that computer. Instead, you must determine the locale setting on the
computer and then select the matching ESSLANG value during installation.

32

Planning the Essbase Installation

ESSLANG Value Settings


Essbase requires you to set an ESSLANG value. See the topic on managing file encoding in the
Hyperion Essbase System 9 Database Administrators Guide.
The default value for ESSLANG is English (Latin1). For examples of ESSLANG values for
languages other than English, see the list of supported locales in the unicode-mode
applications topic in the Hyperion Essbase System 9 Database Administrators Guide.
The Essbase Server installation program displays only the ESSLANG language and encoding;
not the full value. For example, you see English (Latin1), not English_United
States.Latin1@Binary.
Note: ESSLANG does not need to be set on the computer where Essbase client software is installed, unless the client
software is installed on the same computer as Essbase Server. If you are installing only client software, the
installation program does not prompt you to set ESSLANG. When ESSLANG is not set on a client computer, the
computer locale is used for encoding.

Management of ESSLANG Settings


The ESSLANG environment variable on the Essbase Server computer must retain the locale
value of an application for as long as that application is in use.
Note: If the ESSLANG variable is changed after applications are created on an Essbase Server computer, those
applications cannot be opened.

To avoid possible database corruption, the ESSLANG locale specification must be the same on
client and Essbase Server when:

The client is not Unicode enabled

A Unicode-enabled client saves an outline over an existing outline on a version of the


Essbase Server that is not Unicode-enabled

A Unicode-enabled client saves an outline to a non-Unicode application on a Unicodeenabled Essbase Server

The ESSLANG locale specifications on clients and Essbase Server computers can be different
when a Unicode-enabled client views and updates an outline belonging to a Unicode-mode
application.

About the Security File and ESSLANG Values


If the ESSLANG system environment variable is already set on the computer to which you are
installing Essbase Server, be sure to choose the same value.

ESSLANG Variable

33

Caution! If you are upgrading an existing Essbase Server installation, choosing the wrong ESSLANG value

can cause the security file to be corrupted. See ESSLANG Variable on page 32.

If the Essbase Server security file is corrupted during the installation, you can revert to a
backup copy by renaming ESSBASE.BAK to ESSBASE.SEC.

Disk Array
Essbase Server supports the use of any disk array for both data storage and binary installation if
the device is mounted in such a way that it gives a local file system interface, for example NTFS,
HPFS, JFS, VxFS, UFS etc. A disk array mounted using NFS or CIFS is not supported. Note
that although these assertions are made in good faith, certain incompatibilities may exist. In
the event that an incompatibility is identified, Oracle may experience a delay in reproducing
and fixing resultant issues.

Troubleshooting Connection Problems


Before attempting an Essbase client-server connection, test the network protocol installation to
ensure that the connection is installed properly.
Use the PING command on the server to check that the server is running and visible to the
client computer.

If the PING command is successful but the TELNET command is not, there might be a
problem with the inet daemon.

If the PING command is unsuccessful on the server, you might have a routing or hardware
problem.

Upgrading
If upgrading from a previous release of Essbase, see Chapter 10, Upgrading Essbase and the
Essbase readme.
If installing Essbase for the first time, see Chapter 4, Installing Essbase.

34

Planning the Essbase Installation

Chapter

Installing Essbase

4
Read this chapter for information on installing Essbase.

In This Chapter

Before Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36


About Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Running Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Understanding Installation Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Running Silent Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Changing the Hyperion Home Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Installing Additional Instances of Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Installing Essbase

35

Before Installing Essbase


Before installing Essbase:
1 Verify that all prerequisites and system requirements are met.
See Chapter 3, Planning the Essbase Installation.

2 Verify the operating system locale setting on your computer, so that you can set the correct ESSLANG
environment variable.

When installing Essbase on Windows computers, the installation program prompts you to set
the ESSLANG value.

Caution! The ESSLANG setting can affect the functioning of applications and databases. Before you

proceed, review ESSLANG Variable on page 32.

3 If you are upgrading from a previous release, back up Essbase Server files to another directory or to a
backup tape.

See Chapter 10, Upgrading Essbase.

4 If you are installing over an existing release of Essbase Server, uninstall the previous release.
See Chapter 9, Uninstalling Essbase.

Caution! If you are running Essbase Server as a Windows Service, be sure to stop the service before

uninstalling or re-installing Essbase Server.

About Essbase Installation Programs


Essbase distribution files are available from the Oracle E-Delivery site.
Essbase includes installation programs for:

Server softwareEssbase Server, including sample applications

Client softwareRuntime Client, Spreadsheet Add-in, and Application Programming


Interface (API)

Essbase documentation

Note: Online documentation is installed with Spreadsheet Add-in. All other documentation must be installed. See
Installing Essbase Documentation on page 55.

36

Installing Essbase

Essbase server and client installation programs offer these installation options:
Table 11

Installation Options and Components Installed

Installation Option

Components Installed

Typical

(Default) Installs these available components:

Server

Client

Custom

Essbase Server

Sample applications

Required third-party products, if applicable

Runtime Client

Spreadsheet Add-in

Application Programming Interface

Allows you to choose which components to install.

When installing client and server components on the same computer, install them in this
order:
1. Client
2. Server

Running Essbase Installation Programs


You can launch the Essbase installation programs from:

The media pack downloaded from the Oracle E-Delivery site (see the media pack Readme)

Distribution files that have been copied to a network drive

For information on running the documentation installation program, see Installing Essbase
Documentation on page 55.
Note: Running Essbase installation programs with Windows Display Properties set to 256 colors is not supported.

To launch installation programs downloaded from the Oracle E-Delivery site:


1 Log on to the Oracle E-Delivery site.
2 Download the media pack.
3 Run the installation programs for your platform.

To launch installation programs from a network location:


1 Navigate to the network folder where the installation files reside.
2 Run the installation programs for your platform.

Running Essbase Installation Programs

37

Depending on whether you are running the server or client installation program, read the
appropriate topic: Server Installation Program on page 38 or Client Installation Program
on page 39.

Specifying Directory Paths


When prompted for the location of the installation (ARBORPATH) and Hyperion Home
directories, you can accept the default; if available, click Browse to select a different location; or
enter a different path. When typing the path, you can use only English alphanumeric
characters and these special characters:
dash ( - ), underscore ( _ ), plus sign ( + ), backslash ( \ ), forward slash ( / ), dot (.), colon ( : )
The colon character ( : ) is supported only for Windows platforms to specify the drive (for
example, c:\).

Server Installation Program


At the Welcome screen, follow the on-screen instructions:
1 Select your country location.
2 Read the license agreement and select I AGREE.
3 For the installation (ARBORPATH) directory, accept the default location or specify a different path.
See Specifying Directory Paths on page 38 and ARBORPATH Directory on page 41.

4 For the Hyperion Home directory, accept the default location or specify a different path.
The default location for HYPERION_HOME is:
c:\Hyperion

See Specifying Directory Paths on page 38.

5 For installation type, select Typical or Custom.


If you select Custom, all components are selected by default. Clear the check box for each
component you do not want to install.
See About Essbase Installation Programs on page 36.

6 Select whether you want the installation program to update the PATH and ARBOPATH environment
variables, and create a shortcut menu.

7 Select a value for the ESSLANG language environment variable.


See ESSLANG Variable on page 32.

8 Review the pre-installation summary information.


9 When the installation program finishes installing files, review the post-installation summary information.
10 Select whether to run the Hyperion Configuration Utility at this time.
11 Select whether to reboot the computer.

38

Installing Essbase

Client Installation Program


At the Welcome screen, follow the on-screen instructions:
1 Select your country location.
2 Read the license agreement and select I AGREE.
3 For the installation (ARBORPATH) directory, accept the default location or specify a different path.
See Specifying Directory Paths on page 38.

4 For the Hyperion Home directory, accept the default location or specify a different path.
See Specifying Directory Paths on page 38.

5 For installation type, select Typical or Custom.


If you select Custom, all components are selected by default. Clear the check box for each
component you do not want to install.
See About Essbase Installation Programs on page 36.

6 Select a value for the ESSLANG language environment variable.


See ESSLANG Variable on page 32.

7 Select whether you want the installation program to update the PATH and ARBOPATH environment
variables.

8 Review the pre-installation summary information.


9 When the installation program finishes installing files, review the post-installation summary information.
10 Select whether to reboot the computer.

Understanding Installation Operations


By default, the Essbase Server installation program performs the following operations. If you
choose the Custom installation option to install only certain components, some of the
operations are not performed:

Creates new directories for a new installation, or updates existing directories if a previous
release of Essbase Server is installed.

Installs Essbase Server software files to the ARBORPATH directory.


See Directories and Files Installed on page 40.

Installs common components to the HYPERION_HOME directory.


See Directories and Files Installed on page 40.

Installs the appropriate version of Java Runtime Environment (JRE) to the


HYPERION_HOME\common\jre directory, and sets the JVMMODULELOCATION variable in
the essbase.cfg file to point to HYPERION_HOME\common\jre.
See Updating the Environment Manually on page 49.

Installs DataDirect ODBC drivers to the HYPERION_HOME\common\odbc directory.

Understanding Installation Operations

39

Installs Essbase Server sample application files to the ARBORPATH\app directory.

Installs an essnetu file for the supported network protocol: TCP/IP

(Optional) Updates the Windows environment settings.

Installs the files required to use Essbase SQL Interface and Hybrid Analysis

Directories and Files Installed


Files are installed in these locations:

HYPERION_HOME\commonAdditional internal components and third-party products.

ARBORPATH directoryEssbase Server components.

HYPERION_HOME\common
If you choose the Typical installation option when installing Essbase Server, the directories and
files in Table 12 are installed in the HYPERION_HOME\common directory.
Table 12

Directories and Files Installed in HYPERION_HOME\common

Directory

Contains

appServers

TomCat web server files.

config

Hyperion Configuration Utility files.

CSS

Files that support Hyperion external authentication.

DBMS

MySQL database files.

HyperionLookAndFeel

Installation program user-interface files.

JCE

Sun Java Cryptography Extension files.

JDBC

Java Database Connectivity (JDBC) files.

JDK

Java Development Kit (JDK) files.

JRE

Java Runtime Environment (JRE) files.

loggers

Files for external authentication logging.

ODBC

ODBC drivers and documentation.

SharedServices

Shared Services files.

utilities

One of the utilities needed to change the location of Hyperion Home.

XML

Common XML components.

Note: If you perform a Custom installation, some directories are not installed.

40

Installing Essbase

ARBORPATH Directory
In a default installation, the ARBORPATH directory is:
c:\hyperion\AnalyticServices

If you choose the Typical installation option when installing Essbase Server, the directories and
files in Table 13 are installed in the ARBORPATH directory.
Table 13

Directories and Files Installed in the ARBORPATH directory

Directory

Contains

api

Libraries and header files necessary for using MaxL. You do not have to install or use the
API to use MaxL, but the directory is created so that MaxL will work.

app

Essbase Server application files, as they are created.


Essbase Server sample applications and associated databases. See About Sample
Applications on page 70.

bin

Essbase Server files.

java

Java software to support the Java-based features of Essbase.

locale

Character-set files necessary for Essbase Server supported languages.


During the Essbase Server installation. you select a value for the ESSLANG environment
variable, which applies to all languages, including English. See ESSLANG Variable on
page 32.

migrationutility

Utility, which is run only after moving HYPERION_HOME, that fixes all internal references to
the old Hyperion Home location. See Changing the Hyperion Home Location on
page 43.

perlmod

Files required to add the MaxL Perl Module (essbase.pm), which enables you to embed
MaxL statements in Perl programs. You must install Perl. See the documentation in this
directory and the MaxL section of the Essbase Technical Reference.

UninstallServer

Uninstall program files for Essbase Server.

Note: If you perform a Custom installation, some directories are not installed.

Security
The essbase.sec file stores information about users, groups, and passwords for native
security, and privileges on applications and databases. It also stores many application and
database properties.
Each time that you successfully start Essbase Server, a backup copy of the security file is created
(named essbase.bak). Also, if you have specified an interval at which inactive users should
be logged off using the Auto logoff option in the Administration Services Console, a backup of
the security file is created at the same interval.

Understanding Installation Operations

41

If you attempt to start Essbase Server and a password prompt is not displayed or your
password is rejected, no backup file is created. You can restore from the last successful backup
by copying essbase.bak to essbase.sec. Both files are in the bin directory where you
installed Essbase Server.

Network Protocol Files


Network protocol files implement the TCP/IP protocol that is used by Essbase Server. The
network protocol file for server software is essnetu.dll. Additionally, the client software
(for example, Spreadsheet Add-in) is installed with a separate essnetu.dll. Network
protocol files reside in the bin directory with the Essbase Server program files.

Running Silent Installations


If you want to automate the process of installing Essbase Server on multiple computers using
the same installation options, you can record your installation settings and then run a silent
installation from the command line.
To record your installation settings, you first create a response file and then run the regular
installation to record your settings in the response file. Then, when you run the silent
installation from the command line, the response file is used to set the same installation
options as the regular (non-silent) installation.

To record installation settings and run a silent installation:


1 Navigate to the directory that contains the product installation program.
2 To create a response file, at a command prompt, enter:
setup.exe options record <responsefilename>

The <responsefilename> can include an absolute path.

3 When the regular (non-silent) installation program is launched, follow the on-screen instructions,
specifying the settings you want recorded in the response file.

You can modify the response file later, if you want to change any installation options.

4 To run the installation in silent mode, at a command prompt, enter:


setup.exe options <responsefilename> silent

The installation runs in the background.

42

Installing Essbase

Changing the Hyperion Home Location


To change the Hyperion Home location after Hyperion Home has been defined during a
product installation, you must run these utilities (which are installed with Essbase) in the
following order:
1. run.*Moves the files installed in Hyperion Home to the new location.
2. MigrationUtility.*Fixes all internal references to the old Hyperion Home location.

To change the Hyperion Home location:


1 From the current Hyperion Home location, launch the run utility. For example:
HYPERION_HOME\common\utilities\HyperionHomeTool\1.0.1\bin\run.exe

Follow the on-screen instructions.

2 For the Hyperion Home location, enter the location or click Browse to navigate to the location.
The run utility copies the entire Hyperion Home directory to the new location, and replaces
the value of the current HYPERION_HOME system variable.

3 From the Essbase installation location, launch MigrationUtility. For example:


ARBORPATH\migrationutility\bin\MigrationUtility.bat

Follow the on-screen instructions.

4 For the Hyperion Home location, enter the new and old locations, or click Browse to navigate to the
locations.

5 Confirm or correct the current locations of installed Hyperion products.


The MigrationUtility utility:

Creates a backup of each file that contains references to Hyperion Home.

Opens each file.

Replaces references to Hyperion Home with the new location.

Saves the file.

When completed, the utility lists the files that were changed.

Installing Additional Instances of Essbase Server


You can install multiple instances of Essbase Server on a single computer. For example, you
might want to install production and development versions.
When multiple instances of Essbase Server are installed on a single computer, you need to
specify a different port number for each instance. You can connect to subsequent installations
by specifying the machine name and the agent port number, in the form:
machineName:agentPort

Installing Additional Instances of Essbase Server

43

By default, the first instance of Essbase Server uses port number 1423. You can specify a
different default port number in the essbase.cfg file using the AGENTPORT configuration
setting. (See the Essbase Technical Reference.)
When you connect to an instance of Essbase Server specifying only the machine name (not the
machine name and port number), you are connected to the port specified in the configuration
file. You can override the configuration file setting by using the machineName:agentPort
syntax when connecting.
Note: The additional installation is a separate installation of Essbase Server, and does not share the security
configuration or objects of other Essbase Server installations on the same computer.

To install and configure an additional Essbase Server instance on a single Windows computer:
1 Install the second Essbase Server instance in a different ARBORPATH directory from the first Essbase
Server instance.

2 In the second instances ARBORPATH\bin directory, create an essbase.cfg file and add the
following settings:
Table 14

essbase.cfg Settings for an Additional Essbase Server Instance

Configuration Setting

Description

AGENTPORT

Port number that the second instance of Essbase Server uses to connect.

SERVERPORTBEGIN

First port number that the first instance of Essbase Server tries to use to connect.

SERVERPORTEND

Highest port number that a server process can use to connect.

PORTINC

Increment between port numbers used. For example, if PORTINC is assigned a value
of 5, Essbase Server looks for ports 32700, 32705, and so on up to the value of
SERVERPORTEND.
Note: The range of ports used by the first Essbase Server instance must not overlap the
range of ports used by the second one.

DEPLOYMENTID

A number associated with one or more Essbase Servers.

See the Essbase Technical Reference for information on creating the essbase.cfg file and
selecting values for these settings.

3 Create and run a batch script (.bat) that performs these tasks:

Sets ARBORPATH to the correct value for this installation.

Adds the ARBORPATH to the PATH variable. For example:


%ARBORPATH%\bin;%path%

44

Installing Essbase

Starts Essbase Server.

Chapter

Configuring and Setting Up


Essbase

This chapter describes how to configure Essbase using the Hyperion Configuration Utility. It
provides instructions for activating the product and registering it with Shared Services.
Also discussed are advanced installation tasks, such as updating the environment manually,
installing third-party products, and starting and stopping the Essbase Server.

In This Chapter

Hyperion Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46


Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Task Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring Product Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Launching the Hyperion Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Registering Products with Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deregistering Products with Shared Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Reconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuration Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Updating the Environment Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Starting Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Automating Application or Database Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Starting Essbase Server from Administration Services Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Running Essbase Server as a Windows Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Setting JVMMODULELOCATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Installing Essbase Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Verifying Startup Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Using Essbase Server Agent Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Shutting Down Essbase Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Configuring and Setting Up Essbase

45

Hyperion Configuration Utility


The Hyperion Configuration Utility is a common tool used to configure installed Hyperion
products. This utility is installed with the first product installed on a machine, and you can use
it to configure all products that are installed on that machine. You must run the configuration
utility on each machine to which a product is installed.
The configuration utility provides the appropriate set of configuration tasks for the products
installed on the machine:

Shared Services RegistrationRequired for all products. See Registering Products with
Shared Services on page 48.

Shared Services DeregistrationFor registered products, required to deregister from


Shared Services before uninstalling the product. See Deregistering Products with Shared
Services on page 49.

Product-specific configuration tasks may also be provided.


You can use the configuration utility to perform configuration tasks sequentially for multiple
products in one session. The sequence of configuration utility pages depends on your product
and task selections. As a troubleshooting measure, perform configuration tasks individually for
one product at a time.
You can reconfigure products after the initial configuration, following the same procedures.

Prerequisites
Complete these tasks before using the Hyperion Configuration Utility:
Task

Documentation

Install, configure, and start the Shared Services server.

Hyperion Shared Services Installation Guide


Starting Shared Services on page 56

Install Hyperion products.

Product installation guide

Note: Do not start the product you are configuring.

Task Sequence
When performing multiple configuration tasks in one session, Hyperion Configuration Utility
orders the tasks for you. If you use the configuration utility to perform tasks individually,
follow this order:

Product activation

Shared Services registration

Some products may require a different configuration order.

46

Configuring and Setting Up Essbase

Configuring Product Upgrades


You can use Hyperion Configuration Utility to configure products that are upgraded from a
previous release (for example, 9.0.0). The configuration utility determines whether the
products installed on the machine are new or upgraded. The product selection page indicates
which products were specified as upgrades during the product installation process.
All configuration tasks are available for upgraded products; however, if an upgraded product is
configured for a relational database, the database configuration page is read-only except for the
password. You can configure only one upgraded product at a time because each product may
be configured for a different database. Similarly, you cannot configure new products and
upgraded products simultaneously.
If you are upgrading Shared Services and products, upgrade Shared Services first. You must
activate upgraded products and reregister them with Shared Services.
Note: The configuration utility is backward compatible with previous releases and can be used to configure products for
that release.

Launching the Hyperion Configuration Utility


You must run the configuration utility on each machine to which a product is installed. The
utility can be launched from a product installation program or independently.

To launch the configuration utility:


1 Choose a method:

On the last page of a product installation program, select the option to launch the
configuration utility.

From Start, select Programs > Foundation Services > Configuration Utility.

Double-click the configtool.bat file in this directory:


\%HYPERION_HOME%\common\config

From a Windows command prompt, change to this directory:


\%HYPERION_HOME%\common\config

Then enter:
startconfigtool.bat -console
Note: If you are running the configuration utility in console mode, follow the command-line prompts.

2 On the welcome page, click Next.


3 From the list of installed products, select those to configure and click Next.
A list of configuration tasks is displayed.

Launching the Hyperion Configuration Utility

47

4 Follow the instructions for configuration tasks, as appropriate for the selected products:

Registering Products with Shared Services on page 48

Deregistering Products with Shared Services on page 49

Registering Products with Shared Services


Shared Services functionality is programmed into Hyperion products to enable user
provisioning, single-sign on, and metadata management.
Products that implement Shared Services functionality require access to the Shared Services
server and to a database dedicated to Shared Services. Registering with Shared Services enables
a product to implement the required information in the Shared Services server by creating a
registration file under its corresponding product directory in Shared Services.

To register products with Shared Services:


1 Launch the configuration utility.
See Launching the Hyperion Configuration Utility on page 47.

2 From the list of installed products, select those to configure and click Next.
3 On the task selection page, select Shared Services Registration and click Next.
4 Specify Shared Services server information:
Table 15

Shared Services Server Fields

Server

Enter the computer name (host name) where Shared Services Server is installed.
Note: Do not specify an IP address for the server, especially in DHCP environments.

Port

Enter the Shared Services Server port number, or accept the default (58080).

User

Enter the username of the Shared Services Administrator.

Password

Enter the password for the Shared Services Administrator.

SSL

Select if you are using Secure Sockets Layer (SSL).

5 Click Next to go to the next configuration task or to finish.

48

Configuring and Setting Up Essbase

Deregistering Products with Shared Services


If you need to uninstall a Hyperion product after installation and configuration, and if the
product is registered with Shared Services, first deregister the product before uninstalling it.

To deregister products with Shared Services:


1 Launch the configuration utility.
See Launching the Hyperion Configuration Utility on page 47.

2 From the list of installed products, select those to configure and click Next.
3 On the task selection page, select Shared Services Deregistration and click Next.
On the Shared Services location page, the Server, Port, and User fields display the information
that was specified when the product was registered with Shared Services.

4 For Password, enter the password for the specified Shared Services user.
5 Click Next to go to the next configuration task or to finish.

Reconfiguration
The Hyperion Configuration Utility enables you to reconfigure Hyperion products multiple
times. Reconfiguration procedures are identical to the initial configuration procedures.
Launch the configuration utility, select the products to reconfigure, and repeat the procedures.
Select the options that you want to change and follow the prompts to enter the required
information.
Product activation is not required when you reconfigure.

Configuration Troubleshooting
Because the Hyperion Configuration Utility separates configuration from product installation,
the task of tracking and correcting configuration errors is simplified. The configuration utility
logs configuration errors and warning messages to a log file, configtool.log, in a central
location:
%HYPERION_HOME%\common\config\logs
Note: If you experience problems with configuration, as a troubleshooting measure, perform configuration tasks
individually for one product at a time.

Updating the Environment Manually


To run Essbase, the operating system needs to know where Essbase is located. If you do not
choose to let the installation program create or update the ARBORPATH environment variable
and add the ARBORPATH\BIN directory to the system-wide PATH variable, you can do it
manually.

Updating the Environment Manually

49

Note: Changing system settings affects all users who access the system.

To update the environment settings manually:


1 Select Start > Settings > Control Panel > System.
2 On the Advanced tab, click Environment Variables.
3 Set these system variables:

ARBORPATH=C:\Hyperion\AnalyticServices, or wherever Essbase is installed

PATHAdd %ARBORPATH%\BIN

4 Remove outdated ARBORPATH system variables or ANALYTICSERVICES\BIN path settings.


5 Reboot the computer, or log off and log on, for the changes to take effect.

Starting Essbase Server


This section describes ways to start Essbase Server on Windows platforms.

Starting Essbase Server Manually


To start Essbase Server:
1 Choose a method:

Select Start > Programs > Hyperion > Essbase > Essbase.

At a command prompt, enter:


essbase

If you encounter errors during startup:

Check the path and environment settings.

Ensure the TCP/IP network protocol is installed and running on the computer.

2 If this is a first-time installation, enter the following information:

Company name.

Your name (for example, asadmin), which is designated as the Essbase Server system
administrator user ID.
Use this name for the initial logon from a client to Essbase Server.

Caution! Do not specify admin as a user ID in Essbase. If you create an admin user ID and then

migrate your Essbase users to Shared Services (which has a read-only admin user ID), the
Essbase admin user cannot be migrated. See Migrating Users and Groups from Analytic
Services to Shared Services on page 116.

50

Configuring and Setting Up Essbase

System password, which must be different than the user ID and must contain at least six
characters.
This password is required to start Essbase Server and to access Essbase Server from clients
using the system administrator account.

To confirm your choices, enter 1 to verify your entries or 2 to re-enter them.

Note: When you change the password for the administrator, it does not affect the system password (the password
required when you start Essbase Server). During installation, Essbase Server creates two identical users and
passwords, one for the system user who starts Essbase Server and a separate administrator (super user). Thus,
you can change the administrators password without affecting the password used to start Essbase Server.

3 If this is not a first-time installation, Essbase Server prompts you for the system password that you
specified when you first started Essbase Server.

The following message is displayed:


Waiting for Client Requests...

You can now use the Essbase Server Agent window to perform high-level administrator
operations. For a list of Agent commands, see Using Essbase Server Agent Commands on
page 59.
After you start the Essbase Server, Agent activities are recorded in the Essbase Server log
(essbase.log), which is stored in the ARBORPATH directory.
After you start individual applications, application and database activities are recorded in an
application log (appname.log), which is stored in the application directory
(ARBORPATH\app\appname).
See Monitoring Data, Applications, and Databases and Running Essbase Servers,
Applications, and Databases in the Hyperion Essbase System 9 Database Administrators
Guide.

Automating Essbase Server Startup


On Windows, you can place the Essbase Server program in a startup folder so that it starts
automatically when Windows boots. You can also specify the Essbase Server password, to
avoid having to enter it each time Essbase Server starts.

To automate Essbase Server startup on Windows platforms:


1 From the Windows Desktop, right-click the task bar and select Properties.
2 On the Start Menu tab, select Classic Start menu and click Customize.
3 Click Add and specify the location of the Essbase Server Agent program file, essbase.exe. For example:
c:\hyperion\AnalyticServices\bin\essbase.exe

Starting Essbase Server

51

Note: If you want the Essbase Server system password to be automatically entered each time Essbase Server starts,
open a command prompt and enter essbase.exe, followed by a space and the password. For example:
c:\hyperion\AnalyticServices\bin\essbase.exe password
where password is your Essbase Server system password.

4 Click Next, and then double-click the Startup folder.


5 Enter Essbase or your server name, and click Finish.

Automating Application or Database Startup


You can automatically start up an application or a database. When the Essbase Server is
started, Essbase Server starts any application or database that is defined with an automatic
startup setting. You define startup settings using Administration Services (Application
Properties and Database Properties windows).
Note: See Essbase Administration Services Online Help for instructions on defining an automatic startup setting.

Starting Essbase Server from Administration Services Console


To start Essbase Server from the Enterprise View in the Administration Services Console, you
must start a Remote Start Server on the Essbase Server computer. The Remote Start Server files
are installed with the Essbase Server installation.
See Running Essbase Servers, Applications, and Databases in the Hyperion Essbase System 9
Database Administrators Guide.

52

Configuring and Setting Up Essbase

Running Essbase Server as a Windows Service


Running Essbase Server (essbase.exe) as a Windows service lets you start and stop Essbase
Server from the Services tool in Windows Control Panel. When running as an automatic
service, Essbase Server starts in the background when Windows starts.
Note: You cannot use Windows Task Manager to terminate a process started as a service. If the Essbase Server Agent is
started as a service, and the service or the server on which the service runs freezes, you must shut down the
server computer to stop the service.

Installing Essbase Server as a Windows Service


To install Essbase Server as a service that starts automatically when you start Windows:
At a command prompt, enter:
essbase.exe -service install

Essbase Server is listed as Essbase Service in the Services tool.

Setting System Environment Variables


To run Essbase Server as a Windows service and start it automatically when you start
Windows, the operating system needs to know where it is located.

To set the system environment to run Essbase Server as an automatic service:


1 Select Start > Settings > Control Panel > System.
2 On the Advanced tab, click Environment Variables.
3 Set these system variables:

ARBORPATH=C:\Hyperion\AnalyticServices, or wherever Essbase Server is installed

PATHAdd %ARBORPATH%\BIN

4 Reboot the computer for the changes to take effect.

Verifying Essbase Server Is Running as a Service


To verify that Essbase Server is running as an automatic Windows service:
1 Reboot the computer.
2 Select Start > Settings > Control Panel > Services.
3 Ensure that:

Essbase Service is in the list of services

Startup Type is Automatic

Running Essbase Server as a Windows Service

53

Status is Started

Stopping the Essbase Server Service


To stop the Essbase Server service:
1 Select Start > Settings > Control Panel > Services.
2 Right-click Essbase Service in the list of services and select Stop.
For more information on stopping a Windows service, see your platform documentation.
Note: The time it takes to stop the Essbase Server service depends on how many applications are running. The amount
of time is the same as when essbase.exe is run from the command line or as a background process.

Removing the Essbase Server Service


Removing the Essbase Server service removes it from the list of Windows registered services.
Essbase Server, itself, is not uninstalled.

To remove the Essbase Server service:


1 Stop the service.
See Stopping the Essbase Server Service on page 54.

2 At a command prompt, enter:


essbase.exe -service remove

A message displayed in the command prompt window indicates the Essbase Server service was
removed.

Setting JVMMODULELOCATION
The JVMMODULELOCATION setting in the essbase.cfg file enables you to designate a
specific installation of JRE for use with Essbase, and is required to enable Data Mining, Shared
Services, custom defined functions, triggers, and external authentication.
This setting is particularly useful if you have multiple versions of Java installed on the Essbase
Server computer.
During Essbase Server installation, the correct setting for JVMMODULELOCATION is
automatically added to essbase.cfg in commented text. To enable the setting, remove the
semicolon (which is a comment indicator) from the beginning of the line that contains the
JVMMODULELOCATION setting.
To set the JVMMODULELOCATION parameters, you must specify the full path and file name
of the Java Virtual Machine (JVM) library. The location and name of the library varies,
depending on the JRE version and the operating system that you are using.

54

Configuring and Setting Up Essbase

The following table shows where the JRE and jvm.dll files are installed:
Platform (JRE version)

JRE and JVM.DLL Locations

32-bit Windows
JRE
JVM.DLL

HYPERION_HOME\common\jre\sun\1.4.2
HYPERION_HOME\common\jre\sun\1.4.2\bin\server\jvm.dll

64-bit Windows
JRE
JVM.DLL

HYPERION_HOME\common\JRE-IA64\Sun\1.4.2
HYPERION_HOME\common\JRE-IA64\Sun\1.4.2\bin\server\jvm.dll

Installing Essbase Documentation


The Essbase documentation is not installed as part of the Essbase Server or client installations.
A separate documentation installation program enables you to install or update existing
documentation independent of the product installation and to select the documentation
components you want to install. For example, if:

Your organization has an internal server computer dedicated to product documentation, all
or part of the Essbase documentation set can be installed on this server.

A spreadsheet user in your organization does not have the Spreadsheet Add-in
documentation on his client computer, only the spreadsheet documentation can be
installed on his computer.

Installing the current documentation set is strongly recommended.


Note: The documentation installation program runs only on Windows platforms, and is available from the Oracle EDelivery site. For the links to the documentation from help menus, the Information Map, and the Windows Start
menu to work properly, one full set of the documentation must be installed on the Essbase Server computer.

To install the documentation:


1 Launch the documentation installation program.
Follow the on-screen instructions.

2 For Choose Destination Location, either:

Accept the default directory, which is either the:

Existing documentation installation directory (if the documentation was previously


installed)

ARBORPATH directory (for example, \hyperion\AnalyticServices)

Click Browse to select a directory or enter the name of the directory.


If you enter the name of a directory that does not exist, the installation program creates the
directory.

3 For Setup Type, select either:

Installing Essbase Documentation

55

CompleteAll documentation associated with the release is installed.

CustomSelect the documentation components you want to install:

Select ComponentsSelect a documentation category.

Select SubcomponentsSelect the subcomponents you want to install.

To install from another category, repeat this step.

Note: In the Getting Started category, be sure to select the Information Map component, which installs the HTML file
that provides live links to all documentation components. This map enables you to access documentation without
knowing where individual files are installed.

4 After the installation program finishes installing the files, review the pre-installation summary information.
5 On the Setup Complete screen, leave the check box selected and click Finish to view the readme file.
After installation, you can access all installed documentation from a single HTML file, the
Information Map. To access the Information Map, launch the esb_infomap.htm file in the
\docs directory, under the directory that you specified during installation. Note that links
from the Information Map work only for the documentation components that you choose to
install.

Verifying Startup Dependencies


The information in this section applies to Windows and UNIX platforms.
Before starting Essbase Server, you must verify that these dependent software components are
running:
Component

How to Verify Successful Startup

How to Start

Shared Services Server

On the Shared Services server computer, look for


confirmation messages in the server console window
or launch the User Management Console. See
Verifying Successful Startup of Shared Services on
page 57.

See Starting Shared Services on page 56.

Starting Shared Services


This section describes how to start Shared Services if you did not deploy the Shared Services
application server as a Windows service. If you deployed the Shared Services application server
as a Windows service, start the service manually from the Windows control panel.

To start Shared Services Server:


1 Choose a method:

56

On Windows, select Start > Programs > Hyperion Foundation > Start Shared Services.

Configuring and Setting Up Essbase

The menu item indicates which application server the Shared Services server is deployed
to.

Execute the startup script:

Application Server

Path to Script

IBM WebSphere

Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
bin\startSharedServices9.bat

UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
bin/startSharedServices9.sh

BEA WebLogic

Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
startSharedServices.bat

UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
startSharedServices.sh

Oracle

Windows:
<OracleInstallDir>\bin\emctl start iasconsole
<OracleInstallDir>\opmn\bin\opmnctl startall

UNIX:
<OracleInstallDir>/bin/emctl start iasconsole
<OracleInstallDir>/opmn/bin/opmnctl startall

Apache Tomcat

Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
bin\startSharedServices9.bat

UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
bin/startSharedServices9.sh

Note: <HSS_HOME> is the directory where Shared Services is installed; for example, c:\hyperion\SharedServices\9.2.

Verifying Successful Startup of Shared Services


To verify successful startup and configuration of Shared Services:
1 Look for the following confirmation messages in the Shared Services console window during startup:

Database Configuration Test Passed

Security System Initialized Successfully

Shared Services Initialized Successfully

On UNIX, when Shared Services is deployed to the Tomcat application server, these
confirmation messages are logged to the following file:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/
SharedServices9/logs/Catalina.out

Verifying Startup Dependencies

57

On UNIX and Windows, when Shared Services is deployed to WebSphere, these confirmation
messages are logged to the following file:

Windows:
<WebSphereInstallDir>\AppServer\logs\SharedServices9\SystemOut.log

UNIX:
<WebSphereInstallDir>/AppServer/logs/SharedServices9/SystemOut.log

On UNIX and Windows, when Shared Services is deployed to WebLogic, these confirmation
messages are also logged to the following file, unless the log level is set to WARN:

Windows:

<HSS_HOME>\AppServer\InstalledApps\WebLogic\8.1\SharedServices9\
logs\SharedServices_Metadata.log

UNIX:

<HSS_HOME>/AppServer/InstalledApps/WebLogic/8.1/SharedServices9/
logs/SharedServices_Metadata.log

2 On the Shared Services server computer, launch the User Management Console login page using one of
these methods:

a. Open a browser and enter this URL:


http://SharedServicesServerName:port#/interop

where SharedServicesServerName is the name of the computer where the Shared


Services Server is installed and port# is the Shared Services Server port number. The
default port number is 58080; if Shared Services Server is installed to a non-default port,
specify that value. For example, using the default port:
http://jdoe:58080/interop/
Note: As a best practice when accessing User Management Console on the machine where the Shared Services Server
is running, the URL to access the console should always use an IP address or a fully qualified machine name that
includes the domain name. If the IP address is dynamic, use the fully qualified machine name.

b. On Windows, select Start > Programs > Foundation Services > User Management
Console.
If the User Management Console login page is displayed, Shared Services server is started
successfully.

58

Configuring and Setting Up Essbase

Using Essbase Server Agent Commands


Essbase Server provides a server console called the Agent. When you start the Essbase Server
program (essbase.exe), the Agent console is displayed. Use this console to perform highlevel Essbase Server operations. Pressing the Enter key in the Agent console provides a list of all
available commands.
Note: The Agent console is available only if Essbase Server is started in the foreground.

Table 16

Essbase Server Agent Commands

Commands

Description

START appname

Starts the specified application.

STOP appname

Stops the specified application.

USERS

Displays a list of all users that are connected to Essbase Server. The total number of
connections is displayed, as well as the number of ports available.

LOGOUTUSER user

Disconnects a user from Essbase Server and frees a port. This command requires the
Essbase Server system password.

PASSWORD

Changes the system password that is required to start Essbase Server.


This command requires you to enter the old Essbase Server system password.

VERSION

Displays the Essbase Server software version number.

HELP

Lists all valid Agent commands and their respective functions.

PORTS

Displays the number of ports that are installed on Essbase Server and how many are in
use. Number of available ports = number of licensed ports + 1 system administrator
port.

DUMP filename

Dumps information from the Essbase Server security system to a specified file in text
format. If you do not supply a path with the file name, the file is saved to the
$ARBORPATH/bin directory.
This command requires the Essbase Server system password.

QUIT and EXIT

Shuts down all open applications and stops Essbase Server.

To learn more about the Agent, see Running Essbase Servers, Applications, and Databases in
the Hyperion Essbase System 9 Database Administrators Guide.

Using Essbase Server Agent Commands

59

Shutting Down Essbase Server


To shut down Essbase Server when it is running in the foreground, enter EXIT.
To shut down Essbase Server from the Administration Services Console, right-click the server
node and select Stop.
To shut down Essbase Server from any terminal connected to it, use the SHUTDOWNSERVER
command in ESSCMD.
For more information about starting and stopping Essbase Server, applications, and processes,
see the Hyperion Essbase System 9 Database Administrators Guide.

60

Configuring and Setting Up Essbase

Chapter

Installing Essbase Clients

6
This chapter describes how to install Essbase Spreashsheet Add-in for Excel, Runtime Client,
and Application Programming Interface (API).

In This Chapter

Installing Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62


Installing Application Programming Interface (API) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Installing Essbase Spreashsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Installing Essbase Clients

61

Installing Runtime Client


The Essbase Runtime Client enables you to run API programs on computers on which Essbase
Server is not installed.

Before Installing
Before installing, ensure the computer on which you are planning to install Runtime Client
meets the system requirements. See Planning the Essbase Installation on page 15.

Running the Client Installation Program


See Running Essbase Installation Programs on page 37 and Client Installation Program on
page 39.

Installing the 32-bit Runtime Client on a 64-bit Windows


Platform
To install and use the 32-bit Runtime Client on a 64-bit Microsoft Windows machine:
1 Make a note of the value of the system environment variable HYPERION_HOME.
2 Run the 32-bit client installation program on the 64-bit machine from a command prompt or
other shell window where you have changed HYPERION_HOME to a value that does not conflict
with existing Essbase 64-bit client or server installations.
3 Do not let the installation program update the system PATH and ARBORPATH.
4 After the 32-bit client installation is completed, restore the system environment variable
HYPERION_HOME to the value noted in Step 1.
5 When running the precompiled 32-bit client program on the 64-bit machine, run it from a
command prompt or other shell window where ARBORPATH is set to the installation directory
of the 32-bit Runtime Client, and PATH is set to include the bin subdirectory under the
ARBORPATH directory.
For information on Application Programming Interface and Runtime Client, see the Essbase
API Reference. Also see API Support on 64-Bit Platforms on page 82.

Directories and Files Installed


When you install Runtime Client, the installation program creates directories under the
ARBORPATH directory.
Note: Installing Runtime Client does not create files under the HYPERION_HOME directory.

62

Installing Essbase Clients

Installing Application Programming Interface (API)


API is an interface between your custom client program and Essbase Server.

API Compatibility on 32-Bit and 64-Bit Platforms


Essbase provides APIs for 32-bit and 64-bit platforms, which you can use to write and compile
client programs that interface with Essbase Server.

Client programs developed on 32-bit platforms using the Essbase C API or Visual Basic API
can run on 32-bit platforms and connect to either 32-bit or 64-bit Essbase Servers.

Client programs developed on 32-bit platforms using the Essbase Visual Basic API can run
on 64-bit Windows platforms and connect to 64-bit Essbase Server, as long as the 32-bit
runtime environment is set up as according to the instructions in the following topic,
Installing the 32-bit Runtime Client on the 64-bit Windows Platform.

Client programs developed on 64-bit platforms using the Essbase C API:

Can run on 64-bit platforms and connect to 64-bit Essbase Servers

Cannot be run on 32-bit platforms and cannot connect to 32-bit Essbase Servers

Note: Client programs developed on 64-bit platforms do not require the #pragma directive
to set the byte alignment.

You cannot develop a client program on 64-bit Windows using the Essbase Visual Basic
API.

The following table summarizes the compatibility of client programs developed with Essbase
APIs:
Client Development:
Platform with API Version

Platform on which Client


Can Run

Essbase Server: Platforms to which Client Can


Connect

32-bit C API

32-bit

32-bit, 64-bit

32-bit VB API

32-bit Windows

32-bit, 64-bit

64-bit Windows

64-bit

64-bit

64-bit

64-bit C API

For information on the compatibility of 32-bit and 64-bit Hyperion clients and servers with
Essbase Server, see 32-Bit and 64-Bit Client and Server Compatibility on page 24.

Before Installing
Before installing, be sure the computer on which you are planning to install API meets the
system requirements. See Planning the Essbase Installation on page 15.

Installing Application Programming Interface (API)

63

Running the Client Installation Program


When running the client installation program on Windows systems, API can be installed
choosing the Typical or Custom installation option.
See Running Essbase Installation Programs on page 37 and Client Installation Program on
page 39.

Directories and Files Installed


For a listing of files supplied with or required by API to compile programs, see the Essbase API
Reference.

Setting the Environment


Add the lib and include directories to the PATH statement. For example, if you installed
Essbase to the default directory, add the following text to the PATH statement:
c:\hyperion\AnalyticServices\api\lib
c:\hyperion\AnalyticServices\api\include

See the Essbase API Reference for information on the files required to compile, link, and
distribute your programs.

Installing Essbase Spreashsheet Add-in for Excel


Essbase Spreashsheet Add-in for Excel enables multiple users to simultaneously access and
update data on Essbase Server. The Essbase menu, which is added to the Excel menu bar,
includes advanced commands such as Connect, Pivot, Drill-down, and Calculate.

Before Installing
Before installing Spreadsheet Add-in:

Ensure the computer on which you are planning to install Spreadsheet Add-in meets the
system requirements.
See Planning the Essbase Installation on page 15.

Verify a supported version of Microsoft Excel is installed.


The Spreadsheet Add-in installation program checks for an Excel installation and the
version.

Running the Client Installation Program


See Running Essbase Installation Programs on page 37 and Client Installation Program on
page 39.

64

Installing Essbase Clients

Directories and Files Installed


When you install Spreadsheet Add-in, some or all of the directories described in Table 17 are
created under the ARBORPATH directory.
Table 17

Spreadsheet Add-in Directories in the ARBORPATH Directory

Directory

Created During

Contains

bin

Essbase Server and client


installations

Essbase program files for running Spreadsheet Add-in.

client

Essbase Server and client


installations

The installation program adds essexcln.xll to Microsoft Excel to point


Excel to the correct bin directory.
Essbase sample spreadsheets, which reside in client\sample.
If you create applications and databases and store them locally, they reside in
the following directory structure:
client

appname
dbname
where appname is the name of the application and dbname is the name of the
database.
hve

Spreadsheet Add-in
installations

Help files for Oracles Hyperion Essbase Visual Explorer.

locale

Essbase Server and client


installations

Character-set files necessary for Essbase Server supported languages. See


ESSLANG Variable on page 32.

UninstallClient

Essbase client installations

Uninstall program files for client components.

Note: When Spreadsheet Add-in is installed, internal files used by the installation program are installed in the
HYPERION_HOME directory. Third-party products are not installed with Spreadsheet Add-in.

Note: Do not move, rename, or delete the UninstallClient folder. Do not rename the AnalyticServices
directory, or any subdirectories or files beneath it. Modifying installed Essbase files and directories prevents them
from being successfully uninstalled.
To move Essbase to another directory or revert to an earlier release, you must first completely uninstall the
instance. See Chapter 9, Uninstalling Essbase.

(Optional) Registering
Registering Essbase Spreashsheet Add-in for Excel adds entries for Spreadsheet Add-in in the
Windows registry for Excel.
Registering Spreadsheet Add-in is optional. If you experience problems using Spreadsheet
Add-in and it has not been registered, we recommend registering it.
Once registered, unregistering Spreadsheet Add-in clears the Spreadsheet Add-in entries in the
Excel registry.

Installing Essbase Spreashsheet Add-in for Excel

65

To register Spreadsheet Add-in:


Select Start > Programs > Hyperion > Essbase Client > Register Spreadsheet Add-in.

To unregister Spreadsheet Add-in:


Select Start > Programs > Hyperion > Essbase Client > Unregister Spreadsheet Add-in.

(Optional) Installing the Essbase Toolbar


Essbase Spreashsheet Add-in for Excel provides a toolbar with most of the common
Spreadsheet Add-in commands available from the Essbase menu. The toolbar must be
explicitly installed by opening an Excel file provided in the default Essbase installation.

To install the Essbase toolbar:


1 Start Excel.
2 Select File > Open.
3 From the \AnalyticServices\client\sample directory, open the esstoolb.xls file.
Depending on how Spreadsheet Add-in was installed on your computer, this XLS file may not
be available or may be located in a different directory. Contact your Essbase system
administrator if needed.
A blank spreadsheet is displayed, similar to the one shown in Figure 1.

Figure 1

esstoolb.xls File

Note: If two dialog boxes display in sequence when opening the XLS file, click Enable Macros on the first and OK on the
second.

4 Select File > Close to close the XLS file.


You do not need to modify or save the file.
Note: You must have toolbars enabled in Excel to see the Essbase toolbar. If you delete the Essbase toolbar in Excel and
want to use it later, you must re-install it.

For information on using the toolbar or enabling toolbars in Excel, see the Essbase Spreadsheet
Add-in for Excel Users Guide.

66

Installing Essbase Clients

Troubleshooting
You should know how to use the Microsoft Excel Add-ins command to add the Spreadsheet
Add-in for Excel file (essexcln.xll), which is located in the bin directory.
If the Spreadsheet Add-in is not properly installed or configured, follow these troubleshooting
guidelines:
1. Reboot the computer.
2. Check the environment.
See Checking the Environment on page 67.
3. Remove and manually add Spreadsheet Add-in.
See Removing and Manually Adding the Spreadsheet Add-in on page 68.
4. Verify that Trust all installed add-ins and templates is selected.
See Verifying the Macro Security Level in Microsoft Excel on page 68.
5. Install Spreadsheet Add-in again.
See Re-installing Spreadsheet Add-in on page 68.
Note: essxleqd.xla is an additional file for Essbase Query Designer for Excel. This add-in, which loads
automatically when Query Designer is started, enables Excel and Query Designer to synchronize workbook and
worksheet operations, including creating, deleting, and moving workbooks.

Checking the Environment


If you encounter a file not found message, check the PATH and ARBORPATH environment
variables.

To check the PATH and ARBORPATH settings:

At a command prompt, enter PATHEnsure the Essbase bin directory is in the PATH
statement. For example:
AnalyticServices\bin

At a command prompt, enter SETEnsure the ARBORPATH setting indicates the drive and
directory you specified during installation. For example:
ARBORPATH=C:\HYPERION\AnalyticServices

Installing Essbase Spreashsheet Add-in for Excel

67

Removing and Manually Adding the Spreadsheet Add-in


If problems persist, or the Spreadsheet Add-in startup screen does not display when you start
Microsoft Excel, remove Spreadsheet Add-in from Excel, exit and restart Excel, and manually
add the Spreadsheet Add-in.

To manually add Spreadsheet Add-in:


1 In Excel, select Tools > Add-Ins.
2 Click Browse to select essexcln.xll in the BIN directory where Spreadsheet Add-in is installed.
3 Click OK.
4 From the Windows Desktop, select Start > Programs > Start Spreadsheet Add-in.
Verify the Essbase menu appears in the Excel menu bar.

Verifying the Macro Security Level in Microsoft Excel


In Microsoft Excel, if the macro security level is set to high and Trust all installed add-ins and
templates is not selected, you wont see the Spreadsheet Add-in Essbase menu.

To verify the macro security level:


1 In Excel, select Tools > Macro > Security.
2 In the Security Level tab, verify your security setting.
If it is High, go to the next step.

3 Select the Trusted Sources tab.


4 Ensure Trust all installed add-ins and templates is selected.
5 Click OK.

Re-installing Spreadsheet Add-in


If the Essbase menu does not display in Excel or you encounter error messages, uninstall
Spreadsheet Add-in, and run the installation program again (accept the default settings).

68

Installing Essbase Clients

Chapter

Setting Up the Sample


Applications

Read this chapter for information on setting up Essbase sample applications.

In This Chapter

About Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70


Loading Sample Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Providing User Access to Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Preparing the Aggregate Storage Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Preparing the Partitioning Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Setting Up the Sample Applications

69

About Sample Applications


The Essbase Server installation includes sample applications that are designed to familiarize
you with Essbase features. Each application contains one or more databases and each database
has an associated data load file:
Table 18

Sample Databases and Data Load Files

Application

Database

Data Load File

Sample

Basic

Calcdat.txt

Interntl

Currcalc.txt

Xchgrate

Rates.txt

Basic

Data.txt

Company

Calccomp.txt

East

Calceast.txt

Basic

Calcdat.txt

Basic

dmdemo.txt

Sample

dataload.txt*

The Interntl and Xchgrate databases demonstrate Essbase Currency


Conversion features.

Demo
See the Essbase Technical Reference and documentation for Essbase
Report Writer.
Samppart
Demonstrates Essbase Partitioning features.
See Preparing the Partitioning Applications on page 73.
SampEast
Demonstrates Essbase Partitioning features.
See Preparing the Partitioning Applications on page 73.
Sample_U
Contains a Unicode-mode version of the Basic database in the
Sample application, which includes alias tables in English and four
other character sets. Characters in this application are encoded in
UTF-8.
DMDemo
Demonstrates Data Mining features.
ASOsamp
Demonstrates aggregate storage database features.

* The ASOsamp database must be loaded using the dataload.rul rules file. The other samples do not require a rules file.

Note: Depending on your Essbase purchase agreement, only the Sample, Demo, and Sample_U applications might be
installed.

70

Setting Up the Sample Applications

Loading Sample Databases


Before you can use a sample application, you must load data into it.
Note: Before loading data into the Partitioning sample databases, first create a partition user or other username. See
Preparing the Partitioning Applications on page 73.

To load data into a sample database:


1 Open the Administration Services Console.
2 From Enterprise View or a custom view, navigate to the appropriate Essbase Server, application, and
database.

For example:
Essbase Servers > myserver > Applications > Sample > Basic

3 Right-click the database and select Load data.


4 Set the Data Load options.
For

Do

Data Source Type

Select Data file.

Mode

Select a mode:
Load only: Performs a data load.
Build only: Performs a dimension build.
Both: Performs both a data load and a dimension build.

Data Source

Click Find Data File. In the Essbase Server tab, navigate to the correct data source.
For Files of Type, ensure Data files (*.txt) is selected. Click OK.
See About Sample Applications on page 70.

Rules File

If the data source requires a rules file, click Find Rule File. In the Essbase Server tab,
navigate to the rule file. For Files of Type, ensure Rules file (*.rul) is selected. Click
OK.
Note: The ASOsamp database must be loaded using the dataload.rul rules file. The other
samples do not require a rules file.

5 Click OK.
When the data load is completed, the dialog box shown in Figure 2 displays.

Loading Sample Databases

71

Figure 2

Message: Essbase Finished Loading CALCDAT Data File

Providing User Access to Sample Applications


Essbase provides a comprehensive security system for a secure multiple-user environment. By
default, the sample applications are created with a security access level of None, which means
that no user can connect to the sample databases unless the user is defined as an administrator.
The system administrator, defined when installing Essbase, automatically holds administrator
privileges. Therefore, the system administrator can make the sample applications available to
other users.

To provide all users with Write access to a sample application:


1 Log on to Administration Services Console using the system administrator account.
2 From Enterprise View, find the appropriate Essbase Server and application.
3 Right-click the application and select Edit properties.
4 In Application Properties, select the General tab.
5 For Minimum access level, select Write.
For example, if you want all users to have at least Write access to all databases in the
application (meaning that all users can update data values), select Write.

6 From the Minimum Database Access group, select the Write option.
7 Click Apply.
8 Repeat this procedure for each database.
The selected application is ready for use. If you want to provide access to another application,
repeat the procedure. If you want to use the Partitioning applications, turn to Setting the
Environment on page 73. If you do not want to use the partitioning applications, the next step
might be to create the appropriate user names to enable users to log on to Essbase. See the
Hyperion Essbase System 9 Database Administrators Guide.

72

Setting Up the Sample Applications

Preparing the Aggregate Storage Application


To prepare the sample aggregate storage application for use, you need to load data and then
precalculate and store aggregations for the database.
To load data, use the following data and rules files:
ARBORPATH\app\ASOsamp\Sample\dataload.txt
ARBORPATH\app\ASOsamp\Sample\dataload.rul

For instructions on loading data to aggregate storage databases, see the Hyperion Essbase
System 9 Database Administrators Guide and Essbase Administration Services Online Help.
After the data load is complete, precalculate aggregations on the database to improve retrieval
times. To precalculate aggregations, use Aggregation Design Wizard in Administration
Services or the MaxL execute aggregate process statement. See the Essbase Administration
Services Online Help or the MaxL section of the Essbase Technical Reference.
Note: To use the aggregate storage sample application, the essbase.jar file must be in the /java directory of
your Essbase installation.

Preparing the Partitioning Applications


Setting the Environment
Essbase includes two sample applications and databases that demonstrate the features of
Partitioning:

SamppartCompany

SampeastEast

The Partitioning applications and databases include partition definitions stored in .ddb files.
The .ddb files define the map between member combinations in the target database,
Company, and the source database, East. The Hyperion Essbase System 9 Database
Administrators Guide describes Partitioning, member combinations, and the differences
between target and source databases.
For the Partitioning applications to work in your environment, you may need to create a user
named partitionuser, or you may need to change the embedded usernames in the .ddb files.
Note: Do not go into the.ddb files to change username information. Instead, complete the steps in the following
topics: Creating the Partition User on page 73 describes how to create the required username, so that users can
use the applications. Changing Embedded User Names in Sample Partition Definitions on page 74 describes
how to change the embedded server name to your server name.

Creating the Partition User


Before you work with the Samppart and Sampeast applications, you may need to create a user
named partitionuser, which must have Application Manager access to both applications.

Preparing the Partitioning Applications

73

To create partitionuser:
1 Log on to Administration Services Console using the system administrator account.
2 In Enterprise View, navigate to the Administration Services Servers node and select the appropriate
Administration Services Server name.

3 Right-click the User node and select Create user.


4 For Create user on Administration Services Server, enter partitionuser for Username.
5 For Password, enter a password.
6 For Confirm Password, enter the password again.
7 For Administrator privileges, select true.
8 Click OK.

Changing Embedded User Names in Sample Partition


Definitions
If you choose not to create partitionuser, you can change the embedded username in the
partition definition files (.ddb) to the username of your choice, as long as that user has
administrator privileges. The .ddb files shipped with Samppart and Sampeast are based on the
server name localhost.

To change the username in the Samppart Company and Sampeast East .ddb files:
1 Open Administration Services Console.
2 In Enterprise View, expand the Applications node and select the Samppart application.
3 Expand the Databases node and select the Company database.
4 Expand the Partitions node and select Source Databases.
5 Under the Source Databases node, double-click servername:SampEast:East [transparent]
The Repair Partition dialog box displays.

6 For Data Source and Data Target, select a username from User list.
7 Enter the password.
8 Click Repair to save your changes.
Note: If, in the Repair Partition dialog box, you changed the username for both the Data Source Group and the Data
Target group, you do not need to repeat this process to change the username in the Sampeast East .ddb file.

74

Setting Up the Sample Applications

Chapter

Configuring Essbase for


Relational Integration

Essbase SQL Interface and Hybrid Analysis are tools you can use to integrate relational
databases and Essbase databases, thereby leveraging the scalability of a relational database with
the conceptual power of a multidimensional database.
This chapter describes the tasks required to configure the computer on which you run Essbase
to enable Essbase SQL Interface and Hybrid Analysis.

In This Chapter

Before Configuring Essbase SQL Interface or Hybrid Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76


Setting Up Essbase SQL Interface or Hybrid Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Additional Essbase SQL Interface Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Additional Hybrid Analysis Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Configuring Essbase for Relational Integration

75

Before Configuring Essbase SQL Interface or Hybrid Analysis


Although Essbase SQL Interface and Hybrid Analysis are separate products with different
functionality, many of the tasks required to configure the computer on which they are used are
the same. Individual tasks are also required for each product.
The files required to use Essbase SQL Interface and Hybrid Analysis are installed during the
Essbase Server installation.
Before configuring Essbase to run Hybrid Analysis or Essbase SQL Interface, consider the
following information:

Essbase Server must be installed.


See Installing Essbase on page 35.

Verify that the system requirements for Essbase SQL Interface and Hybrid Analysis are met.
See Chapter 3, Planning the Essbase Installation.

You may need to configure your data source.


See the Essbase SQL Interface Guide.

Note: Some ODBC drivers and relational data sources that are supported for Essbase SQL Interface are not supported
for Hybrid Analysis. See Chapter 3, Planning the Essbase Installation.

Setting Up Essbase SQL Interface or Hybrid Analysis


For Essbase SQL Interface, the Essbase Server installation program installs Essbase SQL
Interface program files (including esssql.dll) in the ARBORPATH\bin directory.
For Hybrid Analysis, the Essbase Server installation program does not install Hybrid Analysisspecific files. The Integration Services installation program, however, adds files for creating
sample databases. See the Essbase Integration Services Installation Guide.
ODBC driver files are needed for Essbase SQL Interface and Hybrid Analysis. The ODBC
driver files and their corresponding help (.hlp) files are installed in the HYPERION_HOME
directory. See Directories and Files Installed on page 40.

Setting Up Teradata
If the data source for Essbase SQL Interface or Hybrid Analysis is Teradata, verify the:

Teradata server is installed and running.

Environment variables required to run Teradata are set

Connection to Teradata from the Essbase Server computer.

See the Teradata documentation.


See the Essbase Integration Services Installation Guide for information on running Hybrid
Analysis with Teradata.

76

Configuring Essbase for Relational Integration

Additional Essbase SQL Interface Tasks


Before using Essbase SQL Interface to load SQL, relational, or flat-file data:

Configure the ODBC driver to point to the data source.

Verify the connection to the data source (for example, in the Administration Services
Console, use the Data Prep Editor to open the SQL data source file).

Create an Essbase SQL Interface data load rules file for loading SQL data into the Essbase
database.

See the Essbase SQL Interface Guide.

Additional Hybrid Analysis Tasks


Before using Hybrid Analysis:

In the essbase.cfg file, set HAENABLE TRUE.


See the HAENABLE topic in the Essbase Technical Reference for syntax and usage
guidelines.

In the Spreadsheet Add-in, select Essbase > Options. On the Zoom tab, select Enable Hybrid
Analysis.

Ensure the name of the ODBC data sources used to connect to the OLAP Catalog and the
data source database are the same on Essbase Server as those used on Integration Server to
build the outline. The usernames and passwords for connecting to those databases must
also match.

Build the Essbase database with an Integration Services metaoutline that invokes Hybrid
Analysis.
See the Oracles Essbase Integration Services documentation.

Additional Hybrid Analysis Tasks

77

78

Configuring Essbase for Relational Integration

Uninstalling Essbase

Chapter

9
Uninstallation programs are installed in these directories:
ServerARBORPATH\UninstallServer
ClientARBORPATH\UninstallClient
The installation program filename is the same for both the server and client:
uninstall.exe

To run the uninstallation program:

Choose a method:

Launch uninstall.exe

Use Windows Control Panel (Add/Remove Programs)

Caution! You must always stop Essbase before uninstalling. If Essbase is running as a Windows service,

be sure to stop the service before uninstalling.

Before uninstalling Essbase Release 6.x, 7.x or 9.x, consider these guidelines:

If you plan to reinstall Essbase, always uninstall the existing version first.

Do not manually delete, move, rename, or alter Essbase files and directories. Such actions
cause problems with uninstalling.

Files in the HYPERION_HOME\common directory are not uninstalled and remain after a
successful uninstallation.
See HYPERION_HOME Variable on page 32.

Uninstalling does not remove or clear the HYPERION_HOME environment variable.

Uninstalling does not remove the app folder, existing applications, or the essbase.sec
and essbase.cfg files.

If you perform multiple Essbase installations on or from the same computer, the
uninstallation program removes only the last installation. When using Windows Control
Panel to uninstall, you may see a prompt about removing shared files, as Essbase products
are uninstalled individually and many Essbase files are shared with other Essbase products.

Uninstalling Essbase

79

For example, essapinu.dll is installed with Essbase Server, client software, and API.
Answering Yes To All makes uninstalling faster and does not disrupt other programs
installed on the computer.

80

Uninstalling Essbase

Chapter

Upgrading Essbase

10
This chapter describes how to upgrade from an earlier release of Essbase to Release 9.2.1 on the
same computer and how to move Essbase applications and databases from one computer to
another.

In This Chapter

Upgrading Essbase to Release 9.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81


Moving Applications and Databases Between Computers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Upgrade Path
All products in release 9.2.1 (Data Integration Management excepted) support upgrades from
7.1.6.x, 9.0.1x and 9.2.

Upgrading Essbase to Release 9.2.1


The following sections describe how to upgrade from an earlier release of Essbase to Release
9.2.1 and describe what occurs during the upgrade process.

Caution! Hyperion recommends that you do a complete, not incremental, backup of all Essbase files and

applications before upgrading. You can then revert to the earlier release if you have problems.

Migration Considerations
This section contains information about differences in behavior between Release 9.2.1 and
previous releases and about dropped features.

Upgrading Essbase

81

Migrating Aggregate Storage Databases to Release 9.x: Query


Performance
Because of improvements in database compression, the database file size after loading data
may be smaller in Release 9.x than in previous releases. As a result, the default aggregation view
selection stopping point may change and fewer views may be selected, possibly resulting in
decreased query performance. When migrating an Essbase database to Release 9.x, verify that
you have the required query performance. If query performance is inadequate, specify an
increased storage limit before you restart the aggregate view selection process.
The storage limit is a factor that Essbase Server considers when it selects the aggregate views to
be included in an aggregation. See the Aggregation Design Wizard topic in the Essbase
Administration Services Online Help, or the Execute Aggregate Process MaxL statement in the
Essbase Technical Reference.

Migrating Users and Groups from Essbase to Shared Services


By default, Essbase Server is in native security mode when installed. To use Shared Services
security, you must migrate Essbase Server and existing Essbase users and groups to Shared
Services. See the Hyperion Essbase System 9 Database Administrators Guide.

Caution! When you migrate to Shared Services, Essbase users and groups are converted to equivalent

roles in Shared Services. Shared Services creates a superuser with the user ID named admin,
which is read-only. If Essbase contains a user ID named admin, that user ID cannot be
migrated to Oracles Hyperion Shared Services. Before migrating, change the admin user
ID (for example, from admin to asadmin). To edit the security file in your Essbase
installation, use Administration Services Console or MaxL.

Upgrading Database Files to 64-bit Essbase


The security file (.sec), block storage data files (.pag and .ind) and aggregate storage data
files (.dat files under the metadata, temp, default, and log) from 32-bit implementations
of Essbase Server cannot be upgraded to 64-bit Essbase Server. To upgrade to 64-bit Essbase
Server, you must recreate the application and database, migrate the outline to the new system,
and then reload the data.

API Support on 64-Bit Platforms


For information on API support on 64-Bit Platforms, see API Compatibility on 32-Bit and 64Bit Platforms on page 63.

Supported API Versions


Programs compiled with Release 9.2.1 Application Programming Interface do not work with
earlier runtime releases.

82

Upgrading Essbase

Essbase API programs compiled with header files from a specific release must use the libraries
from the same release. For example, if the header files are from version 6.2, you cannot use 6.5
run-time libraries. If your header files were from 6.5, you cannot use 7.0 runtime libraries.
Table 19 describes compatibility among API, runtime library, and Essbase Server versions.
Table 19

Compatibility Among API, Runtime, and Essbase Server Versions

API Header Files

Runtime Libraries

Essbase Server

7.0.0

7.0.x

6.5.x (except grid operations)


7.x

7.0.1

7.0.1

6.5.x, 7.x

7.1.x

7.1.x

6.5.x, 7.x

7.1.2

7.1.2

6.5.x, 7.x

9.x

9.x

7.x, 9.x

API Functions That Are No Longer Supported


The following alias combination functions are no longer supported:

EssOtlGetNextAliasCombination()

EssOtlDeleteAliasCombination()

EssOtlAddAliasCombination()

Issues Related to Upgrading Applications That Use APIs


Release 7.1 introduced aggregate storage databases, which support multi-million member
outlines. Compared to block storage databases, the number of members in aggregate storage
databases may be several times larger. As a result, certain precautions are necessary when you
upgrade applications created in a release prior to 7.1 that use APIs that retrieve members from
the server.

Compatibility Between Client and Server Software


Essbase Server Release 9.2.1 provides backward compatibility with earlier clients. This includes
Release 7.x Essbase Spreashsheet Add-in for Excel and MaxL Shell. Release 9.2.1 does not
support Application Manager or any releases prior to 7.x.
Note: For information about release compatibility with Administration Services, see the Essbase Administration Services
Installation Guide.

Upgrading Essbase to Release 9.2.1

83

Input/Output Defaults and Upgrading


Read the following topics before upgrading to learn about the two I/O access modes available,
and about how Essbase databases are affected by an upgrade in terms of cache sizes and the I/O
access modes.

How to Determine Which I/O Access Mode to Use


Buffered I/O uses the buffer cache of the file system.
Direct I/O bypasses the file system buffer cache and provides a faster response time and
potential to optimize cache sizes. If you are upgrading from Release 6.2 or later, your databases
may be using either buffered I/O or direct I/O.
Release 6.5.x, 7.x and 9.x databases use buffered I/O by default, unless essbase.cfg contains
the setting DIRECTIO TRUE. When upgraded to Release 9.2.1, all Release 6.5.x and 7.x
databases use the I/O access mode that was used in that release. The I/O access mode for any
database can be changed, using the database settings.
As of Release 6.5, the access mode specified by DIRECTIO is read only once for each database,
upon upgrade or first creation of a database. Thereafter, the I/O access mode must be changed
per database by using the database settings.
Note: The DIRECTIO setting in the essbase.cfg file is server-wide, and affects all databases.

How to Change or Preserve I/O Access Modes


The I/O access mode is a database setting stored in the Essbase Server security file, rather than
a server-wide.cfg setting affecting all databases. The essbase.cfg configuration-file setting
DIRECTIO TRUE|FALSE is maintained for backward compatibility with Release 6.2. It is also
used to provide a default value for newly created databases and for databases that are upgraded
from an earlier release.
If a DIRECTIO setting exists in the essbase.cfg file at upgrade time, only newly created or
upgraded databases are affected by the setting. Essbase Server reads the I/O access mode
specification from essbase.cfg once for each database and copies the information to the
Essbase Server security file (essbase.sec). Thereafter, if you want to change the I/O access
mode used by any database, you must change it at the database level by using the database
setting.
The I/O access mode can be set from Administration Services Console, MaxL (alter database
set io_access_mode), or programmatically using the Essbase Application Programming
Interface. See the Essbase Administration Services Online Help, the Hyperion Essbase System 9
Database Administrators Guide, the MaxL documentation in the Essbase Technical Reference,
or the Essbase API Reference.
If you set a database to use direct I/O, Essbase attempts to use direct I/O the next time the
database is started. It stores the I/O access mode that you selected as a setting in the security file
and attempts to use that access mode. If direct I/O is not available on the platform at the time
the database is started, Essbase uses buffered I/O, which is the default.

84

Upgrading Essbase

How Cache Sizes Are Affected by Upgrades


When you upgrade, the cache sizes for existing databases do not change. If you are currently
running Essbase using direct I/O, the cache sizes for existing databases are probably large,
because direct I/O requires large cache sizes. If, after you upgrade, you plan to use the default
Release 9.2.1 I/O access mode (buffered), you should reduce the cache size settings before
upgrading or before you start the upgraded database.
The following list explains default cache sizes for each I/O access mode, for Essbase databases
when upgrading to Release 9.2.1:

The data cache default size is the same for direct I/O and buffered I/O: 3 MB.

The index cache default size is smaller for buffered I/O than for direct I/O: 1 MB for
buffered I/O and 10 MB for direct I/O.

The data file cache default size is 32 MB when direct I/O is used. The data file cache is not
used when buffered I/O is in effect.

The size of index pages is fixed at 8 K, regardless of the I/O access mode. The index page size
is unchangeable.

Note: The default cache size and maximum cache size are different for 64-bit.

To override defaults after upgrading, change the database settings or properties before you
start the upgraded database for the first time.
See the Hyperion Essbase System 9 Database Administrators Guide for information on
buffered I/O and direct I/O.

Upgrading Databases to Release 9.2.1


This section provides information about client-server compatibility and upgrading databases
from Essbase Release 6.x, 7.x to Release 9.2.1.

When Essbase Server Upgrades Files


Essbase Server upgrades a database when the database is started. By default, a database is set to
start when its application starts. The Essbase Server kernel checks for files resulting from
previous unsuccessful upgrades, restarting the upgrade if necessary.
Essbase Server upgrades the essxxxxx.ind, the dbname.esm, and the dbname.tct files
when the database is started. It upgrades the essxxxx.pag file as data blocks are accessed;
hence, the PAG file upgrades when you run the VALIDATE command after starting the
database. After kernel files are upgraded, they are not backward-compatible with the earlier
release.

Upgrading Essbase to Release 9.2.1

85

Upgrading Databases
The following procedure explains how to upgrade to Release 9.2.1 from an earlier release.
After upgrading, you can restore databases from earlier releases of Essbase Server only from
backups. Therefore, be sure to back up databases before starting to upgrade.

To upgrade to Release 9.2.1:


1 Use the alter database validate statement in MaxL against the database.
If the validation returns errors, revert to a backup that is free of errors.

2 Back up all application files, database files, and the security file.
3 Run a full restructure on the database.
4 If you are using LROs in a production environment, run the LISTLINKEDOBJECTS command in ESSCMD.
This command returns a list of LROs contained in the databases.

5 Stop the Essbase Server.


6 If you are installing over an existing Essbase installation, uninstall the existing release before installing
9.2.1.

Uninstalling does not remove the app folder, existing applications, or the essbase.sec and
essbase.cfg files. See Uninstalling Essbase on page 79.

7 Install Essbase Release 9.2.1 to the same directory as the earlier Essbase installation.
8 Start the Essbase Server Agent (essbase.exe ).
If you want to change database settings, this step is a convenient point at which to do so. If you
change the settings now, you do not have to restart the database to make the settings effective.
See Input/Output Defaults and Upgrading on page 84.

9 Select a database or load an application.


10 Use the alter database validate statement in MaxL against the upgraded database.
11 If the validation returns only LRO-related errors to the log file after upgrading, you must restore data from
the earlier backup and re-create the LROs:

a. Either restore data from a backup of the database that does not contain LROs, or load from
a database export.
b. Restart the database in Essbase Release 9.2.1.
Essbase upgrades the database to Release 9.2.1 format, if the database is restored.
c. Validate the database using alter database validate.
d. Re-create the LROs, using the LISTLINKEDOBJECTS output as a guide. You may need to
manually review the output from LISTLINKEDOBJECTS to verify its completeness.

12 Upon successful completion, unload the database and then back up the Release 9.2.1 database files.
13 Repeat the procedure for each database that you want to upgrade.

86

Upgrading Essbase

Moving Applications and Databases Between Computers


This topic describes how to move existing Essbase applications and databases from one Essbase
computer to another (for example, from a development server to a production server).

To move an application to a different computer:


1 Use the alter database validate statement in MaxL against the database or databases that you are
moving.

If the validation returns errors, revert to a backup that is free of errors.

2 Back up all application files, database files, and the security file on the source Essbase Server computer
(that is, the server computer from which you are moving).

3 Install Essbase on the target server computer.


4 Copy (using the file system) the essbase.cfg file from the AnalyticServices\bin directory on
the original Essbase Server computer to the same directory on the new Essbase Server computer.

5 On the target Essbase Server computer, define disk volumes.


To allocate a new volume, use the alter database statement in MaxL.
Consider carefully how you configure the disk volumes. Any changes that you make to disk
volumes settings after you have loaded data on the target Essbase Server computer are reflected
only in new data loads; changes are not retroactive.

6 Use the Migration Wizard in Oracles Essbase Administration Services to move the application to the
target Essbase Server computer.
Note: For important information about what information is migrated with applications, see Migration Wizard in
Essbase Administration Services Online Help.

The names of the applications and database that you create do not need to be the same as the
ones on the source server computer. However, if you make changes to the names, make sure
that these changes are reflected as necessary in script files, spreadsheet macros, and API-based
applications. In addition, make sure the these changes are clearly communicated to the user
base.

Caution! Do not move the application directory to the new server computer through a file transfer

through the operating system, or through FTP.

7 Using the file system or FTP, move files that are not Oracles Hyperion Essbase System 9 files (such as
ESSCMD or MaxL scripts) to the target server computer.
Note: MaxL includes an ESSCMD-to-MaxL script conversion utility. See the MaxL DDL section of the Essbase Technical
Reference.

Moving Applications and Databases Between Computers

87

8 Export data from the application on the source server computer by either:

Choosing All Data, Input Level Data, or Level 0 Data, depending on the size of the data set
and how the database was initially loaded.

Using the initial data load files that were used to populate the database on the source
server.

9 Import data to the target application on the target server computer.


10 Recalculate the database if any of the following conditions apply:

You loaded input-level data from data load files

You exported only partial data from the database (for example, if you chose to load only
Level 0 or Input Level data)

11 Repeat the steps above for all other databases on the source server computer that you want to move to the
target server computer.

Caution! Moving the security file (essbase.sec) and its backup (essbase.bak) between computers

is not recommended nor supported.

88

Upgrading Essbase

Index

Numerics
32-bit
supported ODBC drivers, 28
supported Relational Data Sources, 28
64-bit
Administration Services, supported combinations, 20
Essbase, supported combinations, 20

API directory, server program files, 41


APP directory, 41
application files
default location, 41
stored on client directory, 65
Application Programming Interface (API)
description of, 9
introduction, 9

installing Runtime Client on Windows, 62


supported ODBC drivers, 28
supported Relational Data Sources, 28
upgrading database files to, 82
64-bit Administration Services
Essbase support, 21
64-bit Essbase
Administration Services support, 21

setting up environments, 64
applications
starting automatically on Windows, 52
starting from Agent, 59
stopping, 59
ARBORPATH setting
manually updating
for Windows Service, 53
on Windows platforms, 50

A
about HYPERION_HOME, 32
accessing sample applications, 72
adding
Essbase toolbar, 66
additional Agents, installing, 43
Administration Services. See Essbase Administration
Services
Agent
commands, 59
removing automatic service, 54
stopping automatic service, 54
agent port number, 44
AGENTPORT setting, 44
aggregate storage databases
about, 8
alter database validate statement
upgrading and, 86

automatically entering passwords, 52


automating installation, 42
auto-starting
applications and databases on Windows, 52
Essbase Server as a Windows service, 53
Essbase Server when Windows starts, 51
available ports, displaying, 59

B
backup
before upgrading, 81
complete, 81
incremental, 81
backup files, 42
BIN directory
client files, 65
server files, 41

Index Numerics

89

enabling, 54, 56

block storage databases


about, 8
buffered I/O, and upgrading, 84

C
cache sizes
defaults, 85

JVMMODULELOCATION required, 54, 56


data mining, sample application, 70
data source, Hybrid Analysis, 77
database files, 65
databases
default location, 41
preparing Sample Basic, 71

I/O access mode, 85

sample. See sample databases

changing
embedded server names, 74
environment settings
manually on Windows, 50
partition definition files, caution, 73

starting automatically on Windows, 52


upgrading, 85
DDB (.DDB) files
caution for changing, 73
changing server names, 74

passwords, 59
server names, in sample partition definitions, 74
changing HYPERION_HOME, 43
character-set files, 41
checklist, installation, 12
client and server compatibility, 83
client directory, 65
client software, directories created, 65
closing Essbase Server See quitting, from Agent
commands, Agent, 59
common components, 40
common directory, contents of, 40
Company database, 70
compatibility
between client and server, 83

storage for partition definitions, 73


default port numbers, application servers, 25
deleting. See removing
deployment example, 26
DEPLOYMENTID setting, 44
direct I/O, and upgrading, 84
directories
BIN, 65
cautions against moving/renaming, 65
client, 65
created
Runtime Client, 62
Essbase Spreadsheet Add-in for Excel, 65
Java, 41
locale, 41

components
Application Programming Interface (API), 9
Essbase Server, 8
Essbase Spreadsheet Add-in for Excel
runtime client, 8
sample applications, 8
connections
displaying, 59
troubleshooting, 34
console commands, 59
copying applications or databases. See migrating across
servers
Currency Conversion, sample databases for, 70
custom installation, 37

moving/renaming (caution), 65
directories installed, 40
disk array, supported, 34
displaying
Essbase toolbar, 66
server information, 59
DMDemo application, introduced, 70
documentation, installing, 55
downloading the installer, 37
DUMP command (Agent), 59
dynamic-link libraries (DLLs)
network protocols, 42

E
D
Data Mining

90

Index C

East database, 70
embedded server names, changing, 74

described, 32

environment
API installations, 64
ESSLANG, described, 32
HYPERION_HOME, 40
manually updating, on Windows environment
variables, See environment
sample applications, 73
updating on Windows platforms, 50
error messages
when starting Windows server, 50
Essbase
components of, 8
description of, 8

matching for client and server, 33


essnetu.dll file, 42
esssql.dll file, 76
esstoolb.xls file, 66
example applications. See sample applications
example spreadsheets. See sample spreadsheets
EXIT command (Agent), 59
exiting, Agent using EXIT command, 59

F
files
cautions against moving/renaming, 65

hardware requirements, 16

default locations, 40

introduction, 8

Essbase client program files, 65

Essbase Administration Services


creating partition user, 74

Essbase Server program files, 41

Essbase Server
changing names in partition definitions, 74

in BIN directory, 65

Essbase Spreadsheet Add-in for Excel, 65


language support, 41

installation process, 36

moving/renaming (caution), 65

installing, 35

network protocol, 42

installing multiple instances on Windows, 44

security files, 42

quitting from Agent, 59


starting
automatically on Windows, 51
on Windows, 50
Essbase Spreadsheet Add-in for Excel
description of
enabling for Hybrid Analysis, 77
installing, 64
introduction
program files, 65
troubleshooting, 67
Essbase Toolbar, installing, 65 to 66
essbase.bak, backup file, 42
essbase.exe program file, 51, 59
essbase.pm,location of, 41
essbase.sec file
backup of, 42

SQL Interface, 76
files installed, 40
FTP and migration, 87

H
HAENABLE, 77
hardware requirements, 16
for Windows, 16
HELP command (Agent), 59
Hybrid Analysis
enabling, 75
enabling Essbase Spreadsheet Add-in for Excel, 77
OLAP Catalog
data source, 77
Hyperion Configuration Utility
custom tasks, 46

ESSLANG considerations, 33

described, 46

migrating and, 88

launching, 47

security file, 42

log file, 49

essexcln.xll file
description, 65

order of tasks, 46

ESSLANG environment variable, 33, 41

reconfiguration, 49

prerequisites, 46

Index F

91

Shared Services deregistration, 49

Shared Services registration, 48

java directory, 41
Java Runtime Environment (JRE) requirements. See Java
requirements
JDK requirements. See Java requirements
JVMMODULELOCATION, setting, 54

task list, 46
troubleshooting, 49
upgrades and, 47
Hyperion Home location, 32
Hyperion Home migration utility, 43
Hyperion Home Tool, 43
Hyperion License Server, 9
Hyperion security platform. See security platform
HYPERION_HOME
files installed in, 40
moving, 43
understanding, 32
uninstallation and, 79
Hyperion_Home setting, 32

I
I/O access mode
cache sizes, 85
changing, 84
preserving, 84
I/O, and upgrading, 84
INCLUDE, setting in Path statement (API), 64
index page size, default, 85
installation
planning, 15
sample applications, 69
what happens during, 39
installation checklist, 12
installation sequence, 12
installer program, launching, 37
installers, 36
installing
client software,Essbase Spreadsheet Add-in for Excel,
64
documentation, 55
Essbase Server, 35 to 36
Essbase Spreadsheet Add-in for Excel, 64

L
launching
installer program on UNIX, 37
installer program on Windows, 37
LIB setting in Path statement (API), 64
License Server, 9
linked objects
upgrading and, 86
VALIDATE and, 86
loading data to sample databases, 71
local client installations, directories created, 65
locale directory and, 41
locale directory, description, 41
localhost server name, 74
LOGOUTUSER command (Agent), 59

M
managing, 33
managing ESSLANG settings, 33
MaxL Perl Module, installation location, 41
Microsoft SQL Server. See SQL Server
migrating across servers
procedure for, 87
using Administration Services, 87
migrating and FTP, 87
migrating users and groups to Shared Services, 82
migration utility, 43
moving applications or databases. See migrating across
servers
moving files and directories, 65
moving HYPERION_HOME, 43
multiple instances of Essbase, 43

Essbase Toolbar, 65 to 66
Integration Services
supported data sources, 29
supported ODBC drivers, 29
Interntl database, sample, 70

92

Index I

N
network protocols
files installed, 42
non-Unicode-enabled client
ESSLANG requirements, 33

Administration Services, 17

OLAP Catalog, 77
OLAP Server. See Essbase Server
opening sample applications, 71
Oracle E-Delivery
launching the installer from, 37

Administration Services Console, 17 to 18


Analytic High Availability Services, 19
Analytic Services Smart View Provider, 19
Integration Services, 18
Integration Services client, 18 to 19
Smart View client, 19
SQL Interface, 76

P
partition definitions, 73
partition users, creating, 74
partitioning, sample applications, 70
PASSWORD command (Agent), 59
passwords
automatically entering, 52

restoring security settings, 42


running applications
Windows servers, 52
runtime client
description of, 8
installing, 61
installing on 64-bit Windows server, 62

changing, 59

introduction, 8

server startup, 51
PATH setting
Application Programming Interface (API), 64
Perlmod directory, 41
planning the installation, Essbase, 15
port number, agent, 44
port numbers, 25
PORTINC setting, 44
PORTS command (Agent), 59
ports, available, displaying, 59
preparing for installation
Essbase Spreadsheet Add-in for Excel, 64
prerequisites. See requirements
program files
Essbase Spreadsheet Add-in for Excel, 65
location of, 65

S
Sampeast application
changing server names, 74
creating partition user, 74
setting up environments, 73
sample applications
accessing, 72
assigning access privileges, 72
description of, 8
included, 70
introduced, 70
introduction, 8
licensing restrictions, 70
setting up environments, 73

Q
QUIT command (Agent), 59
quitting Essbase from Agent, 59

R
RDBMS. See relational databases, 7
release compatibility, 81
releases, upgrading, 81
Remove Shared File prompt, 80
removing, the Agent as automatic service, 54
renaming files and directories, 65
requirements

sample databases, loading data, 71


SAMPLE directory, sample spreadsheets, 65
sample spreadsheets, 65
Sample_U application, introduced, 70
Samppart application
changing server names, 74
creating partition user, 74
introduced, 70
setting up environments, 73
security, 42
access to samples, 72
Agent commands, 59
backup files, 42

Index O

93

restoring, 42

security file
backing up and restoring, 42
ESSLANG considerations, 33
migrating and, 88
sequence, installation, 12
server
automating startup, 51
names, changing, 74

Windows servers, 52
STOP command (Agent), 59
stopping Essbase on Windows, 54
support matrix, 19
supported disk array, 34
system passwords
automatically entering, 52
Windows platforms, 51

starting on Windows servers, 50


server installation
UNIX, 35
Windows, 35
SERVERPORTBEGIN setting, 44
SERVERPORTEND setting, 44
service
removing Agent as, 54
stopping Agent as, 54
setting up system environment
to run Essbase as a service, 53
setting up system environment on Windows
JVMMODULELOCATION, 54
shared files, uninstalling, 80
SHUTDOWNSERVER command, 60
shutting down UNIX servers, 60
silent installation, 42
software support for Windows and UNIX, 19
software support, 64-bit, 21
Spreadsheet Add-in See Essbase Spreadsheet Add-in for
Excel
SQL Interface
checking connection, 77
configuring ODBC drivers for, 77
directories and files
on Windows, 76
installion prerequisites, 76
START command (Agent), 59
starting
applications, 59
databases automatically on Windows, 52
Essbase Server
automatically on Windows servers, 51

T
Teradata
connecting to, 76
support, 28
third-party products installed, 40
toolbar (Essbase Spreadsheet Add-in), installing, 66
troubleshooting
connection problems, 34
Essbase Spreadsheet Add-in for Excel, 67
typical installation, 37

U
understanding HYPERION_HOME, 32
Unicode, sample application, 70
Unicode-enabled client, ESSLANG requirements, 33
uninstallation program, location of, 41
uninstalling Essbase
guidelines, 79
instructions, 79
UNIX servers
shutting down, 60
updating environments
Windows, 50
upgrading, 81
and I/O, 84
databases, 85
procedure for, 86
USERS command (Agent), 59
users, logging off, 59
UTF-8 encoded sample application, 70

on Windows, 50
startup errors
Essbase Spreadsheet Add-in for Excel, 67
Windows server, 50
startup settings

94

Index T

V
VALIDATE command
linked objects and, 86

verifying
Essbase Agent running as a service, 53
VERSION command (Agent), 59
version compatibility, 81
versions, upgrading, 81
viewing
Essbase toolbar, 66
server information, 59

W
Windows platforms
API environment setup, 64
automating server startup, 51
environment, manually updating, 50
installing additional instances of Essbase, 44
Windows Service
starting, 53
stopping, 54

X
Xchgrate database, introduced, 70

Index W

95

96

Index X

Você também pode gostar