Hyperion Essbase – System 9 Installation Guide, 9.3.1

Hyperion Essbase – System 9 Installation Guide, 9.3.1
HYPERION® ESSBASE® – SYSTEM 9
RELEASE 9.3.1
INSTALLATION GUIDE FOR WINDOWS
Essbase Installation Guide for Windows, 9.3.1
Copyright © 1998, 2008, Oracle and/or its affiliates. All rights reserved.
Authors: Essbase Information Development
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
About Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Spreadsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Application Programming Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 2. Planning the Essbase Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Essbase Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
License Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
32-Bit and 64-Bit Client and Server Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Essbase Deployment Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About Hyperion Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Hyperion Home Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ESSLANG Value Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Managing ESSLANG Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
About the Security File and ESSLANG Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Disk Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 3. Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Preparing to Install Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
About Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Running Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Specifying Directory Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Server Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Understanding Installation Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Contents
iii
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Network Protocol Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Running Silent Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Changing the Hyperion Home Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Installing Additional Instances of Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 4. Configuring and Setting Up Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Hyperion Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Task Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Restricted Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Satisfying Initial Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configuring Product Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring Essbase as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Registering With Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Deregistering Products with Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Reconfiguring Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Registering Merant ODBC Drivers on 64-bit Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Updating the Environment Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Starting Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Starting Essbase Server Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Automating Essbase Server Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Automating Application or Database Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Starting Essbase Server from Administration Services Console . . . . . . . . . . . . . . . . . . . . . 33
Running Essbase Server as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Setting System Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Verifying Essbase Server Is Running as a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Stopping the Essbase Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Removing the Essbase Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Setting JVMMODULELOCATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Configuring SAP for Single Sign-on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Using ESS_JVM_OPTION and ESS_CSS_JVM_OPTION . . . . . . . . . . . . . . . . . . . . . . . . 36
Changing the Location of Shared Services Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Verifying Startup Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Starting and Stopping Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Starting Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Verifying Successful Startup of Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Stopping Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
iv
Contents
Using Essbase Agent Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Shutting Down Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Chapter 5. Installing Essbase Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installing Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Preparing to Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installing the 32-Bit Runtime Client on a 64-Bit Windows Platform . . . . . . . . . . . . . . 41
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Installing Application Programming Interface (API) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
API Compatibility on 32-Bit and 64-Bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Preparing to Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Installing Essbase Spreadsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Preparing to Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Registering Essbase Spreadsheet Add-in for Excel(Optional) . . . . . . . . . . . . . . . . . . . 45
Installing Essbase Spreadsheet Add-in Toolbar (Optional) . . . . . . . . . . . . . . . . . . . . . 46
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 6. Setting Up Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
About Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Loading Sample Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Providing User Access to Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Preparing the Aggregate Storage Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Preparing the Partitioning Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Creating the Partition User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Changing Embedded User Names in Sample Partition Definitions . . . . . . . . . . . . . . . 53
Chapter 7. Configuring Essbase for Relational Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Before Configuring Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . 55
Configuring Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Setting Up Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Additional Essbase SQL Interface Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Additional Hybrid Analysis Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Contents
v
Chapter 8. Uninstalling Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 9. Upgrading Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Upgrading Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Upgrading Essbase to Release 9.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Migration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Upgrading Databases to Release 9.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Moving Applications and Databases Between Computers . . . . . . . . . . . . . . . . . . . . . . . . 66
Chapter 10. Installing, Configuring, and Uninstalling Data Integration Management Adapters . . . . . . . . . . . . . 69
Data Integration Management Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Installing Data Integration Management Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Installing Adapters in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Installing Adapters in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Configuring Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Registering Adapters with a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Configuring Hyperion Application Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Configuring JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Uninstalling Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Uninstalling Adapters in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Uninstalling Adapters in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Appendix A. Installing Essbase Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Appendix B. Essbase SQL Interface ODBC Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Essbase SQL Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
32–bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
64–bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Appendix C. Hybrid Analysis, Advanced Relational Access, and Drill-through . . . . . . . . . . . . . . . . . . . . . . . . . 87
Supported Relational Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
vi
Contents
Installation Overview
1
In This Chapter
About Essbase ...................................................................................................................... 7
About Essbase
Oracle's Hyperion® Essbase® – System 9 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 includes these components:
●
Essbase Server
●
Sample applications
●
Runtime Client
●
Essbase Spreadsheet 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 databases—For large-scale, sparsely distributed data that is categorized
into many, potentially large dimensions
●
Block storage databases—For applications that perform interactive planning, allocations,
and sophisticated analytics, such as sales forecast applications or profitability analysis
applications
About Essbase
7
Sample Applications
Essbase Server includes sample applications and databases that demonstrate Essbase features.
See Chapter 6, “Setting Up Sample Applications.”
Runtime Client
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.
Included in the Essbase Runtime Client is the standalone, embedded mode of Java API, which
allows JAPI clients to communicate directly to Essbase Server without requiring Oracle's
Hyperion® Provider Services. High availability and clustering is not available with embedded
Java API. To enable high availability and clustering, you must use Java API with Provider Services.
See the Hyperion Provider Services Installation and Administration Guide.
Essbase Spreadsheet Add-in for Excel
Essbase Spreadsheet Add-in for Excel integrates Essbase with Microsoft Excel. Essbase
Spreadsheet Add-in for Excel adds the Essbase menu to Excel, which 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. Essbase
Spreadsheet Add-in for Excel enables multiple users to access and update data on an 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.
8
Installation Overview
2
Planning the Essbase Installation
In This Chapter
Essbase Requirements ............................................................................................................. 9
License Compliance ................................................................................................................ 9
Ports.................................................................................................................................10
32-Bit and 64-Bit Client and Server Compatibility .............................................................................10
Essbase Deployment Example....................................................................................................10
About Hyperion Home .............................................................................................................11
ESSLANG Variable .................................................................................................................12
Disk Array ...........................................................................................................................13
Upgrading...........................................................................................................................13
Essbase Requirements
For hardware and software system requirements forEssbase, see the Hyperion Installation Start
Here.
For ODBC connectivity requirements for Essbase SQL Interface, see Appendix B, “Essbase SQL
Interface ODBC Connectivity.”
For supported relational databases for Hybrid Analysis, Advanced Relational Access, and Drillthrough, see Appendix C, “Hybrid Analysis, Advanced Relational Access, and Drill-through.”
License Compliance
Hyperion no longer ships or requires Oracle's Hyperion® License Server™ (or standalone license
files) for use with Hyperion products.
To ensure compliance with your license agreement, Hyperion recommends that you implement
an auditing process. In addition, during product configuration with Oracle's Hyperion®
Configuration Utility™, you activate only the features you purchased. For more information,
see “Hyperion License Compliance” in the Hyperion Installation Start Here.
Essbase Requirements
9
Ports
For information on the ports Hyperion products use by default, see the Hyperion Installation
Start Here.
32-Bit and 64-Bit Client and Server Compatibility
Various Hyperion products interface with Essbase. The following table summarizes the
compatibility of 32-bit and 64-bit clients and servers with Essbase Server:
Client
Server
Essbase Server: Platform to which
Client Can Connect
32-bit Administration Services Console
32-bit Administration Server
32-bit, 64-bit
64-bit Administration Services Console
64-bit Administration Server
64-bit
32-bit Integration Services Console
32-bit Integration Server
32-bit , 64-bit
32-bit Integration Services Console
64-bit Integration Server
32-bit , 64-bit
32-bit Oracle's Hyperion® Smart View for
Office
32-bit Provider Services
32-bit, 64-bit
32-bit Oracle's Hyperion® Smart View for
Office
64-bit Provider Services
64-bit
32-bit Administration Services Console
32-bit Provider Services
32-bit, 64-bit
64-bit Administration Services Console
64-bit Provider Services
64-bit
32-bit Java API or XMLA client application
32-bit Provider Services
32-bit, 64-bit
64-bit Java API or XMLA client application
64-bit Provider Services
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 42.
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 company’s environment.
Keep the following considerations in mind as they may affect hardware requirements:
10
●
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 to 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 1
Essbase Installation for up to 150 Users—Hardware Requirements
Hyperion Component
Requirements
Computer 1:
For each computer:
Oracle's Hyperion® Shared Services
❍
Dual Pentium 4, 2 GHz and higher
❍
4 GB RAM
❍
32 GB disk space (after OS installation, 10 GB available)
Computer 2:
Essbase Server
Computer 3:
❍
Essbase Administration Server
❍
Provider Services
Table 2
Essbase Installation for up to 150 Users—Software Requirements
Hyperion Component
Requirements
Computer 1:
See the Hyperion Installation Start Here.
Shared Services
Computer 2:
❍
Essbase Server
❍
Oracle's Essbase® Integration Services
Computer 3:
❍
Essbase Administration Server
❍
Provider Services
About Hyperion Home
When multiple Hyperion products are installed on one computer, common internal and thirdparty components are installed to a central location, called Hyperion Home. The Hyperion
Home location is defined in the system environment variable called HYPERION_HOME.
Hyperion Home Location
The default location for Hyperion Home is C:\Hyperion. When you install, the installer
searches for the HYPERION_HOME environment variable on the computer to which you are
installing.
If the Hyperion Home location was previously defined for another Hyperion product, the
installation uses the previously defined location. The location cannot be changed through the
installer.
About Hyperion Home
11
If the current installation is the first Hyperion installation on the computer, you can specify the
location during installation.
See “Directories and Files Installed” on page 19.
ESSLANG Variable
You must choose the correct ESSLANG setting for programs (such as Essbase and Oracle's
Essbase® Administration Services) 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 computer’s 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.
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 Administrator's 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 Administrator's 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_UnitedStates.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 the ESSLANG variable.
When ESSLANG is not set on a client computer, the computer locale is used for encoding.
Managing 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.
12
Planning the Essbase Installation
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.
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 12.
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
For data storage and binary installation, Essbase supports the use of any disk array device
mounted with a local file system interface (for example, NTFS, HPFS, JFS, VxFS, and UFS). A
disk array mounted using NFS or CIFS is not supported. While these assertions are made in
good faith, certain incompatibilities may exist. If an incompatibility is identified, Hyperion may
experience a delay in reproducing and fixing resultant issues.
Upgrading
If upgrading from a previous release of Essbase, see Chapter 9, “Upgrading Essbase” and the
Essbase readme.
Disk Array
13
If installing Essbase for the first time, see Chapter 3, “Installing Essbase.”
14
Planning the Essbase Installation
Installing Essbase
3
In This Chapter
Preparing to Install Essbase ......................................................................................................15
About Essbase Installation Programs ............................................................................................16
Running Essbase Installation Programs..........................................................................................16
Understanding Installation Operations...........................................................................................19
Running Silent Installations .......................................................................................................22
Changing the Hyperion Home Location ..........................................................................................22
Installing Additional Instances of Essbase Server ..............................................................................23
Preparing to Install Essbase
Review and perform these tasks before installing Essbase.
➤ Before installing Essbase:
1 Verify that all system requirements are met.
See the Hyperion Installation Start Here.
2 Verify that all prerequisites are met.
See the Hyperion Installation Start Here and Chapter 2, “Planning the Essbase Installation” in
this guide
3 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 12.
4 If you are upgrading from a previous release, back up the existing Essbase Server files.
See Chapter 9, “Upgrading Essbase” and the database backup section in the Hyperion Essbase –
System 9 Database Administrator's Guide.
Preparing to Install Essbase
15
Note:
You can then uninstall the existing installation or install the latest release over it. Typically, you
can install Essbase Server without uninstalling the previous release.
5 If you are running Essbase Server as a Windows Service, be sure to stop the service before uninstalling or
reinstalling Essbase Server.
About Essbase Installation Programs
Essbase distribution files are available from the Oracle E-Delivery site (edelivery.oracle.com) or
product DVD.
Essbase includes installation programs for:
●
Server software—Essbase Server, including sample applications
●
Client software—Runtime Client, Essbase Spreadsheet Add-in for Excel, and Application
Programming Interface (API)
Essbase server and client installation programs offer these installation options:
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, which includes embedded Java API
●
Spreadsheet Add-in
●
Application Programming Interface
Allows you to choose which components to install.
When installing client and server components on the same computer, they must be installed in
the same installation (ARBORPATH) directory.
Running Essbase Installation Programs
You can launch the Essbase installation programs from:
16
●
The self-extracting distribution file downloaded from the Oracle E-Delivery site
●
The product DVD
●
Distribution files that have been copied to a network drive
Installing Essbase
Note:
Running Essbase installation programs with Windows Display Properties set to 256 colors is not
supported.
➤ To launch installation programs:
1 Log on to the Oracle E-Delivery (edelivery.oracle.com) site.
2 Navigate to the Essbase product page.
3 Download and then open the self-extracting distribution file.
4 Run the installation programs for your platform.
➤ To launch installation programs from the Essbase DVD:
1 On the DVD, navigate to the appropriate directory for your operating system and platform. For example:
Platform
Directory
Windows
win32
win64
winamd64*
*The
installation program in this directory is for 64-bit Windows running on AMD Opteron or Intel Xeon processors.
2 Select the component directory: client or server.
3 Run the setup.exe installation program.
➤ To launch installation programs from a network location:
1 Navigate to the network location where the distribution files reside.
2 Run the installation programs for your platform.
Depending on whether you are running the server or client installation program, read the
appropriate topic: “Server Installation Program” on page 18 or “Client Installation Program”
on page 18.
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
type a different path. When typing the path, you can use only English alphanumeric characters
and these special characters:
dash ( - ), underscore ( _ ), backslash ( \ ), forward slash ( / ), dot (.), colon ( : ).
The colon character ( : ) is supported only for Windows platforms to specify the drive (for
example, C:\).
Running Essbase Installation Programs
17
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 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 17.
4 For the installation (ARBORPATH) directory, accept the default location or specify a different path.
See “Specifying Directory Paths” on page 17 and “ARBORPATH Directory” on page 20.
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 16.
6 Select whether you want the installation program to update the PATH and ARBORPATH environment
variables.
7 Select a value for the ESSLANG language environment variable.
See “ESSLANG Variable” on page 12.
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 now.
See Chapter 4, “Configuring and Setting Up Essbase” for information on running the Hyperion
Configuration Utility.
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 Hyperion Home directory, accept the default location or specify a different path.
See “Specifying Directory Paths” on page 17.
4 For the installation (ARBORPATH) directory, accept the default location or specify a different path.
See “Specifying Directory Paths” on page 17.
5 For installation type, select Typical or Custom.
18
Installing Essbase
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 16.
6 Select a value for the ESSLANG language environment variable.
See “ESSLANG Variable” on page 12.
7 Review the pre-installation summary information.
8 When the installation program finishes installing files, review the post-installation summary information.
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 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 19.
●
Installs common components to the HYPERION_HOME directory.
See “Directories and Files Installed” on page 19.
●
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 31.
●
Installs DataDirect ODBC drivers to the HYPERION_HOME\common\odbc directory.
●
Installs Essbase Server sample application files to the ARBORPATH\app directory.
●
Installs a TCP/IP network protocol file.
●
(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\common—Additional internal components and third-party products.
●
ARBORPATH directory—Essbase Server components.
Understanding Installation Operations
19
HYPERION_HOME\common
If you choose the Typical installation option when installing Essbase Server, the directories and
files in Table 3, “Common-Component Folders Created in the Common Directory ,” on page
20 are installed in the HYPERION_HOME\common directory.
Table 3
Common-Component Folders Created in the Common Directory
Folder
Contents
config
Hyperion Configuration Utility files
CSS
Files to support Hyperion external authentication
HyperionLookAndFeel
Installer user interface files
JakartaCommons
Common development library files
JDBC
JDBC files
JRE
Java Runtime Environment files
loggers
Files for external authentication logging
ODBC
ODBC drivers
SAP
SAP files
SharedServices
Supporting files for Shared Services
utilities
Utilities to change the location of Hyperion Home and export, import, or validate
provisioning data
XML
Common XML components
Note:
If you perform a Custom installation, some directories are not installed.
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 4 are installed in the ARBORPATH directory.
Table 4
20
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.
Installing Essbase
Directory
Contains
app
Essbase application files, as they are created.
Essbase sample applications and associated databases. See “About Sample Applications”
on page 49.
bin
Essbase Server files.
java
Java software to support the Java-based features of Essbase.
JavaAPI
Files necessary for using embedded Java API, which is installed with Runtime Client.
locale
Character-set files necessary for Essbase 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
12.
migrationutility
Migration utility files
See “Changing the Hyperion Home Location” on page 22.
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
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.
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
Essbase uses TCP/IP network protocol. When installing Essbase Server or client software, a
network protocol file named essnetu.dll is installed in the ARBORPATH/bin directory.
Understanding Installation Operations
21
Running Silent Installations
If you want to automate the process of installing Essbase 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, type:
setup.exe —options—record responsefilename
There is no space between –options–record. 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, type:
setup.exe —options responsefilename —silent
The installation runs in the background.
Changing the Hyperion Home Location
After Hyperion Home is defined through the product installation, you can run a migration utility
to change the Hyperion Home location.
The migration utility moves the files installed in Hyperion Home to the new location and updates
the value of the HYPERION_HOME environment variable.
Hyperion Home Migration Utility is provided with the Shared Services installation.
Note:
For an Apache Tomcat 5.0.28 Windows installation, you can install the Shared Services server
as a Windows service. If you select this option, the Shared Services server is launched
automatically by the service and runs in the background. However, if you change the
HYPERION_HOME location, the Windows service does not automatically start. This problem
occurs because the registry entries for the Windows service retain the old path information. To
solve this problem, you must manually update the location of the Windows service.
22
Installing Essbase
➤ To change the Hyperion Home location:
1 Launch the migration utility:
●
Choose a method:
❍
Select Start > Programs > Hyperion > Foundation Services > Hyperion Home
Migration Utility.
❍
Double-click the run.exe file from <HYPERION_HOME>\common\utilities
\HyperionHomeTool\9.3.1\bin.
❍
From a Windows console, change to <HYPERION_HOME>\common\utilities
\HyperionHomeTool\9.3.1\bin. Then type run.exe -console.
2 Step through the screens, and when prompted, enter the Hyperion Home location or click Browse to navigate
to the preferred location.
Do not choose a HYPERION_HOME location that contains a space character. For example, C:
\Program Files is not acceptable.
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
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 instance’s ARBORPATH\bin directory, add the following settings to the essbase.cfg:
Installing Additional Instances of Essbase Server
23
Table 5
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.
For example: 1478
SERVERPORTBEGIN
First port number that the first server process tries to use to connect.
Default value: 32768
SERVERPORTEND
Highest port number that a server process can use to connect.
Default value: 33768
PORTINC
Increment between port numbers used.
Default value: 1
For example, if SERVERPORTBEGIN is 32470 and PORTINC is 5, Essbase Server first for port
32470. If that port is unavailable, Essbase Server looks for available ports in increments of
5 (for example, 32475 and then 32480) 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.
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%
●
24
Installing Essbase
Starts Essbase Server.
Configuring and Setting Up
Essbase
4
In This Chapter
Hyperion Configuration Utility .....................................................................................................25
Satisfying Initial Requirements ...................................................................................................26
Configuring Product Upgrades ....................................................................................................27
Configuring Essbase ...............................................................................................................27
Configuring Essbase as a Windows Service .....................................................................................28
Registering With Shared Services ................................................................................................29
Deregistering Products with Shared Services....................................................................................30
Reconfiguring Products ............................................................................................................30
Registering Merant ODBC Drivers on 64-bit Windows ..........................................................................30
Updating the Environment Manually .............................................................................................31
Starting Essbase Server ...........................................................................................................31
Automating Application or Database Startup ..................................................................................33
Starting Essbase Server from Administration Services Console ...............................................................33
Running Essbase Server as a Windows Service.................................................................................33
Setting JVMMODULELOCATION ..................................................................................................35
Configuring SAP for Single Sign-on...............................................................................................36
Using ESS_JVM_OPTION and ESS_CSS_JVM_OPTION.........................................................................36
Verifying Startup Dependencies ..................................................................................................37
Starting and Stopping Shared Services..........................................................................................37
Using Essbase Agent Commands ................................................................................................39
Shutting Down Essbase Server ...................................................................................................40
Hyperion Configuration Utility
Hyperion Configuration Utility is a common tool that installs automatically with Hyperion
products. Although you must use it to set up new products that you install, it also enables you
to reconfigure existing products and upgraded products. Configuration involves these tasks:
●
Product option activation — To comply with your license agreement, select the product
features that you are authorized to use.
●
Shared Services registration — To use Shared Services to provision and share users among
Hyperion product applications.
Hyperion Configuration Utility
25
●
Shared Services deregistration — To deregister products from with Shared Services before
upgrading or uninstalling these products.
●
Register Essbase as a Windows service.
Task Sequence
Hyperion recommends that you configure products separately and perform all configuration
tasks. However, you can configure products simultaneously performing all, or specific,
configuration tasks.
Restricted Characters
Only enter alphanumeric, dash (-), dot (.) , underscores (_), and tildes (~) during configuration.
Tildes are only supported on Microsoft Windows. All other characters are not supported.
Troubleshooting
Terminating configuration for one product does not stop the configuration of other products.
All configuration warnings and errors are logged as follows:
Microsoft Windows — <HYPERION_HOME>\logs\config
If you encounter errors, perform these tasks:
●
Configure products individually.
●
See the Hyperion Installation and Configuration Troubleshooting Guide for information about
configuration checks, debugging using logs, troubleshooting methodology, and solutions
to common configuration issues.
Satisfying Initial Requirements
If you are using Hyperion Configuration Utility for the first time, perform these tasks:
Table 6
26
Configuration Requirements
Task
Reference
Satisfy system and product-specific requirements.
“System Requirements” and “Planning Hyperion
Installations” in the Hyperion Installation Start Here
Gather the information you need to configure products.
“Hyperion Configuration Utility Worksheets” in the Hyperion
Installation Start Here
Install, configure, and start the Shared Services server.
Hyperion Shared Services Installation Guide
Configuring and Setting Up Essbase
Configuring Product Upgrades
You can use Hyperion Configuration Utility to configure and reconfigure supported product
upgrades. Note the following:
●
If you upgraded Shared Services, configure it before configuring other products.
●
Configure upgraded products individually.
If you do not want to use Shared Services with the products you are upgrading, select Shared
Services Deregistration during configuration.
Configuring Essbase
Run Hyperion Configuration Utility on the computer hosting the Essbase.
➤ To configure Essbase:
1 Launch Hyperion Configuration Utility as follows:
●
At the end of installation by selecting Launch Hyperion Configuration Utility on the last
panel.
●
Using a method:
On Microsoft Windows:
❍
Select Start > Programs > Hyperion > Foundation Services > Configuration Utility.
❍
Double-click configtool.bat in: <HYPERION_HOME>\common\config.
❍
Change to <HYPERION_HOME>\common\config and type startconfigtool.bat
— console.
2 Select the language in which to configure and click Next.
3 On the Welcome page, click Next.
4 Select the products and the tasks to perform, then click Next.
5 Based on your selection, perform the following tasks, clicking Next between tasks.
Table 7
Configuration Tasks
Selection
Task
Product Options
Select the product features that you are authorized to use based on your purchase
and licensing agreement. See “Hyperion License Compliance” in the Hyperion
Installation Start Here.
During product configuration, Hyperion Configuration Utility copies
registry.properties to <Hyperion_Home>\common\config on the server
on which you ran Hyperion Configuration Utility. After configuration, open this file in
any text editor to confirm and specify which product options are activated. See
“Hyperion License Compliance” in the Hyperion Installation Start Here.
Shared Services Registration
Enter the information in “Registering With Shared Services” on page 29.
Configuring Product Upgrades
27
6 Click Finish.
Configuration time depends on the products and tasks you selected. Progress is recorded in
configtool.log as follows:
<HYPERION_HOME>\logs\config
When configuration finishes, the status of each task is displayed.
If configuration is successful, perform any required post-configuration tasks and start the
product.
If errors display, perform these tasks:
●
Configure products individually and perform tasks separately.
●
See the Hyperion Installation and Configuration Troubleshooting Guide for information
about resolving configuration issues.
7 Important: After you configure each product, you must open registry.properties—in
<Hyperion_Home>\common\config on the server on which you ran Hyperion Configuration Utility—
to review and edit the product options. You must complete this step to ensure you comply with your license
agreement and to activate features you are licensed to use. See “Hyperion License Compliance” in the
Hyperion Installation Start Here.
Configuring Essbase as a Windows Service
Configuring Essbase as a Windows service is an optional task on the configuration task selection
page.
You can use the Hyperion Configuration Utility, at any time, to configure multiple instances of
Essbase as Windows services.
➤ To configure Essbase as a Windows service that starts automatically when you start Windows:
1 Launch Hyperion Configuration Utility.
See “Hyperion Configuration Utility” on page 25.
2 From the list of installed products, select Essbase.
3 From the list of configuration tasks, select Register Essbase Server as Windows Service and click Next.
4 Specify the following information for the Essbase service:
Table 8
Essbase Server Fields
Field
Action Required
Username
Enter the username of the Essbase system administrator.
Note: 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 Essbase to Shared Services” on page 62.
Password
28
Configuring and Setting Up Essbase
Enter the password of the Essbase system administrator.
Field
Action Required
Note: The password must be different than the user ID and must contain at least six
characters.
Company Name
Enter your company's name.
Service Name Identifier
Enter a short description.
A service display name is created using the following syntax:
Hyperion S9 BI+ Analytic Services 9.3.1 —
service_name_identifier
For example:
Hyperion S9 BI+ Analytic Services 9.3.1 — budget
Note: The service name identifier must be unique across all Essbase instances. This name
is stored as AGENTDESC in the Essbase configuration file (essbase.cfg).
5 Click Next.
6 Specify the following port information for the Essbase service:
Table 9
Essbase Fields
Field
Action Required
Agent Port Number
Accept the default port number that Essbase Server uses to connect. Or enter a port number
that is not used by other programs.
Application Start Port
Enter the first port number that Essbase Server tries to use to connect.
Application End Port
Enter the highest port number that Essbase Server can use to connect.
Registering With Shared Services
By default, the user you specify during registration is pre-provisioned as admin. This enables
you to log on to Shared Services after configuration using admin/password, to create and
provision users.
Table 10
Shared Services Registration
Field
Description
Server Name
The name of the computer where the Shared Services server is installed.
Caution! Do not specify an IP address, especially in DHCP environments, or enter restricted
characters.
Port
The default or custom Shared Services server port number.
User
The username of the Shared Services Administrator.
Password
the password of the Shared Services Administrator.
Registering With Shared Services
29
Field
Description
SSL
Select to use Secure Sockets Layer for encryption. See the Hyperion Product SSL Configuration
Guide.
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 Hyperion Configuration Utility.
See “Configuring Essbase” on page 27.
2 From the list of installed products, select those to configure, and click Next.
3 From the list of configuration tasks, 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 In the Password text box, enter the password for the specified Shared Services user.
5 Click Next.
Reconfiguring Products
Hyperion Configuration Utility enables you to reconfigure products to incorporate changes in
your environment.
To reconfigure, launch Hyperion Configuration Utility on the computer hosting the product,
and follow the procedures in this chapter.
Registering Merant ODBC Drivers on 64-bit Windows
Before you can use Essbase SQL Interface on 64-bit Windows running on AMD Opteron or Intel
Xeon processors, you must run a script to register Merant ODBC drivers.
➤ To register Merant ODBC drivers:
1 Install Essbase.
2 Verify that the HYPERION_HOME environment variable is set.
3 Run the RegUpdateODBC51.bat script located in the ARBORPATH/bin directory.
4 Check the ODBC Data Source Administrator to verify that the Merant drivers are listed in the Drivers tab.
30
Configuring and Setting Up Essbase
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.
Note:
Changing system settings affects all users who access the system.
➤ To update the environment settings manually:
1 At a command prompt, use the set command to set these system variables:
●
ARBORPATH=C:\Hyperion\AnalyticServices, or wherever Essbase is installed
●
PATH—Add %ARBORPATH%\BIN
2 Remove outdated ARBORPATH system variables or ANALYTICSERVICES\BIN PATH settings.
3 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, type:
essbase
If you encounter errors during startup:
●
Check the path and environment settings.
●
Ensure that 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.
Updating the Environment Manually
31
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 Essbase
to Shared Services” on page 62.
●
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, type 1 to verify your entries or 2 to retype them.
Note:
When you change the password for the administrator, it does not affect the system password
required to 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 (superuser). Thus, you can change the administrator’s 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 Agent window to perform high-level administrator operations.
For a list of Agent commands, see “Using Essbase Agent Commands” on page 39.
After you start the Essbase, 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 Administrator's
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 type 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.
32
Configuring and Setting Up Essbase
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
Note:
If you want the Essbase Server system password automatically entered each time Essbase Server
starts, open a command prompt and type 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 Type Essbase or your server name, and click Finish.
Automating Application or Database Startup
You can automatically start an application or a database. When Essbase Server is started, any
application or database defined with an automatic startup setting is automatically started. You
define startup settings using Administration Services (Application Properties and Database
Properties windows).
Note:
See the 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 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 Administrator's Guide.
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.
Automating Application or Database Startup
33
Note:
You cannot use Windows Task Manager to terminate a process started as a service. If the Essbase
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.
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 Essbase Server is located.
➤ To set the system environment to run Essbase Server as an automatic service:
1 At a command prompt, use the set command to set these system variables:
●
ARBORPATH=C:\Hyperion\AnalyticServices, or wherever Essbase Server is installed
●
PATH—Add %ARBORPATH%\BIN
2 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 Open the Services applet in the Windows Control Panel.
3 Ensure that:
●
Hyperion S9 BI+ Analytic Services 9.3.1 – service_name_identifier is in the list of
services
●
Startup Type is Automatic
●
Status is Started
Stopping the Essbase Service
➤ To stop the Essbase Server service:
1 Open the Services applet in the Windows Control Panel.
2 Right-click Hyperion S9 BI+ Analytic Services 9.3.1 —
service_name_identifier in the list of services and select Stop.
For more information on stopping a Windows service, see your platform documentation.
34
Configuring and Setting Up Essbase
Note:
The time it takes to stop the Essbase Server service depends on how many applications are
running, and 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 Service” on page 34.
2 At a command prompt, type:
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.
Note:
To run 64–bit Essbase on any 64–bit operating system requires a 64–bit JVM.
The following table shows where the JRE and jvm.dll files are installed:
Setting JVMMODULELOCATION
35
Platform (JRE version)
JRE and JVM.DLL Locations
32-bit Windows:
JRE
HYPERION_HOME\common\jre\sun\1.5.0
JVM.DLL
HYPERION_HOME\common\jre\sun\1.5.0\bin\server
\jvm.dll
64-bit Windows:
JRE
HYPERION_HOME\common\JRE-IA64\Sun\1.4.2
JVM.DLL
HYPERION_HOME\common\JRE-IA64\Sun\1.4.2\bin
\server\jvm.dll
64-bit Windows on AMD Opteron and Intel Xeon:
JRE
HYPERION_HOME\common\JRE-AMD64\Sun\1.5.0
JVM.DLL
HYPERION_HOME\common\JRE-AMD64\Sun\1.5.0\bin
\server\jvm.dll
Configuring SAP for Single Sign-on
To configure SAP for single sign-on, the PATH system variable must include the
HYPERION_HOME\common\SAP\bin directory.
For more information about single sign-on, see the Hyperion Security Administration Guide.
Using ESS_JVM_OPTION and ESS_CSS_JVM_OPTION
The environment variables ESS_JVM_OPTION# (0 through 9) and ESS_CSS_JVM_OPTION# (0
through 9) are available to address any platform and JRE version-specific options required by
JVM.
Changing the Location of Shared Services Log Files
The default location of Shared Services configuration log files depends on the application server
on which Shared Services is deployed. See the Hyperion Shared Services Installation Guide.
To change the location where log files are written, use the ESS_CSS_JVM_OPTION# environment
variable. Be sure to use a # that does not conflict with other ESS_CSS_JVM_OPTION variables
used in your environment.
➤ To set ESS_CSS_JVM_OPTION2:
1 At a command prompt, type:
set ESS_CSS_JVM_OPTION2= -Djava.io.tmpdir=location
For example:
set ESS_CSS_JVM_OPTION2= -Djava.io.tmpdir=c:\csslog
36
Configuring and Setting Up Essbase
Verifying Startup Dependencies
Before starting Essbase Server, verify that Shared Services server is running. For instructions to
start Shared Services server, see “Starting Shared Services” on page 37.
Starting and Stopping Shared Services
Starting Shared Services
If you deployed the Shared Services application server as a Windows service, to start Shared
Services manually, from the Windows control panel, select Administrative Tools > Services.
➤ If you did not deploy Shared Services application server as a Windows service, to start the Shared
Services server:
1 Select Start > Programs > Hyperion > Foundation Services > Start Shared Services.
2 If the menu item does not indicate the application server to which the Shared Services server is deployed,
you must start Shared Services server manually.
➤ To start Shared Services server manually, execute the startup script:
Application Server
Path to Script
IBM WebSphere
<HYPERION_HOME>\deployments\<AppServNameAndVersion>\bin
\startSharedServices9.bat
BEA WebLogic 8.1.x
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>
\SharedServices9\startSharedServices.bat
BEA WebLogic 9.1.x
<HYPERION_HOME>\deployments\<AppServNameAndVersion>\bin
\startSharedServices.bat
Oracle
To start Oracle Enterprise Manager:
<OracleInstallDir>\bin\emctl start iasconsole
To start all managed applications under Oracle Enterprise Manager:
<OracleInstallDir>\opmn\bin\opmnctl startall
To start OC4J instance:
<OracleInstallDir>\opmn\bin\opmnctl start process-type=<instancename>
where Shared Services has been deployed to instance “<instance-name>”.
Apache Tomcat
<HYPERION_HOME>\deployments\<AppServName>\<version>\bin
\startSharedServices9.bat
Verifying Startup Dependencies
37
Verifying Successful Startup of Shared Services
➤ To verify successful startup and configuration of Shared Services:
1 During startup, look for the following confirmation messages in the Shared Services console window:
●
Database Configuration Test Passed
●
Security System Initialized Successfully
Note:
This message will not display for Tomcat.
●
Shared Services Initialized Successfully
When Shared Services is deployed to WebSphere, the confirmation message is logged to
<WebSphereInstallDir>\AppServer\logs\SharedServices9\SystemOut.log.
When Shared Services is deployed to WebLogic 8.1.x, if the log level is not set to WARN,
the confirmation message is logged to <HSS_HOME>\AppServer\InstalledApps
\WebLogic\8.1\SharedServices9\logs\SharedServices_Metadata.log.
When Shared Services is deployed to WebLogic 9.1.x, if the log level is not set to WARN,
the confirmation message is logged to <HYPERION_HOME>\deployments\WebLogic9
\SharedServices9\logs\SharedServices_Metadata.log.
2 On the Shared Services server computer, launch the Oracle's Hyperion® Shared Services User Management
Console login page by opening a browser and entering 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 port number of the Shared Services server. 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, the URL should 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.
Optionally, on Windows, you can select Start > Programs > Hyperion > Foundation Services
> User Management Console.
Display of the Oracle's Hyperion® Shared Services User Management Console login page
indicates that the Shared Services server started successfully.
38
Configuring and Setting Up Essbase
Stopping Shared Services
If you installed the Shared Services application server as a Windows service, to stop Shared
Services server, use the Windows control panel.
➤ To stop Shared Services server manually:
1 Execute the stop script:
Application Server
Path to Script
IBM WebSphere
<HYPERION_HOME>\deployments\<AppServNameAndVersion>\bin
\stopSharedServices9.bat
BEA WebLogic 8.1.x
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>
\SharedServices9\stopSharedServices.bat
BEA WebLogic 9.1.x
<HYPERION_HOME>\deployments\<AppServNameAndVersion>\bin
\stopSharedServices.bat
Oracle
To stop Oracle Enterprise Manager:
<OracleInstallDir>\bin\emctl stop iasconsole
To stop all managed applications under Oracle Enterprise Manager:
<OracleInstallDir>\opmn\bin\opmnctl stopall
To start OC4J instance:
<OracleInstallDir>\opmn\bin\opmnctl stop process-type=<instance-name>
where Shared Services has been deployed to instance “<instance-name>”.
Apache Tomcat
<HYPERION_HOME>\deployments\<AppServName>\<version>\bin
\stopSharedServices9.bat
Note:
On Windows systems, you can optionally select Start > Programs > Hyperion > Foundation
Services > Stop Shared Services.
2 On WebLogic, if a message that suggests using the FORCESHUTDOWN command is displayed, use the
FORCESHUTDOWN command to stop Shared Services server:
a.
In a text editor, open the stop script.
See the table under Step 1 for the stop script location.
b.
In the file, find SHUTDOWN, and replace it with FORCESHUTDOWN.
c.
Save and execute the file.
Using Essbase 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 high-level
Using Essbase Agent Commands
39
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 11
Essbase 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 that you type 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 filename, 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 Administrator's Guide.
Shutting Down Essbase Server
To shut down Essbase Server when it is running in the foreground, type 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 Administrator's Guide.
40
Configuring and Setting Up Essbase
5
Installing Essbase Clients
In This Chapter
Installing Runtime Client ..........................................................................................................41
Installing Application Programming Interface (API) .............................................................................42
Installing Essbase Spreadsheet Add-in for Excel ...............................................................................44
Essbase client tools—Essbase Spreadsheet Add-in for Excel, Runtime Client, and Application
Programming Interface (API)—provide access to the data stored in Essbase Server.
Installing Runtime Client
Runtime client enables you to run API programs on computers on which Essbase Server is not
installed, and to run embedded Java API programs without needing Provider Services.
Preparing to Install
Before installing, ensure that the computer on which you are planning to install Runtime Client
meets system requirements. See Hyperion Installation Start Here.
Running the Client Installation Program
See “Running Essbase Installation Programs” on page 16 and “Client Installation Program” on
page 18.
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 Record the value of the HYPERION_HOME system environment variable.
2 From a command prompt or from a shell window on which the HYPERION_HOME value does not conflict
with existing Essbase 64-bit client or server installations, run the 32-bit client installation program.
3 Do not select the option to update the system PATH and ARBORPATH.
Installing Runtime Client
41
4 After the 32-bit client installation is completed, restore the system environment variable
HYPERION_HOME to the value noted in Step 1.
5 On the 64-bit machine, run the precompiled 32-bit client program from a command prompt or from a shell
window on which 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 and “API Support on 64-Bit Platforms” on page 63.
Directories and Files Installed
When Runtime Client is installed, directories are created under the ARBORPATH directory (not
the HYPERION_HOME directory).
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 Server.
●
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 Servers, 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 run on 32-bit platforms and cannot connect to 32-bit Essbase Servers
Caution!
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:
42
Installing Essbase Clients
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
32-bit Provider Services server
32-bit, 64-bit
32-bit Java API or XMLA client
application
32-bit embedded Java API client
application
32-bit, 64-bit
64-bit C API
64-bit
64-bit
64-bit Java API or XMLA client
application
64-bit Oracle's Hyperion® Provider
Services server
64-bit
64-bit embedded Java API client
application
64-bit
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 10.
Preparing to Install
Before installing, ensure that the computer on which you are planning to install API meets system
requirements. See Chapter 2, “Planning the Essbase Installation.”
Running the Client Installation Program
See “Running Essbase Installation Programs” on page 16 and “Client Installation Program” on
page 18.
Note:
When running the client installation program on Windows systems, API can be installed
choosing the Typical or Custom installation option.
Directories and Files Installed
For a listing of files supplied with or required by API to compile programs, see the Essbase API
Reference.
Installing Application Programming Interface (API)
43
Setting the Environment
Add the lib and include directories to the PATH system variable. For example, if you installed
Essbase to the default directory, add the following text to the PATH system variable:
c:\hyperion\AnalyticServices\api\lib
c:\hyperion\AnalyticServices\api\include
Installing Essbase Spreadsheet Add-in for Excel
Essbase Spreadsheet 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.
Preparing to Install
Before installing Essbase Spreadsheet Add-in for Excel:
●
Ensure that the computer on which you are planning to install Spreadsheet Add-in meets
system requirements.
●
Verify that a supported version of Excel is installed.
The Essbase Spreadsheet Add-in for Excel installation program checks for an Excel
installation and the version.
See the Hyperion Installation Start Here.
Running the Client Installation Program
See “Running Essbase Installation Programs” on page 16 and “Client Installation Program” on
page 18.
Directories and Files Installed
When you install Essbase Spreadsheet Add-in for Excel, some or all of the directories listed in
the following table are created under the ARBORPATH directory:
Table 12
Essbase Spreadsheet Add-in for Excel Directories in the ARBORPATH Directory
Directory
Created During
Contains
bin
Essbase server and client installations
Essbase program files for running Essbase Spreadsheet Add-in for
Excel
The installation program adds essexcln.xll to Excel to point
Excel to the correct bin directory.
client
Essbase server and client installations
Essbase sample spreadsheets, which reside in:
client\sample
44
Installing Essbase Clients
Directory
Created During
Contains
Locally stored applications and databases reside in the following
directory structure:
client
appname
dbname
where appname is the application name and dbname is the
database name.
hve
Essbase Spreadsheet Add-in for Excel installations
Help files for Oracle's Hyperion® Essbase® Visual Explorer.
locale
Essbase server and client installations
Character-set files necessary for Essbase Server supported
languages
See “ESSLANG Variable” on page 12.
UninstallClient
Essbase client installations
Uninstall program files for client components
Note:
When Essbase Spreadsheet Add-in for Excel is installed, internal files used by the installation
program are installed in the HYPERION_HOME directory. Third-party products are not installed.
Note:
Do not move, rename, or delete the UninstallClient folder. Do not rename the
AnalyticServices directory or any subdirectories or files beneath it. Modified Essbase files
and directories cannot be uninstalled. To move Essbase to another directory or to revert to an
earlier release, you must first completely uninstall the previous instance. See Chapter 8,
“Uninstalling Essbase .”
Registering Essbase Spreadsheet Add-in for Excel(Optional)
Registering Essbase Spreadsheet Add-in for Excel adds entries for Essbase Spreadsheet Add-in
for Excel in the Windows registry for Excel. Unregistering Essbase Spreadsheet Add-in for Excel
clears those entries.
Registering Essbase Spreadsheet Add-in for Excel is optional. If you experience problems using
an unregistered installation of Essbase Spreadsheet Add-in for Excel, register it.
Installing Essbase Spreadsheet Add-in for Excel
45
➤ To register Essbase Spreadsheet Add-in for Excel, select Start > Programs > Hyperion > Essbase
Client > Register Spreadsheet Add-in.
➤ To unregister Essbase Spreadsheet Add-in for Excel, select Start > Programs > Hyperion >
Essbase Client> Unregister Spreadsheet Add-in.
Installing Essbase Spreadsheet Add-in Toolbar (Optional)
Essbase Spreadsheet Add-in for Excel for Excel provides a toolbar, which must be explicitly
installed by opening an Excel file (provided in the default Essbase installation).
➤ To install the Essbase Spreadsheet Add-in toolbar:
1 Start Excel.
2 Select File > Open.
3 From the \AnalyticServices\client\sample directory, open the esstoolb.xls file.
Depending on how Essbase Spreadsheet Add-in for Excel was installed on your computer, the
XLS file may not be available or may be located in a different directory. If needed, contact your
Essbase system administrator.
A blank spreadsheet, similar to the following example, is displayed.
Figure 1
esstoolb.xls File
Note:
If, when the XLS file is opened, two dialog boxes are displayed in sequence, click Enable Macros
on the first dialog box and OK on the second one.
4 Select File > Close.
You do not need to modify or save the file.
Note:
To see the Essbase Spreadsheet Add-in toolbar, you must enable toolbars. If you delete the
Essbase Spreadsheet Add-in toolbar in Excel and want to use it later, you must reinstall it.
46
Installing Essbase Clients
For information on using the Essbase Spreadsheet Add-in toolbar toolbar or enabling toolbars
in Excel, see the Essbase Spreadsheet Add-in for Excel User's Guide.
Troubleshooting
You should know how to use the Excel Add-ins command to add the Essbase Spreadsheet Addin for Excel file (essexcln.xll), which is located in the bin directory.
If problems occur, follow these troubleshooting guidelines:
●
Reboot the computer.
●
Check the environment.
See “Checking the Environment” on page 47.
●
Remove and manually add Essbase Spreadsheet Add-in for Excel.
See “Removing and Manually Adding Essbase Spreadsheet Add-in for Excel” on page 48.
●
Verify that Trust all installed add-ins and templates is selected.
See “Verifying the Macro Security Level in Excel” on page 48.
●
Reinstall Essbase Spreadsheet Add-in for Excel.
See “Reinstalling Essbase Spreadsheet Add-in for Excel” on page 48.
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 variable:
At a command prompt, enter PATH.
The PATH statement that is displayed should include the path of the Essbase bin directory. For
example:
C:\>path
PATH=C:\Hyperion\AnalyticServices\bin
➤ To check the ARBORPATH variable:
At a command prompt, enter SET.
Installing Essbase Spreadsheet Add-in for Excel
47
The list of variables that is displayed should include the ARBORPATH variable, which specifies the
path to the Essbase installation. For example:
C:\>set
ARBORPATH=C:\HYPERION\AnalyticServices
Removing and Manually Adding Essbase Spreadsheet Add-in for Excel
If problems persist or the Essbase Spreadsheet Add-in for Excel startup screen is not displayed
when you start Excel, remove Essbase Spreadsheet Add-in for Excel from Excel, exit and restart
Excel, and manually add Essbase Spreadsheet Add-in for Excel.
➤ To manually add Essbase Spreadsheet Add-in for Excel:
1 In Excel, select Tools > Add-Ins.
2 Click Browse, and in the BIN directory where Essbase Spreadsheet Add-in for Excel is installed, select
essexcln.xll.
3 Click OK.
4 From the Windows Desktop, select Start > Programs > Start Spreadsheet Add-in.
5 Verify that the Essbase menu is displayed in the Excel menu bar.
Verifying the Macro Security Level in Excel
In Excel, if the macro security level is set to high and Trust all installed add-ins and templates is
not selected, you won’t see the Essbase Spreadsheet Add-in for Excel 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.
Reinstalling Essbase Spreadsheet Add-in for Excel
If the Essbase menu does not display in Excel or you encounter error messages, uninstall Essbase
Spreadsheet Add-in for Excel, and run the installation program again (accept the default
settings).
48
Installing Essbase Clients
Setting Up Sample Applications
6
In This Chapter
About Sample Applications .......................................................................................................49
Loading Sample Databases.......................................................................................................50
Providing User Access to Sample Applications .................................................................................51
Preparing the Aggregate Storage Application ...................................................................................52
Preparing the Partitioning Applications ..........................................................................................52
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, as described in the following table:
Table 13
Sample Databases and Data Load Files
Application
Database
Data Load File
Sample
Basic
Calcdat.txt
Interntl and Xchgrate databases demonstrate Essbase Currency Conversion features.
Interntl
Currcalc.txt
Xchgrate
Rates.txt
Basic
Data.txt
Company
Calccomp.txt
East
Calceast.txt
Basic
Calcdat.txt
Basic
dmdemo.txt
Demo
See the Essbase Technical Reference and documentation for Essbase Report Writer.
Samppart
Demonstrates Essbase Partitioning features. See “Preparing the Partitioning
Applications” on page 52.
SampEast
Demonstrates Essbase Partitioning features. See “Preparing the Partitioning
Applications” on page 52.
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
About Sample Applications
49
Application
Database
Data Load File
Sample
dataload.txt*
Demonstrates Data Mining features.
ASOsamp
Demonstrates aggregate storage database features.
*The
ASOsamp Sample database must be loaded using the dataload.rul rules file. The other samples do not require a rules file.
Note:
Depending on your Essbase license agreement, only the Sample, Demo, and Sample_U
applications might be installed.
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 52.
➤ 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 49.
50
Setting Up Sample Applications
For
Do
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 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.
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 Write.
Providing User Access to Sample Applications
51
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 52. 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 Administrator's Guide.
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 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 execute aggregate process MaxL 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:
●
Samppart—Company
●
Sampeast—East
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 Administrator's
Guide describes Partitioning, member combinations, and the differences between target and
source databases.
52
Setting Up Sample Applications
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 53 describes how to create the
required username, so that users can use the applications. “Changing Embedded User Names
in Sample Partition Definitions” on page 53 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.
➤ To create partitionuser:
1 Log on to Administration Services Console using the system administrator account.
2 In Enterprise View, navigate to the Administration Server's node and select the appropriate Essbase
Administration Server name.
3 Right-click the User node and select Create user.
4 For Create user on Essbase Administration Server, enter partitionuser for Username.
5 For Password, type a password.
6 For Confirm Password, type 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, select Source Databases, and then double-click:
Preparing the Partitioning Applications
53
servername:SampEast:East [transparent]
5 For Data Source and Data Target, select a username from User list.
6 Enter the password.
7 Click Repair to save your changes.
Note:
If you changed the username for both the Data Source Group and the Data Target group in the
Repair Partition dialog box, you do not need to repeat this process to change the username in
the Sampeast East .ddb file.
54
Setting Up Sample Applications
Configuring Essbase for
Relational Integration
7
In This Chapter
Before Configuring Essbase SQL Interface or Hybrid Analysis .................................................................55
Configuring Essbase SQL Interface or Hybrid Analysis .........................................................................56
Additional Essbase SQL Interface Tasks .........................................................................................56
Additional Hybrid Analysis Tasks .................................................................................................56
With Essbase SQL Interface and Hybrid Analysis, you can integrate relational databases and
Essbase databases, thereby leveraging the scalability of a relational database with the conceptual
power of a multidimensional database.
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 Chapter 3, “Installing Essbase.”
●
Verify that the system requirements for Essbase SQL Interface and Hybrid Analysis are met.
See Chapter 2, “Planning the Essbase Installation.”
●
Verify that you are licensed for Essbase SQL Interface or Hybrid Analysis.
●
You may need to configure your data source.
See the Hyperion Essbase – System 9 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 2, “Planning the Essbase Installation.”
Before Configuring Essbase SQL Interface or Hybrid Analysis
55
Configuring 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 19.
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. For information on running Hybrid Analysis with Teradata,
see the Essbase Integration Services Installation Guide
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 Hyperion Essbase – System 9 SQL Interface Guide.
Additional Hybrid Analysis Tasks
Before using Hybrid Analysis:
●
In the essbase.cfg file, set HAENABLE to TRUE.
See the Essbase Technical Reference for syntax and usage guidelines.
56
●
In Essbase Spreadsheet Add-in for Excel, 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 Essbase Integration
Configuring Essbase for Relational 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 Oracle's Essbase® Integration Services documentation.
Additional Hybrid Analysis Tasks
57
58
Configuring Essbase for Relational Integration
Uninstalling Essbase
8
Uninstallation programs are installed in these directories:
Server—ARBORPATH\UninstallServer
Client—ARBORPATH\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, first perform a complete, not incremental, backup of all
Essbase files and applications.
●
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 “About Hyperion Home” on page 11.
●
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 be prompted to remove shared files, as Essbase products are
uninstalled individually and many Essbase files are shared with other Essbase products. For
59
example, essapinu.dll is installed with Essbase Server, client software and API. Selecting
Yes To All makes uninstalling faster and does not disrupt other programs installed on the
computer.
60
Uninstalling Essbase
Upgrading Essbase
9
In This Chapter
Upgrading Your Installation .......................................................................................................61
Upgrading Essbase to Release 9.3.1 ............................................................................................61
Moving Applications and Databases Between Computers .....................................................................66
Upgrading Your Installation
If you are upgrading from a previous release of Essbase, note the following supported upgrade
paths:
●
9.2.0.3 to 9.3.1
●
9.3.0.x to 9.3.1
If you are using a release prior to 9.2.0.3, you must first upgrade to one of the versions noted
above, and then upgrade to 9.3.1. Upgrading from 9.2 releases prior to 9.2.0.3 will be supported
in an upcoming service pack.
See “Upgrading Databases” on page 64 for information about upgrade procedures.
Upgrading Essbase to Release 9.3.1
The following sections describe how to upgrade from an earlier release of Essbase to Release
9.3.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.
See “Backup and Recovery” in the Hyperion Essbase – System 9 Database Administrator's
Guide.
Migration Considerations
This section contains information about differences in behavior between Release 9.3.1 and
previous releases and about dropped features.
Upgrading Your Installation
61
Managing ID Attribute Migration in Essbase
Shared Services release 9.2.0.3 introduced a unique identity attribute to support user and group
movements across Organizational Units in LDAP-enabled user directories. If you implemented
9.2.0.3 with the unique identity attribute, you can upgrade only to 9.3.1 (not to a release lower
than 9.3.1, such as 9.3).
If upgrading from a version that uses Distinguished Name (DN, which is not unique) as the
identifying attribute for users and groups, you have the option to:
●
Retain DN as the attribute in 9.3.1
●
Implement unique identity attribute in 9.3.1 (the default)
When you upgrade (from a release other than 9.2.0.3), the Unique Identity Attribute is
implemented by default. You can select not to implement the Unique Identity Attribute by
setting, in the essbase.cfg file, IDMIGRATION to NOMIGRATION. See the Essbase
Technical Reference
If upgrading from a version that uses the unique identity attribute (9.2.03), you must configure
user directories in Shared Services using the unique identity attribute.
See "Handling User and Group Move Across OUs in LDAP-Enabled User Directories" in the
Hyperion Security Administration Guide.
If you choose to migrate to the unique identity attribute, restarting Shared Services will upgrade
the data in the Native Directory.
Caution!
Back up the Essbase security file (essbase.sec) and the data in OpenLDAP before starting the
migration process. After migrating users and groups to use the new identity attribute, you cannot
revert to the previously used identity attribute. To revert, restore user and group data in
OpenLDAP and Essbase from the backups.
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.
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
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.
62
Upgrading Essbase
See the Hyperion Essbase – System 9 Database Administrator's Guide.
Upgrading Database Files to 64-bit on Itanium
On Itanium, 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 directories) 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
Client programs developed using the Essbase C API or Visual Basic API can be run on 32-bit
platforms connecting to either 32-bit or 64-bit Essbase Servers.
Precompiled client programs developed using the 32-bit Essbase Visual Basic API can be run on
the 64-bit Windows platform connecting to 64-bit Essbase Servers, as long as the 32-bit runtime
environment is set up according to the instructions in “Installing the 32-Bit Runtime Client on
a 64-Bit Windows Platform” on page 41.
Client programs developed using the Essbase C API can be run on 64-bit platforms connecting
to 64-bit Essbase Servers. There are no extra setup requirements for running C programs on 64bit platforms.
Supported API Versions
Programs compiled with Release 9.3.x Application Programming Interface do not work with
earlier runtime releases.
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 9.x, you cannot use
7.x runtime libraries. The following table describes compatibility among API, runtime library,
and Essbase Server versions:
Table 14
Compatibility Among API, Runtime, and Essbase Server Versions
API Header Files
Runtime Libraries
Essbase Server
9.x
9.x
9.x, 7.x
7.1.x
7.1.x
6.5.x, 7.x
7.0.1
7.0.1
6.5.x, 7.x
7.0.0
7.0.x
6.5.x (except grid operations), 7.x
API Functions That Are No Longer Supported
The following alias combination functions are no longer supported:
Upgrading Essbase to Release 9.3.1
63
●
EssOtlGetNextAliasCombination()
●
EssOtlDeleteAliasCombination()
●
EssOtlAddAliasCombination()
How Cache Sizes Are Affected by Upgrades
If you are running Essbase using direct I/O, and you plan to use buffered I/O (the default) after
the upgrade, you may need to reduce your cache size settings. For more information about I/O
access modes and about setting cache sizes, see the Hyperion Essbase – System 9 Database
Administrator's Guide.
Compatibility Between Client and Server Software
Essbase 9.x releases provide backward compatibility between 9.x Essbase Server with earlier
release clients, such as Essbase Spreadsheet Add-in for Excel and MaxL Shell. 9.x releases do not
support Application Manager or any clients from releases prior to 7.x.
Note:
For information about release compatibility with Administration Services, see the Hyperion
Installation Start Here.
Upgrading Databases to Release 9.3.1
This section provides information about client-server compatibility and upgrading databases
from Essbase Release 9.3.0.x and Release 9.2.0.3 to Release 9.3.1.
Upgrading Databases
The following procedure explains how to upgrade databases from an earlier release to Release
9.3.1.
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.
Before proceeding, familiarize yourself with using MaxL statements. See the MaxL section of the
Essbase Technical Reference.
➤ To upgrade databases to Release 9.3.1:
1 Start Essbase Server.
See “Starting Essbase Server” on page 31.
2 Use the alter database validate MaxL statement against the database.
If the validation returns errors, revert to a backup that is free of errors.
3 Back up all application files, database files, and the security file.
64
Upgrading Essbase
4 In Administration Services Console, run a full restructure on the database.
See the Essbase Administration Services Online Help. Additional information on restructuring
databases can be found in the Hyperion Essbase – System 9 Database Administrator's Guide.
5 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.
6 Before upgrading your Essbase installation, stop all other Hyperion products running on the same machine
as the Essbase instance you are upgrading.
7 Before upgrading, be sure to see the Hyperion Installation Start Here for information on the correct sequence
for installing Hyperion products.
8 Install the Essbase client and server components to the same directory as the earlier Essbase installation.
See Chapter 3, “Installing Essbase.”
Typically, Essbase components are installed in the ARBORPATH directory. See “ARBORPATH
Directory” on page 20.
9 Run the Oracle's Hyperion® Configuration Utility™ to configure Essbase and any other products that you
might have upgraded.
See Chapter 4, “Configuring and Setting Up Essbase.” Also see the Hyperion Installation Start
Here for information on the correct sequence for configuring Hyperion products.
10 Start the Essbase Agent (essbase.exe ).
11 Select a database or load an application.
12 Use the alter database validate MaxL statement against the upgraded database.
13 If the validation returns only LRO-related errors to the log file after upgrading, you must restore data from
the earlier backup and recreate 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.3.1.
Essbase upgrades the database to Release 9.3.1 format, if the database is restored.
c.
Validate the database using the alter database validate MaxL statement.
d.
Recreate the LROs, using the LISTLINKEDOBJECTS output as a guide. You may need to
manually review the output from LISTLINKEDOBJECTS to verify its completeness.
14 Upon successful completion, unload the database and then back up the Release 9.3.1 database files.
15 Repeat steps 11 through 14 for each database that you want to upgrade.
Note:
Essbase Server upgrades a database when the database is started. After kernel files are upgraded,
they are not backward-compatible with the earlier release.
Upgrading Essbase to Release 9.3.1
65
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 MaxL statement 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 ARBORPATH\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 MaxL statement.
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 Oracle's 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 Essbase files (such as ESSCMD or MaxL scripts) to the
target server computer.
66
Upgrading Essbase
Note:
MaxL includes an ESSCMD-to-MaxL script conversion utility. See the MaxL DDL section of the
Essbase Technical Reference.
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 or supported.
Moving Applications and Databases Between Computers
67
68
Upgrading Essbase
Installing, Configuring, and
Uninstalling Data Integration
Management Adapters
10
In This Chapter
Data Integration Management Adapters .........................................................................................69
Installing Data Integration Management Adapters..............................................................................69
Configuring Adapters ..............................................................................................................72
Uninstalling Adapters ..............................................................................................................80
Data Integration Management Adapters
After you install and configure Oracle's Hyperion® Data Integration Management, you can
install and configure adapters that enable you to retrieve and write data for other Hyperion
products:
●
Essbase
●
Oracle's Hyperion® Financial Management – System 9
●
Oracle's Hyperion® Performance Scorecard – System 9
To use Oracle's Hyperion® Data Integration Management Adapter for Financial Management,
you must first install and configure Financial Management. You can use Oracle's Hyperion®
Data Integration Management Adapter for Performance Scorecard and Oracle's Hyperion® Data
Integration Management Adapter for Essbase® without installing Performance Scorecard or
Essbase, respectively.
A Hyperion product and the Data Integration Management adapter for that product can be on
different computers. For example, you can install Oracle's Hyperion® Financial Management –
System 9 on one computer and DIM Adapter for Financial Management on another.
Each adapter includes online help that provides instructions for using the adapter.
Installing Data Integration Management Adapters
You must have administrative privileges on any computer where you install a Data Integration
Management adapter. A Data Integration Management adapter installer provides two options:
●
Typical—Install all adapter components
●
Custom—Install the components that you select:
Data Integration Management Adapters
69
❍
Client Plug-in—Enables you to configure source and target definitions for the Hyperion
application in Designer.
Client Plug-in should be installed on the same computer as PowerCenter Client.
❍
Reader and Writer Plug-ins—Enable you to read information from the Hyperion
application and write information to it.
Reader and Writer Plug-ins should be installed on the same computer as PowerCenter
Server
The installer sets environment and system variables:
●
Windows
❍
❍
❍
●
DIM Adapter for Essbase:
❏
HASCONNECTORPATH is set to Installation Folder\HASConnector\bin.
❏
PATH is updated with the Installation Folder\HASConnector\bin folder.
DIM Adapter for Financial Management:
❏
HFMCONNECTORPATH is set up to Installation Folder\HFMConnector.
❏
PATH is updated with the Installation Folder\HFMConnector\lib folder.
DIM Adapter for Performance Scorecard:
❏
HPSCONNECTORPATH is set toInstallation Folder\HPSConnector\Bin.
❏
PATH is updated with the Installation Folder\HPSConnector\Bin folder.
❏
CLASSPATH is updated with the Installation Folder\HPSConnector\Bin
\Resources folder and the Installation Folder\HPSConnector\Bin\Lib
\HPSPlugin.jar file (for Reader and Write plug-ins only).
UNIX
❍
Reader and Writer plug-ins of DIM Adapter for Essbase (Solaris, AIX, Linux, HP-UX):
❏
HASCONNECTORPATH is set to Installation Directory/HASConnector/bin.
❏
PATH is updated with the Installation Directory/HASConnector/bin
directory.
❏
Library path is updated with the Installation Directory/HASConnector/
bin directory.
Note:
The library path system variable name depends on the UNIX platform. For Solaris and
Linux, it is LD_LIBRARY_PATH. For AIX, it is LIBPATH. For HP-UX, it is
SHLIB_PATH.
❍
Reader and Writer Plug-ins of DIM Adapter for Performance Scorecard (Solaris, AIX):
CLASSPATH is updated with the Installation Directory/HPSConnector/Bin/
Resources directory and the Installation Directory/HPSConnector/Bin/
Lib/HPSPlugin.jar file.
70
Installing, Configuring, and Uninstalling Data Integration Management Adapters
Note:
When you install the client and server components of any Data Integration Management adapter
on one computer, you must install both components in the same location.
➤ To install a Data Integration Management adapter:
1 Take one action from the installation DVD or the directory where you downloaded the adapter installer:
●
Windows—Click setupwin32.exe.
●
UNIX—Run a program:
❍
AIX—setupAix.bin
❍
Solaris—setupSolaris.bin
❍
Linux—setupLinux.bin
❍
HP-UX—setupHP11.bin
2 On the adapter installer Welcome screen, click Next.
3 Select a country for the installation, and click Next.
4 Select I AGREE, and click Next.
Note:
You must select I AGREE to continue with the installation.
5 Specify the directory in which to install the adapter, and click Next.
6 Click Next to accept the Hyperion Home directory.
7 Select a setup type, and click Next.
8 If you selected the Custom setup option in the preceding step, select components to install, and click
Next.
9 Verify the installation summary, and click Next.
Tip:
You can click Back to change installation choices.
While the installer is running, a progress page is displayed. When the installation is complete,
the Configuration Guidelines page is displayed.
Installing Adapters in Silent Mode
When you install a Data Integration Management adapter in silent mode, the installer retrieves
the installation properties that are saved in a response file instead of displaying screens where
you enter these properties. Silent mode is often used for performing installations remotely. You
can create the response file from a template before you perform an installation, or you can create
Installing Data Integration Management Adapters
71
the file during an installation for use in subsequent silent-mode installations. See the Data
Integration Management Installation Guide.
➤ To install an adapter in silent mode, run this command:
InstallerFile -silent -options ResponseFile
where InstallerFile is a platform-specific installation program (such as
setupwin32.exe for an installation on a Windows platform or setupSolaris.bin for a
Solaris platform) and ResponseFile is the property file containing the parameters required
for the installation.
Installing Adapters in Console Mode
When you run the installer for an adapter in console mode, you select input from a series of
menus that are displayed.
➤ To install an adapter in console mode, run this command:
InstallerFile -console
where InstallerFile is a platform-specific installation program (such as
setupSolaris.bin for a Solaris platform).
Configuring Adapters
After installing Data Integration Management adapters, you must configure them on the
computers hosting the PowerCenter Server, Client, and Repository Server components of Data
Integration Management.
Adapter configuration tasks are described in these topics:
●
“Registering Adapters with a Repository” on page 72
●
“Configuring Hyperion Application Connections” on page 74
●
“Configuring JVM Options” on page 78.
You can perform these tasks on Windows computers where PowerCenter Client is installed.
Registering Adapters with a Repository
If you install the Reader and Writer Plug-ins component of a Data Integration Management
adapter, which is a server component, you must register the adapter with the repository. This
registration is not required if you install only the Client Plug-in component.
➤ To register a Data Integration Management adapter with a repository:
1 Copy the HyperionProduct.xml file installed with the adapter to Repository Server
Installation Directory\bin\Plugin.
72
Installing, Configuring, and Uninstalling Data Integration Management Adapters
HyperionProduct.xml locations:
●
DIM Adapter for Essbase– HASConnector\Bin
●
DIM Adapter for Financial Management–HFMConnector\resources
●
DIM Adapter for Performance Scorecard–HPSConnector\Bin
2 Ensure that Data Integration Management Repository Server is running:
a.
From the Windows Control Panel, select Administrative Tools.
b.
Select Services.
c.
In the Services window, check the status of Hyperion S9 data Integration Management
Repository Server.
d.
Unless the status is “Started,” click Start (in the upper left of the window).
Note:
Keep the Services window open for the next step.
3 Stop Data Integration Management Server, if it is running:
a.
In the Services window, check the status of Hyperion S9 Data Integration Management
Server.
b.
If the status is “Started,” click Stop (in the upper left of the window).
4 Connect to the Repository Server host computer:
a.
Select Start > Programs > Hyperion Data Integration Management > Informatica
PowerCenter 7.1.5 - Client > Repository Server Administration Console.
b.
In Repository Server Administration Console, right-click the name of the Repository
Server host computer, and select Connect.
c.
Enter your password for the host computer, and click OK.
5 Under the Repository Server host computer name, click Available packages.
6 Right-click HyperionProduct.xml, and select Register, where HyperionProduct is HAS (DIM Adapter
for Essbase), HFM (DIM Adapter for Financial Management), or HPS (DIM Adapter for Performance
Scorecard).
Configuring Adapters
73
7 Enter the repository administrator user name and password, and click OK.
Note:
By default, both the user name and the password are Administrator if you are using Informatica
native authentication. If you are using Oracle's Hyperion® Shared Services authentication, the
default user name and password are admin and password, respectively.
8 When a message that the registration succeeded is displayed, click OK.
9 Repeat step 6 through step 8 for each adapter to be registered
Note:
For more information, see “Registering and Unregistering Repository Plug-ins” in the
Informatica PowerCenter Repository Guide.
Configuring Hyperion Application Connections
After you configure an adapter, you must configure an application connection in Workflow
Manager before you can extract data from sources or write data into targets. When configuring
application connections, you specify attributes that Data Integration Management Server uses
to connect to a database during a Data Integration Management session. The application
connections that you define in Workflow Manager are saved in Data Integration Management
Repository.
➤ To configure application connections:
1 Ensure that Data Integration Management Repository Server is running:
74
a.
From the Control Panel, select Administrative Tools.
b.
Select Servers.
c.
In the Services window, check the status of Hyperion S9 data Integration Management
Repository Server.
Installing, Configuring, and Uninstalling Data Integration Management Adapters
d.
Unless the status is “Started,” click Start (in the upper left of the window).
2 Start the repository:
a.
Select Start > Programs > Hyperion System 9 > Data Integration Management >
Informatica PowerCenter 7.1.4 - Client > Repository Server Administration Console.
b.
In Repository Server Administration Console, right-click the name of the Repository
Server host computer and select Connect.
c.
Enter your password for the host computer, and click OK.
d.
In the Repositories directory, double-click the repository name.
e.
Click Start (on the left).
3 Select Start > Programs > Hyperion System 9 > Data Integration Management > Informatica
PowerCenter 7.1.4 - Client > Workflow Manager.
4 In Workflow Manager, connect to the repository:
a.
In the Repository Navigator panel, double-click the repository name.
Configuring Adapters
75
b.
Enter the repository administrator's user name and password, and then click Connect.
5 Select Connections > Application.
6 Click New.
7 Select the connection for the adapter that you are configuring, and click OK.
For example, if you are configuring DIM Adapter for Performance Scorecard, select Hyperion
Performance Scorecard Connection.
76
Installing, Configuring, and Uninstalling Data Integration Management Adapters
8 Enter the requested information, and click OK:
The information requested depends on the Hyperion application. It can include these items:
●
Name—A name for the connection
●
User Name—Your user name for the Hyperion application; for example, if you are
configuring Hyperion Performance Scorecard Connection, your user name for Performance
Scorecard
●
Password—Your password for the repository; for example, if you are configuring Hyperion
Performance Scorecard Connection, your password for Performance Scorecard
●
URL—The Hyperion product application URL that you want to use
●
Host or ServerHost—The name of the Hyperion product server host computer; for example,
if you are configuring Hyperion Performance Scorecard Connection, the name of the
Oracle's Hyperion® Performance Scorecard – System 9 server host computer
●
Port—The port number used by the application
See Installation Start Here for information about ports.
●
Cluster —The name of the registered cluster where the application runs
Application Connection Browser lists the new application connection.
Configuring Adapters
77
Tip:
You can edit or delete an application connection by selecting it in the list in Application
Connection Browser and clicking Edit or Delete.
Configuring JVM Options
➤ To configure JVM options:
1 Start Informatica Server Setup:
●
Windows—Select Start > Programs > Hyperion System 9 > Data Integration Management
> Informatica PowerCenter 7.1.4 - Server > Informatica Server Setup.
●
UNIX—Run pmconfig from the $DIM_HOME/Server/bin directory.
Note:
On Solaris, run ./pmconfig to avoid running the Solaris system command by the same
name. The PM_HOME environment variable must point to the PowerCenter Server
installation directory, or the PowerCenter Server cannot start.
2 With Configure Informatica Service selected, click Continue.
78
Installing, Configuring, and Uninstalling Data Integration Management Adapters
3 Select the JVM Options tab.
Configuring Adapters
79
4 In VM Location, enter the fully qualified path to the jvm.dll file in your JAVA_HOME directory and then
click OK.
Uninstalling Adapters
➤ To uninstall a Data Integration Management adapter:
1 Start the adapter uninstaller:
●
80
DIM Adapter for Essbase
❍
Windows—uninstaller.exe
❍
UNIX (AIX, HP-UX, Linux, Solaris)—uninstaller.bin
●
DIM Adapter for Financial Management (Windows only)—Uninstall.exe
●
DIM Adapter for Performance Scorecard
❍
Windows—uninstaller.exe
❍
UNIX (AIX, Solaris)—uninstaller.bin
Installing, Configuring, and Uninstalling Data Integration Management Adapters
2 On the uninstaller Welcome screen, click Next.
3 Select components to uninstall, and click Next.
4 On the uninstallation summary screen, click Next if the list of components to uninstall is correct.
Tip:
You can click Back to change uninstallation choices.
5 When the summary screen says that the uninstallation has succeeded, click Finish.
6 Optional: Remove the adapter from a repository:
a.
Open Data Integration Management Repository Server Administration Console by
selecting Start > Programs > Hyperion System 9 > Data Integration Management >
Informatica PowerCenter 7.1.4–Client > Repository Server Administration Console.
b.
Select the repository in which the adapter is registered.
c.
Stop the repository if it is running.
d.
Click Repository > Registered packages and select the XML file for the adapter:
●
Oracle's Hyperion® Data Integration Management Adapter for Essbase®—HAS.xml
●
Oracle's Hyperion® Data Integration Management Adapter for Financial
Management—HFM.xml
●
Oracle's Hyperion® Data Integration Management Adapter for Performance
Scorecard—HPS.xml
e.
Click Unregister.
f.
In Remove Repository plug-in, enter the repository user name and password, and click
OK.
The Output window displays the status of the plug-in uninstallation.
Note:
Repeat step 6 to remove the adapter from additional repositories.
Uninstalling Adapters in Silent Mode
When you uninstall a Oracle's Hyperion® Data Integration Management adapter in silent mode,
the installer retrieves the uninstallation options that are saved in a response file instead of
displaying screens where you enter these properties. Silent mode is often used for performing
uninstallations remotely. You can create the response file from a template before you perform
an uninstallation, or you can create the file during an uninstallation for use in subsequent silentmode uninstallations. See the Data Integration Management Installation Guide.
➤ To uninstall an adapter in silent mode, run this command:
UninstallerFile -silent -options ResponseFile
Uninstalling Adapters
81
The uninstaller file is in the Uninstall subdirectory of the adapter installation directory. For
uninstaller file names, see step 1 in “Uninstalling Adapters” on page 80.
Uninstalling Adapters in Console Mode
When you run the uninstaller for an adapter in console mode, you select input from a series of
menus that are displayed.
➤ To uninstall an adapter in console mode, run this command:
UninstallerFile -console
The uninstaller file is in the Uninstall subdirectory of the adapter installation directory. For
uninstaller file names, see step 1 in “Uninstalling Adapters” on page 80.
82
Installing, Configuring, and Uninstalling Data Integration Management Adapters
Installing Essbase
Documentation
A
The Essbase documentation set 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. Hyperion highly recommends Installing the current
documentation set.
Note:
The documentation installation program runs only on Windows platforms, and is available from
the Oracle E-Delivery Site or in the docs directory of the product DVD. 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 Essbase documentation set:
1 Launch the installation program and 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, C:\hyperion\AnalyticServices)
Click Browse to select a directory or enter the name of a 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:
●
Complete—All documentation associated with the release is installed.
●
Custom—Select the documentation components you want to install:
❍
Select Components—Select a documentation category.
❍
Select Subcomponents—Select the subcomponents you want to install.
❍
To install from another category, repeat this step.
83
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.
84
Installing Essbase Documentation
Essbase SQL Interface ODBC
Connectivity
B
In This Appendix
Essbase SQL Interface.............................................................................................................85
Essbase SQL Interface
This section describes the supported ODBC drivers for Essbase SQL Interface on 34-bit and 64–
bit platforms.
32–bit
Relational
Database
Windows
Solaris
AIX
HP-UX
Red Hat Linux
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
Oracle 10.1.0.3
DataDirect
Driver 5.2 SP1
Not supported
Not supported
Not supported
Not supported
Oracle 10g 10.1.0.5
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
Microsoft SQL
Server 2005 SP1
SQL Server
2005 ODBC
native driver
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
Microsoft SQL
Server 2000 SP3a
SQL Server
2000 ODBC
native driver
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
DataDirect
Driver 5.2 SP1
Teradata V2R5.1†
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata 3.05
ODBC
IBM DB2 UDB 9.1
IBM DB2 UDB 8.2
IBM DB2 UDB
8.1.7a
IBM DB2 v7x for z/
OS*
Oracle 9i - 9.2.0.1
Essbase SQL Interface
85
Relational
Database
Windows
Solaris
AIX
HP-UX
Red Hat Linux
Teradata V2R6.0‡
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata V12d
Teradata 12.0
ODBC
Teradata 12.0
ODBC
Teradata 12.0
ODBC
Teradata 12.0
ODBC
Teradata 12.0
ODBC
*IBM
†For
DB2 v7x for z/OS is supported as a data source, but not for OLAP Metadata Catalog.
all Teradata releases, Teradata ODBC drivers must be obtained separately from Teradata.
‡Essbase
supports Teradata Parallel Transporter (TPT) 8.2, which can connect to Teradata V2R6.0 databases. See the Hyperion Essbase –
System 9 SQL Interface Guide.
dEssbase supports Teradata Parallel Transporter (TPT) 8.2. Teradata does not support using applications created with TPT 8.2 with Teradata
V12.x databases. Consult your Teradata documentation for supported configurations.
64–bit
Relational Database
Windows
Solaris
AIX
HP-UX
IBM DB2 UDB 9.1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
Oracle 10.1.0.3
DataDirect Driver
5.2 SP1
Not supported
Not supported
Not supported
Oracle 10g - 10.1.0.5
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
Microsoft SQL
Server 2005 SP1
SQL Server 2005
ODBC native driver
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
DataDirect Driver
5.2 SP1
Microsoft SQL
Server 2000 SP3a
SQL Server 2000
ODBC native driver
DataDirect Driver
5.2 SP1
Not supported
DataDirect Driver
5.2 SP1
Teradata V2R5.1*
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata 3.05
ODBC
Teradata V2R6.0†
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata 3.06
ODBC
Teradata 30.6
ODBC
Teradata V12‡
Teradata 12.0
ODBC
Teradata 12.0
ODBC
Teradata 12.0
ODBC
Teradata 12.0
ODBC
IBM DB2 UDB 8.2
IBM DB2 UDB 8.1.7a
Oracle 9i - 9.2.0.1
*For
all Teradata releases, Teradata ODBC drivers must be obtained separately from Teradata.
†Essbase
supports Teradata Parallel Transporter (TPT) 8.2, which can connect to Teradata V2R6.0 databases. See the Hyperion Essbase –
System 9 SQL Interface Guide.
‡Oracle's Hyperion® Essbase® – System 9 supports Teradata Parallel Transporter (TPT) 8.2. Teradata does not support using applications created
with TPT 8.2 with Teradata V12.x databases. Consult your Teradata documentation for supported configurations.
86
Essbase SQL Interface ODBC Connectivity
Hybrid Analysis, Advanced
Relational Access, and Drillthrough
C
In This Appendix
Supported Relational Data Sources..............................................................................................87
Supported Relational Data Sources
This section describes the relational databases that support Hybrid Analysis, Advanced
Relational Access, and drill-through functions.
Relational Database
Hybrid Analysis
Advanced Relational Access
Drill-through
IBM DB2 UDB 9.1
Yes
Yes
Yes
Yes
Yes
Yes
Oracle 10g - 10.1.0.5
Yes
No
Yes
Microsoft SQL Server 2005 SP1
Yes
Yes
Yes
MySQL
No
No
No
Teradata V2R5.1
Yes
Yes
Yes
Teradata V2R6.0
Yes
Yes
Yes
Teradata V12
Yes
Yes
Yes
IBM DB2 UDB 8.2
IBM DB2 UDB 8.1.7a
IBM DB2 v7x for z/OS
Oracle 10.1.0.3
Oracle 9i - 9.2.0.1
Microsoft SQL Server 2000 SP3a
Supported Relational Data Sources
87
88
Hybrid Analysis, Advanced Relational Access, and Drill-through
A
B
C
D
E
F
H
I
J
L
M
N
O
P
Q
R
S
T
U
V
W
X
Index
Numbers
32-bit
client compatibility, 10
server compatibility, 10
supported ODBC drivers, 85
supported relational data sources, 85
64-bit
API support, 63
client compatibility, 10
installing Runtime Client, 41
registering drivers for Essbase SQL Interface, 30
server compatibility, 10
supported ODBC drivers, 86
supported relational data sources, 86
64-bit Itanium
upgrading database files to, 63
A
accessing sample applications, 51
adapters. See Data Integration Management adapters
Agent
commands, 39
configuring multiple Agents, 28
exiting, 40
port number, 23
removing automatic service, 35
stopping automatic service, 34
viewing server information, 39, 40
Agent commands
DUMP, 40
EXIT, 40
HELP, 40
LOGOUTUSER, 40
PASSWORD, 40
PORTS, 40
QUIT, 40
START, 40
STOP, 40
USERS, 40
VERSION, 40
AGENTPORT setting, 24
aggregate storage, 7
ASOsamp sample application, 50
described, 7
alter database validate statement, used in upgrading,
64
API
described, 8
installing, 42
setting up environment, 44
support on 64-bit platforms, 63
api directory, 20
app directory, 21
application connections
configuring for adapters, 74
Application Programming Interface. See API
applications
default location of files, 21
sample. See sample applications
starting automatically, 33
starting from Agent, 39
stopping, 40
stored on client directory, 44
ARBORPATH directory
list of directories and files, 20
location of, 20
ARBORPATH environment variable
manually updating, 31
manually updating for Windows service, 34
ASOsamp sample application, 50
preparing for use, 52
auto-starting
applications and databases, 33
Essbase as a Windows service, 28
Essbase Server when Windows starts, 32
Index
89
A
B
C
D
E
F
H
I
automating installation, 22
B
backup
before upgrading, 61
complete, 61
essbase.bak file, 21
incremental, 61
Basic sample database
described, 49
for Demo sample application, 49
for DMDemo sample application, 49
for Sample sample application, 49
for Sample_U sample application, 49
bin directory
client, 44
server, 21
block storage, 7
described, 7
J
L
M
N
O
P
Q
R
S
T
U
V
W
X
components, of EssbaseEssbase
API, 8
Essbase Server, 7
Essbase Spreadsheet Add-in for Excel, 8
sample applications, 8
configuration
prerequisites, 26
product upgrades, 27
Shared Services registration, 29
restricted characters, 26
task list, 25
task sequence, 26
troubleshooting, 26
connections
displaying, 39
Currcalct.txt data load file, 49
Currency Conversion sample databases, 49
custom installation, 16
D
C
Calccomp.txt data load file, 49
Calcdat.txt data load file, 49
Calceast.txt data load file, 49
changing
passwords, 40
character-set files, 21
characters, restricted, 26
client compatibility
32-bit, 10
64-bit, 10
client directory, 44
commands
Agent, 39
console, 39
common
components, 20
directory, contents of, 20
Company sample database
described, 49
for Samppart sample application, 49
compatibility
32–bit and 64-bit servers and clients, 10
between client and server, 64
components, of Essbase;
Runtime Client, 8
90
Index
Data Integration Management adapters
described, 69
installing, 69
console mode, 72
silent mode, 72
installing (overview), 69
installing (procedure), 71
uninstalling, 80
console mode, 82
silent mode, 81
data load files
Calccomp.txt, 49
Calcdat.txt, 49
Calceast.txt, 49
Currcalct.txt, 49
Data.txt, 49
dataload.txt, 50
dmdemo.txt, 49
Rates.txt, 49
Data Mining
enabling, 35
JVMMODULELOCATION required, 35
sample application, 49
Data.txt data load file, 49
databases
default location, 21
files, 44
A
B
C
D
E
F
H
I
sample. See sample databases
starting automatically, 33
upgrading, 64
dataload.rul file, 50, 51
dataload.txt data load file, 50
DDB (.ddb) files
changing (caution), 53
changing server names, 53
storage for partition definitions, 52
deployment examples, 10
directories
ARBORPATH, 20
client
bin, 44
client, 44
hve, 45
locale, 45
UninstallClient, 45
common components, 20
Essbase Spreadsheet Add-in for Excel, 44
HYPERION_HOME, 11
include, 44
lib, 44
moving/renaming (caution), 45
Runtime Client, 42
server
api, 20
app, 21
bin, 21
java, 21
JavaAPI, 21
locale, 21
migrationutility, 21
perlmod, 21
UninstallServer, 21
directories installed, 19
directory paths
specifying, 17
disk array, supported, 13
distribution files. See installation programs
DMDemo sample application
Basic database, 49
described, 49
dmdemo.txt data load file, 49
documentation, installing, 83
DUMP command (Agent), 40
DVD. See product DVD
J
L
M
N
O
P
Q
R
S
T
U
V
W
X
dynamic-link libraries (DLLs)
network protocol, 21
E
East sample database
described, 49
for SampEast sample application, 49
embedded Java API
described, 8
installing, 41
embedded server names, changing, 53
environment settings
API installations, 44
ESSLANG setting, described, 12
JVMMODULELOCATION environment variable,
35
sample applications, 52
to run Essbase as a service, 34
updating ARBORPATH environment variable, 31
updating PATH, 31
environment variables. See environment settings
error logs, 26
error messages. See troubleshooting
ESS_CSS_JVM_OPTION1, 36
ESS_JVM_OPTION1, 36
Essbase
components of, 7
configuring relational integration, 55
deployment examples, 10
described, 7
documentation, 83
installing, 15
planning the installation, 9
preparing to install, 15
running installation programs, 16
Essbase Query Designer for Excel
described, 47
Essbase Server
aggregate storage, 7
block storage, 7
described, 7
installing multiple instances, 23
quitting from Agent, 40
sample applications, 8
sample databases, 8
silent installations, 22
starting
Index
91
A
B
C
D
E
F
H
I
J
L
automatically, 32
manually, 31
Essbase Spreadsheet Add-in for Excel. See Essbase
Spreadsheet Add-in for Excel
described, 8
enabling for Hybrid Analysis, 56
essexcln.xll, 44
installing, 44
manually adding, 48
preparing to install, 44
program files, 44
reinstalling, 48
removing, 48
troubleshooting, 47
verifying macro security level, 48
Essbase Spreadsheet Add-in toolbar
displaying, 46
installing, 46
registering, 45
Essbase SQL Interface
configuration prerequisites, 55
described, 55
directories and files, 56
esssql.dll file, 56
installed with Essbase Server, 55
registering ODBC drivers on 64-bit Windows, 30
supported data sources, 85
supported ODBC drivers, 85
essbase.bak file
described, 21
essbase.pm file, 21
essbase.sec file
backup of, 21
described, 21
ESSLANG considerations, 13
migrating (caution), 67
restoring, 21
essexcln.xll file, 44
ESSLANG environment variable
configuring in installation program, 12
default value, 12
described, 12
locale directory, 12, 21
managing, 12
matching for client and server, 13
essnetu.dll file, 21
esssql.dll file, 56
92
Index
M
N
O
P
Q
R
S
T
U
V
W
X
esstoolb.xls file, 46
essxleqd.xla file, 47
example applications. See sample applications
example spreadsheets. See sample spreadsheets
Excel add-in. See Essbase Spreadsheet Add-in for Excel
EXIT command (Agent), 40
F
files
default locations, 19
Essbase client program files, 44
Essbase Spreadsheet Add-in for Excel, 44
Essbase SQL Interface, 56
essbase.bak, 21
essbase.exe, 33, 39
essbase.pm, 21
essbase.sec, 21
essexcln.xll, 44
essnetu.dll, 21
esssql.dll, 56
esstoolb.xls, 46
essxleqd.xla, 47
Hybrid Analysis, 56
language support, 21
migrating essbase.sec (caution), 67
moving/renaming (caution), 45
security files, 21
uninstall.exe, 59
FTP and migration, 66
H
HAENABLE setting, 56
HELP command (Agent), 40
hve directory, 45
Hybrid Analysis
configuration prerequisites, 55
described, 55
enabling Essbase Spreadsheet Add-in for Excel, 56
files, 56
installed with Essbase Server, 55
OLAP Catalog data source, 57
Hyperion Configuration Utility
description, 25
prerequisites, 26
reconfiguration, 30
Shared Services deregistration, 30
A
B
C
D
E
F
H
I
J
Shared Services registration, 29
task sequence, 26
upgrades, configuring, 27
Hyperion Home
described, 11
directory name and location, 11
files installed in, 20
Hyperion security platform. See security
HYPERION_HOME environment variable. See
Hyperion Home
I
ID Attribute Migration, 62
include directory, 44
installation programs
available from
Oracle E-Delivery, 16
product DVD, 16
described, 16
installation options
custom, 16
typical, 16
running from
network location, 17
product DVD, 17
user input
client, 18
server, 18
installers. See installation programs
installing
additional instances of Essbase Server, 23
API, 42
client software, 41
Essbase documentation, 83
embedded Java API, 41
Essbase, 15
Essbase Spreadsheet Add-in for Excel, 44
Essbase Spreadsheet Add-in toolbar, 46
installation programs, described, 16
preparing to, 15
Runtime Client, 41
specifying directory paths, 17
system requirements, 9
understanding operations, 19
Interntl sample database
described, 49
L
M
N
O
P
Q
R
S
T
U
V
W
X
J
Java API. See embedded Java API
java directory, 21
Java Runtime Environment. See JRE
Java Virtual Machine. See JVM
JavaAPI directory, 21
JRE
location of files, 35
JVM
location of file, 35
JVMMODULELOCATION environment variable
described, 35
in essbase.cfg file, 35
L
lib directory, 44
LIB setting in PATH statement (API), 44
linked objects
upgrading and, 65
VALIDATE and, 65
loading data to sample databases, 50
locale directory, 21
locale directory, described, 21
localhost server name, 53
LOGOUTUSER command (Agent), 40
M
MaxL Perl Module, 21
migrating across servers
procedure for, 66
using Administration Services, 66
migrating and FTP, 66
migrating users and groups to Shared Services, 62
Migration, 61
ID Attribute, 62
Shared Services, 62
migrationutility directory, 21
multiple
Agent services, 28
instances of Essbase, 23
N
network
running installation programs from, 17
network protocol
files installed, 21
Index
93
A
B
C
D
E
F
H
I
J
L
TCP/IP, 21
non-Unicode-enabled client
ESSLANG requirements, 13
O
ODBC drivers
registering on 64-bit Windows, 30
supported for Essbase SQL Interface, 85
OLAP Catalog, 57
OLAP Server. See Essbase Server
P
partitioning
changing definition files, 53
changing names in partition definitions, 53
creating partition user, 53
definitions, 52
sample applications, 49
storage for partition definitions, 52
PASSWORD command (Agent), 40
passwords
automatically entering, 33
changing, 40
server startup, 32
PATH variable
API, 44
Perlmod directory, 21
PORTINC setting, 24
ports
Agent port number, 23
used by Hyperion products, 10
PORTS command (Agent), 40
prerequisites. See system requirements
procedures
adapter installation, 71
configuring application connections for adapters,
74
repository plug-in registration, 72
uninstalling adapters, 80
product DVD
running installation programs from, 17
Q
QUIT command (Agent), 40
94
Index
M
N
O
P
Q
R
S
T
U
V
W
X
R
Rates.txt data load file, 49
reconfiguration, 30
registration, Shared ServicesShared Services, 29
registry.properties, 27
RegUpdateODBC51.bat file, 30
Remove Shared File prompt, 60
repository plug-in
registering, 72
restricted characters, 26
rules files
dataload.rul, 50
Runtime Client
described, 8
embedded Java API, 8
installing, 41
installing on 64-bit Windows server, 41
S
SampEast sample application
changing server names, 53
creating partition user, 53
described, 49
setting the environment, 52
sample applications
accessing, 51
ASOsamp, 50
assigning access privileges, 51
creating partition user, 53
data mining, 49
described, 49
DMDemo, 49
included, 49
licensing restrictions, 50
loading sample databases, 50
partitioning, 49
preparing partitioning applications for use, 52
SampEast, 49
Sample, 49
Sample_U, 49
Samppart, 49
UTF-8 encoded, 49
sample databases
Basic, 49
Company, 49
East, 49
Interntl , 49
A
B
C
D
E
F
H
I
loading data into, 50
Sample, 50
SAMPLE directory, sample spreadsheets, 44
Sample sample application, 49
Sample sample database
described, 50
for ASOsamp sample application, 50
sample spreadsheets
location of, 44
Sample_U sample application
described, 49
Samppart sample application
changing server names, 53
creating partition user, 53
described, 49
setting the environment, 52
SAP, configuring single sign-on, 36
security
access to samples, 51
Agent commands, 39
backup file (essbase.bak), 21
essbase.sec file, 13
server compatibility
32-bit, 10
64-bit, 10
SERVERPORTBEGIN setting, 24
SERVERPORTEND setting, 24
service
stopping Agent as, 34
shared files, uninstalling, 60
Shared Services
Migration, 62
starting, 37
stopping, 39
Shared Servicews
changing log file location, 36
SHUTDOWNSERVER command, 40
silent installations, 22
single sing-on, configuring for SAP, 36
SQL Interface
checking connection to, 56
configuring ODBC drivers for, 56
START command (Agent), 40
starting
applications, 40
databases automatically, 33
Essbase Server
J
L
M
N
O
P
Q
R
S
T
U
V
W
X
automatically, 32
manually, 31
from Administration Services Console, 33
Remote Start Server, 33
Shared Services, 37
startup
restoring settings, 21
startup commands
for Shared Services server, 37
startup errors. See troubleshooting
startup, verifying for Shared Services, 38
STOP command (Agent), 40
stopping
Essbase Server, 40
Shared Services, 39
storage models
aggregate, 7
block, 7
system passwords. See passwords
system requirements
Essbase, 9
Essbase SQL Interface, 55
Hybrid Analysis, 55
ports, 10
T
TCP/IP network protocol, 21
Teradata data source
connecting to, 56
third-party products installed, 19
troubleshooting, 26
Essbase Spreadsheet Add-in for Excel, 47
Windows server, 31
typical installation, 16
U
Unicode sample application, 49
Unicode-enabled client, ESSLANG requirements, 13
uninstall.exe, 59
uninstallation programs
client, 59
location of, 45
running, 59
server, 59
location of, 21
UninstallClient directory, 45
Index
95
A
B
C
D
E
F
H
I
J
uninstalling
Essbase, 59
Data Integration Management adapters, 80
guidelines, 59
UninstallServer directory, 21
upgrades
configuring, 27
upgrading
databases, 64
procedure for, 64
User Management Console
launching, 38
users
access to sample applications, 51
creating the partition user, 53
logging off, 40
USERS command (Agent), 40
UTF-8 encoded sample application, 49
V
VALIDATE command
linked objects and, 65
variables. See environment settings
verifying
Essbase Agent running as a service, 34
verifying startup of Shared Services, 38
VERSION command (Agent), 40
versions. See releases
W
Windows service
configuring Essbase as, 28
multiple Agents, 28
removing Agent as, 35
stopping, 35
Windows services
starting, 37
X
Xchgrate sample database
described, 49
96
Index
L
M
N
O
P
Q
R
S
T
U
V
W
X
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising