Detail Installation Guide

Hyperion Solutions Corporation

Hyperion® Essbase® Release 6.5

Installation Guide

P/N: D110165000

Copyright 1998–2002 Hyperion Solutions Corporation. All rights reserved.

U.S. Patent Numbers: 5,359,724, and 6,317,750

Hyperion Essbase and the “H” logo are registered trademarks, and Hyperion Solutions is a trademark of Hyperion Solutions Corporation.

All other brand and product names are trademarks or registered trademarks of their respective holders.

No portion of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser’s personal use, without the express written permission of Hyperion Solutions Corporation.

Notice: The information contained in this document is subject to change without notice. Hyperion Solutions Corporation shall not be liable for errors contained herein or consequential damages in connection with the furnishing, performance, or use of this material.

Hyperion Solutions Corporation 1344 Crossman Avenue Sunnyvale, CA 94089

Printed in the U.S.A.

■ iiiEssbase Installation Guide

Contents

Preface .......................................................................................................................... xiAudience ........................................................................................................................... xiDocument Structure ......................................................................................................... xiiPrerequisites .................................................................................................................... xiiiConventions..................................................................................................................... xiiiRelated Documentation................................................................................................... xivOrdering Printed Documentation ..................................................................................... xv

Chapter 1: Preparing to Install Essbase..................................................... 17Installation Workflow ...................................................................................................... 17Verifying Product Contents.............................................................................................. 18Launching the Installers ................................................................................................... 18Verifying Requirements ................................................................................................... 20

Release Compatibility .............................................................................................. 20Pre-Release 6.5 Clients with 6.5 OLAP Server ............................................... 206.5 Clients with Pre-Release 6.5 OLAP Server ............................................... 21

Server Platform System Requirements..................................................................... 22Windows Server Requirements ........................................................................ 23UNIX Server Requirements ............................................................................. 23

Client Platform System Requirements ..................................................................... 27API Client Development Platform System Requirements ....................................... 28Supported ODBC Drivers and Relational Data Sources .......................................... 29

About the Order of Installation ........................................................................................ 30Registering Essbase Software .......................................................................................... 32

Entering License Numbers ....................................................................................... 32Registering a New License Number......................................................................... 32Installing and Registering Separate Products ........................................................... 33

Contents

iv ■ Essbase Installation Guide

Chapter 2: Installing Windows OLAP Server Software ....................... 35Windows OLAP Server Requirements ............................................................................. 36About Installing OLAP Server Software on Windows..................................................... 36Installing the OLAP Server Software on Windows.......................................................... 37

Directory Structure.................................................................................................... 40Security ..................................................................................................................... 42Network Protocol Files ............................................................................................. 42

Starting the OLAP Server on Windows............................................................................ 43Automating the OLAP Server Startup ...................................................................... 44Automating an Application or Database Startup ...................................................... 45

Using Essbase Agent Commands ..................................................................................... 45Optimizing Network Throughput on Windows NT.......................................................... 46Running the Essbase Agent as a Windows Service.......................................................... 47

Installing the Essbase as a Service ............................................................................ 48Setting the System Environment to Run Essbase as a Service ................................. 48Verifying that Essbase is Running as a Service........................................................ 49Stopping the Essbase Service.................................................................................... 50Restarting the Essbase Service.................................................................................. 51Resetting the Essbase Service ................................................................................... 51Removing the Essbase Service ................................................................................. 52

Installing Personal Essbase............................................................................................... 53Personal Essbase Additional Requirements .............................................................. 53Limitations of a Personal Essbase Server ................................................................. 54Connecting to a Personal Essbase OLAP Server ...................................................... 54Troubleshooting Personal Essbase Communication ................................................. 56

Configuring the Windows Hosts File ............................................................... 56Working Without a Network Interface Card .................................................... 57

Chapter 3: Installing UNIX OLAP Server Software ................................ 61Verifying UNIX OLAP Server Requirements.................................................................. 62About Installing OLAP Server Software on UNIX.......................................................... 62Before You Install on UNIX............................................................................................. 63Installing SQL Interface on UNIX ................................................................................... 64

Contents

■ vEssbase Installation Guide

Installing the OLAP Server Software on UNIX............................................................... 64Installing from the CD Root Directory ..................................................................... 65Installing from the CD Product Directory ................................................................ 66Installing from the Hyperion Download Center ....................................................... 67Running the root.sh Shell Script ............................................................................... 67Directories Created (All UNIX Systems) ................................................................. 69

Updating the Environment Settings (All UNIX Systems) ............................................... 70Setting the $ARBORPATH Variable (Mandatory) .................................................. 71Adding Essbase to the Path (Optional) ..................................................................... 71Setting the Library Path Variables (Mandatory)....................................................... 72

Setting Solaris Library Path Variables ............................................................. 72Setting HP-UX Library Path Variables ............................................................ 73Setting AIX Library Path Variables ................................................................. 73

Enabling New Environment Settings ............................................................................... 74Starting the OLAP Server on UNIX................................................................................. 74

Starting Essbase in the Foreground .......................................................................... 74Starting Essbase in the Background.......................................................................... 75Securing a Password Script....................................................................................... 76

Shutting Down the OLAP Server ..................................................................................... 77Essbase Agent Commands ............................................................................................... 77What’s Next? .................................................................................................................... 77

Chapter 4: Installing Application Manager and Spreadsheet Add-in ............................................................................................... 79System Requirements ....................................................................................................... 79Upgrading from Essbase 5.x............................................................................................. 80Choosing Among Client Software Installation Options................................................... 81

Installing Client Software ......................................................................................... 82Installing Client Software From the Network to Your Hard Disk Drive.................. 86

Setting Up Your Computer to Share Client Software on the Network Drive .................. 87Changing the Network Protocol ....................................................................................... 89Client Product Directories and Files Created ................................................................... 90Starting Essbase Application Manager............................................................................. 93

Contents

vi ■ Essbase Installation Guide

Connecting to the OLAP Server with Application Manager............................................ 94Specifying an IP Address as a Server Name............................................................. 96Troubleshooting Application Manager Connections to the OLAP Server ............... 97Checking the Network Protocol ................................................................................ 98

Starting Essbase Spreadsheet Add-in and Connecting to the OLAP Server .................... 99Installing the Essbase Toolbar (Optional—Excel Only)......................................... 100Troubleshooting the Spreadsheet Add-in Installation............................................. 102

Reboot Your Computer................................................................................... 102Check Your Environment ............................................................................... 103Remove and Manually Add the Essbase Spreadsheet Add-in........................ 103Install the Essbase Spreadsheet Add-in Again ............................................... 104

Chapter 5: Setting up the Sample Applications .................................... 105Loading the Sample Databases ....................................................................................... 106Providing User Access to the Sample Applications ....................................................... 110Setting the Environment for the Partitioning Sample Applications ............................... 112

Creating the Partition User...................................................................................... 113Changing Embedded Server Names in the Sample Partition Definitions............... 116

Loading Data into Samppart and Sampeast.................................................................... 121

Chapter 6: Installing the Runtime Client ................................................... 123Before You Install........................................................................................................... 123About Installing the Runtime Client from a Network Drive .......................................... 124

Network Protocol Files for the Runtime Client ...................................................... 124Directories and Files Created on the Network Drive .............................................. 125

Installing the Runtime Client from the Network to Your Client Hard Disk Drive ........ 125Directories Created When You Install the Runtime Client on a

Client Hard Disk Drive ........................................................................................ 127Setting up Your Computer to Use the Runtime Client on the Network Drive ............... 127Manually Updating the Environment ............................................................................. 129

Updating the Environment on Windows 98............................................................ 129Updating the Environment on Windows XP, Windows 2000, and

Windows NT 4.0 .................................................................................................. 130

Contents

■ viiEssbase Installation Guide

Chapter 7: Installing the API ........................................................................... 131API System Requirements.............................................................................................. 131Installing the API............................................................................................................ 132

Installing the API on Windows Platforms .............................................................. 132Preparing to Install the API on UNIX .................................................................... 133

Before You Install the API on UNIX ............................................................. 133Installing the API on UNIX............................................................................ 134

API Directory Structure.................................................................................................. 136Updating Your Environment Variables.......................................................................... 137

Setting Your Environment on Windows Platforms ................................................ 137Setting Your Environment on AIX and Solaris ...................................................... 137Setting Your Environment on HP-UX.................................................................... 138

Chapter 8: Configuring SQL Interface ....................................................... 139Before You Install SQL Interface................................................................................... 140Installing SQL Interface on Windows............................................................................ 140

Workflow for Installing and Configuring SQL Interface on Windows.................. 140Directories and Files on Windows.......................................................................... 141

Installing SQL Interface on UNIX ................................................................................. 142Workflow for Installing and Configuring SQL Interface on UNIX ....................... 142Setting Up RDBMS Before Running SQL Interface on UNIX.............................. 143Directories and Files Created.................................................................................. 144About Setting Your Environment on UNIX .......................................................... 145Setting Up ODBC Drivers Before Linking Them to SQL Interface ...................... 146

Setting Up the MERANT DB2 Driver on AIX or Solaris.............................. 146Setting Up the IBM DB2 Driver on AIX ....................................................... 147

Linking SQL Interface to the ODBC Driver on UNIX .......................................... 148After You Link SQL Interface to Your ODBC Driver on UNIX........................... 150

Setting the Library Path on UNIX.................................................................. 150Using Shell Scripts to Set the Library Path (Optional) .................................. 152Binding Files for the MERANT DB2 Driver on AIX or Solaris ................... 152Editing .odbc.ini Driver Files ......................................................................... 153

Configuring the Data Source and ODBC Driver .................................................... 155

Contents

viii ■ Essbase Installation Guide

Chapter 9: Network Configuration Notes ................................................. 157TCP/IP Support............................................................................................................... 158

General TCP/IP Installation Procedures ................................................................. 158Server .............................................................................................................. 158Client............................................................................................................... 158

Troubleshooting Common Connection Problems................................................... 159Named Pipes Support ..................................................................................................... 159Novell Using Named Pipes Support ............................................................................... 159

Windows Clients ..................................................................................................... 160Connecting from Windows 98 to Windows NT ............................................. 160Increasing Connections on Windows 98 ........................................................ 160

Windows Servers .................................................................................................... 162UNIX Server ........................................................................................................... 162

LAN Manager Using Named Pipes Support .................................................................. 162Windows Clients ..................................................................................................... 162Windows Servers .................................................................................................... 162UNIX Servers.......................................................................................................... 162

Chapter 10: Upgrading and Migrating Databases................................ 163Upgrading to Release 6.5................................................................................................ 163

Understanding Input/Output Defaults and Upgrading ............................................ 164Determining Which I/O Access Mode to Use ................................................ 164Changing or Preserving the I/O Access Mode................................................ 165Understanding How Cache Sizes Are Affected by an Upgrade ..................... 166Platforms On Which Essbase Supports No-Wait I/O ..................................... 167

Considerations When Upgrading from Release 5.x ................................................ 168Upgrading Databases to Release 6.5....................................................................... 168

Compatibility Between Client and Server ...................................................... 169Database Files That Are Upgraded ................................................................. 170When Does Essbase Upgrade the Files?......................................................... 170Steps for Upgrading Databases to Release 6.5 ............................................... 171Opening Retrieval Wizard Files in Query Designer ....................................... 172Windows System File Updates ....................................................................... 173

Migrating Applications and Databases Across Servers.................................................. 174Upgrading and Migrating at the Same Time .................................................................. 178

Contents

■ ixEssbase Installation Guide

Chapter 11: Performing Advanced Installation Tasks....................... 179The Essbase Environment .............................................................................................. 179Manually Updating the Environment on Windows Platforms ....................................... 180

Manually Updating the Environment on Windows Platforms................................ 180Manually Updating the Environment on Windows 98 ........................................... 181

Configuring Client and Server for Non-English Essbase............................................... 181Manually Installing Java................................................................................................. 183

Installing the Java Runtime Environment............................................................... 184Installing JRE on Windows Systems.............................................................. 184Installing JRE on UNIX Systems ................................................................... 184

Setting JVMMODULELOCATION....................................................................... 185Considerations for Setting the JVMMODULELOCATION on Solaris................. 187Updating the Environment for Java on UNIX Systems.......................................... 188

Updating Environment Variables for Java on Solaris .................................... 188Updating Environment Variables for Java on AIX ........................................ 189Updating Environment Variables for Java on HP-UX ................................... 189

Advanced Configuration Options for Java ............................................................. 190Uninstalling Essbase....................................................................................................... 190

Guidelines for Uninstalling..................................................................................... 191What You Can Uninstall......................................................................................... 192Instructions for Uninstalling ................................................................................... 192

Installing Essbase Documentation.................................................................................. 193

Index ............................................................................................................................ 197

Contents

x ■ Essbase Installation Guide

■ xiEssbase Installation Guide

Preface

Welcome to the Essbase Installation Guide. This guide helps you to install

● Hyperion® Essbase® OLAP Server

● Essbase sample applications

● Essbase® Application Manager

● Essbase® Spreadsheet Add-in

● Essbase® Application Programming Interface (API)

It also provides information about hardware and network protocol requirements.

This introduction contains the following topics:

● “Audience” on page xi

● “Document Structure” on page xii

● “Prerequisites” on page xiii

● “Conventions” on page xiii

● “Related Documentation” on page xiv

● “Ordering Printed Documentation” on page xv

AudienceThis book is for Essbase system administrators who need to install and configure Essbase software on Windows or UNIX platforms. It also assists Essbase system administrators in setting up sample applications, working with network protocols, and helping client users install client software.

xii ■ Essbase Installation Guide

Document StructureThis document contains the following information:

● How to install OLAP Server software to Windows and UNIX servers. See Chapter 2, “Installing Windows OLAP Server Software” and Chapter 3, “Installing UNIX OLAP Server Software.”

● How to upgrade or register an OLAP Server when new options or additional ports are licensed. See “Registering Essbase Software” on page 32.

● How to set up the sample applications. See Chapter 5, “Setting up the Sample Applications.”

● How to install client software on a network or local drive. This includes Essbase Application Manager, Essbase Spreadsheet Add-in, and the Runtime Client. See Chapter 4, “Installing Application Manager and Spreadsheet Add-in.”

● How to install the Essbase API software. See Chapter 7, “Installing the API.”

● How to use a different network protocol. See Chapter 9, “Network Configuration Notes.”

● How to configure a stand alone computer to run Personal Essbase. See “Installing Personal Essbase” on page 53.

● How to set up your computer to use non-English versions of Essbase. See “Configuring Client and Server for Non-English Essbase” on page 181.

● How to install the JavaTM Runtime Environment (JRE) on computers running the OLAP Server to support the Java-based features in the product. See “Installing the Java Runtime Environment” on page 184.

● How to uninstall Essbase software. “Instructions for Uninstalling” on page 192.

For the most up-to-date information regarding installation, read the online version of this Installation Guide, which is located in the \essbase\docs\pdf directory. Information available after this document was created is in the readme.htm file located in the ARBORPATH directory.

■ xiiiEssbase Installation Guide

PrerequisitesBefore you begin, make sure that you have all the software, the documentation, and the Registration Card, and then perform the following tasks:

1. If you are upgrading from an earlier release of Essbase, first back up your application and database files to another directory. See “Upgrading and Migrating Databases” on page 163 for more information.

2. Know the operating system of your server and your installed network protocol.

3. Ensure that you have the disk space and the memory that is required for the Essbase products you plan to install. See “Verifying Requirements” on page 20.

ConventionsThis book uses several formatting styles to indicate actions that you should take or types of information that you need. Table i lists each document convention:

Table i: Document Conventions

Example Description

1, 2, 3 Numbered items indicate procedures to follow in a specific order.

• Bulleted items indicate a list of related items.

Product Dimension names and member names appear in regular font.

\essbase Names of files and directories appear in this font.

Enter Specific text that you must type as well as keyboard keys appear in bold type.

Essbase System Login dialog box

Names of dialog boxes and their controls, such as text boxes, and list boxes, appear in bold type.

Essbase Installation Guide

Titles of books and online help systems appear in italics. Italics also indicate important terms and special emphasis.

xiv ■ Essbase Installation Guide

Related DocumentationYou can access online Essbase documentation from the Information Map, an HTML file. To open the Information Map, launch the essdocs.htm file located in the ARBORPATH/docs directory.

Acquiring a Recommended Web BrowserIf you have a Web browser and are connected to the Internet, you can download recommended browsers from the Web sites shown in Table ii.

ARBORPATH This environment variable is set to the directory path of your Essbase installation. The default is C:\Hyperion\Essbase on Windows platforms and /home/hyperion/essbase on UNIX platforms. Whenever instructed to locate a directory in your Essbase installation, use the value of ARBORPATH at your site.

File > Open The greater than symbol (>) indicates a menu followed by an individual menu command in that menu.

Table ii: Web Browsers

Product Web Site

Microsoft Internet Explorer

microsoft.com/windows/ie/download/default.asp

Netscape

Navigatorhome.netscape.com/download/

Table i: Document Conventions (Continued)

Example Description

http://www.microsoft.com/windows/ie/download

http://www.home.netscape.com/download

■ xvEssbase Installation Guide

Microsoft Internet Explorer is included with Windows platforms. Netscape Navigator can be downloaded for free from Netscape’s Web site. You can also purchase either browser from your software dealer.

Note: After you obtain a Web browser, you do not need to have Internet connectivity to read Essbase HTML documents, if they are installed on your local or network drive. Telephone Microsoft at (800) 426-9400 or Netscape at (650) 937-2555. You are responsible for the legal licensing of these browsers.

Ordering Printed DocumentationA complete set of documentation is included on the CD in PDF or HTML format, or in the form of online help as part of the installed product. You may also download documentation from the Hyperion Download Center. For more information on how to order printed documentation, visit our Web site at http://www.hyperion.com, call Customer Service at 877.901.4975, or call your local support office.

http://www.hyperion.com

xvi ■ Essbase Installation Guide

■ 17Essbase Installation Guide

Chapter

1Preparing to Install Essbase

When you set up the Essbase system, you create an Essbase OLAP Server and configure the Essbase clients to access the OLAP Server. This chapter contains the following topics:

● “Installation Workflow” on page 17

● “Verifying Product Contents” on page 18

● “Launching the Installers” on page 18

● “Verifying Requirements” on page 20

● “Release Compatibility” on page 20

● “Server Platform System Requirements” on page 22

● “Client Platform System Requirements” on page 27

● “About the Order of Installation” on page 30

● “Registering Essbase Software” on page 32

Installation WorkflowUse the following workflow to install the Essbase OLAP Server, additional server components, and client software.

1. Get ready to install:

● Verify that you have all of the necessary software and documentation. See “Verifying Product Contents” on page 18.

● Confirm that the computer systems on which you plan to install Essbase meet system requirements. See “Verifying Requirements” on page 20.

● Determine the order in which you will install the software components. See “About the Order of Installation” on page 30.

18 ■

Preparing to Install Essbase


2. Install the Essbase OLAP Server on a supported Windows or UNIX platform. See Chapter 2, “Installing Windows OLAP Server Software” or Chapter 3, “Installing UNIX OLAP Server Software.”

3. Configure SQL Interface if required. See Chapter 8, “Configuring SQL Interface.”

4. Install the client software on a supported Windows platform. See Chapter 4, “Installing Application Manager and Spreadsheet Add-in” and Chapter 6, “Installing the Runtime Client.”

5. Prepare the sample applications for use. See Chapter 5, “Setting up the Sample Applications.”

Verifying Product ContentsBefore you install Essbase, confirm that you have all the necessary product components:

● The Essbase Release 6.5 CD or the appropriate self-extracting download files from the Hyperion Download Center

● A Software Registration Letter, containing the license number of your OLAP Server

● The Essbase Information Map

● The Essbase Quick Path Card

● This book, Essbase Installation Guide

If you purchased additional Essbase components with your base system, see the documentation for these products. The documentation set is described in “Related Documentation” on page xiv.

Launching the InstallersBefore installing Essbase, decide which software installation format you will use. You can install from the root of the Essbase CD, from the product directory of the Essbase CD, from installable files on a network drive, or from files that you have downloaded from the Hyperion Download Center.


1


Depending on the installation format that you use, you may need to run one installer, selecting the product components to install from the menu provided; or you may need to run several installers, one for each product component that you install.

● If you install from the default installer on the root of the CD, you are provided the option of running one installer, specifying the product components to be installed from the menu provided.

● If you install from files on a network drive, you may need to run one installer or several, depending on how the files are configured on your network. Contact your system administrator for more information.

● If you install from the product directory of the CD, or from files that you have downloaded from the Hyperion Download Center, you must run a separate installer for each product component.

Launch the installer for your selected products, using any of the available software installation formats:

➤ To launch the installer from the root of the Essbase CD:

1. Insert the CD.

2. Run setup if the installer does not start automatically.

➤ To launch the installer from the product directory of the Essbase CD:

1. Navigate to the product folder on the CD.

2. Run setup for that product’s installer.

➤ To launch the installer from a network location of the installable files from the Essbase CD:

1. Find out from your system administrator where the installable files reside on your network.

2. Navigate to the appropriate product folder.

3. Run setup for that product’s installer.

20 ■



➤ To launch the installer from the appropriate self-extracting download file from the Hyperion Download Center:

1. Go to the Hyperion Download Center.

2. Download the appropriate zip or tar file for your product.

3. Unzip or untar the file.

4. Run the downloaded file for the product that you want to install. It will self-extract and run the product installer.

Verifying RequirementsUse the following tables to verify that Release 6.5 supports the platforms on which you plan to install Essbase client and server software.

● “Release Compatibility” on page 20

● “Server Platform System Requirements” on page 22.

● “Client Platform System Requirements” on page 27.

● “API Client Development Platform System Requirements” on page 28.

● “Supported ODBC Drivers and Relational Data Sources” on page 29.

Release CompatibilityIt is recommended that you install the Release 6.5 Essbase OLAP Server with Release 6.5 client products. Client products include Essbase Application Manager, Essbase Spreadsheet Add-in, and Essbase Runtime Client.

Pre-Release 6.5 Clients with 6.5 OLAP ServerRelease 5.x, 6.0, 6.1, or 6.2 clients work with the Release 6.5 OLAP Server, but there are feature limitations. For example, you cannot take advantage of the attributes feature if you use Essbase Application Manager Release 5.0.2 with a Release 6.5 OLAP Server because the attributes feature first became available in Release 6.0.


1


Releases of client products before 5.x are not supported with the Release 6.5 OLAP Server.

CAUTION: Be careful when modifying Release 6.5 databases or outlines with earlier releases of Application Manager. If you save a Release 6.5 database that contains new Release 6.5 features with an earlier release of the Application Manager, the new features may be stripped from the database.

For information on release compatibility with the OLAP Server and Essbase Administration Services, see the Essbase Administration Services Installation Guide.

6.5 Clients with Pre-Release 6.5 OLAP ServerYou can use Release 6.5 clients with a Release 6.2 OLAP Server, but there are some feature limitations. For example, you cannot set the direct/buffered I/O mode at the database level using a 6.5 client if you are also using a 6.2 OLAP Server, because the ability to set the I/O mode at the database level first became available with the 6.5 OLAP Server. For more information, see “Changing or Preserving the I/O Access Mode” on page 165.

Using Release 6.5 clients with OLAP Server releases before 6.2 is not supported.

CAUTION: If you install more than one client component on the same computer, such as Spreadsheet Add-in, the Application Manager, and the Runtime Client, make sure that all the client components are at the same release level. Release 6.5 clients share.dll files that may not work with earlier client components.

22 ■



Server Platform System RequirementsTable 1 provides a summary of the system requirements for the OLAP Server software on supported Windows and UNIX platforms.

Table 1: OLAP Server Platform System Requirements

Server Platform Supported Versions

Windows versions • Windows 2000 on Pentium or equivalent computers• Windows NT 4.0 on Pentium or equivalent computers 1

Note: Windows NT 3.5.1 is not supported by Essbase Release 6.5.

1 Personal Essbase for Windows NT and Windows 2000 on Intel computers is also available.

Solaris versions 7 and 8 (SUN OS 5.7 and 5.8) on Sun SPARC or ULTRASPARC computers

AIX versions 4.3.3 and 5L on RS 6000 PowerPC computers

HP-UX versions 11.0 and 11i on PA-RISC computersSee www.essbase.com/main.asp?webpagekey=295

RAM 64 MB or greater (128 MB or greater for UNIX platforms) minimum recommendation 2

2 The minimum recommendation for running Essbase and its sample applications is 64 MB. On UNIX platforms, minimum requirement is 128 MB of physical memory (256 MB recommended) and at least twice the MB of physical memory for swap space (when physical memory is less than .5 GB). Contact your system administrator or hardware vendor for optimum swap configuration.

Note: Start with the base amount of RAM for your platform and then allocate additional memory to accommodate your applications.

Disk space 65–85 MB for the OLAP Server components and sample applications

Network protocol TCP/IP or Named Pipes


1


Windows Server RequirementsThe Essbase OLAP Server and Personal Essbase OLAP Server for Windows platforms require a system that meets specific requirements. Table 2 describes these requirements.

UNIX Server RequirementsThe Essbase OLAP Server for UNIX requires a system that meets minimal hardware and software requirements. Refer to the following sections to find the system requirements for your UNIX platform.

Table 2: Windows Server Requirements

Component Requirement

Microprocessor Pentium or higher

RAM 64 MB 1

1 The base recommendation for running Essbase and its sample applications is 64 MB. Start with this amount and then allocate additional memory to accommodate your Essbase application.

Windows version for Essbase OLAP Server

Windows 2000, or Windows NT 4.0 on PentiumNote: Windows NT 3.5.1 is not supported by Essbase Release 6.5.

Windows version for Personal Essbase OLAP Server

Windows XP, Windows 2000, or Windows NT 4.0 on Pentium

Disk space Approximately 65–85 MB for the OLAP Server software and the sample applicationsSee Chapter 5, “Setting up the Sample Applications.”

Network protocol Named Pipes or TCP/IP

Java platform Java Runtime Environment version 1.2.2 or later

24 ■



Solaris Server Requirements

Table 3 describes the specific Essbase OLAP Server requirements for Solaris.

Table 3: Essbase OLAP Server Solaris System Requirements


Server platform Sun SPARC or ULTRASPARC computers

Solaris version 7 and 8 (SUN OS 5.7, and 5.8) on Sun SPARC or ULTRASPARC computers

RAM 128 MB RAM (256 or more MB recommended)Note: More for large databases

Swap space At least two times the amount of physical memory is recommended when physical memory is less than .5 GB. Contact your system administrator or hardware vendor for optimum swap configuration.

Disk space • 75 MB• OLAP Server software uses 38 MB.• Sample applications use 15 MB as shipped and use

37 MB after they are fully loaded with default settings.

Note: See the Essbase Database Administrator’s Guide for information about sizing your databases.

Network protocol TCP/IP (included with Solaris)

Thread type POSIX Kernel Threads (included with Solaris)

Java platform Java Runtime Environment version 1.2.2 or later


1


AIX Server Requirements

Table 4 describes the specific Essbase OLAP Server requirements for AIX.

Table 4: Essbase OLAP Server AIX System Requirements


Server platform RS 6000 PowerPC computers

AIX version 5L or 4.3.3

RAM 128 MB RAM (256 or more MB recommended)Large databases have greater memory requirements.


Disk space • 75 MB• OLAP Server software uses 38 MB• Sample applications use 15 MB as shipped and

use 37 MB after they are fully loaded with default settings.

Note: See the Essbase Database Administrator’s Guide for information about sizing your databases.

Network protocol TCP/IP (included with AIX)

Thread type POSIX Kernel Threads (included with AIX)

Java platform Java Runtime Environment version 1.2.2 (or later)

26 ■



HP-UX Server Requirements

Table 5 describes the specific Essbase OLAP Server requirements for HP-UX.

Table 5: Essbase OLAP Server HP-UX System Requirements


Server platform PA-RISC computers

HP-UX version • 11.0 and 11i. See readme.htm for required patches• 11.0 and 11i on PA-RISC computers. See

www.essbase.com/main.asp?webpagekey=295

RAM 128 MB RAM (256 or more megabytes recommended). Large databases have greater memory requirements.


Disk space • 75 MB• OLAP Server software uses 38 MB• Sample applications use 15 MB as shipped and use

37 MB after they are fully loaded with default settings. Note: See the Essbase Database Administrator’s Guide for information about sizing your databases.

Network protocol TCP/IP (included with HP-UX)

Thread type POSIX Kernel Threads (included with HP-UX)

Java platform Java Runtime Environment version 1.2.2 (or later)


1


Client Platform System RequirementsTable 6 describes the system requirements for Application Manager, Runtime Client, and Spreadsheet Add-in for Excel and Lotus 1-2-3..

CAUTION: If you plan to use the “install on first use” option when you install Microsoft Office products, be sure to pre-install Visual Basic for Applications (VBA). If VBA is not installed before you attempt to launch the Spreadsheet Add-in for the first time, the Add-in will fail to launch and Essbase will display an error message.

Table 6: Client Platform System Requirements

Client Platforms Supported Versions

Windows version Windows XP, Windows Me, Windows 2000, Windows 98, Windows NT 4.0Windows 95 is not supported by Essbase Release 6.5.

Excel version Excel XP and Excel 2000

Lotus 1-2-3 version Lotus 1-2-3 Millennium Releases 9.5 and 9.6

Citrix Metaframe 1.8 on a Windows 2000 server

The Spreadsheet Add-in for Excel 2000, Excel XP, and for Lotus 1-2-3 Release 9.6 are supported on Citrix Metaframe 1.8. The other Essbase client components are not supported on this platform.

Microprocessor Pentium or equivalent or better

Display Resolution of at least 640 x 480 (800 x 600 or more recommended)

RAM • 16 MB for Spreadsheet Add-in and Application Manager

• 32 MB for Runtime Client

Disk space • 24 MB for Application Manager• 17.5 MB for Spreadsheet Add-in for Lotus 1-2-3• 16.7 MB for Spreadsheet Add-in for Excel• 9 MB for Runtime Client

28 ■



For system requirements of Essbase Administration Services, see the Essbase Administration Services Installation Guide.

API Client Development Platform System RequirementsTable 7 describes the system requirements for the API client development platforms on Windows and on UNIX platforms are described in Table 7.

Table 7: API Client Development Platforms

Platform Supported Versions

Windows version Windows 2000 and Windows NT on Pentium or equivalent, or better computers

Solaris version 7 and 8 (SUN OS 5.7 and 5.8) on Sun SPARC or ULTRASPARC computers

AIX version 4.3.3 and 5L on RS 6000 PowerPC computers

HP-UX version 11.0 and 11i on PA-RISC computers

RAM • 64 MB RAM (128 or more megabytes recommended) for Windows XP, Windows 2000, or Windows NT

• Physical memory: 64 MB (256 megabytes recommended) for AIX, HP-UX, and Solaris

Note: Swap space: 2x physical memory, when physical memory is less than .5 GB. Contact your system administrator or hardware vendor for optimum swap configuration.

Disk space • 15 MB for 32-bit Essbase API on Windows XP, Windows 2000, Windows NT, using a Pentium processor

• 10 MB for AIX, HP-UX, and Solaris


1


Supported ODBC Drivers and Relational Data SourcesDataDirect Technologies (formerly MERANT) ODBC driver version 4.0 is provided with Essbase Release 6.5. However, Hyperion Solutions also tests and supports some non-MERANT Windows NT drivers. These non-MERANT drivers are not provided with Essbase. Hyperion Solutions has tested the database configurations listed in Table 8.

Table 8: Supported ODBC Drivers per Operating System and RDBMS

Relational Database Server (Relational Data Source)

ODBC Drivers per Supported Operating System

Windows NT 4.0Windows 2000Windows XP

Solaris 7, 8(Sun OS 5.7 or 5.8)

AIX 4.3.3AIX 5L

HP-UX 11.01 HP-UX 11i

DB2 UDB 6.1 DB2 6.1 ODBC DB2 6.1 ODBC DB2 6.1 ODBC DB2 6.1 ODBC

DB2 UDB 7.1 DB2 7.1 ODBC DB2 7.1 ODBC DB2 7.1 ODBC DB2 7.1 ODBC

DBASE V Microsoft Driver MERANT 4.0 Not supported MERANT 4.0

Informix 9.x (using Informix client)

MERANT 4.0 MERANT 4.0 (ESQL 9.2)

MERANT 3.6 (ESQL 9.2)

Not supported

Oracle 8i (Net8)

MERANT 4.0 MERANT 4.0 MERANT 3.6 MERANT 4.0

Oracle 9i(Oracle Net)

MERANT 4.0 MERANT 4.0 MERANT 3.6 MERANT 4.0

MS SQL Server 7.0

MS SQL Server 7.0 ODBC

Not supported Not supported Not supported

MS SQL Server 2000

MS SQL Server 2000 ODBC

Not supported Not supported Not supported

Sybase 11.x MERANT 4.0 MERANT 4.0 MERANT 3.6 Not supported

30 ■



About the Order of InstallationBefore installing Essbase, you should establish a working client-server environment based on a Named Pipes Services or TCP/IP protocol.

Essbase clients cannot communicate with the Essbase OLAP Server if the environment is not properly established. For information on supported network configurations, see Chapter 9, “Network Configuration Notes.”

When you run the default Essbase installation program on the CD, it installs components in the following order:

1. Application Manager

2. Spreadsheet Add-in

3. Runtime Client

4. Essbase OLAP Server and Sample Applications

5. Application Programming Interface

Sybase 12 MERANT 4.0 MERANT 4.0 MERANT 3.6 Not supported

Access 2000 Microsoft Driver Not supported Not supported Not supported

Access 2002 Microsoft Driver Not supported Not supported Not supported

Teradata 2.42 Teradata 2.08.01.06 ODBC

Teradata 2.4.01.02 ODBC



1 MERANT 4.0 ODBC drivers are supported on HP-UX 11.0 computers when using 32-bit relational.2 Purchase Teradata ODBC drivers separately from the NCR Corporation.

Table 8: Supported ODBC Drivers per Operating System and RDBMS (Continued)

Relational Database Server (Relational Data Source)

ODBC Drivers per Supported Operating System

Windows NT 4.0Windows 2000Windows XP

Solaris 7, 8(Sun OS 5.7 or 5.8)

AIX 4.3.3AIX 5L

HP-UX 11.01 HP-UX 11i


1


You can also install Essbase components separately, not using the default Essbase installation program on the CD, in the following cases:

● When installing patched client or server software

● When using Web downloads of components from the Hyperion Download Center.

● When choosing to install components one at a time from setup.exe programs in the product directories of the CD

● When installing components from a network drive

For more information, see “Launching the Installers” on page 18.

To uninstall Essbase, you should uninstall each component in the reverse order that it was installed. Therefore, if you installed Essbase using the default Essbase installation program at the root of the CD, you should uninstall components in the following order:

● Application Programming Interface

● Essbase OLAP Server and Sample Applications

● Runtime Client

● Spreadsheet Add-in

● Application Manager

Note: If you are uninstalling Essbase components but you do not remember in what order they were installed, uninstall them in any order, but be aware that you might need to delete empty directories manually.

32 ■



Registering Essbase SoftwareEach Essbase installation requires a license number, which your Software Registration Letter contains. This number, which is unique for your OLAP Server, is encoded to identify and enable the options and capacity that you purchased. The Software Registration Letter lists all of the options you licensed and the number of ports you have available.

Note: Keep this letter in a secure place for future reference.

When you receive your Essbase licensing information, verify that the options and number of ports available are correct. If your Essbase license does not contain the correct options, contact your software provider.

Entering License NumbersDuring the installation of the Essbase OLAP Server, you are prompted to enter your license number. Enter the license number as it appears on your Software Registration Letter—as a sequence of 16 alphanumeric digits followed by a single hyphen and the remaining digits.

Registering a New License NumberWhen you license additional server components, you will receive a new license number that reflects the additional options. These components and port additions require that you register your new license number to activate additional ports or to enable the following components:

● Essbase currency conversion

● Essbase Spreadsheet Toolkit (including Visual Basic for Applications [VBA] for Excel)

● Essbase Partitioning

● Essbase SQL Interface

No additional installation is required.


1


➤ To register a new license number:

1. Stop the Essbase OLAP Server.

If you are not sure how to stop the OLAP Server, see “Running Essbase Servers, Applications, and Databases,” in the Essbase Database Administrator’s Guide.

2. Run the register utility. On Windows platforms, the utility resides in the \hyperion\essbase\bin directory on the server. On UNIX platforms it resides in the home/hyperion/essbase/bin directory on the server.

3. Enter the new license number.

4. Start the Essbase OLAP Server.

Be sure that you read the readme.htm file included with the Essbase installation. You can find this file in the \ARBORPATH directory after installation is complete.

Installing and Registering Separate ProductsSome Hyperion components, when licensed for use on an existing Essbase OLAP Server, require installation and registration of a new license key. During the installation you are asked for your license number. Enter the license number as it appears on the Software Registration Letter.

The following Essbase components require installation and a new license key to run on an existing Essbase OLAP Server:

● Essbase Integration Services

● Essbase Application Programming Interface (API)

If you license Essbase Integration Services or the API at the same time that you license the Essbase OLAP Server, you can install and register them at the same time you install and register the Essbase OLAP Server.

Essbase Administration Services must be installed separately from the Essbase OLAP Server, but it does not require a separate license number. For more information on installing Essbase Administration Services, see Essbase Administration Services Installation Guide.

34 ■




Chapter

2Installing Windows OLAP Server Software

Read this chapter for information on system requirements, directories, and environment settings for running the Essbase OLAP Server on Windows.

If you are installing Personal Essbase, first turn to “Installing Personal Essbase” on page 53 and “Limitations of a Personal Essbase Server” on page 54.

The following topics explain how to install OLAP Server software on your computer:

● “Windows OLAP Server Requirements” on page 36

● “About Installing OLAP Server Software on Windows” on page 36

● “Installing the OLAP Server Software on Windows” on page 37

● “Starting the OLAP Server on Windows” on page 43

● “Using Essbase Agent Commands” on page 45

● “Optimizing Network Throughput on Windows NT” on page 46

● “Running the Essbase Agent as a Windows Service” on page 47

● “Installing Personal Essbase” on page 53

36 ■

Installing Windows OLAP Server Software


Windows OLAP Server RequirementsYour system must meet specific requirements for the OLAP Server and the Personal Essbase OLAP Server to function properly. These requirements are described in “Windows Server Requirements” on page 23.

For information about release compatibility between OLAP Server and Essbase clients, see “Release Compatibility” on page 20.

For information about release compatibility between OLAP Server and Essbase Administration Services, see the Essbase Administration Services Installation Guide.

Note: If you are reverting from a later release to an earlier release, uninstall Essbase through Add/Remove programs before reinstalling.

About Installing OLAP Server Software on Windows

The OLAP Server installation program, setup.exe, performs the following operations:

● Creates new directories for a new installation, or updates existing directories if you have a previous release of Essbase installed

● Copies Essbase files to the\ARBORPATH\bin directory on your hard disk

● Copies, if you choose, Essbase sample application files to the\ARBORPATH\app directory on your hard disk

● Installs an essnet file for supported network protocols: TCP/IP or Named Pipes

● Installs, if you choose, the Java Runtime Environment (JRE) to the \essbase\java\jre directory and sets the JVMODULELOCATION parameter in the essbase.cfg file

● Installs documentation

● Updates, if you choose, the Windows environment settings


2


● Installs SQL Interface

Before you can run SQL Interface, you must:

– Enter a license number that is enabled for SQL Interface. See “Entering License Numbers” on page 32.

– Meet SQL Interface system requirements. See “Supported ODBC Drivers and Relational Data Sources” on page 29.

– Set your environment and configure your data source. See “Configuring SQL Interface” on page 139.

Note: You can install Essbase Application Programming Interface (API) separately or at the same time as your OLAP Server installation. If you install at the same time, be sure to review the information in Chapter 7, “Installing the API.”

Installing the OLAP Server Software on Windows

Install OLAP Server software on Windows platforms by launching the installer and following the prompts on your screen.

➤ To install OLAP Server software on a supported Windows platform:

1. If you are upgrading from an earlier release, back up your Essbase files to another directory or to a backup tape. See “Upgrading and Migrating Databases” on page 163 for more information.

2. If you are installing over an existing Essbase installation Release 6.0 or later, uninstall the existing release before installing 6.5.

Uninstalling will not remove the app folders, existing applications, the essbase.sec file, or the essbase.cfg file.

3. Launch the installer for the OLAP Server software. See “Launching the Installers” on page 18 for more information.

4. Follow the prompts, and provide the information requested.

To cancel the installation at any time, click Cancel and then Exit Setup.

38 ■



5. When prompted, type your license number exactly as it is shown on your registration letter.

See “Registering Essbase Software” on page 32 for more information on registration.

6. When the Select Components dialog box is displayed, select the Server products check box.

This selection installs the OLAP Server and sample applications. To narrow the selection, go to Step 7. To accept and continue, go to Step 8.

The Java Runtime Environment (JRE) is included as an optional installation component. The JRE must be installed to enable the Java-based features of Essbase. If you are upgrading from Release 6.1 or 6.2 and you installed JRE with that release, you do not need to re-install JRE.

If you have already installed a compatible version of the JRE, you must configure it to run with Essbase. For more information, see “Manually Installing Java” on page 183.

The installation program displays the product components for your license agreement and operating system.

7. Click Change to view selected components or to select a subset of server components in the Select Sub-components dialog box, as shown in Figure 1. Leave all options selected to install all server products, or deselect the server products that you do not want to install.

Figure 1: Selecting Server Products


2


8. When you finish selecting your options, click Continue, and then click Next in the Server Products dialog box.

9. In the Choose Server Destination Location dialog box, Destination Folder, specify the directory where you want to install the server products that you have selected, and click Next.

Unless another installation of Essbase exists on the computer, the default directory is c:\hyperion\essbase. Click Browse to select or type the name of another directory. If you type the name of a directory that does not exist, the installation program creates the directory for you.

10. In the Choose Network Protocol dialog box, select your network protocol, and click Next.

11. In the Update Environment dialog box, select the environment updates that you want the installation program to perform, and click Next.

● If you are installing the OLAP Server, select whether the installation program updates environment variables and adds a program group to the Start menu.

● Select whether Open Database Connectivity (ODBC) registry information is to be updated.

Your old ODBC registry information will be appended to, but not overwritten, if you select Yes.

Your ODBC registry information will be unchanged if you select No.

12. In the Check Setup Information dialog box, review the summary of your installation choices, and do one of the following:

● To allow the installation program to begin copying files, click Next.

● To revise your choices, click Back.

● To exit the installation program without installing, click Cancel.

40 ■



13. In the Setup Complete dialog box, leave the check box selected and click Finish to view the Readme file.

14. If you chose to let the installation program update the PATH and ARBORPATH environment variables, log out and log on again, or reboot your computer.

Note: You can install more than one instance of the OLAP Server on the same computer. For information on how to install and configure an additional instance of the OLAP Server, see “Running Essbase Servers, Applications, and Databases” in the Essbase Database Administrator’s Guide.

Directory StructureThe OLAP Server installation program creates a directory structure including the following files:

ARBORPATH api app bin docs java locale perlmod ODBC

● The essbase directory contains an *.isu file for each installed server or client component and a file named Essunins.dll, which facilitates uninstalling the software.

CAUTION: Do not move, rename, or delete the *.isu files in the essbase directory. Do not rename the essbase directory or any subdirectories or files beneath it. Alteration of the installed Essbase files and directories prevents their successful uninstallation. In the event that you want to move Essbase to another directory or revert to an earlier release, you will need to completely uninstall it first. For more information about uninstalling, see “Instructions for Uninstalling” on page 192.

● The api directory contains 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.


2


● The app directory stores Essbase application files as they are created. Each application is stored in a subdirectory under the app directory. Each database in an application is stored in a separate subdirectory under the subdirectory of the application.

For example, suppose that you create two applications on the OLAP Server: Finance and Marketing. Then you add two databases to the Finance application, Currency and Main, and two databases to the Marketing application, Product and Sales. The OLAP Server directory structure looks like this:

app finance currency main marketing product

● The bin directory contains the OLAP Server software. This includes MaxL, a linguistic interface that you can use through the MaxL Shell (essmsh.exe) or the MaxL Perl module (Essbase.pm) to automate most Essbase system administration tasks.

● The docs directory contains online Essbase documentation. Double-click essdocs.htm for a live map to available documentation.

● The java directory contains the Java software to support the Java-based features of Essbase. If you choose to automatically install Java from the Essbase installation program, this directory contains the Java Runtime Environment.

● The locale directory contains the character-set files necessary for all the languages that Essbase supports, including English. For non-English versions, you also need to create the ESSLANG environment variable. For more information about ESSLANG, see “Configuring Client and Server for Non-English Essbase” on page 181.

42 ■



● The perlmod directory contains the files and documentation you need to add the MaxL Perl Module (essbase.pm) to Perl, enabling you to embed MaxL statements in Perl programs. You must install Perl yourself. For more information, see the MaxL Language Reference in the docs\techref\maxl directory, and the readme file included in the perlmod directory.

● The ODBC directory contains the ODBC software and documentation. The Essbase installation program installs Merant 4.0 ODBC Drivers. Hyperion also tests and supports some non-MERANT drivers. These non-MERANT drivers are not provided with Essbase. See “Supported ODBC Drivers per Operating System and RDBMS” on page 29 for more information.

SecurityThe essbase.sec file stores information about users, passwords for native security, groups, privileges, and applications. Each time that you successfully start the OLAP Server, essbase.exe, Essbase makes a backup copy of the security file (essbase.bak). If you attempt to start the Agent and a password prompt is not displayed or your password is rejected, no backup file is created. You can restore from the last successful startup by copying essbase.bak to essbase.sec. Both files are in the bin directory where you installed the OLAP Server.

Network Protocol FilesNetwork protocol files implement the TCP/IP or Named Pipes protocol that you select when you install OLAP Server or client software. The network protocol file for server software is essnet.dll. Additionally, the client software (for example, Essbase Spreadsheet Add-in) is installed with a separate essnet.dll. Network protocol files reside in the bin directory with the Essbase program files.

If you have more than one OLAP Server computer and the servers use different network protocols, you must install the client software in multiple directories, one for each network protocol.

For example, you can install Spreadsheet Add-in for a Named Pipes server in n:\hyperion\essbase and Spreadsheet Add-in for a TCP/IP server in t:\hyperion\essbase. The two installations use different essnet.dll files.


2


Starting the OLAP Server on Windows

➤ To start Essbase:

1. From a command prompt, type essbase and press Enter.

If you encounter any errors during startup:

● Check your path and environment settings.

● Make sure that the appropriate network protocol is installed and running on your Windows computer. See Chapter 9, “Network Configuration Notes,” for information on network protocols.

2. If this is a first-time installation, Essbase prompts you for the following items:

● Company name. The name that you type is embedded in your OLAP Server license registration.

● Your name. The name that you type is designated as the Essbase system supervisor. Use this name for your initial logon from the Essbase client to the OLAP Server.

● System password. The password that you choose is required every time you start the OLAP Server. It is also required to gain access to the OLAP Server from clients using the system supervisor account.

● You are asked to confirm your choices. Type 1 to verify your entries, or 2 to retype them.

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

The Essbase window then displays the following message:

Waiting for Client Requests...

You can now use the Essbase window to perform high-level supervisor operations. See “Using Essbase Agent Commands” on page 45 for a list of available commands. After you start the OLAP Server, all OLAP Server activities are recorded in the OLAP 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). For more information, see “Using Essbase Logs” in the Essbase Database Administrator’s Guide.

44 ■



For more information about starting and stopping the OLAP Server, see “Running Essbase Applications and Databases” in the Essbase Database Administrator’s Guide.

Automating the OLAP Server StartupOn Windows, you can place the OLAP Server program in a startup folder so it will start automatically when Windows boots. You can also specify the server password, to avoid having to type it each time the OLAP Server starts.

➤ To automate the OLAP Server startup on Windows platforms:

1. Find the Windows Start Menu customization controls.

● On Windows NT, select Start > Settings > Taskbar > Start Menu Programs tab.

● On Windows 2000, select Start > Settings > Taskbar & Start Menu > Advanced tab.

2. Click Add and specify the location of the Essbase Agent program file, essbase.exe. If you installed Essbase to the default directory, this is c:\hyperion\essbase\bin\essbase.exe.

If you want the Essbase system password to be automatically entered each time Essbase starts, type the password after essbase.exe on the command line. For example:

c:\hyperion\essbase\bin\essbase.exe password

where password is your Essbase system password.

3. Click Next, and then double-click the StartUp or Startup folder.

4. Type Essbase, or your server name, and click Finish.


2


Automating an Application or Database Startup

You can automatically start up an application or database. When the OLAP Server is started, Essbase starts any application or database that is defined with an automatic startup setting. You define startup settings in Essbase Application Manager (Application Settings dialog box and Database Settings dialog box) or in Essbase Administration Services (Application Properties window and Database Properties window).

Note: See Essbase Application Manager Online Help and Essbase Administration Services Online Help for more information.

Using Essbase Agent CommandsEssbase provides a server console called the Agent. When you start the main Essbase program (essbase.exe), the Agent console is displayed. Use this console to perform high-level OLAP Server operations. Pressing the Enter key in the Agent console provides a list of all available commands.

Table 9: 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 the OLAP Server. The total number of connections is displayed, as well as the number of ports available.

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

PASSWORD Changes the system password that is required to start the OLAP Server.This command requires you to type the old Essbase system password.

VERSION Displays the OLAP Server software version number.

HELP Lists all valid Agent commands and their respective functions.

46 ■



To learn more about the Agent, see “Running Hyperion Essbase, Applications, and Databases” in the Essbase Database Administrator’s Guide.

Optimizing Network Throughput on Windows NT

On Windows NT servers, a network setting enables you to optimize the performance of networked applications. Essbase performance improves significantly on Windows NT with this setting enabled.

Note: On Windows 2000, the default system setting is to optimize performance for networked applications. It is not necessary to change this setting.

➤ To enable the Maximize Throughput for Network Applications setting:

1. Exit Essbase.

2. Start the Windows NT Control Panel.

3. Double-click the Network icon.

4. Select the Services tab.

PORTS Displays the number of ports that are installed on the OLAP 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 security system to a specified file in ASCII format. If you do not supply a path with the file name, the file is saved to the \ARBORPATH\bin directory (/ARBORPATH/bin on UNIX systems).This command requires your Essbase system password.

QUIT and EXIT Shuts down all open applications and quits Essbase.

Table 9: Essbase Agent Commands (Continued)

Commands Description


2


5. In the Network Services list box, double-click Server.

The Server dialog box is displayed.

If a message is displayed on your screen indicating that you cannot configure the software component, then your Windows NT computer is probably a Windows NT Workstation configuration, not a Windows NT server configuration, and you cannot change the network settings.

6. Select Maximize Throughput for Network Applications, as shown in Figure 2.

Figure 2: Choosing Maximize Throughput for Network Applications

7. Click OK.

The Services tab of the Network dialog box is displayed.

8. Click Close.

9. Restart Windows NT.

Running the Essbase Agent as a Windows Service

The Essbase Agent (essbase.exe) can run as a Windows service. Running the Agent as a service lets you start and stop the Agent from the Windows Control Panel. Running the Agent as an automatic service starts the Agent as a service when you start Windows. This section contains the following topics:

● “Installing the Essbase as a Service” on page 48

● “Setting the System Environment to Run Essbase as a Service” on page 48

● “Verifying that Essbase is Running as a Service” on page 49

● “Stopping the Essbase Service” on page 50

48 ■



● “Restarting the Essbase Service” on page 51

● “Resetting the Essbase Service” on page 51

● “Removing the Essbase Service” on page 52

Note: The Windows Task Manager does not enable you to terminate any process started as a service. If the Essbase Agent is started as a service, and if it or the server freezes, you must shut down the server computer to stop the Essbase Service.

Installing the Essbase as a Service

➤ To install the Essbase Agent as a service that starts automatically when you start Windows:

1. Select Start > Run.

2. Type cmd in the Open: window.

3. Click OK.

A command prompt window is displayed.

4. Type the following text at the C:\> prompt:

essbase.exe -service install

A message is displayed in the command prompt window that the Essbase Service is installed. The Essbase Agent is now listed as essbase service in the Services dialog box of the Windows NT Control Panel (on Windows 2000, the service is listed in Control Panel > Administrative Tools > Services). The Essbase Agent is now set to start automatically when you start Windows.

Setting the System Environment to Run Essbase as a Service

To run the Essbase Agent as a Windows service, the operating system needs to know where Essbase is located. Before running the Essbase Agent as an automatic service, you must add the %ARBORPATH%\BIN to the system-wide path variable.


2


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

1. Select Start > Settings > Control Panel > System.

2. Find the Windows environment variable controls.

● On Windows NT, select the Environment tab.

● On Windows 2000, select the Advanced tab, and click Environment Variables.

3. Set the following system variables:

● ARBORPATH=C:\HYPERION\ESSBASE, or wherever Essbase is installed.

● Add %ARBORPATH%\BIN to the PATH variable.

4. Reboot your computer to allow these changes to take effect.

The Essbase Agent now runs as a Windows service. It also starts automatically when you start Windows.

Verifying that Essbase is Running as a Service

➤ To verify that the Essbase Agent is running as an automatic Windows service after you reboot:

1. Reboot the Windows server.

2. Select Start > Settings > Control Panel.

3. Open the Services dialog box.

● On Windows NT, double-click Services.

● On Windows 2000, double-click Administrative Tools, then double-click Services.

You will see the Essbase Agent listed as Essbase Service in the list of services. The Startup (or Startup Type) field for Essbase Service should say Automatic, and the Status field will say Started.

Note: If the Startup field is blank or if it says Disabled or Manual, see “Resetting the Essbase Service” on page 51.

50 ■



Stopping the Essbase Service

➤ To stop the Essbase Agent from the Control Panel:





The Services dialog box is displayed. Essbase is listed as Essbase Service in the list of services.

3. Highlight, but do not double-click, Essbase Service.

4. Stop the service.

● On Windows NT, click Stop.

● On Windows 2000, select Action > Stop.

The Service Control message box is displayed and then removed, and the Status field for Essbase Service is changed.

Note: Stopping the Essbase Service can take some time, depending on how many application servers are running. The time that it takes is the same amount it would take to stop essbase.exe if it were running from the command line or as a background process.


2


Restarting the Essbase ServiceIf you have stopped the Essbase Service, you can start it again from the Services dialog box of the Control Panel.

➤ To restart the Essbase Service:





The Services dialog box is displayed. Essbase is listed as Essbase Service in the list of services.

3. Highlight, but do not double-click, Essbase Service.

4. Start the Essbase Service.

● On Windows NT, click Start.

● On Windows 2000, select Action > Start.

The Service Control message box is displayed and then removed, and the Status field for Essbase Service is changed.

Resetting the Essbase ServiceWhen you install the Essbase Agent as a Windows service, it is listed as Essbase Service in the list of services, if however, someone disables it or sets it to manual startup, you can reset the Essbase Service to start automatically.

➤ To reset the Essbase Service to start automatically:





The Services dialog box is displayed. Find Essbase Service in the list of services.

52 ■



3. Double-click Essbase Service.

4. Set the Essbase service to log on automatically as a system account.

On Windows NT,

a. In the Service dialog box, click the Automatic option.

b. Under the Log On As section, select System Account.

On Windows 2000,

a. In the Essbase Service Properties dialog box, select Automatic from the Startup type drop-down list box.

b. In the Log On tab, select Local System account.

Removing the Essbase Service

➤ To remove the Essbase Agent as a Windows service:

1. Stop the Essbase service.

For more information, see “Stopping the Essbase Service” on page 50.

2. Select Start > Run.

3. Type cmd in the Open: window.

4. Click OK.

A command prompt window is displayed.

5. Type the following text at the C:\> prompt:

essbase.exe -service remove

A message is displayed in the command prompt window that the Essbase Service is removed.

Removing the Essbase Service removes it from the list of Windows registered services. It does not uninstall Essbase. You can still start the OLAP Server. See “Restarting the Essbase Service” on page 51.


2


Installing Personal EssbaseSee the following sections for information on Personal Essbase:

● “Personal Essbase Additional Requirements” on page 53

● “Limitations of a Personal Essbase Server” on page 54

● “Connecting to a Personal Essbase OLAP Server” on page 54

● “Troubleshooting Personal Essbase Communication” on page 56

A basic Personal Essbase installation includes the following components:

● A one-port OLAP Server for Windows (including MaxL and ESSCMD)

● Essbase Application Manager

● Essbase Spreadsheet Add-in for your spreadsheet application: Excel 97, Excel 2000, Excel XP, or Lotus 1-2-3 Millennium Release 9.5 or 9.6

➤ To Install Personal Personal Essbase:

1. Verify that you meet the requirements listed in “Personal Essbase Additional Requirements” on page 53.

2. Follow the installation instructions in “Installing the OLAP Server Software on Windows” on page 37.

Personal Essbase Additional RequirementsPersonal Essbase installations require some specific procedures in addition to those for Essbase:

● You must install the OLAP Server and client components in the same root Essbase directory (ARBORPATH). By default, this directory is c:\hyperion\essbase.

● If you have previously installed either Essbase client software or a OLAP Server on your computer, and the installation was not Personal Essbase, you must reinstall both the server and the client software when you install Personal Essbase.

● When installing on a Personal Essbase computer, you must install Release 6.5 client and server software. The combination of a 5.x or 6.1 client and a 6.5 OLAP Server is not recommended.

54 ■



● If you install Personal Essbase on a computer with a dual-boot configuration (for example, Windows NT 4.0 and Windows 2000), do not mix the installations across operating systems. For example, if you install Personal Essbase for Windows NT on a computer that has Essbase installed on a Windows 2000 partition, do not install Personal Essbase for Windows NT in the same directory where Essbase or Personal Essbase is installed for Windows 2000. From within each operating system, you must independently specify the ARBORPATH and PATH settings for the Essbase program files.

Limitations of a Personal Essbase ServerPersonal Essbase is restricted in some ways:

● Only one application and two databases are able to run simultaneously. A system exceeding this configuration is not recommended and is not supported.

● Disk volumes are not supported. The database must fully reside on the disk that contains the OLAP Server software.

● Essbase SQL Interface is not supported.

● Only one port with a local connection (client and server on the same computer) is allowed.

● The Personal Essbase license allows only Personal Essbase clients to connect to the Personal Essbase server. However, Personal Essbase clients may also connect to other OLAP Server on the network. See “Registering Essbase Software” on page 32 for more information on Essbase licenses.

Connecting to a Personal Essbase OLAP ServerAfter you have installed Personal Essbase server and client software, you are ready to use Essbase Spreadsheet Add-in, Essbase Application Manager, or MaxL to connect to the OLAP Server.

➤ To connect to the OLAP Server using Application Manager:

1. Restart your computer to enable changes to the environment.

2. Start Essbase by running essbase.exe.

3. In the Application Manager, select Server > Connect to open the Essbase System Login dialog box, as shown in Figure 3.


2


4. Type the name of your Personal Essbase server.

For example, select Local as the server name:

Figure 3: Typing Your Personal Essbase Server Name Local

You may choose from several server names when connecting:

● Use the default or alias name defined in the Windows hosts file.

For example, type localhost or local as the OLAP Server name.

● Use the computer name, as defined by the operating system for networking.

If you use Named Pipes, using LOCAL as the OLAP Server name is faster than using the computer name.

● Use the default loopback IP address as defined in the hosts file.

For example, type 127.0.0.1 as the OLAP Server name. For more information, see “Configuring the Windows Hosts File” on page 56.

● If you use TCP/IP and the MS Loopback Adapter, you can use the alias name that you mapped in the hosts file to the IP address for the MS Loopback Adapter.

See “Configuring the Windows Hosts File” on page 56.

● If you have not mapped the IP address in the hosts file, and if you have a network adapter card, use the IP address assigned to your network adapter card.

● If you have not mapped the IP address in the hosts file and if you do not have a network adapter card, use the IP address assigned to the MS Loopback Adapter.

5. Click OK.

Note: For information about connecting to Essbase using Essbase Administration Services, see the Essbase Administration Services Installation Guide.

56 ■



Troubleshooting Personal Essbase CommunicationAny of the following problems indicate a configuration error:

● You cannot start the Personal Essbase server (essbase.exe). You see an empty console window, or the following message is displayed in essbase.log:

Network Error [10047]: Unable To Create Host Server Socket

● You can start the Personal Essbase server, but you cannot connect to the server using client software, such as Essbase Application Manager. You see the following message:

Network Error [11002]: Unable To Locate [] In Hosts File

To resolve these problems, confirm that you have the following system components configured correctly:

● You have an appropriate hosts file in your Windows system directory. See “Configuring the Windows Hosts File” on page 56.

● You have installed a supported network protocol (TCP/IP or Named Pipes), which is bound to a network adapter. If you are using a stand-alone computer that has no network interface card (NIC), you must simulate network connectivity by binding your network protocol to the appropriate Microsoft adapter. See “Working Without a Network Interface Card” on page 57.

Configuring the Windows Hosts FileMake sure that you have a hosts file in your Windows system directory.

➤ To create a Windows hosts file:

1. Copy the sample file hosts.sam from your Windows system directory (for example, C:\WINDOWS or C:\WINNT\SYSTEM32\DRIVERS\ETC\HOSTS) and save it as hosts.


2


2. If necessary, edit the hosts file as follows:

On Windows NT or Windows 2000, optionally add a line to hosts that maps the IP address of the MS Loopback Adapter to a name. For example, if the IP address of the MS Loopback Adapter is 149.22.15.1, you can map it to LOCALLOOP as follows:

149.22.15.1 LOCALLOOP

Leave a space between the IP address and the alias name.

Note: Names in the hosts file are case-sensitive.

3. Save the changes to the hosts file.

The hosts file should not have a file name extension. If the text editor adds an extension to the hosts file, remove the extension from the file name using Windows Explorer.

Working Without a Network Interface CardIf you are using Personal Essbase Windows computer that has no network interface card (NIC), you can simulate network connectivity by binding the network protocol to adapter software. The following steps show you how to configure the TCP/IP or Named Pipes network protocol to use the Microsoft Loopback adapter provided with Windows.

➤ To bypass the network on Windows NT or Windows 2000:

1. Install the Microsoft Loopback Adapter.

See “Installing the Microsoft Loopback Adapter” on page 58.

2. If you use TCP/IP, configure Microsoft Loopback with TCP/IP.

See “Configuring Microsoft Loopback with TCP/IP” on page 59.

These instructions assume that you have either TCP/IP or Named Pipes (NetBEUI) installed as a protocol on your Windows NT Workstation. You can use this method whether or not you have a network interface card.

58 ■



Installing the Microsoft Loopback Adapter

➤ To install the Microsoft Loopback Adapter on Windows NT 4.0:

1. Select Start > Settings > Control Panel > Network > Adapters tab.

2. If the Network Adapter list box does not contain MS Loopback Adapter, click Add, and select MS Loopback Adapter from the list of available adapters.

3. Click OK.

If you are prompted for settings such as Frame Type, click OK to accept the defaults. These prompts occur if you have IPX/SPX installed. IPX/SPX is not required for Personal Essbase.

Windows NT prompts you to insert the “Windows NT Workstation CD” into the CD drive.

4. Insert the CD and click OK. MS Loopback Adapter is added to the Network Adapters list box in the Adapters dialog box.

5. Click Close.

If you use only Named Pipes as a network protocol, Windows installs the Microsoft Loopback Adapter and prompts you to reboot your computer so the new settings can take effect.

6. Restart your computer.

If you use TCP/IP, see “Configuring Microsoft Loopback with TCP/IP” on page 59.

➤ To install the Microsoft Loopback Adapter on Windows 2000:

1. Select Start > Settings > Control Panel > Add/Remove Hardware.

2. In the Add/Remove Hardware Wizard, click Next, then select Add/Troubleshoot a device, and click Next.

Windows 2000 searches for available devices.

3. If Microsoft Loopback Adapter is not already listed as an installed device, select Add a new device and click Next.

4. Select No, I want to select the hardware from a list, and click Next.

5. Select Network Adapters from the list of hardware types, and click Next.


2


6. Select Microsoft from the list of manufacturers, and select Microsoft Loopback Adapter from the list of network adapters, and click Next.

7. After Windows 2000 installs the Microsoft Loopback Adapter, click Finish.

Configuring Microsoft Loopback with TCP/IP

➤ To configure the Microsoft Loopback Adapter, complete the following steps that pertain to your operating system:

On Windows NT 4.0:

1. In the Microsoft TCP/IP Properties dialog box, select the IP Address tab.

2. In the IP Address tab of the Microsoft TCP/IP Properties dialog box, select MS Loopback Adapter from the Adapter list box.

3. Type the IP Address and Subnet Mask for the MS Loopback Adapter.

The MS Loopback Adapter has a default IP address. You may give it a fictitious IP address or the IP address of your computer, but its IP address must be different from the IP address for the network adapter, if you have one. The subnet mask for MS Loopback is the same as for the network adapter, if you have one. See your network administrator for the correct addresses.

4. Select the DNS tab, and type the Host Name, Domain, and DNS Service Search Order for the MS Loopback Adapter.

Contact your network administrator for the correct information.

5. Click Add, and click OK.

Windows installs the MS Loopback Adapter and prompts you to reboot your computer so the new settings can take effect.

6. Restart your computer.

On Windows 2000:

1. Select Start > Settings > Control Panel > Network and Dial-up Connections.

2. Right-click the Local Area Connection icon and select Properties.

Verify that Microsoft Loopback Adapter is shown in the Connect using field.

3. Verify that the Internet Protocol (TCP/IP) component is checked. If it is not, select it.

60 ■



4. Select Internet Protocol (TCP/IP) and click Properties.

5. Type the IP Address and Subnet Mask for the Microsoft Loopback Adapter.

The Microsoft Loopback Adapter has a default IP address. You may give it a fictitious IP address or the IP address of your computer, but its IP address must be different than the IP address for the network adapter, if you have one. The subnet mask for Microsoft Loopback is the same as for the network adapter, if you have one. See your network administrator for the correct addresses.

6. Type the DNS server address information. Contact your network administrator for the correct information.

7. Click OK twice.


Chapter

3Installing UNIX OLAP Server Software

Essbase OLAP Server is available for the following UNIX platforms:

● Solaris from Sun Microsystems

● AIX from IBM

● HP-UX from Hewlett Packard

Read this chapter for information on installation, directories, setting your environment, and running the OLAP Server on UNIX.

This chapter contains the following topics:

● “Verifying UNIX OLAP Server Requirements” on page 62

● “About Installing OLAP Server Software on UNIX” on page 62

● “Before You Install on UNIX” on page 63

● “Installing the OLAP Server Software on UNIX” on page 64

● “Updating the Environment Settings (All UNIX Systems)” on page 70

● “Enabling New Environment Settings” on page 74

● “Starting the OLAP Server on UNIX” on page 74

● “Shutting Down the OLAP Server” on page 77

62 ■

Installing UNIX OLAP Server Software


Verifying UNIX OLAP Server RequirementsThe OLAP Server for UNIX requires a system that meets specific requirements. For a summary of UNIX system requirements, see “UNIX Server Requirements” on page 23.

See the appropriate sections to find the system requirements for your UNIX platform:

● “Solaris Server Requirements” on page 24

● “AIX Server Requirements” on page 25

● “HP-UX Server Requirements” on page 26

About Installing OLAP Server Software on UNIXTable 10 describes how Essbase operates in a UNIX environment.

Table 10: Essbase in a UNIX Environment

Multithreading Essbase uses a multithreaded architecture to ensure high performance in a client-server environment. To accomplish this on UNIX platforms, Essbase uses POSIX Threads.

Symmetric Multiprocessing

Essbase supports symmetric multiprocessing (SMP). An SMP server is beneficial where more than one Essbase application is defined on a single server computer.

File systems and buffered I/O

By default, Essbase 6.5 uses buffered I/O.Note: Essbase 6.2 also uses buffered I/O by default. Essbase 6.0 and 6.1 use direct I/O by default. See “Determining Which I/O Access Mode to Use” on page 164 for more information.


3


Before You Install on UNIX

➤ To prepare to install Essbase on any UNIX platform:

● Apply the latest patches for your operating system.

● Create an account that has Read/Write/Execute access to the target directory for Essbase (/home/hyperion/essbase is the default installation directory). This account should belong to the Essbase system administrator. Give this account the same default directory you are using for Essbase (for example, /home/hyperion/essbase). Ideally, the system administrator account owns the target directory.

Note: As of Release 6.0, you are no longer required to install and run Essbase from an account called arbor. Any user can install the product, but it should be the same user account that starts Essbase.

● If you are upgrading from an earlier release of Essbase, first back up your ARBORPATH directory and subdirectories to a backup tape or to another directory. See “Upgrading and Migrating Databases” on page 163 for more information.

X Windows Essbase does not use X Windows.When you run Essbase, the Essbase Agent becomes the active terminal, unless you started Essbase in the background. When you start an Essbase application, the Agent runs in the background. Messages from the application appear in the Essbase Agent terminal (if it is running in the foreground) and are also entered in the appname.log file. To view these messages from a telnet session, use the Tail command to redirect messages to another window at a set interval. It is recommended that you use tail -f logfile to view logged messages as they are posted to the file. Press Ctrl + C to stop viewing the file.You can also run the Essbase Agent in the background. For more information, see “Starting Essbase in the Background” on page 75.

Table 10: Essbase in a UNIX Environment (Continued)

64 ■



Installing SQL Interface on UNIXBeginning with Release 6.5, SQL Interface is installed during the OLAP Server installation.

Before you can run SQL Interface, you must:

● Enter a license number that is enabled for SQL Interface. See “Entering License Numbers” on page 32.

● Meet SQL Interface system requirements. See “Supported ODBC Drivers and Relational Data Sources” on page 29.

● Set your environment and configure your data source. See “Configuring SQL Interface” on page 139.

Installing the OLAP Server Software on UNIXOn UNIX, you can install OLAP Server software in any of the following ways:

● From the root directory of the CD

You do this by running setup.sh (or SETUP.SH) and selecting the component to install. You can install only one component at a time.

● From a network copy of the CD

This option is useful if the system you are installing to does not have a CD drive, or if you do not have access to a CD but the OLAP Server software has been copied to an accessible network drive. You do this by copying the appropriate product directory from the network (for example, /solaris/server), and then running essinst (or ESSINST) in the product directory.

● From files you downloaded from the Hyperion Download Center.

Download the files and untar them, and follow the instructions in the Start Here document. This document is located on the same page of the download center as the Essbase software components.


3


For more information about different installation formats, see “Launching the Installers” on page 18.

To enable the Java-based features of Essbase, you must also manually install Java on the computer running the OLAP Server. For more information about installing Java, see “Manually Installing Java” on page 183.

Note: You can install more than one instance of the OLAP Server on the same computer. For information on how to install and configure an additional instance of the OLAP Server, see “Running Essbase Servers, Applications, and Databases” in the Essbase Database Administrator’s Guide.

Installing from the CD Root Directory

➤ To install OLAP Server products on UNIX from the root directory of the CD:

1. Log on as the Essbase system administrator account. For example, log on as admin if you created a user account called admin that owns the target installation directory /home/hyperion/essbase.

2. Insert the CD into your CD drive.

3. Change to the root directory of the CD (for example, cd /cdrom).

4. Use the ls command to find setup.sh (or SETUP.SH).

Some UNIX CD drives list file names in uppercase. Others list them in lowercase. See whether setup.sh is in uppercase or lowercase.

5. Type ./setup.sh or ./SETUP.SH, depending on what you learned in Step 4. You must run Setup separately for each Essbase product that you want to install. This is what setup does:

● Asks you which product to install: API or OLAP Server

● Runs essinst (or ESSINST) to install that product

6. Follow the prompts and provide the information requested.

To cancel installation at any time, press Ctrl + C.

7. When prompted, type your license number as it appears on your registration letter. Do not include any spaces in the license number.

See “Registering Essbase Software” on page 32 for more information on software registration.

66 ■



8. When prompted, type the directory where you want to install Essbase.

If this is the first installation of Essbase, the installation program uses /home/hyperion/essbase/ as the default directory. You can select another directory, and if it does not exist, the installation program creates it for you.

The installation program decompresses the filename.tz files and copies files to the directory that you select (or default to) and to subdirectories it creates under that directory. Do not create these subdirectories yourself.

Note: If this installation is to a new directory where Essbase has not been installed previously, ignore the following warning that is displayed during the installation process: chmod: WARNING: can't access $ARBORPATH/bin/*.* The message is displayed because chmod is being run on a nonexistent directory.

Update your environment before you use Essbase. See “Updating the Environment Settings (All UNIX Systems)” on page 70.

Installing from the CD Product DirectoryIf you do not have access to the CD, you must copy the appropriate directory of the CD to a network copy before completing these instructions.

Note: If you have access to the CD, it is recommended that you install from the root directory of the CD. See “Installing from the CD Root Directory” on page 65.

➤ To install OLAP Server products on UNIX from the CD product directory, or a copy of it, complete the following steps:

1. Log on as the Essbase system administrator account. For example, log on as admin if you created a user account called admin that owns the target installation directory /home/hyperion/essbase.

2. Change to the appropriate directory for the product you want to install. For example, change to /cdrom/solaris/sqlifc to install Essbase SQL Interface on Solaris.

3. Use the ls command to find essinst (or ESSINST).

Some UNIX CD drives list file names in uppercase and others list them in lowercase. Check whether essinst is in uppercase or lowercase.

4. Type ./essinst or ./ESSINST, depending on what you learned in Step 3. essinst (or ESSINST) installs the product from your current directory.


3



To cancel installation at any time, press Ctrl + C.

6. When prompted, type your license number as it appears on your registration letter.

See Chapter 1, “Preparing to Install Essbase,” for more information on software registration.

7. When prompted, type the directory where you want to install Essbase.

If this is the first installation of Essbase, the installation program uses/home/hyperion/essbase as the default directory. You can choose another directory, and if it does not exist, the installation program will create it for you.

The installation program decompresses the filename.tz files, and copies files to the directory you choose (or default to) and to subdirectories it creates under that directory. Do not create these subdirectories yourself.

8. Update your environment before you use Essbase. See “Updating the Environment Settings (All UNIX Systems)” on page 70.

Installing from the Hyperion Download CenterYou can install from files that you download from the Hyperion Download Center. Download the files, untar them, and run the installation program for each product component. For more information about different installation formats, see “Launching the Installers” on page 18. For more information about using the Hyperion Download Center, See the Start Here document for the product you are downloading.

Running the root.sh Shell ScriptIf you are running Essbase on a Solaris system and you plan to use the Cache Memory Locking database setting, you must run the Bourne shell script root.sh.

Note: It is not necessary run root.sh unless you plan to use the Cache Memory Locking database setting on a Solaris system.

68 ■



After you install the OLAP Server, run root.sh from the root account. The script, located in ARBORPATH/bin, performs post-installation tasks. To run root.sh, log on as user root, and type the following commands:

$ su - Password: (type your password) # cd /home/hyperion/essbase/bin # sh ./root.sh # exit

This is what the script does:

● Runs as root so that it has appropriate access to files and directories.

● Changes ownership of ESSSVR, the application server process to root. This is necessary to enable use of the optional Cache Memory Locking setting.

● Creates symbolic links in /usr/lib to the following shared libraries in ARBORPATH/bin:

Solaris libesssd.so.1libessapi.so.1libessnet.so.1libessotl.so.1libessshr.so.1libesssql.so.1libessutl.so.1libesssvrd.so.1libesssm.so.1libessdvrq.so.1libglobalc.so.

● Asks whether you have installed the Essbase SQL Interface module. If you are not licensed for SQL Interface, it was not installed during the OLAP Server installation. If your answer is no, the program ends and the task is complete.

● If you are licenced for Essbase SQL Interface, it was installed during the OLAP Server installation and you must complete additional tasks before beginning to use it. See Chapter 8, “Configuring SQL Interface,” for more information.


3


Directories Created (All UNIX Systems)The installation program creates a directory structure including the following files:

ARBORPATH bin api app docs locale java perlmod ODBC

The bin directory contains the OLAP Server software. This now includes MaxL, a linguistic interface you can use via the MaxL Shell (essmsh) or the MaxL Perl Module (Essbase.pm) to automate most Essbase system-administration tasks.

The api directory contains libraries and header files necessary for compiling Perl Module. You do not have to install or use the API to compile Perl Module, but the directory is created so that Perl Module can be compiled.

The app directory stores Essbase application files as they are created. Each application is stored in a subdirectory under the app directory. Each database in an application is stored in a separate subdirectory under the subdirectory of the application.

For example, suppose that you create two applications on the OLAP Server: Finance and Marketing. Then you add two databases to the Finance application: Currency and Main, and two databases to the Marketing application: Product and Sales. The OLAP Server directory structure looks like this:

app Finance Currency Main Marketing Sales

The docs/techref/maxl directory contains the MaxL Language Reference, which you need in order to use MaxL, the multi-dimensional access language for Essbase.

The java directory contains the Java software to support the Java-based features of Essbase.

70 ■



The locale directory contains the character-set files necessary for all the languages that Essbase supports, including English. For non-English versions, you also need to create the ESSLANG environment variable. For more information about ESSLANG, see “Configuring Client and Server for Non-English Essbase” on page 181.

The perlmod directory contains the files and documentation you need to add the MaxL Perl Module (Essbase.pm) to Perl, enabling you to embed MaxL statements in Perl programs. You must install Perl yourself. For more information, see the MaxL Language Reference in the docs/techref/maxl directory, and the readme file included in the perlmod directory.

Updating the Environment Settings (All UNIX Systems)

The installation program does not update the environment files.cshrc or.profile. Because the format of these files varies depending on the shell you use, you need to update the appropriate file for your system manually.

Read hyperionenv.doc text file in your installation directory (default installation directory is /home/hyperion/essbase) for the environment setting for the OLAP Server.

Note: If you are installing on Solaris, and you plan to use the Cache Memory Locking database setting, also run root.sh from the ARBORPATH/bin directory. See “Running the root.sh Shell Script” on page 67.

If you are installing SQL Interface on any UNIX platform, you must take additional steps to set your environment. See Chapter 8, “Configuring SQL Interface,” for details.

Note: After installation and updating the environment, you must log out and log on again to enable the new settings to take effect.


3


Setting the $ARBORPATH Variable (Mandatory)You must update the $ARBORPATH environment variable before you begin to use Essbase.

➤ To update the environment:

1. Open and read the hyperionenv.doc text file in your installation directory (default installation directory is /home/hyperion/essbase).

The installation program creates a file, hyperionenv.doc, with the shared library information you need in your global environment. If you installed Essbase to/home/hyperion/essbase, you see the following string:

ARBORPATH=/home/hyperion/essbase

2. Add this setting to your environment in the appropriate format for your system. For example:

● In the C shell, add the following to your.cshrc environment file:

setenv ARBORPATH "/home/hyperion/essbase"

● In the Bourne or Korn shell, add the following to your .profile environment file:

ARBORPATH=/home/hyperion/essbase; export ARBORPATH

3. Log out from your UNIX server and log back in again to enable the changes to your environment to take effect.

Adding Essbase to the Path (Optional)You might want to add the $ARBORPATH/bin directory to the path so you can quickly access Essbase components. For example:

● In the C shell, edit the .cshrc file:

set PATH=($PATH /usr/bin $ARBORPATH/bin)

● In the Bourne or Korn shell, edit the .profile file:

PATH=$PATH:/usr/bin:$ARBORPATH/BIN; export PATH

72 ■



Setting the Library Path Variables (Mandatory)You must update the system library path setting to include the $ARBORPATH/bin directory. Set the library path variables in the appropriate format for your shell.

● “Setting Solaris Library Path Variables” on page 72

● “Setting HP-UX Library Path Variables” on page 73

● “Setting AIX Library Path Variables” on page 73

If you have licensed SQL Interface, you also need to add $ARBORPATH/dlls to the library path setting. For more information about Essbase SQL Interface environment settings, see Chapter 8, “Configuring SQL Interface.”

Setting Solaris Library Path VariablesOn Solaris, you must update the LD_LIBRARY_PATH setting to include the $ARBORPATH/bin directory. If you already have an LD_LIBRARY_PATH setting, append $ARBORPATH/bin after the existing setting.

● In the C shell, set the LD_LIBRARY_PATH path in the.cshrc file:

setenv LD_LIBRARY_PATH "$LD_LIBRARY_PATH:/usr/lib:$ARBORPATH/bin"

If you have licensed SQL Interface, also include $ARBORPATH/dlls:

setenv LD_LIBRARY_PATH "$LD_LIBRARY_PATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls"

● In the Bourne or Korn shell, set LD_LIBRARY_PATH in the .profile file:

LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib:$ARBORPATH/bin; export LD_LIBRARY_PATH


LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls; export LD_LIBRARY_PATH


3


Setting HP-UX Library Path VariablesOn HP-UX, you must update the SHLIB_PATH setting to include the $ARBORPATH/bin directory. If you already have an SHLIB_PATH setting, append $ARBORPATH/bin after the existing setting.

● In the C shell, add the following to the .cshrc file:

setenv SHLIB_PATH "$SHLIB_PATH:/usr/lib:$ARBORPATH/bin"


setenv SHLIB_PATH "$SHLIB_PATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls"

● In the Bourne or Korn shell, add the following to the .profile file:

SHLIB_PATH=$SHLIB_PATH:/usr/lib:$ARBORPATH/bin; export SHLIB_PATH


SHLIB_PATH=$SHLIB_PATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls export SHLIB_PATH

Setting AIX Library Path VariablesOn AIX, you must update the LIBPATH setting to include the $ARBORPATH/bin directory. If you already have an LIBPATH setting, append $ARBORPATH/bin after the existing setting.

● In the C shell, add the following string to the .cshrc file:

setenv LIBPATH "$LIBPATH:/usr/lib:$ARBORPATH/bin"


setenv LIBPATH "$LIBPATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls"

● In the Bourne or Korn shell, add the following to the .profile file:

LIBPATH=$LIBPATH:/usr/lib:$ARBORPATH/bin; export LIBPATH


LIBPATH=$LIBPATH:/usr/lib:$ARBORPATH/bin:$ARBORPATH/dlls; export LIBPATH

74 ■



Enabling New Environment SettingsAfter updating the environment, you must enable the new environment settings to take effect:

➤ To enable the new environment settings:

1. Log out from your UNIX server.

2. Log back in again.

3. Type env to verify the new environment settings.

Starting the OLAP Server on UNIXYou can start the OLAP Server in the foreground or in the background.

Before you can access the OLAP Server, you must be logged on to the UNIX server on an account that has at least Read/Write/Execute access to the Essbase directories. Ideally, this is the same account that was used to install Essbase. For more information, see “Before You Install on UNIX” on page 63.

After you start the OLAP Server, all OLAP Server activities are recorded in the OLAP 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). For more information, see “Using Essbase Logs” in the Essbase Database Administrator’s Guide.

Starting Essbase in the Foreground

➤ To start the OLAP Server in the foreground:

1. From the command prompt, type

$ARBORPATH/bin/ESSBASE

or, if your path includes $ARBORPATH/bin, type

ESSBASE

If you encounter any errors during startup, check your path and environment settings.


3


2. If this is a first-time installation, Essbase prompts you for the following items:

● Company name. The name you type will be embedded in your OLAP Server license registration.

● Your name. The name you type will be designated as the Essbase system supervisor. Use this name for your initial logon from the Essbase client to the OLAP Server.

● System password. The password you choose is required every time you start the OLAP Server.

● You are asked to confirm your choices. Type 1 to verify your entries, or 2 to retype them.

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

The Essbase Agent then displays the following message:

Waiting for Client Requests...

You can now use the Essbase Agent to perform high-level supervisor operations. See “Using Essbase Agent Commands” on page 45 for a list of available commands.

Starting Essbase in the BackgroundIf you are starting Essbase for the first time after installing, you must start Essbase in the foreground once before you can start it in the background. See “Starting Essbase in the Foreground” on page 74.

Note: You must start Essbase in the foreground the first time after installing is because you are prompted for a company name, an administrator user name, and a password. Essbase requires this startup information to run.

If you installed Essbase Release 6.5 in the same directory as an existing Essbase installation, it is not necessary to start Essbase in the foreground before starting it in the background.

After you have started Essbase in the foreground and followed the prompts to enter your company name, Essbase administrator user name, and password, type EXIT to stop the OLAP Server and follow the instructions to start Essbase as a background process.

76 ■



➤ To start Essbase as a background process:

1. If this is a first time installation, you must start Essbase in the foreground. See “Starting Essbase in the Foreground” on page 74.

2. To start Essbase in the background on UNIX, or on Windows systems utilizing a UNIX-like shell such as MKS, enter the following command at the command prompt of your operating system:

$ARBORPATH/bin/ESSBASE password -b &

If your path already includes $ARBORPATH/bin, type this instead:

ESSBASE password -b &

You can start Essbase without using the ampersand (&) at the end of the command, but if you do not type the &, the command prompt is not returned after the OLAP Server is started.

Securing a Password ScriptTo hide the Essbase system password from the UNIX process listing created by the ps -ef utility on Solaris and HP-UX, you must create a simple shell script and use it to launch the Essbase Agent. Create a shell script named essbase.secure, consisting of the following lines:

#!/bin/sh PASS=$1 ESSBASE -b -secure << EOF & ${PASS} EOF

After creating this script, launch the Agent to start it in the background with password secured from process listing details:

essbase.secure password

Note: On AIX servers the Essbase system password is hidden automatically.


3


Shutting Down the OLAP ServerTo shut down the OLAP Server when Essbase is running in the foreground, type EXIT.

To shut down the OLAP Server from any terminal connected to it, use the SHUTDOWNSERVER command in ESSCMD.

For more information about starting and stopping the OLAP Server, applications, and processes, see “Running Essbase Applications and Databases” in the Essbase Database Administrator’s Guide.

Essbase Agent CommandsEssbase has an OLAP Server process called the Agent. When you start the main Essbase program (ESSBASE), the Agent becomes the active terminal, unless you start Essbase in the background. The Agent acts as a console for high-level OLAP Server operations. Pressing the Enter key in the Agent terminal provides a list of all available commands.

Note: The Agent commands are available only when Essbase is started in the foreground.

For a list of Agent commands, see “Essbase Agent Commands” on page 45.

To learn about the Agent, see “Running Essbase Applications and Databases” in the Essbase Database Administrator’s Guide.

What’s Next?After you have successfully started the OLAP Server, install Essbase Application Manager on a Windows computer and verify that you can connect to the OLAP Server from there.

Note: See Chapter 4, “Installing Application Manager and Spreadsheet Add-in,” for information on Essbase Application Manager.

78 ■



If you installed the sample applications, you need to load data into them. The sample applications are provided as examples of basic Essbase databases. The Essbase Spreadsheet Add-in User’s Guide uses the Sample Basic database in a step-by-step tutorial on the spreadsheet features.

Note: See Chapter 5, “Setting up the Sample Applications,” for information on loading data into the sample applications and preparing them for use.


Chapter

4Installing Application Manager and Spreadsheet Add-in

This chapter tells you how to install or share Essbase client software for Windows and how to connect to the Essbase OLAP Server. Client software includes Essbase Spreadsheet Add-in, Essbase Application Manager, and Runtime Client. For information about installing Essbase Administration Services, see the Essbase Administration Services Installation Guide.

This chapter contains the following topics:

● “System Requirements” on page 79

● “Upgrading from Essbase 5.x” on page 80

● “Choosing Among Client Software Installation Options” on page 81

● “Setting Up Your Computer to Share Client Software on the Network Drive” on page 87

● “Changing the Network Protocol” on page 89

● “Client Product Directories and Files Created” on page 90

● “Starting Essbase Application Manager” on page 93

● “Connecting to the OLAP Server with Application Manager” on page 94

● “Starting Essbase Spreadsheet Add-in and Connecting to the OLAP Server” on page 99

System RequirementsInstall the Essbase client software on a Windows-based computer that meets the system requirements described in “Client Platform System Requirements” on page 27.

80 ■

Installing Application Manager and Spreadsheet Add-in


Before installing client software:

● Identify the client operating environment: Windows XP, Windows 2000, Windows NT, Windows ME, or Windows 98

● Identify the network protocol that you use

● If installing from a network drive, locate where the software resides on the network

Note: If you are reverting from a later release to an earlier release, uninstall Essbase through Add/Remove programs before reinstalling.

Upgrading from Essbase 5.xWhen you install a Release 6.5 client, the default directory for installation is c:\hyperion\essbase. With Release 5.x, the default directory was c:\essbase.

For information on the compatibility of different releases of Essbase clients and the OLAP Server, see “Release Compatibility” on page 20.

Unless you choose to update environment variables manually, the client installation program updates your ARBORPATH variable to point to the new Essbase directory, and your PATH to include the bin directory beneath the new Essbase directory.

To install Release 6.5 clients successfully:

● Install all clients in the same directory. This includes Essbase Application Manager and Essbase Spreadsheet Add-in.

● If you install Essbase Application Manager and Essbase Spreadsheet Add-in on the same computer, make sure that both are Release 6.5. Release 6.5 clients share.dll files that may not work with earlier clients.

For backward compatibility, you can use Release 5.x Essbase SQL Drill-Through with Essbase Release 6.5. If you choose to do so, this is what you must do:

– Install Essbase Spreadsheet Add-in Release 6.5 first.

– Use Essbase SQL Drill-Through 5.0.2 Patch 9 or later.

– Install Essbase SQL Drill-Through to the same directory as the Essbase Spreadsheet Add-in Release 6.5.


4


● If you decide to run Release 5.x of Essbase Spreadsheet Add-in for Excel with the Release 6.5 OLAP Server, make sure that the spreadsheet application points to essexcln.xll (Excel) or ess123.12a (Lotus 1-2-3) in the correct directory. If necessary, remove the add-in from Excel or Lotus 1-2-3 and then add it again, pointing it to the correct directory. See “Remove and Manually Add the Essbase Spreadsheet Add-in” on page 103.

● Move any client application files that you have created to the new location. For example, if your old installation is in c:\essbase5, and your new installation is in c:\hyperion\essbase6, copy the c:\essbase5\client directory and its contents to c:\hyperion\essbase6\client. Using MS-DOS, you can use the following command (all on one line):

XCOPY C:\ESSBASE5\CLIENT\*.* C:\HYPERION\ESSBASE6\CLIENT\*.* /S

When you have successfully copied all files, delete the old client directory.

Choosing Among Client Software Installation Options

Before installing Essbase client software, decide whether you are installing from a CD, from a network drive, or from Web downloads of components from the Hyperion Download Center. Also, identify whether you are installing to a network drive or to a client computer:

● Install from the CD to a client hard disk drive or to a network drive. Any user who has access to the CD can install from the CD to a client hard disk drive. A system administrator can install to a network drive. See “Installing Client Software” on page 82.

● Install from a network to a client hard disk drive. This option is available for client users if the system administrator previously installed software to a network drive. See “Installing Client Software From the Network to Your Hard Disk Drive” on page 86.

82 ■



● Install from Web downloads of components to a client hard disk drive or to a network drive. See “Launching the Installers” on page 18 and the Start Here document on the Hyperion Download Center for more information.

● Set up the client computer to use shared executables located on the network drive. This option is available for client users if the system administrator previously installed software to a network drive. See “Setting Up Your Computer to Share Client Software on the Network Drive” on page 87.

● Change the network protocol. This option is for the system administrator. Everyone who uses a shared executable on a network drive must use the same network protocol file. See “Changing the Network Protocol” on page 89.

Installing Client SoftwareIf you are running Windows, you can install client software on your hard disk drive or to a network drive. If you are a system administrator, you can install the following client software to a network drive so that client users can install from there:

● Application Manager

● Spreadsheet Add-in for Excel or Lotus 1-2-3

● Runtime Client

Essbase Administration Services is installed separately from Essbase. For information about installing Essbase Administration Services, see the Essbase Administration Services Installation Guide.

Note: This installation procedure is written for the default installation program on the Essbase CD, but much of this information also applies to other installation formats. For more information about different installation formats, see “Launching the Installers” on page 18.


4


➤ To install any or all of the above products on your client hard disk drive or to a network drive:

1. Launch the installation program.

See “Launching the Installers” on page 18 for more information.


Note: To cancel installation at any time, click the Cancel and Exit Setup buttons.

3. When the Select Components dialog box is displayed, select the Client products check box, as shown in Figure 4.

This step installs all the client product choices for your license agreement and operating system.

Figure 4: Selecting to Install All Client Products

84 ■



4. Click Change to view the Select Sub-components dialog box as shown in Figure 5.

Leave all options selected to install all client products, or clear the check boxes next to the client products that you do not want to install.

Figure 5: Selecting Which Client Products to Install

5. When you finish selecting options, click Continue and Next.

6. In the Client Setup and Destination Directory dialog box, select Local if you are installing to your hard disk drive or Network if you are installing to a network drive. In the Destination Folder, specify the directory where you want to install, and click Next to go to the Choose Network Protocol dialog box.

Note: The default directory is c:\hyperion\essbase. Click Browse to select or type another directory. If you select or type a directory that does not exist, the installation program creates it for you.


4


7. In the Choose Network Protocol dialog box, select your network protocol as shown in Figure 6, and click Next.

Figure 6: Choosing a Local Client Installation

8. If you are installing Essbase Application Manager, the Install HTML Documentation dialog box is displayed. Review the size requirements for the available online documents, select the HTML documentation to install, and click Next.

It is recommended that the system administrator install or copy the HTML documentation to a network drive so that all client users can access it from there. See “Installing Essbase Documentation” on page 193 for information on installing additional copies of the documentation. To view a guide to the Essbase documentation, open the essdocs.htm file in the docs directory.

9. In the Update Environment dialog box, select which environment updates you want the installation program to perform, and click Next.

You can select whether or not the installation program makes the following changes to your environment variables:

● Creates an ARBORPATH environment variable, and adds a statement to the PATH environment variable. If you do not choose to let the installation program update the environment, then you must do it yourself. The update is needed to enable the system to find Essbase files.

● Adds a program group to the Windows Start menu.

86 ■



10. In the Check Setup Information dialog box, review the summary of your installation choices. Click Back to revise your choices, Cancel to exit the installation program, or Next to allow the installation program begin copying files.


12. If you chose to allow the installation program to update the PATH and ARBORPATH environment variables, do one of the following tasks:

● On Windows NT, Windows 2000, Windows XP, or Windows ME, log out and log on again, or reboot your computer, to allow the environment changes to take effect.

● On Windows 98, reboot your computer to allow the environment changes to take effect.

Installing Client Software From the Network to Your Hard Disk Drive

Before you can install client software from a network drive, it must be installed to a network drive by a system administrator. You should know the following information before installing client software from a network drive:

● The network protocol you use: TCP/IP or Named Pipes

● Where the client software resides on the network

➤ To install client software from the network to a client computer:

1. Using Windows Explorer, browse to the appropriate location for setup, where n:\hyperion\essbase is the name of the network drive and directory where your system administrator installed the client software:

● For Essbase Application Manager:

n:\hyperion\essbase\appman32\setup

● For Essbase Spreadsheet Add-in for Excel:

n:\hyperion\essbase\essexc32\setup

● For Essbase Spreadsheet Add-in for Lotus 1-2-3:

n:\hyperion\essbase\esslot32\setup


4


2. Double-click setup to start the installation program.

Note: If you are installing Essbase Spreadsheet Add-in, the installation program detects whether you have the correct version of Excel or Lotus 1-2-3 for the add-in you are installing.

3. Complete step 2 to 12 in “Installing Client Software” on page 82.

Setting Up Your Computer to Share Client Software on the Network Drive

After the Essbase system administrator has installed Essbase client software on a network drive, you can configure your computer to use the client software without installing it locally.

➤ To set up your computer to run Essbase Application Manager or Essbase Spreadsheet Add-in from the network drive:

1. Using Windows Explorer, browse to the appropriate location for setup, where n:\hyperion\essbase is the name of the network drive and directory where your system administrator installed the client software:

● For Essbase Application Manager:

n:\hyperion\essbase\appman32\setup

● For Essbase Spreadsheet Add-in for Excel:

n:\hyperion\essbase\essexc32\setup

● For Essbase Spreadsheet Add-in for Lotus 1-2-3:

n:\hyperion\essbase\esslot32\setup

2. Double-click setup to start the installation program:

Note: If you are installing Essbase Spreadsheet Add-in, the installation program detects whether you have the correct version of Excel or Lotus 1-2-3 for the add-in you are installing.

3. Follow the directions on your screen.

88 ■



4. When prompted to Choose Installation Type, select Set up client to use shared executables, as shown in Figure 7, and click Next.

Figure 7: Choosing to Set Up Your Computer to Run the Client Software on the Network Drive

5. The program detects where the network installation of the client software resides. If the program cannot find the client software, you are prompted for the directory. Click Browse to specify the location.

Note: The Essbase shared executable files are in the n:\hyperion\essbase\bin directory, where n:\hyperion\essbase is the name of the network drive and directory where your system administrator installed the client software.

6. In the Check Setup Information dialog box, review the summary of your installation choices. Click Back to revise your choices, Cancel to exit the installation program, or Next to allow the installation program to begin updating your environment.

This type of installation automatically creates or updates the ARBORPATH environment variable, and adds a statement to the PATH environment variable. This update is needed to enable the system to find shared Essbase files.


8. Take one of the following actions to allow the environment changes to take effect:

● On Windows XP, Windows 2000, Windows NT, or Windows ME, log out and log on again, or reboot your computer.

● On Windows 98, reboot your computer.


4


Changing the Network ProtocolIf you are a client user, changing the network protocol is something you rarely do. If you installed client products on your hard disk drive, contact your system administrator before changing your network protocol.

CAUTION: If you set up your client computer to run client products from the network drive, do not change the network protocol. Everyone who uses a shared executable on a network drive must use the same network protocol file. Only the system administrator should change the protocol of a shared network installation.

The network protocol file implements the TCP/IP or Named Pipes protocol you selected when you installed the client software on your hard disk drive, or that the system administrator selected to install the client software to a network drive. The network protocol file, essnet.dll, resides in the bin directory with the client software. This can be on your hard disk drive or on a network drive, depending on which installation option you selected. For more information on network protocols, see Chapter 9, “Network Configuration Notes.”

➤ To install a different network protocol file:

1. Run setup from the CD (follow step 1 through step 4 of “Installing Client Software” on page 82).

2. In the Select Components dialog box, select the Update Protocols check box, and click Next.

3. When prompted to Choose Network Protocol, as shown in Figure 8, select a network protocol and click Next.

Contact your system administrator if you are not sure which option to select.

Figure 8: Choosing the TCP/IP Network Protocol

4. The program detects where the installation of the client software resides. If the program cannot find the client software, you are prompted for the directory. Click Browse to specify the location.

90 ■



5. In the Check Setup Information dialog box, review the summary of your installation choices. Click Back to revise your choices, Cancel to exit the installation program, or Next to allow the installation program to begin copying files.

6. In the Setup Complete dialog box, click Finish.

Client Product Directories and Files CreatedWhen you install Essbase client products to a hard disk drive or to a network drive, some or all of the directories described in Table 11 are created under \hyperion\essbase (this is the default installation directory; if you select another location, the directories are created there). Directories created depend on which client products you install and which installation type you select.

When you set up your computer to run client software on the network drive, the installation program, setup, does not create any directories on your hard disk drive. It installs only Windows system files on your hard disk drive. You run the program files that are on the network drive. The program files are in the directories described in Table 11.

Table 11: Client-specific Directories in the Essbase Directory

Directory Created with Details

api All installations of Essbase Application Manager and the OLAP Server

Contains 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.

bin All Essbase product installations

Contains Essbase program files for running local and shared network installations: • essadmin.exe, the executable file for Essbase

Application Manager • essexcln.xll, the Essbase Spreadsheet Add-in file the

installation program adds to Excel to point Excel to the correct bin directory

• ess123.12a, the Essbase Spreadsheet Add-in file the installation program adds to Lotus 1-2-3 to point Lotus 1-2-3 to the correct bin directory


4


client All Essbase product installations

The Essbase sample spreadsheets reside in client\sample. If you create applications and databases, and store them on your hard disk drive, they reside in the client directory as follows:

client appname dbname

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

docs Local and network installations of some Essbase products

Depending on the component you install, online documentation is installed in \docs. Open the essdocs.htm file to view doc components.You can download Adobe Acrobat Reader from http://www.adobe.com.

locale Local and network installations of some Essbase products

Contains the character-set files necessary for all the languages Essbase supports, including English. For non-English versions, you also need to create the ESSLANG environment variable. For more information about ESSLANG, see Chapter 11, “Performing Advanced Installation Tasks.”

perlmod All installations of Essbase Application Manager and the OLAP Server

Contains the files and documentation you need to add the MaxL Perl Module (Essbase.pm) to Perl, enabling you to embed MaxL statements in Perl programs. You must install Perl yourself. For more information, see the MaxL Language Reference in the docs\techref\maxl directory, and the readme file included in the perlmod directory.

appman32 Network installations of Essbase Application Manager

Contains the installation directory for installing Essbase Application Manager on the hard disk drive of the client computer. Contains setup.exe.

essexc32 Network installations of Essbase Spreadsheet Add-in for Excel

Contains the installation directory for installing Essbase Spreadsheet Add-in for Excel on the hard disk drive of the client computer. Contains setup.exe.

Table 11: Client-specific Directories in the Essbase Directory (Continued)


http://www.adobe.com

92 ■



In addition to a readme.htm file and the subdirectories listed above, the essbase directory contains an *.isu file for each installed server or client component, and a file named Essunins.dll, which facilitates uninstalling the software.

CAUTION: Do not move, rename, or delete the *.isu files in the essbase directory. Do not rename the essbase directory or any subdirectories or files beneath it. Alteration of the installed Essbase files and directories prevents their successful uninstallation. In the event that you want to move Essbase to another directory or revert to an earlier release, you must completely uninstall it first. For more information about uninstalling, see Chapter 11, “Performing Advanced Installation Tasks.”

esslot32 Network installations of Essbase Spreadsheet Add-in for Lotus 1-2-3

Contains the installation directory for installing Essbase Spreadsheet Add-in for Lotus 1-2-3 on the hard disk drive of the client computer. Contains setup.exe.

runtime Network installations of Essbase Runtime Client

Contains the installation directory for installing Essbase Runtime Client on the hard disk drive of the client computer. Contains setup.exe.

Table 11: Client-specific Directories in the Essbase Directory (Continued)



4


Starting Essbase Application ManagerAfter you install Essbase Application Manager on your hard disk drive or set up your operating environment to run Essbase Application Manager on the network drive, reboot your computer. If, during the installation, you selected to add icons to the Start menu program group, the icons shown in Table 12 are available when you select Start > Programs > Hyperion Solutions > Essbase 6.5:

To run Essbase Application Manager, select Start > Programs > Hyperion Solutions > Essbase 6.5 > Essbase Application Manager.

The Essbase Application Manager desktop is displayed, as shown in Figure 9.

Figure 9: Application Manager Desktop

Table 12: Program Icons

Icon Program Where To Get Information

Essbase Application Manager

Essbase Database Administrator’s Guide

Essbase Application Manager Help

Click the Help button in any dialog box.

ESSCMD Essbase Database Administrator’s Guide

94 ■



If your ARBORPATH environment variable is not correct or if the essbase.mdb file is missing, you see the error message shown in Figure 10 when you start Essbase Application Manager.

Figure 10: Cannot Initialize Essbase Error Message

Connecting to the OLAP Server with Application Manager

After you start Application Manager, try connecting to the OLAP Server to verify that you can establish a connection.

➤ To connect to the OLAP Server from the Application Manager:

1. From the Server drop-down menu, select Connect.

The Essbase System Login dialog box is displayed, as shown in Figure 11.

Figure 11: Logging in Using the Server Name

2. From the Server list box, select the server name to connect to, or type it in the Server text box.

The server name is defined by the server operating system and by the network protocol. In Figure 11, for example, the server name is Aspen.

An alternative way to enter the server name, if you use TCP/IP, is to type its IP address. See “Specifying an IP Address as a Server Name” on page 96 for more information. See your network administrator for your server’s IP address.


4


3. Type your user name and password in the text boxes, as shown in Figure 12.

If you do not know your user name and password or if you are unable to connect to the OLAP Server, contact your Essbase system administrator. If you or the system administrator just installed the OLAP Server software, the only user that exists on the OLAP Server is the user name of the Essbase system supervisor, and you should use the Essbase system password. See the installation chapter for your server platform for more information.

Figure 12: Logging in Using the Server IP Address

4. Click OK.

The application desktop window is displayed on the Application Manager desktop. For example, if the server name is Aspen, the desktop looks like the example shown in Figure 13.

Figure 13: Application Desktop Window for the Aspen Server

Note: If you cannot connect to the OLAP Server, see “Troubleshooting Application Manager Connections to the OLAP Server” on page 97.

96 ■



Specifying an IP Address as a Server NameWhen connecting to a OLAP Server from any Essbase client, you normally use the server computer name, as defined by the operating system. You can also use the IP address of the server computer, if the server computer is TCP/IP-enabled.

From ESSCMD, or from any client login dialog box, you can type the IP address in place of the server name. Type the IP address in dotted notation as shown in the following example:

A.B.C.D

where A, B, C, and D are integers in decimal, hexadecimal, or octal format.

To specify an IP address using decimals, type the IP address, beginning with any digit except 0 (zero). For example:

149.22.15.154

To specify an IP address using octals, type the IP address with a leading 0 (zero). For example:

0225.26.17.232

To specify an IP address using hexadecimals, type the IP address with a leading 0x or 0X. For example:

0x95.16.F.9A


4


Troubleshooting Application Manager Connections to the OLAP Server

If you have difficulty connecting to the OLAP Server, this section helps you to determine why you cannot connect and how to correct the problem.

● Essbase Application Manager can find the server computer but cannot connect to the OLAP Server. This error message may be displayed if Essbase is not running on the server or if the network protocols for the server and the client are different or are not correctly installed and running. In this case, the error message shown in Figure 14 is displayed.

Figure 14: Cannot Locate Essbase on the Server Computer

If you see the message shown in Figure 14:

a. Reboot your computer and try again.

b. Verify that Essbase is running on the server computer.

c. Ensure that your network protocol is correctly installed. See “Checking the Network Protocol” on page 98.

● Essbase Application Manager cannot find the server name you entered. This error message can be displayed if you enter an invalid server name, or if the network protocols for the server and the client are different or are not correctly installed and running. In this case, the error message shown in Figure 15 is displayed.

Figure 15: Cannot Locate the Server Computer

98 ■



If you see the message shown in Figure 15:


b. Verify that the server name you entered is correct.

c. Ensure that your network protocol is correctly installed. See “Checking the Network Protocol” on page 98.

● A similar error, Network Error: Unable to Connect to Server-name, is displayed if the network protocols for the server and the client are different or are not correctly installed and running.

If you see this message,


b. Ensure that your network protocol is correctly installed. See “Checking the Network Protocol” on page 98.

Checking the Network ProtocolIf you suspect that the network protocol for Essbase Application Manager is not correctly installed:

1. See “Changing the Network Protocol” on page 89.

2. See Chapter 9, “Network Configuration Notes” for more information on network protocols.

3. See your network protocol vendor documentation for more detailed information.

Note: Do not change the network protocol on your client computer if you set up your operating environment to run Essbase Application Manager on the network drive. All users running—and sharing—client software on a network drive must use the same network protocol file. Only the Essbase system administrator should change the protocol of a shared network installation.


4


Starting Essbase Spreadsheet Add-in and Connecting to the OLAP Server

After installing Essbase Spreadsheet Add-in on your hard disk drive or setting up your computer to run Essbase Spreadsheet Add-in on the network drive, the next step is to start the Essbase Spreadsheet Add-in and connect to the OLAP Server.

➤ To start the Essbase Spreadsheet Add-in and connect to the OLAP Server:

1. Reboot Windows to let the changes to your environment take effect.

2. Run Excel or Lotus 1-2-3.

The Essbase startup screen is displayed.

If the startup screen is not displayed, and Essbase is not listed on the Excel or Lotus 1-2-3 menu, see “Troubleshooting the Spreadsheet Add-in Installation” on page 102 to correct the problem.

3. Select Essbase > Connect.

The Essbase System Login dialog box, shown in Figure 16, is displayed.

Figure 16: Entering the Server Name in the Essbase System Login Dialog Box

100 ■



4. Type your server name, user name, and password, and then click OK.

An alternative way to type the server name, if you use TCP/IP, is to type its IP address, as shown in Figure 17. See your network administrator for the IP address of your server.

Figure 17: Entering the IP Address in the Essbase System Login Dialog Box

5. After you connect to the server, select the application and database to connect to, and click OK.

See the Essbase Spreadsheet Add-in User’s Guide for more information about connecting to OLAP Servers and databases.

Installing the Essbase Toolbar (Optional—Excel Only)The Essbase Spreadsheet Add-in for Excel provides a convenient toolbar that displays buttons for accessing most of the common Essbase commands without having to open the Essbase menu. To use the Essbase toolbar, you must first install it by opening an Excel file that is provided as part of the default Essbase installation. For more information on using the toolbar, see “Using the Essbase Toolbar” in the Essbase Spreadsheet Add-in User’s Guide.


4


➤ To install the Essbase toolbar:

1. Start Excel.

2. Select File > Open.

3. Open the esstoolb.xls file from the \essbase\client\sample directory.

Depending on how software is installed on your computer, this file may not be available or may be located in a different directory. Contact your Essbase system administrator for more information.

A blank spreadsheet is displayed, similar to the one shown in Figure 18.

Figure 18: esstoolb.xls File

Note: If two Excel dialog boxes are displayed in sequence when you open the esstoolb.xls file, click Enable Macros on the first dialog box, and click OK on the second.

4. Select File > Close to close the esstoolb.xls file.

You do not need to modify or save the file.

You should not have to perform the toolbar installation procedure again unless you delete the Essbase toolbar from the Toolbars dialog box in Excel. If you delete the toolbar, perform the installation procedure again.

Note: If you have toolbars turned off in Excel, you will not see the Essbase toolbar. You must enable toolbars first. For more information, see “Using the Essbase Toolbar” in the Essbase Spreadsheet Add-in User’s Guide for Excel.

102 ■



Troubleshooting the Spreadsheet Add-in InstallationThe installation program automatically adds Essbase Spreadsheet Add-in to Excel or Lotus 1-2-3. This adds Essbase to the spreadsheet menu bar, and points the spreadsheet program to the appropriate Essbase Spreadsheet Add-in file, located in the bin directory.

As a troubleshooting measure, you should know how to use the Excel or Lotus 1-2-3 add-in facility to add the appropriate file to Excel or Lotus 1-2-3. The Spreadsheet Add-in file is in the bin directory on your hard disk drive if you selected to install the Spreadsheet Add-in locally, or in the bin directory on the network drive if you selected to set up your computer to run it there.

● ess123.12a is the add-in file for Lotus 1-2-3 Millennium Releases 9.5, and 9.6.

● essexcln.xll is the add-in file for Excel 2000 and Excel XP.

Note: essxleqd.xla is an additional add-in file for Essbase Query Designer for Excel. This add-in, which loads automatically when Essbase Query Designer is started, enables Excel and EQD to synchronize workbook and worksheet operations, including creating, deleting, and moving the workbooks.

If Essbase Spreadsheet Add-in is not properly installed or configured after the installation program is complete, follow these steps to isolate the problem. They are explained further in the following topics:

1. Reboot your computer.

2. Check your environment. See “Check Your Environment” on page 103.

3. Remove and manually add Essbase Spreadsheet Add-in. See “Remove and Manually Add the Essbase Spreadsheet Add-in” on page 103.

4. Install Essbase Spreadsheet Add-in again. See “Install the Essbase Spreadsheet Add-in Again” on page 104.

Reboot Your ComputerOn Windows 98, reboot your computer. On Windows XP, Windows NT 4.0 or Windows 2000, log out and log on again, or reboot your computer. This ensures that changes to your environment settings take effect.


4


Check Your EnvironmentIf the message shown in Figure 19 is displayed, you may have a problem with your PATH and ARBORPATH environment variables.

Figure 19: File Not Found Error Message

Check your PATH and ARBORPATH settings:

● Type PATH at the MS-DOS command prompt. Make sure that \essbase\bin, or the bin directory of the directory you specified during installation is in the PATH statement.

● Type SET at the MS-DOS command prompt and check your ARBORPATH setting. It should indicate the drive and directory you specified during installation; for example:

ARBORPATH=C:\HYPERION\ESSBASE

Remove and Manually Add the Essbase Spreadsheet Add-inIf problems persist, or the Essbase startup screen is not displayed when you start the spreadsheet program, remove Essbase Spreadsheet Add-in from the spreadsheet program, exit and restart the spreadsheet program, and manually add the add-in as described in the following steps:

➤ To manually add Essbase Spreadsheet Add-in to Excel:

1. In Excel, select Tools > Add-Ins.

The Add-Ins dialog box is displayed.

2. Click Browse.

A file selection dialog box is displayed.

104 ■



3. Select the file essexcln.xll in the BIN directory where you installed Essbase Spreadsheet Add-in on your hard disk drive or where your system administrator installed Essbase Spreadsheet Add-in on a network drive.

4. Click OK twice to close the dialog boxes and start Essbase Spreadsheet Add-in.

The Essbase startup screen is displayed, and Essbase is added to the Excel menu.

➤ To manually add Essbase Spreadsheet Add-in to Lotus 1-2-3:

1. In Lotus 1-2-3, select File > Add-Ins > Manage Add-Ins.

The Manage Add-ins dialog box is displayed.

2. Click Register.

3. Select the file ess123.12a in the bin directory where you installed Essbase Spreadsheet Add-in on your hard disk drive, or in the bin directory where your system administrator installed Essbase Spreadsheet Add-in on a network drive.

4. Click Open.

5. Select the ess123.12a add-in file, and click Done to close the Manage Add-Ins dialog box and start Essbase Spreadsheet Add-in. Make sure there is a check mark next to the ess123.12a add-in file.

The Essbase startup screen is displayed, and Essbase is added to the Lotus 1-2-3 menu bar.

Install the Essbase Spreadsheet Add-in AgainIf Essbase is still not displayed in the spreadsheet menu bar, or if you continue to receive error messages, uninstall Essbase Spreadsheet Add-in and run the installation program again. Accept the default settings. Be sure to specify the correct network protocol.


Chapter

5Setting up the Sample Applications

The Essbase OLAP Server installation includes four sample applications. These sample applications are based on The Beverage Company (TBC), a fictional company that manufactures and sells soft drink products.

● The main application used in the documentation is called Sample. It contains three databases: Basic, Interntl, and Xchgrate. The latter two contain specific features corresponding to the Essbase currency conversion option.

● The second application, called Demo, contains one database, Basic, referred to in the Technical Reference in the docs directory and in some of the documentation for Essbase Report Writer.

● The third application, called Samppart, is the first of two applications designed to show the features of Essbase Partitioning. Samppart contains a Company database that is the target of a partitioned database.

● The fourth application, called Sampeast, is the second of two applications designed for Partitioning. Sampeast contains an East database that is the source of data for a partitioned database.

Note: In some licensing instances, installation of the sample applications may be restricted to the main application (Sample) and its three databases (Basic, Interntl, and Xchgrate). Refer to your license agreement for details.

If you selected to install the sample applications during your OLAP Server installation, you must perform additional steps to prepare them for use in your organization. This chapter contains the following sections:

● “Loading the Sample Databases” on page 106

● “Providing User Access to the Sample Applications” on page 110

● “Setting the Environment for the Partitioning Sample Applications” on page 112

106 ■

Setting up the Sample Applications


Loading the Sample DatabasesTo prepare the sample databases for use, you must load data into them.

Each of the sample databases has a corresponding data load file. Table 13 shows the sample applications, the databases that are contained within them, and their corresponding data load files:

➤ To load data into the sample databases:

Choose an application and database and the corresponding data load file from Table 13 and complete these steps.

1. Open Essbase Application Manager.

2. Connect to the server on which the application is installed. This example uses a server called Aspen. See Chapter 4, “Installing Application Manager and Spreadsheet Add-in” if you are unsure how to do this.

3. From the Applications list box, select one of the applications.

Table 13: Sample Databases and Data Load Files.

Application Database Data Load File

Sample Basic Calcdat

Interntl Currcalc

Xchgrate Rates

Demo Basic Data

Samppart Company Calccomp

Sampeast East Calceast


5


4. From the Databases list box, select one of the databases.

Figure 20: Selecting the Basic Database

5. From the Database drop-down menu, select Database > Load Data.

The Data Load dialog box is displayed, as shown in Figure 21.

Figure 21: Data Load Dialog Box Before Selecting a Data File

The Data Load dialog box is described in detail in the Essbase Application Manager online help, and in the Essbase Database Administrator’s Guide.

108 ■



6. Click the Find button above the Data files list box to locate a data file to load.

The Open Server Data File Objects dialog box is displayed.

7. Ensure that List Objects of Type is Text files.

8. From the Objects list box, select a data load file, as shown in Figure 22.

Figure 22: Selecting the CALCDAT Text File


5


9. Click OK to close the dialog box.

Essbase updates the Data Load dialog box to display the file you selected, as shown in Figure 23.

Figure 23: Data Load Dialog Box with CALCDAT Data File Selected

110 ■



10. Click OK to load the selected file.

The data file is a fully calculated data set. It may take several minutes to load, and then the Data Load Completed dialog box is displayed, as shown in Figure 24.

Figure 24: Message that Essbase Has Finished Loading CALCDAT Data File

11. Click Close.

Providing User Access to the 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 a supervisor.

The system supervisor, defined when the OLAP Server was installed, automatically has supervisor privilege. Therefore, the system supervisor can make the sample applications available to other users.


5


➤ To provide all users with Write access to the sample databases: Repeat this procedure for each database.

1. Log on using the system supervisor account.


3. Connect to the server on which the application for which you want to provide access is installed.

See Chapter 4, “Installing Application Manager and Spreadsheet Add-in” if you are unsure how to do this.

4. From the Applications list box, select the application.

5. Select Application > Settings.

The Application Settings dialog box is displayed as shown in Figure 25.

Figure 25: Choosing Write Access for the Sample Application

6. From the Minimum Database Access group, select the Write option and click OK to save the setting.

Essbase closes the dialog box and returns you to the Application Desktop window.

Tip: You can also use Essbase Administration Services to perform this task, using the Application Properties window. See Essbase Administration Services Online Help for more information.

112 ■



The applications are now ready for use. If you want to use the Partitioning applications, turn to “Setting the Environment for the Partitioning Sample Applications” on page 112. If you do not want to use the Partitioning applications, your next step might be to create the appropriate user names to be able to log on to Essbase. See the Essbase Database Administrator’s Guide for information on creating users.

Setting the Environment for the Partitioning Sample Applications

In some licensing instances, installation of the sample applications may be restricted to the main application (Sample) and its three databases (Basic, Interntl, and Xchgrate). Refer to your license agreement for details.

Essbase includes two sample applications and databases that show the features of Essbase Partitioning:

● Samppart, Company

● Sampeast, East

These 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 Essbase Database Administrator’s Guide describes Partitioning, member combinations, and the differences between target and source databases.

For these applications to work in your environment, you need to match or change the information contained in the.ddb files.

➤ To use the applications:

● Create a user named partitionuser. This is necessary because the sample partitions use this user name to transfer data between the Company database and the East database.

● Change the server name that is embedded in the applications.

Note: Do not go into the.ddb files to change this information. Instead, complete the steps in the following sections: “Creating the Partition User” on page 113 describes how to create the required user name, so that your users can use these applications. “Changing Embedded Server Names in the Sample Partition Definitions” on page 116 describes how to change the embedded server name to your server name.


5


Creating the Partition UserYou must create a user named partitionuser before you work with the Samppart and Sampeast applications. Partitionuser must have Application Designer access to both applications.

➤ To create the partitionuser:


2. Using a user name that is a supervisor or that has Create/Delete Users, Groups privilege, connect to the server on which the Samppart and Sampeast applications are installed.

3. Select Security > Users/Groups.

The User/Group Security dialog box is displayed, as shown in Figure 26.

Figure 26: User/Group Security Dialog Box

114 ■



4. Click New User.

Essbase displays the New User dialog box, as shown in Figure 27.

Figure 27: New User Dialog Box

5. In the Username text box, type partitionuser.

Be sure to use all lowercase letters.

6. In the Password text box, shown in Figure 28, type a password.

For example, type any word such as password. Essbase displays asterisks in the place of the characters you type.

7. In the Confirm Password text box, type the password again.

Figure 28: Entering New User Name and Password


5


8. Click App Access.

Essbase displays the User/Group Application Access dialog box, as shown in Figure 29.

Figure 29: User/Group Application Access Dialog Box

9. From the Applications list box, shown in Figure 30, select Sampeast and click App Designer in the Access group.

10. From the Applications list box, select Samppart and click App Designer in the Access group.

Figure 30: Selecting Samppart Application and App Designer Privilege

11. Click OK to return to the New User dialog box.

12. Click OK to return to the User/Group Security dialog box.

13. Click Close.

Tip: You can also use Essbase Administration Services to perform this task, using the User Properties window. See Essbase Administration Services Online Help for more information.

116 ■



Changing Embedded Server Names in the Sample Partition Definitions

The following steps change the embedded server name in the partition definition files (.ddb) to your server name. The.ddb files shipped with Samppart and Sampeast are based on the server name “localhost.”

➤ To change the server name in the Samppart Company.ddb file:

1. In the Application Desktop window, select the Samppart application and Company database, as shown in Figure 31.

Figure 31: Selecting Samppart Application and Company Database

2. From the Database drop down menu, select Database > Partition Manager.

After a brief pause, Essbase displays the Partition Manager dialog box, as shown in Figure 32.

Note: If the Partition Manager dialog box does not appear or if it contains no definition entries, contact your Essbase system administrator. Your OLAP Server must be registered with a license number supporting Partitioning.


5


3. Under the Source Cube heading, select the first definition entry, Localhost: SampEast: East, as shown in Figure 32.

Figure 32: Selecting Localhost: SampEast: East

4. Click Edit.

The Dangling Remote Reference dialog box is displayed, as shown in Figure 33. Because you are not connected to a server named Localhost, Essbase warns you before it enables you to edit the definition.

Figure 33: Dangling Remote Reference Dialog Box for Localhost: Sampeast: East

5. Click Advanced.

The Fix Dangling Partition Reference dialog box is displayed, as shown in Figure 34.

6. In the Action group, select Correct the invalid partition reference.

118 ■



7. In the Server text box in the Reconnect group, replace Localhost with your server name, such as Aspen, as shown in Figure 34.

Figure 34: Replacing Server Name Localhost with Server Name Aspen

8. Click Apply.

Essbase displays the Partition Manager dialog box. See Figure 32.

9. In the Source Cube list, select the second definition entry, Localhost: Sampeast: East.

10. Repeat Step 4 through Step 8.

11. In the Target Cube list, select Localhost: Sampeast: East.


13. Select Partition > Close to return to the Application Desktop window.

You have changed the server name in the Samppart Company.ddb file.


5


➤ To change the server name in the Sampeast East.ddb file, take the following actions:

1. In the Application Desktop window, select the Sampeast application and East database, as shown in Figure 35.

Figure 35: Selecting Sampeast Application and East Database

2. From the Database drop down menu, select Partition Manager.

After a brief pause, Essbase displays the Partition Manager dialog box, as shown in Figure 36.

3. Under the Source Cube heading, select Localhost: samppart: Company as shown in Figure 36.

Figure 36: Selecting Localhost: Samppart: Company

120 ■



4. Click Edit.

The Dangling Remote Reference dialog box is displayed, as shown in Figure 37. Because you are not connected to a server named Localhost, Essbase warns you before it enables you to edit the definition.

Figure 37: Dangling Remote Reference Dialog Box for Localhost: Samppart: Company

5. Click Advanced.

The Fix Dangling Partition Reference dialog box is displayed, as shown in Figure 38.

6. in the Action group, select Correct the invalid partition reference.

Figure 38: Replacing Server Name Localhost

7. In the Server text box in the Reconnect group, replace Localhost with your server name.

8. Click Apply.

Essbase displays the Partition Manager dialog box. See Figure 36.


5


9. In the Target Cube list, select the first definition entry, Localhost: samppart: Company.


11. In the Target Cube list, select the second definition entry, Localhost: samppart: Company.


13. Select Partition > Close to return to the Application Desktop window.

You have changed the server name in the Sampeast East.ddb file.

Loading Data into Samppart and SampeastAfter setting up the environment for the Samppart and Sampeast databases, you need to load data into each database. This topic shows you how to load the Samppart Company database.

➤ To load data into the Samppart Company Database:


2. Connect to the server on which Samppart is installed.

3. From the Applications list box, select Samppart.

4. From the Databases list box, select Company.

5. From the Database drop-down list, select Load Data.

The Data Load dialog box is displayed.

6. From above the Data files list box, click the Find button.

The Open Server Data File Objects dialog box is displayed.

7. Ensure that List Objects of Type is Text files.

8. From the Objects list box, select CALCCOMP.

9. Click OK to close the dialog box.

10. Click OK to load the selected file.

11. Click Close.

Repeat for the Sampeast application, East database, and calceast data file.

122 ■




Chapter

6Installing the Runtime Client

The Runtime Client is provided so that you can install only the Essbase files that are required to run applications made using the Application Programming Interface (API), or to run Essbase Administration Services (EAS).

For information about installing Administration Services, see the Essbase Administration Services Installation Guide.

Note: As of release 6.5, the Runtime Client is available for UNIX as well as for Windows.

This chapter contains the following sections:

● “Before You Install” on page 123

● “About Installing the Runtime Client from a Network Drive” on page 124

● “Installing the Runtime Client from the Network to Your Client Hard Disk Drive” on page 125

● “Setting up Your Computer to Use the Runtime Client on the Network Drive” on page 127

● “Manually Updating the Environment” on page 129

Before You InstallSee “Client Platform System Requirements” on page 27 for a list of minimum system requirements for the Runtime Client.

Decide whether you are going to install Runtime Client from the Essbase CD, from a network drive, or from installable files downloaded from the Hyperion Download Center. See “Launching the Installers” on page 18 for more information about different software installation formats.

124 ■

Installing the Runtime Client


Before installing the Runtime Client, you should know this:

● The name of your client operating system

● Which network protocol you use

About Installing the Runtime Client from a Network Drive

When installing from a network drive, the Runtime Client installation program provides the following options:

● Install to client installs the Runtime Client software on your hard disk drive. See “Installing the Runtime Client from the Network to Your Client Hard Disk Drive” on page 125.

● Set up client to use shared executables sets up your computer operating environment to use the Runtime Client previously installed on a network drive by the system administrator. You install only Windows system files on your hard disk drive. See “Setting up Your Computer to Use the Runtime Client on the Network Drive” on page 127.

Network Protocol Files for the Runtime ClientThe network protocol file implements the TCP/IP or Named Pipes protocol that you selected on installing the Runtime Client (or other client software) on your computer hard disk drive, or that the system administrator selected on installing the Runtime Client (or other client software) to a network drive. The network protocol file, essnet.dll, resides in the bin directory with the Runtime Client software. This can be on your computer hard disk drive or on a network drive, depending on which installation option you chose.

Note: For more information on network protocols, see Chapter 9, “Network Configuration Notes.”


6


Directories and Files Created on the Network DriveWhen the Essbase system administrator installs the Runtime Client to a network drive, the installation program installs the following files on the network drive:

● An installation folder for installing the Runtime Client on your client computer hard disk drive. This contains the Essbase installation program and Windows system files for setting up your computer environment.

● Program files for using the Runtime Client from the network drive.

If the system administrator installs the Runtime Client to the network drive N, and accepts the default directory \hyperion\essbase, the installation program creates the following directories:

N:\hyperion\essbase bin locale runtime

The installation program, setup.exe, is in the runtime directory and the program files for the Runtime Client are in the bin directory. The locale directory contains the character-set files necessary for all the languages that Essbase supports, including English.

Installing the Runtime Client from the Network to Your Client Hard Disk Drive

➤ To install the Runtime Client from the network to your client computer hard disk drive:

1. Using Windows Explorer, browse to the appropriate location for setup.exe, where n:\hyperion\essbase is the name of the network drive and directory where the your system administrator installed the Runtime Client. For example,

N:\essbase\runtime\setup.exe

2. Double-click setup.exe to start the installation program.


126 ■



4. When prompted to Choose installation type, select Install to client and click Next.

5. When prompted to Choose Destination Location, specify the directory in which to install the Runtime Client. The default is c:\hyperion\essbase, or the location of the last previously installed Essbase software. Click Browse to specify a different location.

Note: Install all client software in the same directory. See “About Installing the Runtime Client from a Network Drive” on page 124 for more information.

6. When prompted, select a network protocol. See your Essbase System Administrator if you are not sure which option to select.

7. In the Update Environment dialog box, choose whether you want the installation program to update the environment by creating an ARBORPATH environment variable, and adding ARBORPATH\bin to the PATH environment variable. This enables the system to find Essbase files.

8. Click Next.

9. When prompted to Check Setup Information, review the summary of your installation choices. Click Next to allow the installation program to begin copying files, click Back to revise your choices, or click Cancel to exit the installation program.

10. In the Setup Complete dialog box, leave the check box selected and click Finish to view the readme.htm file.

11. If you chose to allow the installation program to update the PATH and ARBORPATH environment variables, do one of the following tasks:

● On Windows XP, Windows 2000, or Windows NT, log out and log on again, or reboot your computer, to allow the environment changes to take effect.

● On Windows 98, reboot your computer to allow the environment changes take effect.


6


Directories Created When You Install the Runtime Client on a Client Hard Disk Drive

When you install the Runtime Client on your client hard disk drive, the installation program creates the following directories:

hyperion\essbase bin locale

The Runtime Client program files are in the bin directory.

The locale directory contains the character-set files necessary for all the languages that Essbase supports, including English.

Setting up Your Computer to Use the Runtime Client on the Network Drive

When you set up your computer to use the Runtime Client on the network drive, the installation program does not create any directories on your client computer hard disk drive. It installs only Windows system files on your client computer hard disk drive. You use the program files that are on the network drive.

The network drive has the following directories:

hyperion\essbase bin locale

The Runtime Client program files are in the bin directory.

The locale directory contains the character-set files necessary for all the languages Essbase supports, including English.

➤ To set up your computer to use the Runtime Client from the network drive:

1. Using Windows Explorer, browse to the appropriate location for setup.exe, where n:\hyperion\essbase is the name of the network drive and directory where your system administrator installed the Runtime Client. For example,

n:\essbase\runtime\setup.exe

2. Double-click setup.exe to start the installation program.

128 ■




4. When the program prompts you to Choose installation type, select Set up client to use shared executables, as shown in Figure 39, and click Next.

Figure 39: Choosing to Set Up Your Computer to Use the Runtime Client from the Network Drive

The program detects where the network installation of the Runtime Client resides. If it cannot find it, you are prompted for the directory. Click Browse to display and specify the location.

Note: The shared Runtime Client files are in the bin directory.

5. In the Check Setup Information dialog box, review the summary of your installation choices. Click Back to revise your choices, Cancel to exit the installation program, or Next to let the installation program begin updating your environment.

This type of installation automatically creates or updates the ARBORPATH environment variable and adds a statement to the PATH environment variable. This update is needed to enable the system to find shared Essbase files.

6. Choose one of the following steps to allow the environment changes to take effect:

● On Windows XP, Windows 2000, or Windows NT, log out and log on again, or reboot your computer.

● On Windows 98, reboot your computer.

Note: You might not need to reboot if you previously installed client software to the same directory where you are installing the Runtime Client.


6


Manually Updating the Environment If you do not want the installation program to update your environment, you may need to set up the environment manually.

Keep these points in mind as you manually update your environment settings:

● The instructions assume that you installed the Runtime Client to c:\hyperion\essbase. If you installed the Runtime Client to a different drive and directory, substitute the letter of that drive and name of that directory.

● If you set up your computer to run the runtime client from a network drive, substitute C:\HYPERION\ESSBASE with the letter of the drive and name of the directory where the Runtime Client is installed on the network.

Updating the Environment on Windows 98

➤ To update your environment settings on Windows 98 manually:

1. Add the following environment variable to your autoexec.bat file:


Do not put a space before or after the equal sign (=) in the ARBORPATH environment setting.

2. Add C:\HYPERION\ESSBASE\BIN to your PATH statement.

3. Remove references to installations of Essbase in other directories.

Tip: You can type SET from an MS-DOS command prompt to view your current environment settings.


130 ■



Updating the Environment on Windows XP, Windows 2000, and Windows NT 4.0

➤ To update the environment settings on Windows XP, Windows 2000, or Windows NT 4.0 manually, complete the following steps:




● On Windows 2000 or Windows XP, select the Advanced tab, and click Environment Variables.



● Add %ARBORPATH%/BIN to the Path variable, or C:\HYPERION\ESSBASE\BIN, depending on where Essbase is installed.

Note: You are changing System settings, which affect all users who access your computer.

4. Remove outdated ARBORPATH system variables or ESSBASE\BIN Path settings.

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


Chapter

7Installing the API

The Essbase Application Programming Interface (API) is available for the following platforms:

● Windows XP, Windows 2000, and Windows NT

● AIX

● HP-UX

● Solaris


● “API System Requirements” on page 131

● “Installing the API” on page 132

● “API Directory Structure” on page 136

● “Updating Your Environment Variables” on page 137

Note: You must enter your license number during installation. See Chapter 1, “Preparing to Install Essbase” on software registration.

API System RequirementsBefore installing the API, confirm that the computers on which you intend to install the software meet basic system requirements. Turn to “API Client Development Platforms” on page 28 for information on the minimum hardware and software requirements for the API.

132 ■

Installing the API


Installing the APIYou can install the API from the Essbase CD, from a network drive, or from installable files downloaded from the Hyperion Download Center. For more information on the different installation formats, see “Launching the Installers” on page 18.

To install the API, refer to the following sections for the information that applies to your platform.

Installing the API on Windows Platforms

➤ To install the API on Windows XP, Windows 2000, or Windows NT 4.0:

1. Launch the API installation program.

See “Launching the Installers” on page 18 for more information.

If you are installing from the Essbase CD, the installation program should start automatically. If it does not, run setup from the root directory of the CD.


To cancel installation at any time, click the Cancel and Exit Setup buttons.

3. In the Select Components dialog box, select the API products check box.

This installs the API for 32-bit Windows platforms.

4. When Essbase has finished installing, click Continue and Next.

5. When prompted for the destination directory name, specify where you want to install the API.

The default is c:\hyperion\essbase. You can install to a network drive and then share the library files with other programmers.

6. In the Choose Network Protocol dialog box, select your network protocol, and click Next.

Essbase creates an essnet file that corresponds to your network protocol.

7. In the Install HTML Documentation dialog box, review the size requirements for the available online documents, select which ones to install, and click Next.

Installing the API

7


8. In the Check Setup Information dialog box, review the summary of your installation choices. Click Back to revise your choices, Cancel to exit the installation program, or Next to allow the installation program begin copying files.


Preparing to Install the API on UNIXYou must complete certain tasks before you can install the API on UNIX. These tasks are described in “Before You Install the API on UNIX” on page 133.

You can install from the root directory or from a product directory on the CD, from files on a network drive, or from files you download from the Hyperion Download Center. See “Launching the Installers” on page 18 and “Installing the API on UNIX” on page 134.

Before You Install the API on UNIX

➤ To prepare to install the API on any UNIX platform:

1. Create an account that has Read, Write, and Execute access to the target directory for the Essbase installation.

This account should belong to the Essbase system administrator. Give this account the same default directory you are using for Essbase (for example, /home/hyperion/essbase). Ideally, the system administrator account will own this target directory.

Note: With Release 6.0 and later, you are no longer required to install and run Essbase from an account called arbor. Any user can install, but this should be the same user account that will start Essbase.

134 ■

Installing the API


2. Create a target directory for the Essbase files; for example,

/home/hyperion/essbase

If you do not create a target directory, the installation program prompts you for permission to create it. If you want to use, or fall back to, a previous release of Essbase, install Release 6.5 to a different directory from the previous release. Do not create directories under/essbase. The installation program creates the appropriate subdirectories.

3. Apply the latest patches for your operating system.

Installing the API on UNIX

➤ To install the API on UNIX:

1. Log on to the UNIX server as the Essbase system administrator account.

For example, log on as admin if you created a user account called admin that owns the target installation directory /home/hyperion/essbase.


3. Depending on the directory from which you want to install, perform either of the following sets of steps:

If you want to install from the root directory:

a. Change to the root directory of the CD (for example, cd /cdrom/essbase_6).

b. Use the ls command to find setup.sh (or SETUP.SH).

Some UNIX CD drivers list file names in uppercase. Others list them in lowercase.

c. Type ./setup.sh or ./SETUP.SH, depending on what you learned in Step 3b.

d. When prompted, choose to install the API.

Installing the API

7


If you want to install from the product directory:

a. Change to the CD directory for the product you want to install (for example, cd /solaris/api).

b. Use the ls command to find essinst (or ESSINST).

Some UNIX CD drivers list file names in uppercase. Others list them in lowercase.

c. Type ./essinst or ./ESSINST, depending on what you learned in Step 3b.


Note: To cancel installation at any time, press Ctrl + C.

5. When prompted, type your license number exactly as it appears on your registration card.

See “Registering Essbase Software” on page 32 for more information on software registration.

6. When prompted, type the directory where you want to install the API.

The installation program uses/home/hyperion/essbase/ as the default directory. You can choose another directory, and if it does not exist, the installation program creates it for you.

7. Answer whether you want to install the online HTML documentation.

Note: The installation program decompresses the api.tz file, and the docs.tz file if you choose to install the online HTML documentation, and copies files to the directory you choose (or to the default directory), and to subdirectories it creates under that directory. Do not create these subdirectories yourself.

8. Update your environment before you use the API.

See “Updating Your Environment Variables” on page 137.

136 ■

Installing the API


API Directory StructureThe API installation program creates the following directory structure:

This assumes that you accepted the default directory, c:\hyperion\essbase or /home/hyperion/essbase, during installation.

Note: When you install the online HTML documentation, the installation program creates a docs directory (/docs directory on UNIX platforms). It contains numerous subdirectories, as well as the essdocs.htm file you open to view the HTML documentation.

For a listing of files supplied with or required by the Essbase API in order to compile programs, see the API Reference in your docs directory. On Solaris you can create soft links to supplied library files.

The locale directory contains the character-set files necessary for all the languages that Essbase supports, including English. For non-English versions, you also need to create the ESSLANG environment variable. For more information about ESSLANG, see Chapter 11, “Performing Advanced Installation Tasks,”

Windows and Windows NT UNIXC:\hyperion\essbase

api include lib redist locale

docs

/home/hyperion/essbase api

include lib redist locale

docs

Installing the API

7


Updating Your Environment VariablesYou may need to update your environment variables to use the API. Read the section that is appropriate for your platform.

Setting Your Environment on Windows PlatformsAdd the lib and include directories to your PATH statement. For example, if you installed Essbase to the default directory, add the following text to your PATH statement:

c:\hyperion\essbase\api\lib c:\hyperion\essbase\api\include

Setting Your Environment on AIX and SolarisTo link and run your program, add the following text to the LIBPATH variable:

$ARBORPATH/api/lib

For example, if you are using the C shell, the.cshrc file might look like this:

setenv ARBORPATH /essbasesetenv/opt/SUNWspro/lib:/usr/openwin/lib:/usr/lib:$ARBORPATH/api/lib

On Solaris, you can create soft links to supplied library files. For example, you can create .so files as soft links to the supplied .so.1 files, as follows:

ln -s libessnet.so.1 libessnet.so

See the API Reference in your docs directory for more information on the files you need to compile, link, and distribute your programs.

138 ■

Installing the API


Setting Your Environment on HP-UXEssbase on HP-UX uses the environment variables LPATH (for linking) and SHLIB_PATH (at run time).

If you are using static libraries, you do not need to use environment variables. If you are using dynamic libraries, you need to add the following path to your LPATH search path environment variable to link your program:

/home/hyperion/essbase/api/lib

where /home is the name of your home directory and /hyperion/essbase is the directory where you chose to install the API.

All shared library (.sl) files should be located in a directory specified in the LPATH search path. For example, the LPATH variable can be set to:

.:/lib:/usr/lib:$ARBORPATH/api/lib

➤ To run your program:

Perform one of these tasks.

● Store the shared library files in the same directory from which you linked.

● Link your program with the +s flag. The +s flag allows you to put the.sl files at any location and use the SHLIB_PATH environment variable to search for it at run time.

See the API Reference in your docs directory for information on the files you need to compile, link, and distribute your programs.


Chapter

8Configuring SQL Interface

This chapter explains how to configure Essbase SQL Interface.

As of Essbase Release 6.5, you are no longer required to run a separate installation program for SQL Interface. Instead, it is installed automatically, as part of the Essbase OLAP Server installation. However, in order to use SQL Interface, your license number must be enabled for it.

After you install the OLAP Server using a license number that is enabled for SQL Interface, you must set your environment variables and configure your data source.

You also may need to configure your ODBC driver. For this information, see the Essbase SQL Interface Guide. This guide, Essqlint.pdf, is provided in the\essbase\docs\pdf directory for online viewing and printing in Adobe Acrobat Reader (Version 3.0.1 or later).

For installations on UNIX, this chapter tells you what to do after you install and before you link your drivers to SQL Interface.


● “Before You Install SQL Interface” on page 140

● “Installing SQL Interface on Windows” on page 140

● “Installing SQL Interface on UNIX” on page 142

140 ■

Configuring SQL Interface


Before You Install SQL InterfaceBefore you install SQL Interface via the OLAP Server installation, consider the following information:

● On every installation, you are asked for your license number. For more information on software registration, see Chapter 1, “Preparing to Install Essbase.”

● On Windows NT and Windows 2000, each MERANT ODBC driver has its own help file. You can access it using the ODBC Administrator. See the Essbase SQL Interface Guide.

● The MERANT ODBC drivers come with a document called MERANT DataDirect Connect ODBC Reference. This reference is in PDF format for online viewing and for printing in Adobe Acrobat Reader (Version 3.0.1 or later).

Installing SQL Interface on WindowsIf your license number is enabled for SQL Interface, it is installed during your installation of the OLAP Server. Still, you must meet the specific system requirements for SQL Interface and you must set your environment variables and configure your data source before you can use SQL Interface.

The following workflow is an overview of tasks required to install and configure Essbase SQL Interface on Windows effectively.

Workflow for Installing and Configuring SQL Interface on Windows

➤ To install and configure SQL Interface on Windows:

1. Verify requirements: See “Supported ODBC Drivers and Relational Data Sources” on page 29 to confirm that you meet system requirements.


8


2. Make sure that the relational database management system (RDBMS) environment is set up correctly before you install.

You must be able to connect to the RDBMS from the OLAP Server computer before SQL Interface can work. Confirm that:

a. The RDBMS server is installed and running. You must set the environment variables required to run the RDBMS. For more information, see your RDBMS documentation.

b. The RDBMS database client software is installed on the computer where Essbase is (or will be) installed; for example, the correct version of Client Application Enabler (CAE) for DB2 is installed, or the correct version of Open Client for Sybase is installed.

c. You can connect to the RDBMS.

d. You can issue a query to the RDBMS using an RDBMS client utility.

3. Install the OLAP Server.

For detailed instructions on installing the OLAP Server software (along with SQL Interface if it is enabled in your license number), see Chapter 2, “Installing Windows OLAP Server Software.”

4. Configure the ODBC data source.

Before you can access relational data using SQL Interface, you must use the ODBC Administrator (odbcad32.exe) to tell Essbase what data sources are available and which drivers it should use. For detailed instructions, see the Essbase SQL Interface Guide (essqlint.pdf), which is installed in the essbase\docs\pdf directory of your Essbase installation when you install SQL Interface.

Directories and Files on WindowsIf you accept the default during installation, the installation program places all SQL Interface program files in the C:\hyperion\essbase\bin directory on Windows. This includes esssql.dll, the ODBC driver files and their corresponding help (.hlp) files, and .bnd and .lic files. If you choose to install the server software in a different directory from the default, the installation program stores the files in the bin directory in the appropriate path.

142 ■



The SQL Interface installation program also installs the Essbase SQL Interface Guide in the docs\pdf directory, and installs ODBC driver files and their corresponding help and .pdf files in the ARBORPATH/ODBC/Merant40/Docs directory.

Installing SQL Interface on UNIXSQL Interface is installed on UNIX (AIX, HP-UX, and Solaris) during your installation of the OLAP Server. Before installing, ensure that your RDBMS environment is set correctly. After installing, set up the server environment and the ODBC drivers.

The following workflow is an overview of tasks required to install and configure Essbase SQL Interface on UNIX effectively.

Workflow for Installing and Configuring SQL Interface on UNIX

➤ To install and configure SQL Interface on UNIX:

1. Make sure that the RDBMS environment is set up correctly before installing.

See “Setting Up RDBMS Before Running SQL Interface on UNIX” on page 143.

2. Install the OLAP Server.

See Chapter 3, “Installing UNIX OLAP Server Software.” SQL Interface is installed during your installation of the OLAP Server if your license number is enabled for SQL Interface.

3. Set up the ODBC driver that you plan to use.

Steps vary depending on platform/driver configurations. For examples, see “Setting Up ODBC Drivers Before Linking Them to SQL Interface” on page 146.

4. Run inst-sql.sh to link SQL Interface to your ODBC driver.

5. Complete post-installation tasks, including setting the library path and configuring the .odbc.ini file.

See “After You Link SQL Interface to Your ODBC Driver on UNIX” on page 150.


8


6. Consult the Essbase SQL Interface Guide in your docs/pdf directory to learn more about SQL Interface and how to configure your ODBC data source.

See “Configuring the Data Source and ODBC Driver” on page 155.

Setting Up RDBMS Before Running SQL Interface on UNIXYou must be able to connect to the RDBMS from the OLAP Server computer before SQL Interface can work.

➤ To set the RDBMS environment variables, confirm that:

1. The RDBMS server is installed and running. You must set the environment variables required to connect to the RDBMS.

Examples of Setting RDBMS Environment Variables (Solaris)

For Oracle:

● Set ORACLE_HOME and ORACLE_SID.

● Make sure that LD_LIBRARY_PATH contains the Oracle library path ($ORACLE_HOME/lib).

● Make sure that the path contains the Oracle bin ($ORACLE_HOME/bin).

For Informix:

● Set INFORMIXDIR and INFORMIXSERVER.

● Make sure that LD_LIBRARY_PATH contains the Informix library path ($INFORMIXDIR/lib).

● Make sure that the path contains the Informix bin($INFORMIX/bin).

For Sybase:

● Set SYBASE and DSQUERY.

● Make sure that LD_LIBRARY_PATH contains the Sybase library path ($SYBASE/lib).

● Make sure that the path contains the Sybase bin ($SYBASE/bin).

144 ■



For DB2:

● Set DB2INSTANCE and INSTHOME.

● Make sure that LD_LIBRARY_PATH contains the DB2 library path ($INSTHOME/sqllib/lib).

● Make sure that the path contains the DB2 bin ($INSTHOME/sqllib/bin).

Note: Library path variable names vary across UNIX platforms. For more information, see your RDBMS documentation.

2. The RDBMS client software is installed on the computer where the OLAP Server is (or will be) running.

3. You can connect to the RDBMS.

4. You can issue a query to the RDBMS using an RDBMS client utility.

See the “Supported ODBC Drivers and Relational Data Sources” on page 29 for information on tested and supported SQL Interface platforms and ODBC drivers.

Also, set the environment variables required to run your RDBMS.

Directories and Files CreatedIf the license number is enabled for SQL Interface, the OLAP Server installation program installs files into the $ARBORPATH/bin and $ARBORPATH/dlls directories.

The installation program performs these actions:

● Copies the.odbc.ini file into the $ARBORPATH/bin directory on the UNIX server computer. This tells Essbase which drivers are installed.

If you accepted the default directory during installation, $ARBORPATH is /home/hyperion/essbase.

● Installs MERANT ODBC drivers files to an $ARBORPATH/dlls directory on the UNIX server computer.


8


● Installs these Essbase SQL Interface files to the $ARBORPATH/bin directory:

– libesssql.insolv.a on AIX

– libesssql.insolv.sl on HP-UX

– libesssql.so.1 on Solaris

When the OLAP Server is installed on UNIX, it creates:

● The SQL Interface library file:

– libesssql.a on AIX

– libesssql.sl on HP-UX

– libesssql.so on Solaris

● A stub ODBC drivers file:

– libesssql.arbor.a on AIX

– libesssql.arbor.sl on HP-UX

– libesssql.arbor.so.1 on Solaris

After you install SQL Interface, you must run the shell script inst-sql.sh, which creates a symbolic link between the SQL Interface library file and the MERANT ODBC drivers file. See “Linking SQL Interface to the ODBC Driver on UNIX” on page 148.

About Setting Your Environment on UNIX On UNIX, you run inst-sql.sh to create a symbolic link between the SQL Interface library file and your MERANT ODBC drivers file. Before you run inst-sql.sh, you must set the proper environment for your ODBC driver. After you run inst-sql.sh, you must reset the proper environment for your ODBC driver.

The following topics address setting your environment on UNIX:

● “Setting Up ODBC Drivers Before Linking Them to SQL Interface” on page 146

● “Linking SQL Interface to the ODBC Driver on UNIX” on page 148

● “After You Link SQL Interface to Your ODBC Driver on UNIX” on page 150

146 ■



Setting Up ODBC Drivers Before Linking Them to SQL Interface

After you install SQL Interface on AIX, HP-UX, or Solaris, you must set up your ODBC driver before you link SQL Interface to it by running inst-sql.sh.

To set your environment so that you can link SQL Interface to the driver that you chose, complete the steps after you run setup.sh, but before you run inst-sql.sh. The steps you take depend on the driver and platform that you use. Examples for the following configurations are provided in this section:

● “Setting Up the MERANT DB2 Driver on AIX or Solaris” on page 146

● “Setting Up the IBM DB2 Driver on AIX” on page 147

For information about setting up MERANT Oracle or Informix drivers, see the MERANT DataDirect Connect ODBC Reference. Also see Oracle or Informix documentation.

Setting Up the MERANT DB2 Driver on AIX or Solaris

➤ To set the environment so that you can link SQL Interface to the MERANT DB2 driver:

Complete these steps after you run setup.sh, but before you run inst-sql.sh.

1. Log on as the instance owner, and make sure that you have Read or Read and Write access to $ARBORPATH.

2. Set the DB2 environment variable, for example, INSTHOME, to point to the home directory of your DB2 instance.

An instance corresponds to one or more databases. For every database to which you want to connect, you must ensure that an instance corresponding to that database exists.


8


3. Set the environment variable DB2INSTANCE to point to the instance name, and set LIBPATH.

Here is a Bourne shell example:

DB2INSTANCE=inst1LIBPATH=/lib:/usr/lib:/home/essbase/bin:$INSTHOME/sqllib/lib:export INSTHOME DB2INSTANCE LIBPATH

where INSTHOME is the environment variable that you defined in Step 2, and “inst1” is the instance name.

For more information about setting environment variables for the MERANT DB2 driver, see the MERANT DataDirect Connect ODBC Reference. Also see DB2 documentation.

Setting Up the IBM DB2 Driver on AIX

➤ To set the environment so that you can link SQL Interface to the IBM DB2 driver:

Complete these steps after you run setup.sh, but before you run inst-sql.sh.

1. Make sure that the relational client software for DB2 is installed on the same AIX computer that you are using for SQL Interface.

2. Create a configuration file, esssql.cfg, as described in the Essbase SQL Interface Guide.

Here is an example of an esssql.cfg file:

[ Description "IBM DB2 Call Level Interface" DriverName db2.o Database 1 Password 1 UserId 1 SingleConnection 0 UpperCaseConnection 0 IsQEDriver 0 ]

3. Set the environment variable INSTHOME to point to the home directory of your DB2 instance.

148 ■



4. Define DB2 instance names for SQL Interface.

An instance corresponds to one or more databases. For every database to which you want to connect, this is required:

● You must ensure that an instance corresponding to that database exists.

● You must have Read or Read and Write access to the driver manager library, libodbc.a in INSTHOME/sqllib/odbclib/lib.

● You must include the instance in the LIBPATH as shown in Step 6.

5. Log on as the Essbase system administrator account.

This is the account used to install and run Essbase. You should have Read or Read and Write access to the driver manager library, libodbc.a, in INSTHOME/sqllib/odbclib/lib.

6. Set the environment variables DB2INSTANCE and LIBPATH as in the following Bourne shell example:

DB2INSTANCE=inst1LIBPATH=/lib:/usr/lib:/home/essbase/bin:$INSTHOME/sqllib/lib:export INSTHOME DB2INSTANCE LIBPATH

where INSTHOME is the environment variable that you defined in Step 3, and “inst1” is the instance name.

For more information about setting environment variables for the IBM DB2 driver, see DB2 documentation.

Linking SQL Interface to the ODBC Driver on UNIXAfter you have completed the following actions, you are ready to link SQL Interface to your ODBC driver by running inst-sql.sh:

● Installed and configured your RDBMS.

See “Setting Up RDBMS Before Running SQL Interface on UNIX” on page 143.

● Installed SQL Interface.

See “Installing SQL Interface on UNIX” on page 142.


8


● Set up the ODBC driver that you selected during installation.

See “Setting Up ODBC Drivers Before Linking Them to SQL Interface” on page 146.

Running inst-sql.sh ensures that server processes can access the software necessary for SQL Interface. essinst, or setup.sh (which runs essinst), places inst-sql.sh in the $ARBORPATH directory. The default is/home/hyperion/essbase.

inst-sql.sh uses the odbc.ini, odbcinst.ini, and template (extension .tmpl) files in the $ARBORPATH/setup directory to create a set of files that point Essbase to the correct driver product.

The script handles the following tasks for you:

● Ensures root privileges are not accidentally granted to a user-level script

● Checks for the availability of the OLAP Server

● Checks for the availability to the OLAP Server of supported database systems

● Provides default environment extensions as shell files in the $ARBORPATH/bin directory

● Provides initialization files in the $ARBORPATH/bin directory for access by the driver software

● Creates and dynamically compiles an extra library if needed

● Generates the shell scripts odbc.csh for the C shell, and odbc.sh for the Bourne or Korn shell

These files contain commands that update the library path to specify the correct environment variables for Essbase. After you run inst-sql.sh to link SQL Interface to the ODBC driver, you can optionally use these scripts to update your library path, or you can do it manually. See “Setting the Library Path on UNIX” on page 150.

150 ■



➤ To run inst-sql.sh:

1. Using the Essbase system administrator account (this is the account used to install and run Essbase), type the following command:

sh inst-sql.sh

2. Supply information when the script prompts you for it.

When the script finishes, the command prompt is displayed.

3. Type the following command:

exit

After You Link SQL Interface to Your ODBC Driver on UNIXNow that you have linked SQL Interface to your ODBC driver by running inst-sql.sh, you are ready to complete the following post installation tasks:

● Set the library path, either manually or by using the odbc.sh or odbc.csh shell scripts. See “Setting the Library Path on UNIX” on page 150.

● If you are using the MERANT DB2 driver, bind files in the /ESSBASE/bin directory. See “Binding Files for the MERANT DB2 Driver on AIX or Solaris” on page 152.

● Complete the configuration of your ODBC drivers by editing the .odbc.ini file. Some examples are provided. See “Editing .odbc.ini Driver Files” on page 153.

● Configure the ODBC data source and (if applicable) configure your non-MERANT ODBC driver. See the Essbase SQL Interface Guide, located in the docs/pdf directory.

Setting the Library Path on UNIXOn UNIX, you must add the $ARBORPATH/dlls directory to the library path before you can use SQL Interface. If your installation of SQL Interface is an upgrade to a pre-existing installation, you may not have to reset the library path.


8


Alternatively, you can use shell scripts created by inst-sql.sh to update your library path. See “Using Shell Scripts to Set the Library Path (Optional)” on page 152.

● On Solaris, add the $ARBORPATH/dlls directory to the LD_LIBRARY_PATH variable:


setenv ARBORPATH /hyperion/essbasesetenv LD_LIBRARY_PATH /usr/lib:$ARBORPATH/dlls

● On AIX, add the $ARBORPATH/dlls directory to the LIBPATH variable:


setenv ARBORPATH /hyperion/essbasesetenv LIBPATH /usr/lib:$ARBORPATH/dlls

● On HP-UX, add the $ARBORPATH/dlls directory to the SHLIB_PATH variable:


setenv ARBORPATH /hyperion/essbasesetenv SHLIB_PATH /usr/lib:$ARBORPATH/dlls

The.profile file, if you are using the Bourne or Korn shell, might look like this:

ARBORPATH=/home/hyperion/essbaseexport ARBORPATHSHLIB_PATH=$SHLIB_PATH:$ARBORPATH/dllsexport SHLIB_PATHPATH=/usr/bin:/etc:/usr/sbin:/usr/ucb:$ARBORPATH/dlls: /usr/bin/X11:/sbin:.export PATH

Note: HP-UX uses SHLIB_PATH to search for shared library files at run time and LPATH to link to shared library files while compiling.

For more information, see your UNIX documentation.

152 ■



Using Shell Scripts to Set the Library Path (Optional)The script that links SQL Interface to your ODBC driver (inst-sql.sh) also creates shell scripts, which you can use to automatically update the library path for Essbase. inst-sql.sh generates the following files and places them in the $ARBORPATH/setup directory:

● odbc.csh for the C shell

● odbc.sh for the Bourne or Korn shell.

These files contain commands that specify the correct environment variables for Essbase. $ARBORPATH/dlls is added to the library path, and ODBCINI is set to $ARBORPATH/bin/.odbc.ini.

To use these scripts so that Essbase environment variables are available to your shell environment every time you log on, complete one of the following tasks after you run inst-sql.sh:

● In the C shell, use the source command against odbc.csh in the .login or.cshrc file. For example, edit the.login or.cshrc file to include this line:

% source $ARBORPATH/setup/odbc.csh

● In the Bourne or Korn shell, use the . (dot) command against odbc.sh. in the .profile file. For example, edit the.profile file to include this line:

% . $ARBORPATH/setup/odbc.sh

Binding Files for the MERANT DB2 Driver on AIX or Solaris

➤ To bind files so that the DB2 driver can understand the MERANT commands on AIX or Solaris:

Complete these steps after you run inst-sql.sh.

1. Change to the $ARBORPATH/bin directory.

For example:

cd /home/hyperion/essbase/bin


8


2. Start the DB2 command-line interface.

For example:

db2

3. Connect to the DB2 database.

For example:

CONNECT TO DATABASENAME

4. Bind all files, or at least the .bnd files, in your $ARBORPATH/bin directory.

For example:

BIND iscsso.bnd

File names may change for new driver versions. List all the files that you need to bind with the .bnd extension in the $ARBORPATH/bin directory.

It is recommended that you bind all the files in the bin directory.

5. Grant user privileges for accessing data.

For more information about binding and granting privileges, see the MERANT DataDirect Connect ODBC Reference.

Editing .odbc.ini Driver FilesTo complete your ODBC driver setup after installing Essbase SQL Interface, you must modify.odbc.ini to include the correct driver and data source names. See the following examples for the IBM DB2 driver on AIX, and for the MERANT DB2 driver on Solaris:

Editing .odbc.ini for the IBM DB2 Driver on AIX

To set up your.odbc.ini file for DB2 Version 5 on AIX, complete the following tasks after you run inst-sql.sh:

Note: On AIX, inst-sql.sh prompts you to choose between the MERANT DB2 driver and the IBM Call-Level Interface (CLI) for DB2 driver. inst-sql.sh links SQL Interface to different libraries, depending on which DB2 driver you choose. To switch DB2 driver sets after you run inst-sql.sh, reinstall SQL Interface.

154 ■



In $ARBORPATH (the directory where Essbase is installed), modify .odbc.ini to include the correct driver and data source name.

For example:

[ODBC Data Sources]DB25SAMP=IBM DB2 ODBC DRIVER

[DB25SAMP]Driver=/home/db2inst/sqllib/lib/db2.oDatabase=dbname

[ODBC]Trace=0TraceFile=odbctrace.outInstallDir=/home/db2inst/sqllib/odbclib

In these examples, /home/db2inst is the $INSTHOME directory. You cannot use environment variables in.ini files.

For more information on instances and other IBM-specific details, see the IBM manual, DATABASE 2—Installing and Using AIX Clients. See your IBM representative for the latest ordering information.

Editing .odbc.ini for the MERANT Oracle Driver on Solaris

To set up your.odbc.ini file for Oracle 8 on Solaris, complete the following tasks after you run inst-sql.sh:

In $ARBORPATH (the directory where Essbase is installed), modify .odbc.ini to include the correct driver and data source name.

For example:

[ODBC Data Sources]Oracle8=MERANT 3.60 Oracle 8 Driver

[Oracle8]Driver=/home/hyperion/essbase/dlls/ARor815.soDescription=Oracle8ServerName=name

where name is the appropriate Oracle server name.


8


Configuring the Data Source and ODBC DriverYou have already completed the following tasks:

● Installed SQL Interface

● Set up the ODBC driver for your platform and driver configuration

● Linked SQL Interface to the ODBC driver using inst-sql.sh

● Set the library path for Essbase

● Completed ODBC driver setup by editing the odbc.ini file

● Bound files in ESSBASE/bin, if you are using the DB2 driver

You are now ready to configure the data source. You may also need to configure your ODBC driver. To perform these tasks, see the Essbase SQL Interface Guide, which is provided in .pdf (Essqlint.pdf), in the\essbase\docs\pdf directory, for online viewing and printing in Adobe Acrobat Reader (Version 3.0.1 or later).

156 ■




Chapter

9Network Configuration Notes

This chapter provides information on the supported TCP/IP and Named Pipes network configurations. It serves as a checklist to ensure that the basic elements are installed and running on the client and server computers.

Refer to your network and operating system documentation for detailed information on installing the software and services required to run Essbase. Your software provider assumes no liability and does not guarantee the accuracy of this information.


● “TCP/IP Support” on page 158

● “Named Pipes Support” on page 159

● “Novell Using Named Pipes Support” on page 159

● “LAN Manager Using Named Pipes Support” on page 162

158 ■

Network Configuration Notes


TCP/IP SupportThe following protocol stacks have been tested and are supported by Essbase:

● Client Support: Microsoft Windows 98 Native TCP/IP

● Server Support:

– Windows NT or Windows 2000 Native TCP/IP from Microsoft

– HP-UX Native TCP/IP from Hewlett Packard

– AIX Native TCP/IP from IBM

– Solaris Native TCP/IP from Sun Microsystems

Note: Check the conventional memory requirements of these drivers to ensure that you have sufficient memory available.

General TCP/IP Installation ProceduresThis section provides general steps for installing TCP/IP.

ServerTCP/IP is included with Windows and UNIX platforms. As part of defining the Windows or UNIX computer with the TCP/IP protocol, the computer name and IP address are defined during the installation of the operating system.

Client

➤ To install TCP/IP on a client computer:

1. Install one of the supported protocol stacks.

2. For each server on the network, update the client HOSTS file to contain an entry for the server.

For example, the following entry would be made for the server MAPLE at IP address 198.137.238.10:

198.137.238.10 MAPLE


9


The hosts file specifies the IP address of the server so that the client can communicate with the server. A host is any device attached to the network that uses TCP/IP. To receive and deliver packets successfully between hosts, TCP/IP relies on information in the hosts file.

Troubleshooting Common Connection ProblemsBefore attempting an Essbase client-server connection, test the protocol installation to ensure that the connection is installed properly.

Use the PING command on the server to check that it is running and visible to your PC client. If the PING command is successful but the TELNET command is not, then there may be a problem with the inet daemon. If the PING command is unsuccessful on the server, you might have a routing or hardware problem.

Named Pipes SupportThe following protocol stacks are tested and supported by Essbase:

Client Support:

● Microsoft LAN Manager (NetBEUI)

● Microsoft Windows 98 Native NetBEUI

Server Support:

● Windows NT/2000 Native Named Pipes (NetBEUI)

● Microsoft LAN Manager (NetBEUI)

Novell Using Named Pipes SupportEssbase supports the Named Pipes protocol stack on Novell Netware local area networks (LANs). Novell currently supports Named Pipes services for PC clients connecting to Windows NT servers but does not offer support for UNIX servers.

160 ■



Windows ClientsThis section contains information on connecting the Windows 98 client computer to Windows servers using Named Pipes.

Connecting from Windows 98 to Windows NTTo connect from Windows 98 to Windows NT, Windows 2000, or Windows XP using Named Pipes, you might need to connect to the server computer independently of Essbase before attempting to connect to the Essbase server. To connect to the server computer:

1. From your Windows 98 desktop, open Network Neighborhood.

2. Locate and double click your server name.

3. If prompted, type the password for the server, then click OK.

When you are connected to the server, the server window is displayed showing one or more directories to which you have access.

4. Close the server window and Network Neighborhood.

Now you are ready to connect to Essbase.

Increasing Connections on Windows 98When connecting from Windows 98 to Windows NT, Windows 2000, or Windows XP using Named Pipes, you may see the error message, “Network error: Cannot receive data, try increasing the maximum number of connections on your Windows 98 computer.”

➤ To increase the maximum number of connections on your Windows 98 computer:


2. Double-click the Network icon.

The Network dialog box is displayed.

3. In the The following network components are installed list box, double-click NetBEUI.

If you have more than one NetBEUI option, choose one of them.

The NetBEUI Properties dialog box is displayed, as shown in Figure 40.


9


4. Select the Advanced tab.

5. In the Property list box, select Maximum Sessions.

6. In the Value text box, increase the Value of the maximum sessions setting.

You may need to experiment with this setting. In Figure 40, the setting was increased from 10 to 20.

Figure 40: Increasing the Maximum Sessions Value to 20

7. When finished, click OK.

8. Click OK again to close the Network dialog box.

9. Close Control Panel.

If prompted, reboot your computer.

162 ■



Windows ServersNovell supports Named Pipes service in its IPX protocol environment.

Note: The Novell Named Pipes environment does not require the Windows NT server to log on to the file server.

After installing Windows NT, Windows 2000, or Windows XP, install the NWLINK IPX/SPX driver on the Windows server. Select the Network options during installation or configuration of Windows NT or Windows 2000, and select NWLINK IPX/SPX.

UNIX ServerNovell does not currently provide Named Pipes requestors for UNIX.

LAN Manager Using Named Pipes SupportEssbase supports the Named Pipes protocol stack on Microsoft LAN Manager. Microsoft currently provides Named Pipes services for PC clients connecting to Windows NT servers but does not offer support for UNIX servers.

Windows ClientsLAN Manager workstations must meet the following requirements:

● Workstations must use LAN Manager 2.0 Enhanced (or above) drivers and have Named Pipes permission.

● Users executing “Net Logon” must attach to the appropriate server computer in the correct domain.

Windows ServersLAN Manager support for Named Pipes service under Windows NT, Windows 2000, or Windows XP is built-in, using NetBEUI.

UNIX ServersLAN Manager does not support Named Pipes service to UNIX.


Chapter

10Upgrading and Migrating Databases

This section describes how to upgrade from an earlier release of Essbase to Essbase Release 6.5 on the same computer, and how to migrate Essbase applications and databases from one computer to another.

● “Upgrading to Release 6.5” on page 163

● “Migrating Applications and Databases Across Servers” on page 174

● “Upgrading and Migrating at the Same Time” on page 178

Upgrading to Release 6.5This section describes how to upgrade from an earlier release of Essbase to Essbase Release 6.5 on the same computer and describes what occurs during the upgrade process.

CAUTION: Hyperion recommends that you do a complete, not incremental, backup of all of your Essbase files before upgrading. You can then revert to the earlier release if you have problems.

● “Understanding Input/Output Defaults and Upgrading” on page 164

● “Considerations When Upgrading from Release 5.x” on page 168

● “Upgrading Databases to Release 6.5” on page 168

164 ■

Upgrading and Migrating Databases


Understanding Input/Output Defaults and UpgradingRead this section before upgrading to understand the two I/O access modes available with Release 6.5, and how Essbase databases are affected by an upgrade to Release 6.5, in terms of cache sizes and the I/O access modes.

● “Determining Which I/O Access Mode to Use” on page 164

● “Changing or Preserving the I/O Access Mode” on page 165

● “Understanding How Cache Sizes Are Affected by an Upgrade” on page 166

● “Platforms On Which Essbase Supports No-Wait I/O” on page 167

Determining Which I/O Access Mode to UseBuffered I/O uses the buffer cache of the file system. If you are upgrading from a release prior to Release 6.0, your databases are using buffered I/O.

Direct I/O bypasses the file system buffer cache and is able to provide faster response time and more potential to optimize cache sizes. If you are upgrading from Release 6.0 or 6.1, your databases are using direct I/O.

Cache memory locking can only be used if direct I/O is used. You also must use direct I/O if you want to use the no-wait (asynchronous) I/O of the operating system. For platform-support information related to I/O, see Table 15.

Table 14 shows the default I/O access mode for each release, and the I/O access mode choices available (if applicable) for each release. Use this table and this section to determine whether you are currently using buffered or direct I/O, and to decide which you will use after you upgrade to Release 6.5.

Table 14: Default I/O Access Modes for Each Essbase Release

Release Direct I/O Buffered I/O

Before 6.0 N/A Default

6.0 and 6.1 Default N/A

6.2 Available by using DIRECTIO TRUE in essbase.cfg.

Default

6.5 Available per-database, as a database setting.Available once for all new or upgraded databases, by using DIRECTIO TRUE config-file setting in essbase.cfg.

Default


10■ 165Essbase Installation Guide

The following list can help you to determine which I/O access mode your databases currently use, and how those databases will upgrade if you do not make any changes.

● Release 6.2 databases use buffered I/O, unless essbase.cfg contains the setting DIRECTIO TRUE. When upgraded to Release 6.5, all Release 6.2 databases will use same the I/O access mode that was used in Release 6.2. The I/O access mode for any database can be changed once upgraded to Release 6.5, using the database settings.

● Release 6.0 and Release 6.1 databases use direct I/O. When upgraded to Release 6.5, all Release 6.0 or Release 6.1 databases will use buffered I/O, unless essbase.cfg contains the setting DIRECTIO TRUE. The I/O access mode for any database can be changed once upgraded to Release 6.5 by using the database settings.

● Databases in releases prior to 6.0 use buffered I/O. When upgraded to Release 6.5, all pre-Release 6.0 databases will use buffered I/O, unless essbase.cfg contains the setting DIRECTIO TRUE. The I/O access mode for any database can be changed once upgraded to Release 6.5, using the database settings.

The DIRECTIO setting introduced in Release 6.2 is server-wide, and affects all databases. With Release 6.5, the access mode specified by DIRECTIO is only read once for each database, upon upgrading or first creation of a database. Thereafter, the I/O access mode must be changed per database using the database settings.

Changing or Preserving the I/O Access ModeWith Release 6.5, the I/O access mode is a database setting stored in the Essbase security file, rather than a server-wide.cfg setting affecting all databases. The essbase.cfg configuration-file setting DIRECTIO TRUE|FALSE is maintained for backward compatibility with Release 6.2. It is also used to provide a default value for newly created databases and for databases that are upgraded from an earlier release.

If a DIRECTIO setting exists in the essbase.cfg file at upgrade time, only newly created or upgraded databases will be affected by the setting: Essbase reads the I/O access mode specification from essbase.cfg once for each database, and copies that information to the Essbase security file (essbase.sec). Thereafter, if you want to change the I/O access mode used by any database, you must change it at the database level using the database setting.

166 ■



The I/O access mode can be set from Application Manager (Database Settings > Storage tab), MaxL (alter database set io_access_mode), or programmatically using the Essbase Application Programming Interface. For more information, see the Essbase Database Administrator’s Guide, the MaxL documentation in the Technical Reference in the docs directory, or the API Reference in your docs directory.

If you want to use an operating system’s no-wait I/O, select direct I/O as the Essbase I/O access mode. Essbase attempts to use no-wait I/O, when available, as long as direct I/O is the I/O access mode. To determine whether Essbase is using no-wait I/O at a particular time, view the database information in Application Manager (Database Information > Storage tab), MaxL (display database), or programmatically using the Essbase Application Programming Interface. For a list of platforms on which Essbase supports no-wait I/O, see “Platforms on Which Essbase Supports No-wait I/O” on page 167.

If you set a database to use direct I/O, Essbase will attempt to use direct I/O the next time the database is started. If direct I/O is not available on the platform at the time the database is started, Essbase will use buffered I/O, which is the default. However, Essbase stores the I/O access mode you selected as a setting in the security file, and will attempt to use that I/O access mode each time the database is started.

Understanding How Cache Sizes Are Affected by an UpgradeWhen you upgrade, your cache sizes for existing databases will not change. If you are currently running Release 6.0 or 6.1 and using the default I/O access mode (direct), your cache sizes for existing databases are probably large, because direct I/O requires larger cache sizes. If, after you upgrade, you plan to use the default Release 6.5 I/O access mode (buffered), you should reduce the cache size settings before upgrading or before you start the upgraded database.

The following list explains default cache sizes for Essbase databases when upgrading to Release 6.5, for each I/O access mode:

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

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



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

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

To override the defaults after upgrading, change the database settings or properties before you start the upgraded database for the first time.

For more information on buffered I/O and direct I/O, see the Essbase Database Administrator’s Guide.

Platforms On Which Essbase Supports No-Wait I/OTable 15 shows the platforms on which Essbase supports no-wait (or asynchronous) I/O. Although no-wait I/O is not used by Essbase on Solaris and AIX, direct I/O is still available for those platforms.

Table 15: Platforms on Which Essbase Supports No-wait I/O

Platform Direct I/O No-Wait I/OCache Memory Locking

Windows 98 Not supported Not supported Not supported

Windows XP Supported Supported Supported1

Windows 2000 Supported Supported Supported1

1 On Windows XP, Windows 2000, and Windows NT, the Essbase Agent must be started by an administrator or power user to enable Cache Memory Locking (optional). Specifically, a power user is one who can run processes with the SE_INC_BASE_PRIORITY_NAME privilege set.

Windows NT Supported Supported Supported1

AIX Supported Not supported Not supported

Solaris Supported Not supported Supported2

2 After the OLAP Server software is installed, the root user must run a script, root.sh, to enable Cache Memory Locking (optional). For more information, see “Considerations When Upgrading from Release 5.x” on page 168.

HP-UX Supported3

3 Direct I/O not supported on HFS on HP-UX.

Supported Not supported

168 ■



Considerations When Upgrading from Release 5.xThe following additional considerations may apply to your upgrade situation.

● When upgrading from Release 5.0 or 5.0.1 to any later release, to use outline synchronization, you must:

– Delete existing.chg files from all OLAP Server computers.

– Install this release on all OLAP Server computers sharing partitions, and on any client computers used for outline synchronization editing.

● As of Release 6.0, you are no longer required to install and run Essbase from an account called arbor. Any user can install, but this must be the user who starts Essbase.

● Release 6.0 introduced Cache Memory Locking, which locks the memory used for the index cache, data file cache, and data cache into physical memory, giving the Essbase kernel priority use of system RAM. After installing Essbase, you can use the Cache Memory Locking feature available in Release 6.0 or later if the following prerequisites are met:

– You are using direct I/O. Direct I/O is the default for Release 6.0 and Release 6.1, and direct I/O is the only option for those releases. Release 6.5 uses buffered I/O by default, but it can be changed to direct I/O.

– On Solaris, this feature requires you to first run the Bourne shell script, root.sh, from the root account as part of the installation procedure.

Upgrading Databases to Release 6.5This section provides information about client-server compatibility and tells you how to upgrade databases from Essbase Release 5.x or later to Release 6.5. For the order of steps to follow, see “Steps for Upgrading Databases to Release 6.5” on page 171.

Hyperion supports upgrading databases from release 5.x or later to Release 6.5. If you are upgrading from a release prior to 5.x, you must first upgrade to 5.x and then upgrade to 6.5.



Compatibility Between Client and ServerOLAP Server Release 6.5 provides backward compatibility with earlier clients. This includes Essbase Application Manager as well as Essbase Spreadsheet Add-in, and Releases 6.1 and 6.2 of the MaxL Shell. Essbase Administration Services requires a Release 6.2 or later OLAP Server.

Although backward compatibility is supported, Hyperion recommends that you upgrade to Release 6.5 clients when you upgrade to the Release 6.5 OLAP Server because earlier client releases lack features of Release 6.5.

Essbase Application Manager releases prior to Release 5.0 do not work with the Release 6.5 OLAP Server, and this combination is not supported. Essbase Spreadsheet Add-in releases prior to 5.0 may work with the Release 6.5 OLAP Server, but this combination also is not supported.

Note: For information about release compatibility with Essbase Administration Services, see the Essbase Administration Services Installation Guide.

If you need to phase your upgrades, use the following order:

1. Install the Release 6.5 OLAP Server and Essbase Application Manager.

2. Install the Release 6.5 Essbase Spreadsheet Add-in.

170 ■



Database Files That Are UpgradedThis section lists the files that are upgraded for each database, for each release. The following files of same-named databases are upgraded from the specified earlier release to the new release:

Note: Essbase.sec, the Essbase security file in $ARBORPATH/bin, also upgrades for all releases.

When Does Essbase Upgrade the Files?Essbase upgrades databases when the database is started. By default, a database is set to start when its application starts. The Essbase kernel checks for files resulting from previous unsuccessful upgrades, restarting the upgrade if necessary.

Essbase upgrades the essxxxxx.ind, dbname.esm, and the dbname.tct files when the database is started. Essbase upgrades the essxxxx.pag file as data blocks are accessed; hence, the .PAG file upgrades when you run the VALIDATE command after starting the database. After the kernel files are upgraded, they are not backward-compatible with the earlier release.

Table 16: Database files that upgrade

File name File type Releases

essxxxxx.ind Index file Upgrades from Release 5.x to 6.0 or later.Upgrades from Release 6.0, 6.1, or 6.2 to Release 6.5.

essxxxx.pag Data file Upgrades from Release 5.x to 6.0 or later.Does not upgrade from Release 6.0 to Release 6.1, 6.2, or 6.5.

dbname.esm Persistent database root file

Upgrades from Release 5.x to 6.0 or later.Upgrades from Release 6.0, 6.1, or 6.2 to Release 6.5

dbname.tct Database transaction control file

Upgrades from Release 5.x to 6.0 or later.Does not upgrade from Release 6.0 to Release 6.1, 6.2, or 6.5.

dbname.otl Outline file Upgrades for all releases.



Steps for Upgrading Databases to Release 6.5The following steps explain how to upgrade to Release 6.5 from an earlier release on the same computer. To migrate databases to another computer without upgrading, see “Migrating Applications and Databases Across Servers” on page 174. To upgrade to a new release on a new computer at the same time, see “Upgrading and Migrating at the Same Time” on page 178.

After upgrading, you can restore databases from earlier releases of Essbase only from backups. Therefore, be sure to back up databases before starting to upgrade.

➤ To upgrade to Release 6.5 on the same computer:

Proceed in this order for each database.

1. Run the VALIDATE command in ESSCMD against the database.

VALIDATE prompts you to specify a name for the error log file that it will use.

If VALIDATE returns errors, revert to a backup that is free of those errors.

2. Back up all application files, database files, and the security file.

3. If you are using LROs in a production environment, run the LISTLINKEDOBJECTS command in ESSCMD before upgrading.

This command returns a list of LROs contained in the databases.

In Release 6.1, VALIDATE checks for LRO errors, which you may need information about after upgrading.

4. Stop the OLAP Server, if it is running.

5. Install OLAP Server Release 6.5 to the same directory as the earlier Essbase installation.

6. Start the Essbase Agent (essbase.exe ).

If you want to change database settings, this is a convenient point at which to do so. If you change the settings now, you will not have to restart the database to make the settings effective. See “Understanding Input/Output Defaults and Upgrading” on page 164.

7. Select a database or load an application.

Depending on which release you are upgrading from, the server upgrades the files listed in “Database Files That Are Upgraded” on page 170.

172 ■



8. Run the VALIDATE command in ESSCMD against the upgraded database.


9. If VALIDATE returns only LRO-related errors to the log file after upgrading, you must restore data from the earlier backup and re-create the LROs:

a. Either restore data from a backup of the database that does not contain LROs, or reload from a database export.

b. Restart the database in Essbase Release 6.5.

Essbase upgrades the database to Release 6.5 format if the database was restored.

c. Run the VALIDATE command.

d. Re-create the LROs, using the LISTLINKEDOBJECTS output as a guide. You may need to review the output from LISTLINKEDOBJECTS manually to verify its completeness.

10. Upon successful completion, unload the database and then back up the Release 6.5 database files.

Opening Retrieval Wizard Files in Query DesignerIn Release 6.0 and later, Essbase Query Designer (EQD) replaces Retrieval Wizard for creating queries. If you have Retrieval Wizard (.WIZ) files, the EQD may not properly translate Retrieval Wizard subsets to EQD member filters, which could cause the following problems:

● EQD does not interpret parentheses within the subsets. It ignores them.

● If the subset contains both AND and OR conditions, EQD may not group the conditions as expected, which may affect the result of the retrieval.

After opening Retrieval Wizard files, make sure the navigation panel nodes define the member filters as you want them. If necessary, manually promote, demote, or move nodes around or add new nodes.



For example, the following subset from the Retrieval Wizard,

(Flavor is Apple AND Container is glass) OR Flavor is Grape

will be interpreted in the EQD as:

|__Flavor is Apple

|__Container is Glass

|__Flavor is Grape

You need to change the member filters in the EQD to:

|__Flavor is Apple

|__Container is Glass

|__Flavor is Grape

Windows System File UpdatesOn Windows platforms, the Essbase installation program updates the client or server system environment to run Essbase Release 6.5 software. Microsoft system files are installed to the Windows system directory (for example, C:\Winnt\System32 on Windows NT 4.0) if the files do not already exist, or if the version shipped with Essbase is newer.

Table lists Windows system files installed with each Essbase component on supported Windows platforms. A check mark in a column indicates that the system file is installed with the specified Essbase component. These files are installed to your system directory only if the files do not already exist, or if older versions exist.

174 ■



Migrating Applications and Databases Across Servers

This section describes how to migrate existing Essbase applications and databases from one OLAP Server computer to another, for example, from a development server to a production server. To upgrade to a new release and move Essbase to a new computer at the same time, see “Upgrading and Migrating at the Same Time” on page 178.

➤ To move Essbase Release 6.5 databases to a different computer:

Proceed in the following order for each database.

1. Run the VALIDATE command in ESSCMD against the database you will migrate.


If VALIDATE returns errors, revert to a backup that is free of those errors.

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

3. Install Essbase on the target server computer.

Table 17: Windows System Files Installed With Essbase Components

FileOLAP Server

Application Manager

Spreadsheet Add-in

Runtime Client API File Version

ATL.DLL ✔ 2.00.7024

CTL3D32.DLL ✔ 2.31.000

MFC42.DLL ✔ ✔ ✔ 4.21.7022 1

1 Do not use file versions 6.00 through 6.00.8336, as these file versions may cause memory allocation problems.

MSVCRT.DLL ✔ ✔ ✔ ✔ ✔ 5.00.7022 2

2 Do not use file versions 6.00 through 6.00.8266, as these file versions may cause memory allocation problems.

MSVCIRT.DLL ✔ ✔ ✔ ✔ ✔ 5.00.7022



4. Copy the essbase.cfg file from the essbase\bin directory on the original OLAP Server to the same directory on the new OLAP Server using the file system.

5. On the target OLAP Server, define disk volumes.

To allocate a new volume, use SETDBSTATEITEM 23 in ESSCMD and follow the prompts. You can also use the Database Settings dialog box in Application Manager or the alter database statement in MaxL.

Consider carefully how you configure your disk volumes. Any changes you make to your disk volumes settings after you have loaded data on the target OLAP Server are reflected only in new data loads; changes are not retroactive.

6. Using Application Manager, MaxL, or ESSCMD, create new applications and databases on the target OLAP Server.

Note: For Release 6.2 and later, you can use Essbase Administration Services to migrate applications and databases (without re-creating them) from one OLAP Server to another. When you migrate applications and databases across servers using Administration Services, the following information is copied to the target server: all databases and outlines, Essbase objects, user and group security for the application or database (including filter associations), and security filters.

The names of the applications and database you create do not need to be the same as the ones on the source server. 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 that these changes are clearly communicated to the user base.

CAUTION: Do not move the application directory to the new server through a file transfer via the operating system or via FTP.

7. On a client or server computer that has connectivity to both the source and target OLAP Servers, open Application Manager.

8. Select File > Open, click Client, and select the source server, application, and database.

9. Open the original outline (.OTL ) file, and select File > Save As.

176 ■



10. Save the.OTL file to the new application and database on the target server.

At this point, you should avoid making changes to the outline if you want to be able to import the data file that you will export from the source application.

11. Move all calculation scripts, rules files, and report scripts to the target server using one of the following procedures:

● Repeat Step 8 through Step 11 of this procedure.

● Move the files to the new server via the file system or via FTP.

If you are migrating between different server platforms, be sure to use the procedure described in Step 8 through Step 11 of this procedure. If you are migrating between the same server platforms, calculation script and report script files can be moved using the operating system. If you move these files via the operating system, check to make sure that they function properly after moving them.

CAUTION: Data load rules files are binary files and should always be migrated as described in Step 8 through Step 11.

12. Move any ESSCMD or MaxL scripts to the target server using the file system or via FTP.

Note: In Release 6.5, MaxL includes an ESSCMD-to-MaxL script conversion utility. For more information, see the MaxL Language Reference.

13. If you are migrating a Release 6.5 database to another computer and the database uses linked reporting objects, export the LROs so that you can re-import them to the migrated database.

Use the export lro and import lro MaxL statements. For more information, see the MaxL Language Reference.

Note: If you decide to clear data from the source database, note that any LROs you want to migrate must be exported before data is cleared. When data is cleared, LROs are also cleared.



14. Export data from the application on the source server in one of the following ways:

● Choose All Data, Input Level Data, or Level 0 Data, depending on the size of your data set as well as how the database was initially loaded.

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

15. Import data to the target application on the target server.

16. Recalculate your database if these apply:

● You loaded input-level data from data load files, or

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

17. If you exported any linked-reporting objects (LROs) from the source database, reimport them to the upgraded database using the import lro MaxL statement.

For more information, see the MaxL Language Reference.

18. Repeat these steps for all other databases on the source server that you want to migrate to the target server.

19. Migrate security information by recreating user filters, groups, and permissions on the target server.

Note: If you are migrating Release 6.2 or later databases from one server to another, you can use Essbase Administration Services to migrate security information. See the Essbase Administration Services Online Help for more information.

CAUTION: Moving the security file (essbase.sec and its backup essbase.bak) between computers is not recommended or supported.

178 ■



Upgrading and Migrating at the Same TimeWhen you upgrade to a new release of Essbase, you may want to do so on a different computer. You have two options for upgrading and migrating at the same time:

● First upgrade the existing Essbase installation to the new release on the same computer, and then migrate applications and databases to the target computer. This is the recommended order if you are upgrading/migrating to a computer that runs a different operating system.

● First migrate existing applications and databases to the target computer, test the environment, and then upgrade to the new release on that computer.


Chapter

11Performing Advanced Installation Tasks

This chapter describes how to perform advanced installation tasks, such as updating the Essbase environment manually or configuring Essbase to use a non-English language. It contains the following sections:

● “The Essbase Environment” on page 179

● “Manually Updating the Environment on Windows Platforms” on page 180

● “Configuring Client and Server for Non-English Essbase” on page 181

● “Manually Installing Java” on page 183

● “Uninstalling Essbase” on page 190

● “Installing Essbase Documentation” on page 193

The Essbase EnvironmentThis section explains the changes that are made to your system when you install Essbase products, locally or to the network, on a supported Windows platform.

When you install Essbase products on UNIX platforms, you must update the environment manually.

● To learn how to update the UNIX environment for the Essbase OLAP Server, see Chapter 3, “Installing UNIX OLAP Server Software.”

● To learn how to update the UNIX environment for SQL Interface, see Chapter 8, “Configuring SQL Interface.”

● To learn how to update the UNIX or Windows environment for Essbase Application Programming Interface (API), see Chapter 7, “Installing the API.”

180 ■

Performing Advanced Installation Tasks


Manually Updating the Environment on Windows Platforms

To run Essbase, the operating system needs to know where Essbase is located. If you did 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. This section explains the following procedures:

● “Manually Updating the Environment on Windows Platforms” on page 180

● “Manually Updating the Environment on Windows 98” on page 181

Manually Updating the Environment on Windows Platforms

➤ To update the environment settings manually on Windows NT 4.0, Windows 2000, or Windows XP:




● On Windows 2000 or Windows XP, select the Advanced tab, and click the Environment Variables button.



● Add %ARBORPATH%\BIN to the Path variable, or C:\HYPERION\ESSBASE\BIN, depending on where Essbase is installed.

Note: Changing System settings affects all users who access your system.

4. Remove outdated ARBORPATH system variables or ESSBASE\BIN Path settings.

5. Reboot your computer, or log out and log on, to enable the changes to take effect.


11


Manually Updating the Environment on Windows 98

➤ To update the environment settings manually on Windows 98:

1. Add the following environment variable to your AUTOEXEC.BAT file:


where C:\HYPERION\ESSBASE is the local or network directory where Essbase is installed.

Do not put a space before or after the equal sign (=) in the ARBORPATH environment setting.

2. Add C:\HYPERION\ESSBASE\BIN to your PATH statement.

where C:\HYPERION\ESSBASE is the directory where Essbase is installed.

3. Remove references to installations of Essbase in other directories.

Tip: You can type SET from an MS-DOS command prompt to view your current environment settings.


Configuring Client and Server for Non-English Essbase

To use non-English versions of Essbase successfully, you must set the ESSLANG variable to be the same on both the client computers and the server computer.

Create the ESSLANG environment variable to point Essbase clients and servers to the correct Uniscape code page (installed in the ESSBASE\LOCALE directory). If no ESSLANG value is set, the default is United States English.

You can create the ESSLANG variable as a user variable or a system variable. If ARBORPATH is defined as a system variable, also create ESSLANG as a system variable. If ARBORPATH is defined as a user variable, create ESSLANG as a user variable.

ESSLANG settings should follow the format ESSLANG=<locale> where <locale> is a supported Uniscape GlobalC locale of the format:

<Language>_<Territory>.<code page name>@<sort sequence>

182 ■



Examples of ESSLANG Settings:

ESSLANG=German_Germany.Latin1@DefaultESSLANG=French_France.Latin1@DefaultESSLANG=Spanish_Spain.Latin1@SpanishESSLANG=Italian_Italy.Latin1@DefaultESSLANG=Portuguese_Portugal.Latin1@DefaultESSLANG=Norwegian_Norway.Latin1@DanishESSLANG=Swedish_Sweden.Latin1@SwedishESSLANG=Danish_Denmark.Latin1@DanishESSLANG=Finnish_Finland.Latin1@FinnishESSLANG=Japanese_Japan.MS932@binaryESSLANG=CanadianFrench_French-Canada.Latin1@DefaultESSLANG=TraditionalChinese_Taiwan.MS950@BinaryESSLANG=SimplifiedChinese_China.MS936@BinaryESSLANG=Albanian_Albania.ISO-8859-2@DefaultESSLANG=Arabic_SaudiArabia.ISO-8859-6@DefaultESSLANG=Bulgarian_Bulgaria.ISO-8859-5@DefaultESSLANG=Byelorussian_Belarus.ISO-8859-5@DefaultESSLANG=Catalan_Catalonia.Latin1@DefaultESSLANG=Croatian_Croatia.ISO-8859-2@CroatianESSLANG=Czech_CzechRepublic.ISO-8859-2@CzechESSLANG=Dutch_Netherlands.Latin1@DefaultESSLANG=Estonian_Estonia.ISO-8859-4@EstonianESSLANG=Farsi_Iran.ISO-8859-6@DefaultESSLANG=Greek_Greece.ISO-8859-7@DefaultESSLANG=Hebrew_Israel.ISO-8859-8@DefaultESSLANG=Hungarian_Hungary.ISO-8859-2@HungarianESSLANG=Korean_Korea.MS949@BinaryESSLANG=Latvian_Latvia.ISO-8859-4@LatvianESSLANG=Lithuanian_Lithuania.ISO-8859-4@LithuanianESSLANG=Macedonian_Macedonia.ISO-8859-5@DefaultESSLANG=Romanian_Romania.ISO-8859-2@RomanianESSLANG=Russian_Russia.ISO-8859-5@DefaultESSLANG=Serbian_Yugoslavia.ISO-8859-2@DefaultESSLANG=CyrillicSerbian_Yugoslavia.ISO-8859-5@DefaultESSLANG=Slovak_Slovakia.ISO-8859-2@SlovakESSLANG=Slovenian_Slovenia.ISO-8859-2@SlovenianESSLANG=Thai_Thailand.MS874@ThaiESSLANG=Turkish_Turkey.ISO-8859-9@TurkishESSLANG=Ukrainian_Ukraine.ISO-8859-5@UkrainianESSLANG=Vietnamese_VietNam.MS1258@Vietnamese


11


Manually Installing JavaOn Windows systems, you have the option to install Java Runtime Environment (JRE) automatically. If you do not choose this option, or if you are installing Essbase on UNIX systems, you must manually install the Java 2 Runtime Environment (JRE) or the Java 2 platform, Standard Edition, version 1.2 or 1.3.

Support for JRE on specific platforms:

● Beginning with Release 6.2, Essbase supports AIX JRE version 1.3. You may want to use it instead of 1.2.2 if you are also planning to use Essbase Administration Services.

● Beginning with Release 6.2, Essbase supports JRE 1.3.01 and later with HP-UX. You may want to use it instead of 1.2.2 if you are also planning to use Essbase Administration Services.

➤ To install Java to work with Essbase:

● Install JRE.

See “Installing the Java Runtime Environment” on page 184.

● Set the JVMMODULELOCATION parameter in the essbase.cfg file.

See “Setting JVMMODULELOCATION” on page 185.

● On UNIX systems, set environment variables. See “Updating the Environment for Java on UNIX Systems” on page 188.

Note: You may need to install operating system patches to support JRE. For more information, see “Installing JRE on UNIX Systems” on page 184.

If you have already installed a supported version of JRE, you do not have to reinstall JRE. However, you must set the JVMMODULELOCATION parameter, and, on UNIX systems, set additional environment variables.

For more information about supported versions of JRE, see “Windows OLAP Server Requirements” on page 36 or “Verifying UNIX OLAP Server Requirements” on page 62.

184 ■



Installing the Java Runtime EnvironmentJRE is required by Essbase to enable Java-based features, such as custom-defined functions. JRE must be installed on the computer running the OLAP Server.

Installing JRE on Windows SystemsThe Essbase installation program will install JRE for you if you select JRE as a server sub-component. See “Selecting Server Products” on page 38.

JRE installation packages for Windows systems are self-installing executables that walk you through the installation of JRE.

➤ To install JRE on Windows systems:

1. Insert the Essbase CD into your CD drive.

2. Go to the directory containing JRE installer for the Windows system:

● For Windows 98, change to the directory, \win32\server\win9x\jre\

● For Windows NT, 2000, and XP, change to the directory, \win32\server\nt\jre\

3. Run the setup.exe file in the directory.

4. Follow the on-screen installation instructions to complete the installation of JRE.

Installing JRE on UNIX SystemsJRE installation packages and installation procedures for each of the supported platforms are substantially different. Readme files and installation instructions from JRE providers are included in .txt or .htm files with each package. Review these instructions carefully. You may need to refer to the Web site of the JRE provider for additional information about installing JRE.


11


➤ To install JRE on UNIX systems:

1. Log on as the Essbase system administrator account.

For example, log on as admin if you created a user account called admin that owns the target installation directory, /home/hyperion/essbase.


3. Change to the root directory of the CD (for example, cd /cdrom).

4. Change to the directory containing the JRE install package for the operating system:

● For Solaris, change to the directory, /solaris/server/jre/

● For AIX, change to the directory, /aix/server/jre/

● For HP-UX, change to the directory, /hpux/server/jre/

5. Decompress the .tar file into a temporary directory using the UNIX tar utility.

6. Review the readme file in the directory for system requirements and installation instructions to complete the installation of JRE.

Note: Use of JRE requires operating system patches on some platforms. Review the Essbase readme file for special requirements and verify that you have installed the correct patch level to support the JRE you are installing.

7. Set any environment variables specified by readme.htm or installation instructions for the JRE you have installed.

Setting JVMMODULELOCATIONJVMMODULELOCATION is a setting in the essbase.cfg file that enables you to designate a specific installation of JRE for use with Essbase. This setting is particularly useful if you have multiple versions of Java installed on the computer running OLAP Server.

In Windows, if the user selects to install JRE automatically, it is installed to the $ARBORPATH\java\jre13 directory. Therefore the JVM.DLL file with be in $ARBORPATH\java\jre13\bin\hotspot\jvm.dll. JVMMODULELOCATION is automatically set up in essbase.cfg if JRE is installed automatically.

186 ■



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 this library varies, depending on the JRE version and the operating system that you are using. Table 18 shows the correct locations for the JVM.

CAUTION: If the JVMMODULELOCATION variable is set to point directly to the libjvm.so file, and a symbolic link to libjvm.so also exists, the JVM will crash when Essbase attempts to load it. Either set the symbolic link to point to the desired version of libjvm.so (client or server), or delete the symbolic link and set JVMMODULELOCATION to point directly to the desired version.

Table 18: Locations and Names of JVM Library Files

Operating System (JRE version) Location and Name of JVM Library File

Windows systems (JRE 1.3)

C:\Program Files\JavaSoft\JRE\1.3\bin\hotspot\jvm.dll

Solaris (JRE 1.3) /usr/j2se/jre/lib/sparc/libjvm.so.

AIX (JRE 1.2) /usr/java120/jre/bin/classic/libjvm.a

HP-UX (JRE 1.2) /opt/java1.2/jre/lib/PA_RISC/classic/libjvm.sl1

1 The directory, PA_RISC, may be PA_RISC2.0, depending on the processor used by the computer running HP-UX.


11


Considerations for Setting the JVMMODULELOCATION on Solaris

The location, /usr/j2se/jre/lib/sparc/libjvm.so is actually a symbolic link to /usr/j2se/jre/lib/sparc/client/libjvm.so. The JVMMODULELOCATION must be set to point to this link, not to the file itself. If you want to use server JVM with Essbase, you need to choose one of the following options:

● Change the symbolic link to point to /usr/j2se/jre/lib/sparc/server/libjvm.so

● Remove the symbolic link altogether. After you remove it, you can safely set JVMMODULELOCATION directly to /usr/j2se/jre/lib/sparc/server/libjvm.so

➤ To set JVMMODULELOCATION:

1. On the computer that runs the OLAP Server, change to the ARBORPATH\bin directory.

2. Locate the essbase.cfg file in this directory and open the file in a text editor.

If the file does not exist, create and open a new text file named essbase.cfg.

3. In the essbase.cfg file, add a new line to the end of the file and type the following text:

JVMMODULELOCATION FullpathAndFilenameOfJvmLibraryFile

Do not include spaces in the path and filename. Do not enclose the parameter in quotation marks. A semicolon is not required at the end of the line.

On Windows systems, be sure to specify the path and file name without spaces, as in the following example:

JVMMODULELOCATION c:\progra~1\javasoft\jre\1.3\bin\hotspot\jvm.dll

188 ■



4. Save the changed text file as essbase.cfg.

5. Close the file and exit the text editor.

Note: On Solaris, the symbolic link for the JVM is set to the client version by default. If you want to use the server VM with Essbase (instead of the default client vm), modify the link to the following setting:

$JAVAHOME/jre/lib/sparc/libjvm.so->$JAVAHOME/jre/lib/sparc /server/libjvm.so

On UNIX systems, you must update additional environment variables to enable the JVM to work with Essbase in addition to these changes. For more information, see “Updating the Environment for Java on UNIX Systems” on page 188.

Updating the Environment for Java on UNIX SystemsOn AIX and HP-UX, you must update environment variables to enable Essbase to use JRE.

Updating Environment Variables for Java on SolarisOn Solaris, if you are using version 1.3 of JRE, you must set an ESS_JVM_OPTION.

In the C shell, add the following text to the.cshrc file:

setenv ESS_JVM_OPTION1 "-XX:+AllowUserSignalHandlers"

In the Bourne or Korn shell, add the following text to the .profile file:

ESS_JVM_OPTION1=-XX:+AllowUserSignalHandlers; export ESS_JVM_OPTION1;


11


Updating Environment Variables for Java on AIXOn AIX, you must update the LIBPATH setting to include the JREHOME/bin/ and the JREHOME/bin/classic/ directories. The default directory location for JREHOME is shown in the following examples:

In the C shell, add the following text to the .cshrc file:

setenv LIBPATH "/usr/java120/jre/bin: /usr/java120/jre/bin/classic:$LIBPATH"


LIBPATH=/usr/java120/jre/bin:/usr/java120/jre/bin/classic: $LIBPATH; export LIBPATH;

Note: These LIBPATH directory entries must be added to the beginning of the LIBPATH environment variable.

Updating Environment Variables for Java on HP-UXOn HP-UX, you must update the SHLIB_PATH setting to include the JREHOME/lib/PA_RISC/ and the JREHOME/lib/PA_RISC/classic/ directories. The default directory location for JREHOME is shown in the following examples.

In addition, due to a problem with the Just In Time compiler in Release 1.2.2 of JRE for HP-UX, you must also add two ESS_JVM_OPTION settings to your environment.

In the C shell, add the following text to the .cshrc file:

setenv SHLIB_PATH "$SHLIB_PATH:/opt/java1.2/jre/lib/PA_RISC: /opt/java1.2/jre/lib/PA_RISC/classic"

setenv ESS_JVM_OPTION1 "-Djava.compiler=NONE"

setenv ESS_JVM_OPTION2 "-Xnojit:all"

190 ■




SHLIB_PATH=$SHLIB_PATH:/opt/java1.2/jre/lib/PA_RISC: /opt/java1.2/jre/lib/PA_RISC/classic; export SHLIB_PATH;

ESS_JVM_OPTION1=-Djava.compiler=NONE; export ESS_JVM_OPTION1;

setenv ESS_JVM_OPTION2=-Xnojit:all; export ESS_JVM_OPTION2;

Note: The directory, PA_RISC, may be PA_RISC2.0, depending on the processor used by the computer running HP-UX.

Advanced Configuration Options for JavaIf you are having difficulties getting Essbase to work with Java, it may be necessary to set start-up options for the Java Virtual Machine (JVM). You can make Essbase use specific JVM start-up options when it loads the JVM by setting the environment variables ESS_JVM_OPTION1 through ESS_JVM_OPTION9. For Solaris and HP-UX, you must set one of these options so that Essbase can work with the JVM.

For examples of setting ESS_JVM_OPTION environment variables, see “Updating Environment Variables for Java on Solaris” on page 188 and “Updating Environment Variables for Java on HP-UX” on page 189.

Note: Use and support of ESS_JVM_OPTION settings is likely to change in future releases of Essbase.

Uninstalling EssbaseYou can uninstall Essbase from Windows 98, Windows XP, Windows NT 4.0, and Windows 2000 platforms. This section helps you determine conditions for uninstalling Essbase, and shows you how to uninstall OLAP Server and client software from your computer or from a network drive.

This section contains the following subsections:

● “Guidelines for Uninstalling” on page 191

● “What You Can Uninstall” on page 192

● “Instructions for Uninstalling” on page 192


11


Guidelines for UninstallingBefore uninstalling Essbase software, read the following guidelines:

● Do not manually delete, move, rename, or alter Essbase files and directories. This causes problems with uninstalling.

● Use the Windows Add/Remove Programs icon in the Control Panel to uninstall software, as described in “Instructions for Uninstalling” on page 192.

● If you want to reinstall Essbase, uninstall the existing version first.

● You must uninstall Essbase software components separately. Uninstall them in the following order (assuming you installed all components):

a. API

b. OLAP Server

c. Runtime Client

d. Spreadsheet Add-in for Excel

e. Spreadsheet Add-in for Lotus 1-2-3

f. Application Manager

This is the reverse of the default installation order.

● If you previously set up your client computer to share Essbase client software on a network drive and you want to install Essbase to your local hard disk drive, uninstall the shared configuration first.

● If you perform two or more Essbase installations on or from the same computer, the uninstaller removes only the last installation. Therefore, for ease of removal, it is recommended that system administrators who install software locally use a different computer to install software to a network drive for shared use.

● The uninstall program works only for Essbase Release 6.x; you cannot uninstall earlier releases using the Windows Add/Remove Programs method.

192 ■



What You Can UninstallYou can uninstall all types of Essbase Release 6.x installations:

● Local installations of OLAP Server and Essbase API on supported Windows platforms

● Local installations of Essbase client software on supported Windows platforms

Client software includes Essbase Application Manager, Essbase Spreadsheet Add-in, and Essbase Runtime Client.

● Network installations of Essbase client software on supported Windows platforms

● Shared-use configurations, in which a local client computer is set up to run shared executables on the network

This type of uninstallation does not remove the software from the network drive; rather, it removes from the client hard disk drive the environment and registry settings which enable shared use.

● Local installations of Personal Essbase client and server software on supported Windows platforms

Instructions for UninstallingTo uninstall Essbase, use the Windows Add/Remove Programs icon in the Control Panel.

➤ To uninstall Essbase from a supported Windows platform:

1. Select Start > Settings > Control Panel > Add/Remove Programs.

2. Complete the following step that is appropriate for your operating system:

● On Windows 98 and Windows NT 4.0:

On the Install/Uninstall tab, select the Essbase program you want to remove, and click Add/Remove.

● On Windows 2000 and Windows XP:

Select Change/Remove Programs, select the Essbase program you want to remove, and click Change/Remove.


11


3. Click Yes to confirm that you want to remove the program.

4. If a Remove Shared File? prompt is displayed, click Yes To All.

Note: You see the prompt because Essbase products are uninstalled individually, and many Essbase files are shared with other Essbase products. For example, essapin.dll is installed with the OLAP Server, as well as with client software and the API. Clicking Yes To All makes uninstalling faster and does not disrupt other programs installed on your computer.

Windows removes the program and associated files. If some elements of the program could not be removed, a Details button is displayed.

5. Click Details for more information.

6. Click OK.

Installing Essbase DocumentationIn addition to installing documentation files as part of the software installation, Essbase now provides a separate installer for documentation. This separate installer enables you to install additional copies of Essbase documentation or to update existing documentation, independent from the software installation.

All documentation is still available with the Essbase software installation, according to the software components that you select during installation.

Note: In this release, the documentation installer is available only for Windows platforms. You can access this installer via essbase.com or the Hyperion Download Center.

The documentation installer enables you to select the documentation components that you want to install and to specify where to install them. Example scenarios for using the documentation installer:

● During the OLAP Server software installation, you chose not to install the Essbase Database Administrator’s Guide and the Technical Reference on the OLAP Server computer. Users attempting to access these files from the Application Manager Help menu are receiving error messages. You now want to go back and install only these documentation components on the OLAP Server.

194 ■



● Your organization has an internal server set up specifically for product documentation. You want to install all or part of the Essbase documentation set on this internal server.

● A spreadsheet user at your organization is missing the documentation for the Spreadsheet Add-in. That individual can use the documentation installer to install only the spreadsheet documentation on his or her client computer without having to reinstall the Spreadsheet Add-in software.

Note: Links to documentation from help menus, the Information Map, and the Windows Start menu will not work properly if you do not have one full copy of documentation installed on the OLAP Server computer.

➤ To install documentation:

1. Download the documentation installer from essbase.com or the Hyperion Download Center (from the same location as the OLAP Server software downloads).

2. Open the docinst directory, and double-click setup.exe.

3. Follow the prompts to the Choose Destination Location screen.

4. Click Browse to select or type the name of the directory where you want to install the documentation.

The default directory is the existing installation directory (if documentation has been previously installed on this computer) or ARBORPATH or \hyperion\essbase on the same drive as Windows.

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

5. On the Setup Type screen, select one of the following options:

● Complete: Installs all documentation associated with the release.

● Custom: Enables you to select the documentation components that you want to install.


11


6. If you select Custom, select the documentation categories that you want to install on the Select Components screen:

a. To select documentation components within each category, select the category and click Change.

b. On the Select Sub-components screen, select the sub-components that you want to install.

Note: Be sure to select the Information Map component in the Getting Started category in order to install the HTML file that provides live links to all documentation components (essdocs.htm). This map enables you to access documentation without having to know where individual files are installed.

7. On the Check Setup Information screen, review the summary of your installation choices, and perform one of the following steps:

● To allow the installation program to begin copying files, click Next.

● To revise your choices, click Back.

● To exit the installation program without installing, click Cancel.

8. 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 essdocs.htm file in the \docs directory, under the directory you specified during installation. Note that links from the Information Map work only for those documentation components you choose to install.

196 ■




Ind

ex

Index

Symbols+s flag (UNIX), 138

Aaccessing sample applications, 110activity log files, UNIX servers, 63activity logs. See log filesadding

Essbase Excel toolbar, 101IP addresses, 56server licenses, 32Spreadsheet Add-in to Excel or Lotus 1-2-3, 102

Administration Services. See Essbase Administration Services

advanced installation tasks, 179Agent

commands, 45removing automatic service, 52running as automatic service, 47stopping automatic service, 50

AIX serversAPI library path, 137installing

API, 133OLAP Server, 61SQL Interface, 142

library path variables, 73multithreading, 62starting, 74system requirements, 25

AllowUserSignalHandlers option for Java, 188

API directory, 90UNIX server program files, 69Windows server program files, 40

API. See Application Programming InterfaceAPP directory

UNIX servers, 69Windows servers, 41

Application Desktop window, 95application files

default location on UNIX servers, 69default location on Windows servers, 41migrating from Release 5.x, 81stored on client hard disk drive, 91

Application Managerconnecting to the server, 94creating partition user, 113default directories on network drive, 91desktop, 93installing

as shared on network drive, 87to hard disk, 83to network drive, 82

online help icon, 93program files, 90running, 93shared network installation, 87Start Menu icon, 93starting, 93troubleshooting connections, 97

Application Programming Interface (API)API directory, 136default directories, 136files required to compile programs, 136installing on UNIX, 133installing on Windows, 132

Index

198 ■ Essbase Installation Guide

platform requirements, 28setting up environments, 137supported platforms, 131UNIX servers, 133 to 134updating environment variables, 137

Application Settings dialog box, 111applications

logs for, 43, 74quitting, 77starting automatically on Windows, 45starting from Agent, 45stopping, 45

Applications list box, 106APPMAN32 directory, 91arbor account, 168ARBORPATH setting

described, xivmanually updating

for Windows Service, 49in Windows 98 AUTOEXEC.BAT, 181on Windows servers, 180

Personal Essbase and, 54problems with, 94Runtime Client, 129UNIX servers, 71

automatically entering passwords, 44auto-starting

applications and databases on Windows, 45Essbase as a Windows service, 48Essbase when Windows starts, 44

available portsdisplaying, 45licensing, 32

Bbackground process, starting Essbase on UNIX, 76backup

before upgrading, 163complete, 163incremental, 163

backup files, 42BIN directory

client files, 90runtime client files, 125

UNIX server files, 69Windows server files, 41

bind command, 153bnd (.bnd) files, 141, 153Bourne shell

adding Essbase, 71ARBORPATH setting, 71library path (AIX), 73library path (HP-UX), 73library path (Solaris), 72set path, 71setting up drivers, 147 to 148Solaris script, 68

buffered I/O, and upgrading, 164

CC shell environment settings

adding Essbase, 71ARBORPATH, 71library path (AIX), 73library path (HP-UX), 73library path (Solaris), 72set path, 71

cache memory locking, 164on Solaris, 68upgrading and, 168

cache sizesdefaults, 166I/O access mode, 166

CALCDAT sample data file, 108Call-Level Interface DB2 driver. See IBM DB2

driverscanceling installation, 37CD installation

API on UNIX, 134client software on hard disks (Windows), 83server software on UNIX, 64

changingembedded server names, 116environment settings

manually on Windows 98, 181manually on Windows NT/2000, 180Runtime Client, 129UNIX servers, 70

network protocols, 89

Index


partition definition files, caution, 112passwords, 45server names

by editing the Windows HOSTS file, 56in sample partition definitions, 116

Windows NT network settings, 46character-set files

API, 136client software (Windows), 91UNIX servers, 70Windows servers, 41

Check Setup Information dialog boxclient network protocol update, 90shared client installation, 88shared Runtime Client installation, 128Windows server installation, 39

Citrix support, 27CLI DB2 driver. See IBM DB2 driversclient and server compatibility, 169CLIENT directory, 91client installations

from network to hard disk drive, 86guidelines, 80Named Pipes network protocols, 159TCP/IP network protocols, 158to hard disks, 83to network drives, 82

client softwaredirectories created, 90installing

as shared on network drive, 87from network drives, 86to hard disk, 83to network drive, 82

network protocols, 89closing Essbase. See quitting, from Agentcode pages, setting the ESSLANG environment

variable, 181commands, Agent, 45communication protocols. See network protocolsCompany database, 105compatibility

between client and server, 169between releases, 20

componentsinstallations, 18order for uninstalling, 191

configuringdata source and ODBC driver, 155for non-English, 181Microsoft loopback adapter, 59Windows hosts file, 56

Connect command, 55, 94connection protocols. See network protocolsconnections

database, 106, 148displaying on Windows server, 45errors, 97, 160increasing numbers, 160Personal Essbase, 55testing, 159to server from Application Manager, 94to server from Spreadsheet Add-in, 99troubleshooting, 97

considerations when upgrading from 5.x, 168console commands, 45copying client application files, 81copying Essbase. See migrating across serverscross-server migrating, 174cshrc (.cshrc) files, 70Currency Conversion, sample databases for, 105

Ddatabase files, 91database instances

define DB2 instance names, 148set DB2 environment variable, 146

databasesconnecting to DB2, 148default location on UNIX, 69default location on Windows, 41preparing Sample Basic, 106sample. See sample databasesstarting automatically on Windows, 45upgrading and, 168

DB2 driversbinding files, 152Editing .odbc.ini, 153implementing, 152, 154

Index


instance names, 146, 148setting up, 146 to 147, 153supported, 29switching, 153

DB2INSTANCE setting, 147 to 148DB2INSTANCEPATH setting, 148DDB (.DDB) files

caution for changing, 112changing server names, 116storage for partition definitions, 112

defining server names, 55deleting. See removingDemo application, introduced, 105development environment, migrating from, 174direct I/O, and upgrading, 164DIRECTIO setting, 165directories

API, 90, 136APPMAN32, 91BIN, 90, 141cautions against moving/renaming, 40, 92CLIENT, 91client software, 90created

API, 136Runtime Client hard disk drive, 127Runtime Client network drives, 125UNIX server default, 69Windows server default, 40

DOCS, 91DOCS\CLIENT, 141ESSEXC32, 91ESSLOT32, 92for installing Spreadsheet Add-in from network,

91INCLUDE, 136LIB, 136LOCALE, 41, 70, 91, 136moving/renaming (caution), 40, 92network installations of Application Manager, 91ODBCDocs, 141ownership requirements (UNIX), 63, 134Personal Essbase, 53REDIST, 136RUNTIME, 92selecting, 39

specifying server destinationUNIX, 63Windows, 39

SQL Interface default, 141, 144disk space

AIX system requirements, 25HP-UX system requirements, 26Solaris system requirements, 24Windows system requirements, 23

displayingExcel Essbase toolbar, 101Readme file, 40server information (Windows), 45

DOCS directory, 91docs.tz, 135DOCS\CLIENT directory, 141documentation

accessing, xivformatting conventions, xiiiinstalling with API, 132readme file, location, 33

dot command in SQL Interface setup on UNIX, 152Downloading Installers, 18downloading installers, 18driver manager library, 148dual boot configurations, 54DUMP command (Agent)


dynamic-link libraries (DLLs)Application Programming Interface, 132, 138backward compatibility, 21client software, 89network protocols, 42Runtime Client, 124

EEAS. See Essbase Administration ServicesEast database, 105editing odbc.ini files, 153embedded server names, changing, 116entering username and password

when creating partition user for sample applications, 114

Index


when logging into server from Application Manager, 95

when starting Essbase, 43environment

API installations, 137client installation choices, 85ESSLANG variable for non-English Essbase, 181manually updating

for API, 137for Runtime Client, 129on Windows 98, 181on Windows NT/2000, 180

prerequisites, 30Runtime Client

manually updating, 129setting during installation, 128Windows platforms, 129

sample applications, 112SQL Interface

on UNIX, 145updating with shell scripts on UNIX, 152

UNIX information in hyperionenv.doc, 71updating on UNIX, 70updating on Windows servers, 180Windows server installation choices, 39

environment variables, See environmenterror messages

Cannot initialize Essbase, 94Cannot receive data, 160File not found, 103Spreadsheet Add-in, 103startup, 98Unable to Connect to hostname, 97 to 98Unable to Locate hostname in Hosts File, 56, 97when starting UNIX server, 74when starting Windows server, 43Windows connections, 160

ESS_JVM_OPTION settings, 190ESS123.12A

add Lotus 123 manually, 104for releases 9.1 and 9.5, 102in BIN directory, 90

ESSADMIN.EXE, 90

Essbaseperformance, optimizing, 46quitting from Agent

UNIX servers, 77Windows, 45

running as a service, 47starting automatically on Windows, 44starting on UNIX, 74starting on Windows, 43supported protocol stacks, 159uninstalling, 190upgrades

client software, 81licensing, 32

Essbase Administration Services, 33ESSBASE directory, 39Essbase Integration Server, 33Essbase System Login dialog box

Application Manager, 94Spreadsheet Add-in, 99

Essbase Toolbar, installing, 100ESSBASE.BAK, 42ESSBASE.EXE, 44ESSBASE.MDB, 94essbase.pm

location of, on UNIX, 70location of, on Windows, 42, 91

ESSBASE.SECbackup of, 42migrating and, 177security file, 42upgrading and, 170

essbase.secure, 76ESSCMD and Personal Essbase, 53ESSCMD icon, 93ESSDOCS.HTM, xivESSEXC32 directory, 91ESSEXCLN.XLL

add-in file for Excel 2000 and Excel XP, 102description, 90manually adding Spreadsheet Add-in to Excel,

104upgrades and, 81

essinst, 65ESSLANG environment variable, 70, 181ESSLOT32 directory, 92

Index


essmsh (MaxL Command Shell on UNIX), 69essmsh.exe (MaxL Command Shell on Windows), 41ESSNET.DLL, 42, 89, 124, 132esssql.cfg, 147ESSSQL.DLL, 141ESSTOOLB.XLS, 101essunins.dll, 40, 92ESSXLEQD.XLA, 102event logs. See log filesexample spreadsheets. See sample spreadsheetsExcel add-in

installing, 79installing Essbase toolbar, 100starting, 99

executable file for installing, 65executables. See shared executablesexiting

Agent EXIT command (UNIX), 77Agent EXIT command (Windows), 45

Ffiles

application logs, 43, 74UNIX, 63

Application Manager, 90BND (.BND), 142cautions against moving/renaming, 40, 92cshrc (.cshrc), 70essinst, 65ESSSQL.DLL, 142essunins.dll, 40, 92hosts file (Windows), 56Hyperion Essbase client program files

(Windows), 90Hyperion Essbase program files (Windows), 41hyperionenv.doc, 71in API directory, 90in BIN directory, 90ISU (.ISU), 41language support, 41LIC (.LIC), 141logs, 43, 74MaxL header and library (Windows), 90migrating client applications, 81moving/renaming (caution), 40, 92

network protocol, 42, 89, 124NLS (.NLS), 41ODBC drivers and documents, 142odbc.ini (.odbc.ini), 153profile (.profile), 70required to compile API programs, 136root.sh, 68Runtime Client

client drives, 127security files, 42server logs, 43, 74setup.sh, 64shared library (.sl), 138Spreadsheet Add-in, 90SQL Interface

UNIX, 144Windows, 141

UNIX default locations, 69upgrades and Spreadsheet Add-ins, 81upgrading and, 170Windows default locations, 41

FTP and migrating, 175

Hhard disk drives

client software, 83Runtime Client, 125

HELP command (Agent)UNIX servers, 77Windows servers, 45

help for ODBC drivers, 140host name options for Personal Essbase, 55hosts file

configuring on Windows, 56error message, 56installing TCP/IP, 159

HP-UX serversAPI environment setup, 138installing


multithreading, 62network protocols, 26

Index


starting, 74system requirements, 26

HTML documentationaccessing, xivinstalling with API

on UNIX, 135on Windows, 132

Hyperion Download Center, 18hyperionenv.doc, 71

II/O access mode

changing, 165preserving, 165

I/O access mode, cache sizes, 166I/O, and upgrading, 164IBM DB2 drivers

instance names, 148setting up, 147, 153switching, 153

icons, program, 93INCLUDE

directory (API), 136setting in Path statement (API), 137

index page size, default, 167Install to client option, 124installation

advanced tasks, 179API, 131 to 132Application Manager, 79canceling, 37client software, 79Essbase Administration Services, 79Essbase Toolbar, 100JRE


network protocols, 157OLAP Server software


Personal Essbase, 53

prerequisites, 17recommended order, 30sample applications, 105Spreadsheet Add-in, 79SQL Interface, 139workflow, 17

installers, about, 18INSTHOME setting, 146inst-sql.sh

files generated by, 152linking SQL Interface to ODBC drivers, 148prerequisite for running, 146

Integration Server, 33Interntl database, sample, 105INTERSOLV ODBC drivers. See MERANT ODBC

driversinvalid server names, 97IP addresses

locating, 94Microsoft Loopback Adapter

adding to host, 56specifying, 59

TCP/IP-enabled server, 96

JJava

advanced configuration options, 190installing automatically, 38installing manually, 183installing on UNIX, 184requirements for AIX, 25requirements for HP-UX, 26requirements for Solaris, 24requirements on Windows systems, 23setting environment variables on UNIX systems,

188updating environment

AIX, 189HP-UX, 189Solaris, 188

Java Runtime Environment (JRE). See JavaJust In Time compiler option for Java on HP-UX, 189JVMMODULELOCATION, setting, 185

Index


KKorn shell

ARBORPATH setting, 71library path (AIX), 73library path (HP-UX), 73library path (Solaris), 72

Llanguage support by setting the ESSLANG

environment variable, 181LANs. See Microsoft LAN Manager; Novell Netware

LANsLD_LIBRARY_PATH setting, 137LIB

directory (API), 136setting in Path statement (API), 137

LIBPATH settingDB2 driver on AIX, 148UNIX servers, 72

librariesdriver manager, 148dynamic-link. See dynamic-link librariesUNIX servers, 71 to 72

library pathAIX, 73HP-UX, 73Solaris, 72

LIC (.LIC) files, 141licensing

Personal Essbase, 54viewing licenced products, Windows platforms,

38licensing,upgrades and, 32limitations of Personal Essbase, 54linked objects

migrating and, 176upgrading and, 171 to 172VALIDATE and, 171

linking SQL to ODBC drivers on UNIX, 148loading data into Samppart and Samppeast, 121loading sample databases, 106local area networks. See Microsoft LAN Manager;

Novell Netware LANslocal client installations, directories created, 90LOCAL server name, 55

locale directorycreated under some Hyperion Essbase products,

91description, 41, 70on UNIX, 136setting the ESSLANG environment variable, 181

localhost server name, 116log files, 43, 63, 74logging in, 94

from Application Manager, 94from Spreadsheet Add-in, 99

LOGOUTUSER command (Agent)UNIX servers, 77Windows servers, 45

Loopback adapter, See Microsoft Loopback adapterLotus 1-2-3 add-in file, manually adding, 104LPATH setting, 138ls command (UNIX), 65 to 66, 134

MManage Add-Ins dialog box (Lotus 1-2-3), 104manually updating environments

Runtime Client, 129UNIX servers, 70

Maximize Throughput for Network Applications option, 47

MaxLon UNIX, 69on Windows, 41

MaxL header files,location of, 90MaxL Perl Module

installed location on UNIX, 70installed location on Windows, 42, 91

memoryAIX system requirements, 25HP-UX system requirements, 26Solaris system requirements, 24Windows system requirements, 23

MERANT ODBC driversbinding files, 152DB2, 146, 154linking to SQL Interface, 149Oracle, 154

Microsoft LAN Manager, 162

Index


Microsoft LoopbackIP addresses

adding to host, 56specifying, 59

Windows Personal Essbase, 57Microsoft Windows. See Windowsmigrating

FTP and, 175migrating across servers, 174

LROs and, 176procedure for, 174upgrading and, 178using Administration Services, 175

migrating, rules files, 176moving Essbase. See migrating across serversmoving files and directories, 40, 92multiple network protocols, 42multithreaded UNIX programs, 62

NNamed Pipes Services protocol, 30

client installations, 160, 162optimizing, 55server names and, 55support, 159UNIX servers, 162Windows NT servers, 162Windows NT/2000 servers, 162

NetBEUI Properties dialog box (Windows), 160Network error

Cannot receive data message, 160Unable to Create Host Server Socket, 56Unable to Locate in Hosts File, 56

network interface card, working without, 57Network Protocol dialog box used by Windows

platforms, 39network protocols

Application Managerproblems with, 97 to 98specifying, 126

changing, 89files installed on Windows, 42, 89files installed with Runtime Client, 124

Microsoft LANs, 162Named Pipes installations, 160

Windows Client, 162Windows NT servers, 162

Novell LANs, 160optimizing Named-Pipes Services, 55selecting Windows platforms, 39server names and, 55supported, 157supported protocol stacks, 159TCP/IP installations, 158troubleshooting, 159UNIX servers

AIX platforms, 25HP-UX platforms, 26Solaris platforms, 24

Windows servers, 23network protocols, types, 30networks

Application Manager environment setup, 87changing settings (Windows NT), 46client software, 82

directories created, 90installing, 86

configurations. See network protocolsconfiguring Windows hosts file, 56performance, optimizing on NT, 46Runtime Client

directories created, 125running, 127sharing on network, 127

Spreadsheet Add-inrunning, 99setting up environment, 87

NLS (.NLS) files in locale directoryAPI, 136UNIX server, 70Windows clients, 91Windows servers, 41

non-English configuration of Essbase, 181Novell Netware LANs, 159no-wait I/O, platform support, 167NWLINK IPX/SPX drivers, 162

Index


OODBC drivers

implementing, 152, 154linking to SQL Interface

on UNIX servers, 146running inst-sql.sh, 149

setting up IBM DB2 .ini files, 153odbc.csh script, 152odbc.ini (.odbc.ini)

editing for DB2 driver on AIX, 153editing for Oracle driver on Solaris, 154

odbc.sh script, 152ODBCDocs directory, 141OLAP Server

backward compatibility, 81connecting to. See connectionslog for, 43, 74names

changing, 116invalid, 97IP addresses as, 96Named Pipes systems and, 55selecting, 94Windows connections, 55

starting, 74UNIX installation

platforms, 61prerequisites, 63server software, 64

online documentation, accessing, xivopening sample applications, 106operating environments. See environmentorder for uninstalling Hyperion Essbase products,

191outline synchronization, and upgrading, 168

Ppaging space

AIX system requirements, 25HP-UX system requirements, 26Solaris system requirements, 24

PA-RISC, 22, 26partition definitions, 112Partition Manager dialog box, 116partition users, creating, 113

partitioning, sample applications, 105PASSWORD command (Agent)


passwordsautomatically entering, 44changing, 45entering, 95, 114hiding in UNIX process listings, 76server startup, 43, 75

PATH settingApplication Programming Interface, 137in Windows 98 AUTOEXEC.BAT, 181installilng Personal Essbase, 54manually updating on Windows 98, 181Runtime Client, 129Windows NT Service, 49Windows NT/2000, 180

PDF files, location of, 91performance, optimizing, 46Perl module


Perlmod directoryUNIX, 70Windows, 42, 91

Personal Essbasecomponents, 53installation guidelines, 54licensing, 54limitations, 54manually updating environment, 181requirements, 53Windows NT installation, 53

physical memoryAIX system requirements, 25HP-UX system requirements, 26Solaris system requirements, 24

PING command, 159platform requirements

UNIX, 23Windows, 22

platform support for no-wait I/O, 167PORTS command (Agent)


Index


ports, available, displaying, 45POSIX Kernel Threads, 24prerequisites

for installation, xiiifor installing SQL Interface, 140

product contents,verifying, 18product directory installation (UNIX), 66production environment, migrating to, 174products, order for uninstalling, 191profile (.profile) files, 70profile files, 70program files

copying Spreadsheet Add-ins and, 81for Application Manager, 90for Spreadsheet Add-in, 90for SQL Interface, 144for Windows servers, 41location of, 90Runtime Client

client drives, 127location on network, 125

SQL Interface, 141UNIX default locations, 69

program iconsfor Essbase, 93

protocol stacks, supported, 159protocols. See server protocols, network protocolsps utility, hiding password on UNIX, 76

QQuery Designer, upgrading and, 172QUIT command (Agent), 77quitting Essbase

from Agent (UNIX), 77from Agent (Windows), 45

RRAM

server requirementAIX, 25HP-UX, 26Solaris, 24Windows, 23

readme file for Essbase, 33README.HTM in ESSBASE directory, 33

README.TXT, displaying, 40, 88REDIST directory (API), 136REGISTER.EXE, 33registration

new licenses, 33part of installation, 32

registration utility, 33reinstalling

DB2 drivers, 153Spreadsheet Add-in, 101

release compatibility, 20, 163releases, upgrading, 163Remove Shared File prompt, 193removing

Agent, as automatic service, 52Essbase Service (Windows), 52

renaming files and directories, 40, 92Report Writer, 105requirements

Personal Essbase, 53server, 22UNIX, 23verifying, 20Windows, 23

resetting Essbase Service, 51restoring security settings, 42Retrieval Wizard files, upgrading, 172root directory installation (UNIX), 65root.sh script, 68running Application Manager

after install, 93problems with, 94

running applicationsUNIX servers, 77Windows servers, 45

running Essbase, as Windows Service, 47running installation programs

Application Programming InterfaceUNIX servers, 134Windows servers, 132

client softwarehard disk drives, 86network drives, 87

root.sh script on UNIX, 68Runtime Client on network drives, 127Windows, 36

Index


running Spreadsheet Add-in, 99Runtime Client

directories created, installation, 127directories used to run on network drive, 127installation

network protocol files, 124to hard disks, 125

manually updating the environment, 129running on network drive, 127

RUNTIME directory, 92

SSampeast application

changing server names, 116creating partition user, 113introduced, 105setting up environments, 112

sample applicationsaccessing, 110assigning access privileges, 111included, 105introduced, 105licensing restrictions, 105setting up environments, 112

Sample Basic database, connecting to, 106sample databases, loading data, 106SAMPLE directory, sample spreadsheets, 91sample spreadsheets, 91Samppart application

changing server names, 116creating partition user, 113introduced, 105setting up environments, 112

secure password script, 76security, 42

access to samples, 110Agent commands (UNIX), 77Agent commands (Windows), 45backup files, 42security file, 42

security filemigrating and, 177upgrading and, 170

security file, backing up and restoring, 42Select Components dialog box, 38Select Sub-components dialog box, 38selecting network protocols, in Application Manager,

126server

automating startup, 44connecting with Spreadsheet Add-in, 99log for, 43, 74requirements on UNIX, 23requirements on Windows, 23starting on UNIX, 74starting on Windows servers, 43

Server Destination Directory dialog box, Windows platforms, 39

server installationsNamed Pipes network protocols, 159selecting components, 38TCP/IP network protocols, 158UNIX platforms, 64

server licenses, adding, 32server names, 112

changing, 116defining, 55invalid, 97IP addresses as, 96Named Pipes systems and, 55selecting, 94Windows connections, 55

Server products check box, 38server protocols, 89, 157

Application Managerproblems with, 97 to 98specifying, 126

implementing, 42Named Pipes installations

Windows Client, 160, 162Windows NT servers, 162

optimizing Named Pipes Services, 55Runtime Client, 124selecting on Windows platforms, 39server names and, 55supported protocol stacks, 159TCP/IP installations, 158troubleshooting, 159

Index


UNIX serversAIX platforms, 25Solaris platforms, 24

Windows servers, 23server requirements, 22service

removing agent as, 52resetting agent as, 51restarting agent as, 51stopping agent as, 50

SET command, viewing environment settings on Windows 98, 181

set path command (UNIX), 71Setting up system environment

for Java on UNIX, 188for SQL Interface

DB2 drivers (MERANT), 146library path, 142ODBC drivers, 146RDBMS, 143

JVMMODULELOCATION, 185to run Essbase as a service, 48

Settings command, 111Setup Complete dialog box

shared client installation, 88Windows platforms, 40

setup directory, SQL Interface environment scripts, 152

SETUP.EXEApplication Programming Interface, 132client software on networks, 86client software on Windows, 82Runtime Client, 125server software on Windows, 36

setup.sh, 64, 134shared, 87shared executables

client drives, 124network drives, 124 to 125setting up for client, 87

shared files, uninstalling, 193shared libraries, UNIX servers, 71 to 72shared network installations, 124sharing client software on a network drive, 87shell environments, 152SHLIB_PATH setting, 138

SHUTDOWNSERVER command, 77shutting down UNIX servers, 70, 74, 77SMP (symmetric multiprocessing), 62software

license number, 32licensing Personal Essbase, 54recommended installation procedures, 30registering, 32 to 33

Software Registration Card, 32Solaris servers

API library path, 137cache memory locking and, 68installing


LIBPATH setting, 72multithreading, 62starting, 74system requirements, 24

source command, SQL Interface setup on UNIX, 152Spreadsheet Add-in

Citrix support, 27directories created on network drive, 91Excel Essbase toolbar, 100installing

as shared on network drive, 87from network drive, 86to hard disk, 83to network drive, 82

logging in, 99network installation directories, 91program files, 90server compatibility, 81shared network installation, 87starting, 99troubleshooting, 102

Spreadsheet Toolkit, add-on option, 32SQL Drill-Through, support, 80SQL Interface

directories and fileson UNIX, 144on Windows, 141

environment setup scripts (UNIX), 152environment, on UNIX, 145

Index


installingon UNIX, 142prerequisites, 140simultaneously with OLAP server on

Windows, 38linking to ODBC drivers (UNIX), 149

SQL Interface installationsworkflow on UNIX, 142workflow on Windows, 140

START command (Agent)UNIX servers, 77Windows servers, 45

starting, 43Application Manager, 93applications on Windows servers, 45databases automatically on Windows servers, 45Essbase

as a Windows service, 51automatically on Windows servers, 44in the background (UNIX), 76in the foreground (UNIX), 74Windows NT/2000 servers, 43

Spreadsheet Add-in, 99startup errors

Application Manager, 94, 97Spreadsheet Add-in, 103UNIX server, 74Windows server, 43

startup informationUNIX servers, 75Windows NT servers, 43

startup settingsrestoring, 42Windows servers, 45

static libraries (API), 138STOP command (Agent)


stopping Essbase Service on Windows, 50summary panel, Windows platforms, 39Sun SPARC, 22, 24Sun ULTRASPARC, 22, 24supported protocol stacks, 159supported server protocols, 30

swap spaceAIX system requirements, 25HP-UX system requirements, 26Solaris system requirements, 24

symmetric multiprocessing (SMP), 62system passwords, 95

automatically entering, 44Windows platforms, 43, 75

system requirementsUNIX servers, 23, 62Windows servers, 23

Ttarget directories (UNIX)

accounts for, 63creating, 134

TCP/IP protocol, 30, 158installing, 158server names and, 55troubleshooting, 159Windows Personal Essbase servers, 59

telnetfailing TELNET command, 159viewing application messages (UNIX), 63

Teradata, ODBC drivers, 30Teradata, support, 30testing server connections, 159The Beverage Company (TBC), introduction, 105threads, UNIX supported thread libraries, 62throughput, maximizing, 47toolbar (Spreadsheet Add-in), installing, 100troubleshooting

Application Manager connections, 97Personal Essbase communication, 56Spreadsheet Add-in, 102Windows hosts file, 56

Uuninstalling

cautions, 40Essbase, 190 to 191Essbase, instructions, 191 to 192guidelines, 191order, 191shared file prompt, 193

Index


UNIX serversAPI installation, 133

setting up environments, 137creating target directories, 134default directories, 69default file locations, 69hiding password, 76installing

options for, 64platforms supported, 61prerequisites, 63

multithreaded programs, 62network protocols

AIX platforms, 25HP-UX platforms, 26installing, 158not supported, 162Solaris platforms, 24

registration utility, 33shutting down, 70, 74, 77SQL Interface

DB2 driver setup (IBM), 147DB2 driver setup (MERANT), 146environment overview, 145library path, 152

SQL Interface installations, prerequisites, 140starting Essbase, 74startup information, 75supported types, 61system requirements, 23, 62target directories, 63updating environment, 70updating environment for Java, 188

Update Environment dialog boxclient software installation, 85Windows platforms, 39

updates to Windows system files, 173updating environments

Application Programming Interface, 137client software, 85UNIX servers, 70Windows NT/2000, 180Windows servers, 39

upgradingand cache memory locking, 168and I/O, 164and license numbers, 32databases and, 168from 5.x, considerations, 168on different computer, 178procedure for, 171server license, 32to release 6.5, 163

user namesentering, 95, 114for sample partition applications, 112

userslogging off, 45logging on, 94, 99

USERS command (Agent)UNIX servers, 77Windows servers, 45

VVALIDATE

linked objects and, 171VALIDATE command

migrating and, 174upgrading and, 171

variables, See environmentverifying

Essbase Agent running as a service, 49product contents, 18requirements, 20

VERSION command (Agent)UNIX servers, 77Windows servers, 45

version compatibility, 163versions

upgrading, 163viewing

environment settings on Windows 98, 181Excel Essbase toolbar, 101licensed products, 38Readme file, 40, 88Windows server information, 45

virtual memory, See swap space

Index


WWindows

configuring loopback, 59default server file locations, 41network protocols, TCP/IP hosts, 59Personal Essbase connections, 55server installation, 37server system requirements, 23uninstalling, 190

Windows 98API installation, environment setup, 137environment setup, 137Personal Essbase installation, restrictions, 54registration utility, 33Runtime Client installation, 125setting program directories, 39Spreadsheet Add-in environments, 102updating environment, 181

Windows platformsautomating server startup, 44client installations, 83dual boot configurations, 54network protocols, installing, 158

Windows serversAPI environment setup, 137directories created, 40environment, manually updating, 180installing API, 132network protocols, 159SQL Interface installations environment settings,

145updating environment, 180

Windows Serviceabout, 47installing, 51removing, 52resetting, 51running Essbase as, 47starting, 48stopping, 50

Windows system files, Runtime Client shared installation, 127

Windows system files, updates to during upgrade, 173

workflowfor SQL Interface installations on UNIX, 142for SQL Interface installations on Windows, 140installation, 17

XX Windows, 63Xchgrate database, introduced, 105

Documents

Detail Installation Guide