Escolar Documentos
Profissional Documentos
Cultura Documentos
RELEASE 9.2.1.0.0
Contents
Contents
iii
Disk Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Troubleshooting Connection Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CHAPTER 4 Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Before Installing Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
About Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Running Essbase Installation Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Directory Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
38
38
39
39
40
41
42
iv
Contents
53
53
53
53
54
54
Setting JVMMODULELOCATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Installing Essbase Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Verifying Startup Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Starting Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Verifying Successful Startup of Shared Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using Essbase Server Agent Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Shutting Down Essbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
CHAPTER 6 Installing Essbase Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Installing Runtime Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Installing the 32-bit Runtime Client on a 64-bit Windows Platform . . . . . . . . . . . . . . . . . 62
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Installing Application Programming Interface (API) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
API Compatibility on 32-Bit and 64-Bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Installing Essbase Spreashsheet Add-in for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Running the Client Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Directories and Files Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
(Optional) Registering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
(Optional) Installing the Essbase Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
CHAPTER 7 Setting Up the Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
About Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Loading Sample Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Providing User Access to Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Preparing the Aggregate Storage Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Preparing the Partitioning Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Setting the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Creating the Partition User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Changing Embedded User Names in Sample Partition Definitions . . . . . . . . . . . . . . . . . . 74
CHAPTER 8 Configuring Essbase for Relational Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Before Configuring Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting Up Essbase SQL Interface or Hybrid Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting Up Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Additional Essbase SQL Interface Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Contents
81
81
84
85
vi
Contents
Chapter
Installation Overview
1
This chapter introduces you to Oracles Hyperion Essbase System 9.
In This Chapter
Essbase Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Essbase Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installation Overview
Essbase Introduction
Essbase provides companies with the ability to deliver critical business information to the right
people at the right time. With Essbase, companies can leverage and integrate data from
multiple existing data sources and distribute filtered information to end-user communities.
Users interact and intuitively explore data in real-time and along familiar business dimensions,
enabling them to perform speed-of-thought analytics.
Essbase Components
Essbase includes these components:
Essbase Server
Sample applications
Runtime Client
Essbase Server
Essbase Server is a database for storing data with multiple dimensions such as time, accounts,
regions, channel, or product. It manages analytical data models, data storage, calculations, and
data security.
Essbase Server offers two storage models:
Sample Applications
Essbase Server includes sample applications and databases that demonstrate Essbase features.
See Chapter 7, Setting Up the Sample Applications.
Runtime Client
The Runtime Client is the minimal set of program files needed to communicate with a remote
Essbase Server using either a local custom Essbase application or MaxL.
Installation Overview
License Compliance
Beginning with this release, Hyperion License Server and standalone license files are not
used for license management. Instead, administrators need to audit product use. To ensure
compliance with your license agreement, you need to edit a properties file to activate or
deactivate features in accordance with what you have purchased.
For more information about license compliance, see the Hyperion License Compliance Readme
(hyp_license_compliance_readme_921.pdf ), which you can find on the Oracle
E-Delivery site.
License Compliance
10
Installation Overview
2
This chapter provides information about installing, configuring, and setting up Essbase:
Installation checklist to guide you through each step in the installation and configuration
process
Step
Instruction
Product Component
Documentation
11
Oracles Hyperion System 9 BI+ Analytic Services Smart View Provider (and Oracles
Hyperion Smart View for Office client)
Note: Smart View Provider does not automatically install the Smart View client, but places SmartView.exe in the
SUP_HOME/redist directory.
This checklist and Chapter 3, Planning the Essbase Installation cover all Essbase product
components. The other chapters in this guide provide installation information specifically for
Essbase (Essbase Server and clients). For installation information for each component, see each
product installation guide. Page numbers in this checklist refer to the Hyperion Essbase
System 9 Installation Guide (this guide), unless otherwise noted.
Before you begin the installation process, ensure the hardware and software system
requirements described in Chapter 3, Planning the Essbase Installation are met.
Install Shared Services and Configure the Shared Services Application Server
and RDBMS
Reference
1. Ensure that the database you are using for Shared Services is installed and
operational before installing Shared Services.
2. Download the Shared Services media pack, which contains software and
documentation, from the Oracle E-Delivery site.
3. Install Shared Services and configure the Shared Services Application server and
RDBMS.
Note: These steps do not apply if you are using Essbase in native security mode and are
not using external authentication.
Reference
12
Install Essbase
Reference
Essbase
Administration Services
Integration Services
Print and review the readme and installation documentation before installing
products.
Readme for:
Essbase
Administration Services
Integration Services
Installation Guides:
Readme for:
Essbase
Essbase
Administration Services
Administration Services
Integration Services
Integration Services
Installation Guides:
13
Configuration Tasks
Reference
Activate and configure Essbase components and register with Shared Services using
the Hyperion Configuration Utility.
Note: For Administration Services and Integration Services, Shared Services Server and
Essbase Server must be running to perform this step. For Analytic High Availability
Services and Smart View Provider, only Shared Services needs to be running.
No additional tasks are required for Analytic High Availability Services, Integration
Services, or Smart View Provider.
Reference
Assign Roles for Shared Services User Management and Provision Users
Reference
Assign the Project Manager role to users who are responsible for creating projects
and assigning applications to projects.
For each application, assign the Provisioning Manger role to users who are
responsible for assigning roles and access control permissions to users of the
application.
Assign the Directory Manager role to users who are responsible for managing the
native Shared Services directory.
Project Managers can now create projects and add applications to projects as
necessary. Provisioning Managers for each application can now provision users and
groups (assign roles and access control permissions) for their applications.
14
Chapter*
3
Read this chapter for information on planning the installation of Essbase products and
components on supported platforms.
In This Chapter
Essbase Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
32-Bit and 64-Bit Client and Server Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Port Numbers Used by Hyperion Products. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Default Port Numbers for Remote Method Invocation (RMI) Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Essbase Deployment Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Essbase SQL Interface Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Integration Services Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Hybrid Analysis, Advanced Relational Access, and Drill-through Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
HYPERION_HOME Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ESSLANG Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Disk Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Troubleshooting Connection Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
15
Essbase Requirements
Essbase consists of five separate components:
Integration Services
Essbase components may have different requirements. For example, Administration Services
requires deployment of an application server; Essbase does not.
This section describes hardware and software requirements for Essbase, and requirements for a
representative deployment of up to 150 total users (30-40 concurrent users) and one Essbase
Server installation. For larger deployments, we highly recommend that you call Hyperion
Consulting Services to determine the appropriate number of servers for your environment.
Note: Estimated disk space and RAM requirements in this document are approximate. Actual requirements may be
higher. Disk space estimates include documentation files (if applicable) and Hyperion common components.
Documentation is installed automatically with some products. The installation program calculates the amount of
required disk space, based on your installation choices.
Hardware Requirements
Table 1
256 MB
64-bit Essbase:
1 GB
Note: The base recommendation for running Essbase Server and its sample applications is approximately
100 MB. Start with this amount and then allocate additional memory to accommodate the Essbase Server
applications. 64-bit Essbase benefits from increased addressability. Typically, 64-bit servers are
configured with a modest amount of RAM. Production servers, however, typically are configured with 4 GB
or higher.
Processor
32-bit Essbase:
64-bit Essbase:
Network protocol
16
on Itanium 2
TCP/IP
Table 1
Essbase clients (Runtime Client, Spreadsheet Add-in, and Application Programming Interface)
Disk space
Runtime Client:
20 MB
Spreadsheet Add-in:
20 MB
RAM
20 MB
Spreadsheet Add-in:
64 MB
Processor
Same as Essbase.
Network protocol
TCP/IP
Display
400 MB minimum
Note: This estimate includes documentation files and Hyperion common components. The installation
program calculates the amount of required disk space, based on your installation choices. Allow extra disk
space for data files and outline files that are copied to Administration Services Server during data loads
and outline editing, respectively.
RAM
Processor
Same as Essbase.
Network protocol
HTTP, HTTPS
150 MB minimum
This estimate includes documentation files and Hyperion common components. The installation
program calculates the amount of required disk space, based on your installation choices.
RAM
Processor
Same as Essbase
Network protocol
HTTP, HTTPS
Screen resolution
1024 x 768
Essbase Requirements
17
Table 1
1 MB (as shipped)
Sample applications (on the RDBMS server computer containing the sample application database):
105 MB When set up, without Hybrid Analysis or Unicode sample application
Optional items:
RAM
120 MB When set up, without Hybrid Analysis or Unicode sample application
64 MB or higher
Processor
Network Protocol
TCP/IP
Optional item:
46 MB
Processor
RAM
64 MB or higher
Spreadsheet Add-in:
Network protocol
18
16 MB
TCP/IP
Table 1
148 MB
RAM
128 MB
Processor
Network protocol
On Itanium 2
188 MB
330 MB
RAM
128 MB
Processor
Network Protocol
On Itanium 2
HTTP, HTTPS
Negligible
RAM
Negligible
Processor
Pentium or equivalent
Software Requirements
Verify that these software requirements, which include requirements for supported third-party
products and variances by product, are met.
Essbase Requirements
19
Table 2
32-bit Essbase:
64-bit Essbase:
Note: 64-bit Administration Services Server supports only 64-bit Essbase Server. 32-bit Administration
Services Server supports both 32-bit and 64-bit Essbase Server.
Authentication sources
Microsoft NTLM
OpenLDAP 2.3.37
Essbase Clients
Operating system
Spreadsheet Add-in:
Windows XP Professional
Windows Vista
Runtime client:
Spreadsheets
Same as Essbase
CAUTION! If you plan to use the install on first use option when installing Microsoft Office products, be
sure to pre-install Visual Basic for Applications (VBA). If you attempt a first-time launch of Spreadsheet
Add-in without pre-installing VBA, the Add-in will fail to launch and Essbase will display an error message.
20
Table 2
Note: 64-bit Administration Services Server supports only 64-bit Essbase Server. 32-bit Administration
Services Server supports both 32-bit and 64-bit Essbase Server.
MySQL 4.0.12 (32-bit), 4.0.23 (64-bit HP-UX), installed automatically on all platforms
Oracle 11g
Oracle 9i - 9.2.0.5
Authentication sources
Relational database
Microsoft NTLM
OpenLDAP 2.3.37
Essbase
Shared Services (unless using Administration Services Server in native security mode.)
Essbase Requirements
21
Table 2
32-bit:
64-bit:
Essbase
Essbase
Operating system
22
Table 2
Authentication sources
Microsoft NTLM
OpenLDAP 2.3.37
Communication Protocol
Essbase
Shared Services (unless using Analytic High Availability Services in native security mode)
Administration Services
Authentication sources
Microsoft NTLM
OpenLDAP 2.3.37
Essbase Requirements
23
Table 2
Essbase
Shared Services
Administration Services
Microsoft Vista
24
Client
Server
32-bit, 64-bit
64-bit
32-bit
32-bit, 64-bit
64-bit
32-bit, 64-bit
64-bit
32-bit, 64-bit
64-bit
Client
Server
32-bit, 64-bit
64-bit
For information on the compatibility of client programs developed with Essbase APIs, see API
Compatibility on 32-Bit and 64-Bit Platforms on page 63.
Hyperion Product
Listen Port
Shared Services
58080
58090
58005
21080
21090
21005
22080
22082
22081
Administration Services
10080
10090
10005
11080
11090
11005
8300
8300
8301
14080
14090
14005
8200
8201
16000
16001
17080
17090
17005
18080
18090
18005
25
Table 3
Hyperion Product
Listen Port
18081
18091
18006
8180
8280
8105
13080
19000
9010
8205
13090
13005
45001
RMI Port
58000
1099
11333
1494 - 1498
1800
1801-1803
OpenLDAP
58081
26
Concurrent usage may be higher or lower in your environment than in this example. For
instance, your organization may have 150 users total, but concurrent usage may typically be
around 80 (rather than 30-40), increasing hardware requirements.
The frequency of queries and the volume of report generation affect hardware
requirements.
Adequate load & performance testing should be integrated into the testing phase of your
implementation to validate your production environment hardware sizing and assess overall
technical readiness.
Table 4
Hyperion Component
Requirements
Computer 1:
Shared Services
Computer 2:
Essbase Server
Computer 3:
Table 5
Hyperion Component
Requirements
Computer 1:
Shared Services
Computer 2:
See:
Essbase Server
Integration Server
Computer 3:
27
32-bit Platforms
Table 6
Supported ODBC Drivers and RDBMS for Essbase SQL Interface 32-bit Windows Platforms
ODBC Drivers by Supported Platform
Windows 2000 (SP4)
Windows XP
Teradata V2R5.12
Informix 9.3
Informix 9.2
Sybase 12.5 (Adaptive Server)
Sybase 12.0
Access 2002
Microsoft Driver
Access 2000
1 Supports data source only; does not support the OLAP catalog.
2 Teradata ODBC drivers must be obtained separately from NCR Corporation.
64-bit Platforms
Table 7
Supported ODBC Drivers and RDBMS Essbase SQL Interface 64-bit Windows Platforms
ODBC Drivers by Supported Platform
28
Table 7
Supported ODBC Drivers and RDBMS Essbase SQL Interface 64-bit Windows Platforms (Continued)
Sybase 12.0
Teradata VR6.0
Teradata V2R5.0
1 IBM DB2 v7x for z/OS, Access 2000 and 2003 are not supported on 64-bit Microsoft Windows.
2 Teradata ODBC drivers must be obtained separately from NCR Corporation.
Informix 9.3
Informix 9.2
Microsoft SQL Server 2005 (SP1)
Microsoft SQL Server 2000 (SP 3a)
29
Table 8
Sybase 12.5
Sybase 12.0
Teradata V2R6.03
Teradata V2R5.1
1 Supports data source only; does not support the OLAP catalog.
2 MySQL ODBC drivers must be obtained separately from MySQL.
3 Teradata ODBC drivers must be obtained separately from NCR corporation.
4 On Microsoft Windows 2000, Service Pack 4 is required.
5 Microsoft SQL Server 2000 driver must be obtained separately from Microsoft.
Integration Services provides DataDirect 4.2 ODBC drivers on UNIX for supported databases
running on IBM AIX, HP-UX, and Solaris; and for Microsoft Windows 2000 and Microsoft
Windows XP.
The JDBC Type 1 driver is not officially supported by Teradata; however, it works on all
platforms except HP-UX.
When Teradata is run on the HP-UX platform, the JDBC Type 3 driver is required.
The JDBC Type 3 driver is supported by Teradata and works on all platforms. The JDBC Type 4
driver is required by Integration Services if you are using Oracle with OCI. The JDBC Type 4
driver for Oracle works on all platforms.
The following table lists Oracle and Teradata support for JDBC drivers by supported platform:
Table 9
JDBC Type
Oracle:
JDBC Type 1
30
Supported
Table 9
JDBC Type
JDBC Type 4 1
Supported
Teradata:
JDBC Type 1 2
Not supported
JDBC Type 3 3
Supported
1 JDBC Type 4 drivers must be implemented when Oracle with OCI is being used.
2 For Teradata, JDBC Type 1 drivers function for all platforms except HP-UX, but are not
supported by NCR Corporation.
3 JDBC Type 3 drivers must be purchased separately for Teradata from NCR
Corporation.
Supported Relational Database Servers Hybrid Analysis, Advanced Relational Access, Drill-through
Hybrid Analysis
Advanced Relational
Access
Drill-through
Yes
Yes
Yes
Yes
No
Yes
Informix 9.3
No
No
Yes
Yes
Yes
Yes
No
No
No
Oracle 11g
Yes
No
Yes
Oracle 9i - 9.2.0.5
Yes
Yes
Yes
Sybase 12.5
No
No
Yes
Informix 9.2
Microsoft SQL Server 2005
Microsoft SQL Server 2000
Sybase 12.0
31
Table 10
Supported Relational Database Servers Hybrid Analysis, Advanced Relational Access, Drill-through
Hybrid Analysis
Advanced Relational
Access
Drill-through
Teradata V2R6.1
Yes
No
Yes
Teradata V2R5.1
Yes
Yes
Yes
HYPERION_HOME Variable
The Essbase installation program prompts you to define the location for Hyperion Home,
which is the root directory where Hyperion applications are installed. You must specify a
location for HYPERION_HOME or accept the default location.
The installation program searches for the HYPERION_HOME system variable on the computer
to which you are installing. It uses the Hyperion Home location defined on the computer, if a
previous installation defined a location, or uses a Hyperion Home location that you specify, if a
location was not previously defined. See Changing the Hyperion Home Location on page 43.
Note: You can have only one HYPERION_HOME on a single computer.
The Hyperion Home location is defined in the HYPERION_HOME system variable. The default
location for HYPERION_HOME is:
c:\Hyperion
Some internal components and third-party products used by Hyperion products are installed
in the following shared directory:
HYPERION_HOME\common
ESSLANG Variable
You must choose the correct ESSLANG setting for your Hyperion programs to start successfully.
ESSLANG points to the correct Global C locale (installed in the ARBORPATH\locale
directory). The ESSLANG setting for a computer must agree with the locale setting of the
computers operating system.
On Windows platforms, the Essbase Server installation program prompts you to select a value
for the ESSLANG environment variable.
Caution! The Essbase Server installation program does not default to an ESSLANG value that matches the
locale setting on that computer. Instead, you must determine the locale setting on the
computer and then select the matching ESSLANG value during installation.
32
To avoid possible database corruption, the ESSLANG locale specification must be the same on
client and Essbase Server when:
The ESSLANG locale specifications on clients and Essbase Server computers can be different
when a Unicode-enabled client views and updates an outline belonging to a Unicode-mode
application.
ESSLANG Variable
33
Caution! If you are upgrading an existing Essbase Server installation, choosing the wrong ESSLANG value
can cause the security file to be corrupted. See ESSLANG Variable on page 32.
If the Essbase Server security file is corrupted during the installation, you can revert to a
backup copy by renaming ESSBASE.BAK to ESSBASE.SEC.
Disk Array
Essbase Server supports the use of any disk array for both data storage and binary installation if
the device is mounted in such a way that it gives a local file system interface, for example NTFS,
HPFS, JFS, VxFS, UFS etc. A disk array mounted using NFS or CIFS is not supported. Note
that although these assertions are made in good faith, certain incompatibilities may exist. In
the event that an incompatibility is identified, Oracle may experience a delay in reproducing
and fixing resultant issues.
If the PING command is successful but the TELNET command is not, there might be a
problem with the inet daemon.
If the PING command is unsuccessful on the server, you might have a routing or hardware
problem.
Upgrading
If upgrading from a previous release of Essbase, see Chapter 10, Upgrading Essbase and the
Essbase readme.
If installing Essbase for the first time, see Chapter 4, Installing Essbase.
34
Chapter
Installing Essbase
4
Read this chapter for information on installing Essbase.
In This Chapter
Installing Essbase
35
2 Verify the operating system locale setting on your computer, so that you can set the correct ESSLANG
environment variable.
When installing Essbase on Windows computers, the installation program prompts you to set
the ESSLANG value.
Caution! The ESSLANG setting can affect the functioning of applications and databases. Before you
3 If you are upgrading from a previous release, back up Essbase Server files to another directory or to a
backup tape.
4 If you are installing over an existing release of Essbase Server, uninstall the previous release.
See Chapter 9, Uninstalling Essbase.
Caution! If you are running Essbase Server as a Windows Service, be sure to stop the service before
Essbase documentation
Note: Online documentation is installed with Spreadsheet Add-in. All other documentation must be installed. See
Installing Essbase Documentation on page 55.
36
Installing Essbase
Essbase server and client installation programs offer these installation options:
Table 11
Installation Option
Components Installed
Typical
Server
Client
Custom
Essbase Server
Sample applications
Runtime Client
Spreadsheet Add-in
When installing client and server components on the same computer, install them in this
order:
1. Client
2. Server
The media pack downloaded from the Oracle E-Delivery site (see the media pack Readme)
For information on running the documentation installation program, see Installing Essbase
Documentation on page 55.
Note: Running Essbase installation programs with Windows Display Properties set to 256 colors is not supported.
37
Depending on whether you are running the server or client installation program, read the
appropriate topic: Server Installation Program on page 38 or Client Installation Program
on page 39.
4 For the Hyperion Home directory, accept the default location or specify a different path.
The default location for HYPERION_HOME is:
c:\Hyperion
6 Select whether you want the installation program to update the PATH and ARBOPATH environment
variables, and create a shortcut menu.
38
Installing Essbase
4 For the Hyperion Home directory, accept the default location or specify a different path.
See Specifying Directory Paths on page 38.
7 Select whether you want the installation program to update the PATH and ARBOPATH environment
variables.
Creates new directories for a new installation, or updates existing directories if a previous
release of Essbase Server is installed.
39
Installs the files required to use Essbase SQL Interface and Hybrid Analysis
HYPERION_HOME\common
If you choose the Typical installation option when installing Essbase Server, the directories and
files in Table 12 are installed in the HYPERION_HOME\common directory.
Table 12
Directory
Contains
appServers
config
CSS
DBMS
HyperionLookAndFeel
JCE
JDBC
JDK
JRE
loggers
ODBC
SharedServices
utilities
XML
Note: If you perform a Custom installation, some directories are not installed.
40
Installing Essbase
ARBORPATH Directory
In a default installation, the ARBORPATH directory is:
c:\hyperion\AnalyticServices
If you choose the Typical installation option when installing Essbase Server, the directories and
files in Table 13 are installed in the ARBORPATH directory.
Table 13
Directory
Contains
api
Libraries and header files necessary for using MaxL. You do not have to install or use the
API to use MaxL, but the directory is created so that MaxL will work.
app
bin
java
locale
migrationutility
Utility, which is run only after moving HYPERION_HOME, that fixes all internal references to
the old Hyperion Home location. See Changing the Hyperion Home Location on
page 43.
perlmod
Files required to add the MaxL Perl Module (essbase.pm), which enables you to embed
MaxL statements in Perl programs. You must install Perl. See the documentation in this
directory and the MaxL section of the Essbase Technical Reference.
UninstallServer
Note: If you perform a Custom installation, some directories are not installed.
Security
The essbase.sec file stores information about users, groups, and passwords for native
security, and privileges on applications and databases. It also stores many application and
database properties.
Each time that you successfully start Essbase Server, a backup copy of the security file is created
(named essbase.bak). Also, if you have specified an interval at which inactive users should
be logged off using the Auto logoff option in the Administration Services Console, a backup of
the security file is created at the same interval.
41
If you attempt to start Essbase Server and a password prompt is not displayed or your
password is rejected, no backup file is created. You can restore from the last successful backup
by copying essbase.bak to essbase.sec. Both files are in the bin directory where you
installed Essbase Server.
3 When the regular (non-silent) installation program is launched, follow the on-screen instructions,
specifying the settings you want recorded in the response file.
You can modify the response file later, if you want to change any installation options.
42
Installing Essbase
2 For the Hyperion Home location, enter the location or click Browse to navigate to the location.
The run utility copies the entire Hyperion Home directory to the new location, and replaces
the value of the current HYPERION_HOME system variable.
4 For the Hyperion Home location, enter the new and old locations, or click Browse to navigate to the
locations.
When completed, the utility lists the files that were changed.
43
By default, the first instance of Essbase Server uses port number 1423. You can specify a
different default port number in the essbase.cfg file using the AGENTPORT configuration
setting. (See the Essbase Technical Reference.)
When you connect to an instance of Essbase Server specifying only the machine name (not the
machine name and port number), you are connected to the port specified in the configuration
file. You can override the configuration file setting by using the machineName:agentPort
syntax when connecting.
Note: The additional installation is a separate installation of Essbase Server, and does not share the security
configuration or objects of other Essbase Server installations on the same computer.
To install and configure an additional Essbase Server instance on a single Windows computer:
1 Install the second Essbase Server instance in a different ARBORPATH directory from the first Essbase
Server instance.
2 In the second instances ARBORPATH\bin directory, create an essbase.cfg file and add the
following settings:
Table 14
Configuration Setting
Description
AGENTPORT
Port number that the second instance of Essbase Server uses to connect.
SERVERPORTBEGIN
First port number that the first instance of Essbase Server tries to use to connect.
SERVERPORTEND
PORTINC
Increment between port numbers used. For example, if PORTINC is assigned a value
of 5, Essbase Server looks for ports 32700, 32705, and so on up to the value of
SERVERPORTEND.
Note: The range of ports used by the first Essbase Server instance must not overlap the
range of ports used by the second one.
DEPLOYMENTID
See the Essbase Technical Reference for information on creating the essbase.cfg file and
selecting values for these settings.
3 Create and run a batch script (.bat) that performs these tasks:
44
Installing Essbase
Chapter
This chapter describes how to configure Essbase using the Hyperion Configuration Utility. It
provides instructions for activating the product and registering it with Shared Services.
Also discussed are advanced installation tasks, such as updating the environment manually,
installing third-party products, and starting and stopping the Essbase Server.
In This Chapter
45
Shared Services RegistrationRequired for all products. See Registering Products with
Shared Services on page 48.
Prerequisites
Complete these tasks before using the Hyperion Configuration Utility:
Task
Documentation
Task Sequence
When performing multiple configuration tasks in one session, Hyperion Configuration Utility
orders the tasks for you. If you use the configuration utility to perform tasks individually,
follow this order:
Product activation
46
On the last page of a product installation program, select the option to launch the
configuration utility.
From Start, select Programs > Foundation Services > Configuration Utility.
Then enter:
startconfigtool.bat -console
Note: If you are running the configuration utility in console mode, follow the command-line prompts.
47
4 Follow the instructions for configuration tasks, as appropriate for the selected products:
2 From the list of installed products, select those to configure and click Next.
3 On the task selection page, select Shared Services Registration and click Next.
4 Specify Shared Services server information:
Table 15
Server
Enter the computer name (host name) where Shared Services Server is installed.
Note: Do not specify an IP address for the server, especially in DHCP environments.
Port
Enter the Shared Services Server port number, or accept the default (58080).
User
Password
SSL
48
2 From the list of installed products, select those to configure and click Next.
3 On the task selection page, select Shared Services Deregistration and click Next.
On the Shared Services location page, the Server, Port, and User fields display the information
that was specified when the product was registered with Shared Services.
4 For Password, enter the password for the specified Shared Services user.
5 Click Next to go to the next configuration task or to finish.
Reconfiguration
The Hyperion Configuration Utility enables you to reconfigure Hyperion products multiple
times. Reconfiguration procedures are identical to the initial configuration procedures.
Launch the configuration utility, select the products to reconfigure, and repeat the procedures.
Select the options that you want to change and follow the prompts to enter the required
information.
Product activation is not required when you reconfigure.
Configuration Troubleshooting
Because the Hyperion Configuration Utility separates configuration from product installation,
the task of tracking and correcting configuration errors is simplified. The configuration utility
logs configuration errors and warning messages to a log file, configtool.log, in a central
location:
%HYPERION_HOME%\common\config\logs
Note: If you experience problems with configuration, as a troubleshooting measure, perform configuration tasks
individually for one product at a time.
49
Note: Changing system settings affects all users who access the system.
PATHAdd %ARBORPATH%\BIN
Select Start > Programs > Hyperion > Essbase > Essbase.
Ensure the TCP/IP network protocol is installed and running on the computer.
Company name.
Your name (for example, asadmin), which is designated as the Essbase Server system
administrator user ID.
Use this name for the initial logon from a client to Essbase Server.
Caution! Do not specify admin as a user ID in Essbase. If you create an admin user ID and then
migrate your Essbase users to Shared Services (which has a read-only admin user ID), the
Essbase admin user cannot be migrated. See Migrating Users and Groups from Analytic
Services to Shared Services on page 116.
50
System password, which must be different than the user ID and must contain at least six
characters.
This password is required to start Essbase Server and to access Essbase Server from clients
using the system administrator account.
Note: When you change the password for the administrator, it does not affect the system password (the password
required when you start Essbase Server). During installation, Essbase Server creates two identical users and
passwords, one for the system user who starts Essbase Server and a separate administrator (super user). Thus,
you can change the administrators password without affecting the password used to start Essbase Server.
3 If this is not a first-time installation, Essbase Server prompts you for the system password that you
specified when you first started Essbase Server.
You can now use the Essbase Server Agent window to perform high-level administrator
operations. For a list of Agent commands, see Using Essbase Server Agent Commands on
page 59.
After you start the Essbase Server, Agent activities are recorded in the Essbase Server log
(essbase.log), which is stored in the ARBORPATH directory.
After you start individual applications, application and database activities are recorded in an
application log (appname.log), which is stored in the application directory
(ARBORPATH\app\appname).
See Monitoring Data, Applications, and Databases and Running Essbase Servers,
Applications, and Databases in the Hyperion Essbase System 9 Database Administrators
Guide.
51
Note: If you want the Essbase Server system password to be automatically entered each time Essbase Server starts,
open a command prompt and enter essbase.exe, followed by a space and the password. For example:
c:\hyperion\AnalyticServices\bin\essbase.exe password
where password is your Essbase Server system password.
52
PATHAdd %ARBORPATH%\BIN
53
Status is Started
A message displayed in the command prompt window indicates the Essbase Server service was
removed.
Setting JVMMODULELOCATION
The JVMMODULELOCATION setting in the essbase.cfg file enables you to designate a
specific installation of JRE for use with Essbase, and is required to enable Data Mining, Shared
Services, custom defined functions, triggers, and external authentication.
This setting is particularly useful if you have multiple versions of Java installed on the Essbase
Server computer.
During Essbase Server installation, the correct setting for JVMMODULELOCATION is
automatically added to essbase.cfg in commented text. To enable the setting, remove the
semicolon (which is a comment indicator) from the beginning of the line that contains the
JVMMODULELOCATION setting.
To set the JVMMODULELOCATION parameters, you must specify the full path and file name
of the Java Virtual Machine (JVM) library. The location and name of the library varies,
depending on the JRE version and the operating system that you are using.
54
The following table shows where the JRE and jvm.dll files are installed:
Platform (JRE version)
32-bit Windows
JRE
JVM.DLL
HYPERION_HOME\common\jre\sun\1.4.2
HYPERION_HOME\common\jre\sun\1.4.2\bin\server\jvm.dll
64-bit Windows
JRE
JVM.DLL
HYPERION_HOME\common\JRE-IA64\Sun\1.4.2
HYPERION_HOME\common\JRE-IA64\Sun\1.4.2\bin\server\jvm.dll
Your organization has an internal server computer dedicated to product documentation, all
or part of the Essbase documentation set can be installed on this server.
A spreadsheet user in your organization does not have the Spreadsheet Add-in
documentation on his client computer, only the spreadsheet documentation can be
installed on his computer.
55
Note: In the Getting Started category, be sure to select the Information Map component, which installs the HTML file
that provides live links to all documentation components. This map enables you to access documentation without
knowing where individual files are installed.
4 After the installation program finishes installing the files, review the pre-installation summary information.
5 On the Setup Complete screen, leave the check box selected and click Finish to view the readme file.
After installation, you can access all installed documentation from a single HTML file, the
Information Map. To access the Information Map, launch the esb_infomap.htm file in the
\docs directory, under the directory that you specified during installation. Note that links
from the Information Map work only for the documentation components that you choose to
install.
How to Start
56
On Windows, select Start > Programs > Hyperion Foundation > Start Shared Services.
The menu item indicates which application server the Shared Services server is deployed
to.
Application Server
Path to Script
IBM WebSphere
Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
bin\startSharedServices9.bat
UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
bin/startSharedServices9.sh
BEA WebLogic
Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
startSharedServices.bat
UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
startSharedServices.sh
Oracle
Windows:
<OracleInstallDir>\bin\emctl start iasconsole
<OracleInstallDir>\opmn\bin\opmnctl startall
UNIX:
<OracleInstallDir>/bin/emctl start iasconsole
<OracleInstallDir>/opmn/bin/opmnctl startall
Apache Tomcat
Windows:
<HSS_HOME>\AppServer\InstalledApps\<AppServName>\<version>\SharedServices9\
bin\startSharedServices9.bat
UNIX:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/SharedServices9/
bin/startSharedServices9.sh
Note: <HSS_HOME> is the directory where Shared Services is installed; for example, c:\hyperion\SharedServices\9.2.
On UNIX, when Shared Services is deployed to the Tomcat application server, these
confirmation messages are logged to the following file:
<HSS_HOME>/AppServer/InstalledApps/<AppServName>/<version>/
SharedServices9/logs/Catalina.out
57
On UNIX and Windows, when Shared Services is deployed to WebSphere, these confirmation
messages are logged to the following file:
Windows:
<WebSphereInstallDir>\AppServer\logs\SharedServices9\SystemOut.log
UNIX:
<WebSphereInstallDir>/AppServer/logs/SharedServices9/SystemOut.log
On UNIX and Windows, when Shared Services is deployed to WebLogic, these confirmation
messages are also logged to the following file, unless the log level is set to WARN:
Windows:
<HSS_HOME>\AppServer\InstalledApps\WebLogic\8.1\SharedServices9\
logs\SharedServices_Metadata.log
UNIX:
<HSS_HOME>/AppServer/InstalledApps/WebLogic/8.1/SharedServices9/
logs/SharedServices_Metadata.log
2 On the Shared Services server computer, launch the User Management Console login page using one of
these methods:
b. On Windows, select Start > Programs > Foundation Services > User Management
Console.
If the User Management Console login page is displayed, Shared Services server is started
successfully.
58
Table 16
Commands
Description
START appname
STOP appname
USERS
Displays a list of all users that are connected to Essbase Server. The total number of
connections is displayed, as well as the number of ports available.
LOGOUTUSER user
Disconnects a user from Essbase Server and frees a port. This command requires the
Essbase Server system password.
PASSWORD
VERSION
HELP
PORTS
Displays the number of ports that are installed on Essbase Server and how many are in
use. Number of available ports = number of licensed ports + 1 system administrator
port.
DUMP filename
Dumps information from the Essbase Server security system to a specified file in text
format. If you do not supply a path with the file name, the file is saved to the
$ARBORPATH/bin directory.
This command requires the Essbase Server system password.
To learn more about the Agent, see Running Essbase Servers, Applications, and Databases in
the Hyperion Essbase System 9 Database Administrators Guide.
59
60
Chapter
6
This chapter describes how to install Essbase Spreashsheet Add-in for Excel, Runtime Client,
and Application Programming Interface (API).
In This Chapter
61
Before Installing
Before installing, ensure the computer on which you are planning to install Runtime Client
meets the system requirements. See Planning the Essbase Installation on page 15.
62
Client programs developed on 32-bit platforms using the Essbase C API or Visual Basic API
can run on 32-bit platforms and connect to either 32-bit or 64-bit Essbase Servers.
Client programs developed on 32-bit platforms using the Essbase Visual Basic API can run
on 64-bit Windows platforms and connect to 64-bit Essbase Server, as long as the 32-bit
runtime environment is set up as according to the instructions in the following topic,
Installing the 32-bit Runtime Client on the 64-bit Windows Platform.
Cannot be run on 32-bit platforms and cannot connect to 32-bit Essbase Servers
Note: Client programs developed on 64-bit platforms do not require the #pragma directive
to set the byte alignment.
You cannot develop a client program on 64-bit Windows using the Essbase Visual Basic
API.
The following table summarizes the compatibility of client programs developed with Essbase
APIs:
Client Development:
Platform with API Version
32-bit C API
32-bit
32-bit, 64-bit
32-bit VB API
32-bit Windows
32-bit, 64-bit
64-bit Windows
64-bit
64-bit
64-bit
64-bit C API
For information on the compatibility of 32-bit and 64-bit Hyperion clients and servers with
Essbase Server, see 32-Bit and 64-Bit Client and Server Compatibility on page 24.
Before Installing
Before installing, be sure the computer on which you are planning to install API meets the
system requirements. See Planning the Essbase Installation on page 15.
63
See the Essbase API Reference for information on the files required to compile, link, and
distribute your programs.
Before Installing
Before installing Spreadsheet Add-in:
Ensure the computer on which you are planning to install Spreadsheet Add-in meets the
system requirements.
See Planning the Essbase Installation on page 15.
64
Directory
Created During
Contains
bin
client
appname
dbname
where appname is the name of the application and dbname is the name of the
database.
hve
Spreadsheet Add-in
installations
locale
UninstallClient
Note: When Spreadsheet Add-in is installed, internal files used by the installation program are installed in the
HYPERION_HOME directory. Third-party products are not installed with Spreadsheet Add-in.
Note: Do not move, rename, or delete the UninstallClient folder. Do not rename the AnalyticServices
directory, or any subdirectories or files beneath it. Modifying installed Essbase files and directories prevents them
from being successfully uninstalled.
To move Essbase to another directory or revert to an earlier release, you must first completely uninstall the
instance. See Chapter 9, Uninstalling Essbase.
(Optional) Registering
Registering Essbase Spreashsheet Add-in for Excel adds entries for Spreadsheet Add-in in the
Windows registry for Excel.
Registering Spreadsheet Add-in is optional. If you experience problems using Spreadsheet
Add-in and it has not been registered, we recommend registering it.
Once registered, unregistering Spreadsheet Add-in clears the Spreadsheet Add-in entries in the
Excel registry.
65
Figure 1
esstoolb.xls File
Note: If two dialog boxes display in sequence when opening the XLS file, click Enable Macros on the first and OK on the
second.
For information on using the toolbar or enabling toolbars in Excel, see the Essbase Spreadsheet
Add-in for Excel Users Guide.
66
Troubleshooting
You should know how to use the Microsoft Excel Add-ins command to add the Spreadsheet
Add-in for Excel file (essexcln.xll), which is located in the bin directory.
If the Spreadsheet Add-in is not properly installed or configured, follow these troubleshooting
guidelines:
1. Reboot the computer.
2. Check the environment.
See Checking the Environment on page 67.
3. Remove and manually add Spreadsheet Add-in.
See Removing and Manually Adding the Spreadsheet Add-in on page 68.
4. Verify that Trust all installed add-ins and templates is selected.
See Verifying the Macro Security Level in Microsoft Excel on page 68.
5. Install Spreadsheet Add-in again.
See Re-installing Spreadsheet Add-in on page 68.
Note: essxleqd.xla is an additional file for Essbase Query Designer for Excel. This add-in, which loads
automatically when Query Designer is started, enables Excel and Query Designer to synchronize workbook and
worksheet operations, including creating, deleting, and moving workbooks.
At a command prompt, enter PATHEnsure the Essbase bin directory is in the PATH
statement. For example:
AnalyticServices\bin
At a command prompt, enter SETEnsure the ARBORPATH setting indicates the drive and
directory you specified during installation. For example:
ARBORPATH=C:\HYPERION\AnalyticServices
67
68
Chapter
In This Chapter
69
Application
Database
Sample
Basic
Calcdat.txt
Interntl
Currcalc.txt
Xchgrate
Rates.txt
Basic
Data.txt
Company
Calccomp.txt
East
Calceast.txt
Basic
Calcdat.txt
Basic
dmdemo.txt
Sample
dataload.txt*
Demo
See the Essbase Technical Reference and documentation for Essbase
Report Writer.
Samppart
Demonstrates Essbase Partitioning features.
See Preparing the Partitioning Applications on page 73.
SampEast
Demonstrates Essbase Partitioning features.
See Preparing the Partitioning Applications on page 73.
Sample_U
Contains a Unicode-mode version of the Basic database in the
Sample application, which includes alias tables in English and four
other character sets. Characters in this application are encoded in
UTF-8.
DMDemo
Demonstrates Data Mining features.
ASOsamp
Demonstrates aggregate storage database features.
* The ASOsamp database must be loaded using the dataload.rul rules file. The other samples do not require a rules file.
Note: Depending on your Essbase purchase agreement, only the Sample, Demo, and Sample_U applications might be
installed.
70
For example:
Essbase Servers > myserver > Applications > Sample > Basic
Do
Mode
Select a mode:
Load only: Performs a data load.
Build only: Performs a dimension build.
Both: Performs both a data load and a dimension build.
Data Source
Click Find Data File. In the Essbase Server tab, navigate to the correct data source.
For Files of Type, ensure Data files (*.txt) is selected. Click OK.
See About Sample Applications on page 70.
Rules File
If the data source requires a rules file, click Find Rule File. In the Essbase Server tab,
navigate to the rule file. For Files of Type, ensure Rules file (*.rul) is selected. Click
OK.
Note: The ASOsamp database must be loaded using the dataload.rul rules file. The other
samples do not require a rules file.
5 Click OK.
When the data load is completed, the dialog box shown in Figure 2 displays.
71
Figure 2
6 From the Minimum Database Access group, select the Write option.
7 Click Apply.
8 Repeat this procedure for each database.
The selected application is ready for use. If you want to provide access to another application,
repeat the procedure. If you want to use the Partitioning applications, turn to Setting the
Environment on page 73. If you do not want to use the partitioning applications, the next step
might be to create the appropriate user names to enable users to log on to Essbase. See the
Hyperion Essbase System 9 Database Administrators Guide.
72
For instructions on loading data to aggregate storage databases, see the Hyperion Essbase
System 9 Database Administrators Guide and Essbase Administration Services Online Help.
After the data load is complete, precalculate aggregations on the database to improve retrieval
times. To precalculate aggregations, use Aggregation Design Wizard in Administration
Services or the MaxL execute aggregate process statement. See the Essbase Administration
Services Online Help or the MaxL section of the Essbase Technical Reference.
Note: To use the aggregate storage sample application, the essbase.jar file must be in the /java directory of
your Essbase installation.
SamppartCompany
SampeastEast
The Partitioning applications and databases include partition definitions stored in .ddb files.
The .ddb files define the map between member combinations in the target database,
Company, and the source database, East. The Hyperion Essbase System 9 Database
Administrators Guide describes Partitioning, member combinations, and the differences
between target and source databases.
For the Partitioning applications to work in your environment, you may need to create a user
named partitionuser, or you may need to change the embedded usernames in the .ddb files.
Note: Do not go into the.ddb files to change username information. Instead, complete the steps in the following
topics: Creating the Partition User on page 73 describes how to create the required username, so that users can
use the applications. Changing Embedded User Names in Sample Partition Definitions on page 74 describes
how to change the embedded server name to your server name.
73
To create partitionuser:
1 Log on to Administration Services Console using the system administrator account.
2 In Enterprise View, navigate to the Administration Services Servers node and select the appropriate
Administration Services Server name.
To change the username in the Samppart Company and Sampeast East .ddb files:
1 Open Administration Services Console.
2 In Enterprise View, expand the Applications node and select the Samppart application.
3 Expand the Databases node and select the Company database.
4 Expand the Partitions node and select Source Databases.
5 Under the Source Databases node, double-click servername:SampEast:East [transparent]
The Repair Partition dialog box displays.
6 For Data Source and Data Target, select a username from User list.
7 Enter the password.
8 Click Repair to save your changes.
Note: If, in the Repair Partition dialog box, you changed the username for both the Data Source Group and the Data
Target group, you do not need to repeat this process to change the username in the Sampeast East .ddb file.
74
Chapter
Essbase SQL Interface and Hybrid Analysis are tools you can use to integrate relational
databases and Essbase databases, thereby leveraging the scalability of a relational database with
the conceptual power of a multidimensional database.
This chapter describes the tasks required to configure the computer on which you run Essbase
to enable Essbase SQL Interface and Hybrid Analysis.
In This Chapter
75
Verify that the system requirements for Essbase SQL Interface and Hybrid Analysis are met.
See Chapter 3, Planning the Essbase Installation.
Note: Some ODBC drivers and relational data sources that are supported for Essbase SQL Interface are not supported
for Hybrid Analysis. See Chapter 3, Planning the Essbase Installation.
Setting Up Teradata
If the data source for Essbase SQL Interface or Hybrid Analysis is Teradata, verify the:
76
Verify the connection to the data source (for example, in the Administration Services
Console, use the Data Prep Editor to open the SQL data source file).
Create an Essbase SQL Interface data load rules file for loading SQL data into the Essbase
database.
In the Spreadsheet Add-in, select Essbase > Options. On the Zoom tab, select Enable Hybrid
Analysis.
Ensure the name of the ODBC data sources used to connect to the OLAP Catalog and the
data source database are the same on Essbase Server as those used on Integration Server to
build the outline. The usernames and passwords for connecting to those databases must
also match.
Build the Essbase database with an Integration Services metaoutline that invokes Hybrid
Analysis.
See the Oracles Essbase Integration Services documentation.
77
78
Uninstalling Essbase
Chapter
9
Uninstallation programs are installed in these directories:
ServerARBORPATH\UninstallServer
ClientARBORPATH\UninstallClient
The installation program filename is the same for both the server and client:
uninstall.exe
Choose a method:
Launch uninstall.exe
Caution! You must always stop Essbase before uninstalling. If Essbase is running as a Windows service,
Before uninstalling Essbase Release 6.x, 7.x or 9.x, consider these guidelines:
If you plan to reinstall Essbase, always uninstall the existing version first.
Do not manually delete, move, rename, or alter Essbase files and directories. Such actions
cause problems with uninstalling.
Files in the HYPERION_HOME\common directory are not uninstalled and remain after a
successful uninstallation.
See HYPERION_HOME Variable on page 32.
Uninstalling does not remove the app folder, existing applications, or the essbase.sec
and essbase.cfg files.
If you perform multiple Essbase installations on or from the same computer, the
uninstallation program removes only the last installation. When using Windows Control
Panel to uninstall, you may see a prompt about removing shared files, as Essbase products
are uninstalled individually and many Essbase files are shared with other Essbase products.
Uninstalling Essbase
79
For example, essapinu.dll is installed with Essbase Server, client software, and API.
Answering Yes To All makes uninstalling faster and does not disrupt other programs
installed on the computer.
80
Uninstalling Essbase
Chapter
Upgrading Essbase
10
This chapter describes how to upgrade from an earlier release of Essbase to Release 9.2.1 on the
same computer and how to move Essbase applications and databases from one computer to
another.
In This Chapter
Upgrade Path
All products in release 9.2.1 (Data Integration Management excepted) support upgrades from
7.1.6.x, 9.0.1x and 9.2.
Caution! Hyperion recommends that you do a complete, not incremental, backup of all Essbase files and
applications before upgrading. You can then revert to the earlier release if you have problems.
Migration Considerations
This section contains information about differences in behavior between Release 9.2.1 and
previous releases and about dropped features.
Upgrading Essbase
81
Caution! When you migrate to Shared Services, Essbase users and groups are converted to equivalent
roles in Shared Services. Shared Services creates a superuser with the user ID named admin,
which is read-only. If Essbase contains a user ID named admin, that user ID cannot be
migrated to Oracles Hyperion Shared Services. Before migrating, change the admin user
ID (for example, from admin to asadmin). To edit the security file in your Essbase
installation, use Administration Services Console or MaxL.
82
Upgrading Essbase
Essbase API programs compiled with header files from a specific release must use the libraries
from the same release. For example, if the header files are from version 6.2, you cannot use 6.5
run-time libraries. If your header files were from 6.5, you cannot use 7.0 runtime libraries.
Table 19 describes compatibility among API, runtime library, and Essbase Server versions.
Table 19
Runtime Libraries
Essbase Server
7.0.0
7.0.x
7.0.1
7.0.1
6.5.x, 7.x
7.1.x
7.1.x
6.5.x, 7.x
7.1.2
7.1.2
6.5.x, 7.x
9.x
9.x
7.x, 9.x
EssOtlGetNextAliasCombination()
EssOtlDeleteAliasCombination()
EssOtlAddAliasCombination()
83
84
Upgrading Essbase
The data cache default size is the same for direct I/O and buffered I/O: 3 MB.
The index cache default size is smaller for buffered I/O than for direct I/O: 1 MB for
buffered I/O and 10 MB for direct I/O.
The data file cache default size is 32 MB when direct I/O is used. The data file cache is not
used when buffered I/O is in effect.
The size of index pages is fixed at 8 K, regardless of the I/O access mode. The index page size
is unchangeable.
Note: The default cache size and maximum cache size are different for 64-bit.
To override defaults after upgrading, change the database settings or properties before you
start the upgraded database for the first time.
See the Hyperion Essbase System 9 Database Administrators Guide for information on
buffered I/O and direct I/O.
85
Upgrading Databases
The following procedure explains how to upgrade to Release 9.2.1 from an earlier release.
After upgrading, you can restore databases from earlier releases of Essbase Server only from
backups. Therefore, be sure to back up databases before starting to upgrade.
2 Back up all application files, database files, and the security file.
3 Run a full restructure on the database.
4 If you are using LROs in a production environment, run the LISTLINKEDOBJECTS command in ESSCMD.
This command returns a list of LROs contained in the databases.
Uninstalling does not remove the app folder, existing applications, or the essbase.sec and
essbase.cfg files. See Uninstalling Essbase on page 79.
7 Install Essbase Release 9.2.1 to the same directory as the earlier Essbase installation.
8 Start the Essbase Server Agent (essbase.exe ).
If you want to change database settings, this step is a convenient point at which to do so. If you
change the settings now, you do not have to restart the database to make the settings effective.
See Input/Output Defaults and Upgrading on page 84.
a. Either restore data from a backup of the database that does not contain LROs, or load from
a database export.
b. Restart the database in Essbase Release 9.2.1.
Essbase upgrades the database to Release 9.2.1 format, if the database is restored.
c. Validate the database using alter database validate.
d. Re-create the LROs, using the LISTLINKEDOBJECTS output as a guide. You may need to
manually review the output from LISTLINKEDOBJECTS to verify its completeness.
12 Upon successful completion, unload the database and then back up the Release 9.2.1 database files.
13 Repeat the procedure for each database that you want to upgrade.
86
Upgrading Essbase
2 Back up all application files, database files, and the security file on the source Essbase Server computer
(that is, the server computer from which you are moving).
6 Use the Migration Wizard in Oracles Essbase Administration Services to move the application to the
target Essbase Server computer.
Note: For important information about what information is migrated with applications, see Migration Wizard in
Essbase Administration Services Online Help.
The names of the applications and database that you create do not need to be the same as the
ones on the source server computer. However, if you make changes to the names, make sure
that these changes are reflected as necessary in script files, spreadsheet macros, and API-based
applications. In addition, make sure the these changes are clearly communicated to the user
base.
Caution! Do not move the application directory to the new server computer through a file transfer
7 Using the file system or FTP, move files that are not Oracles Hyperion Essbase System 9 files (such as
ESSCMD or MaxL scripts) to the target server computer.
Note: MaxL includes an ESSCMD-to-MaxL script conversion utility. See the MaxL DDL section of the Essbase Technical
Reference.
87
8 Export data from the application on the source server computer by either:
Choosing All Data, Input Level Data, or Level 0 Data, depending on the size of the data set
and how the database was initially loaded.
Using the initial data load files that were used to populate the database on the source
server.
You exported only partial data from the database (for example, if you chose to load only
Level 0 or Input Level data)
11 Repeat the steps above for all other databases on the source server computer that you want to move to the
target server computer.
Caution! Moving the security file (essbase.sec) and its backup (essbase.bak) between computers
88
Upgrading Essbase
Index
Numerics
32-bit
supported ODBC drivers, 28
supported Relational Data Sources, 28
64-bit
Administration Services, supported combinations, 20
Essbase, supported combinations, 20
setting up environments, 64
applications
starting automatically on Windows, 52
starting from Agent, 59
stopping, 59
ARBORPATH setting
manually updating
for Windows Service, 53
on Windows platforms, 50
A
about HYPERION_HOME, 32
accessing sample applications, 72
adding
Essbase toolbar, 66
additional Agents, installing, 43
Administration Services. See Essbase Administration
Services
Agent
commands, 59
removing automatic service, 54
stopping automatic service, 54
agent port number, 44
AGENTPORT setting, 44
aggregate storage databases
about, 8
alter database validate statement
upgrading and, 86
B
backup
before upgrading, 81
complete, 81
incremental, 81
backup files, 42
BIN directory
client files, 65
server files, 41
Index Numerics
89
enabling, 54, 56
C
cache sizes
defaults, 85
changing
embedded server names, 74
environment settings
manually on Windows, 50
partition definition files, caution, 73
passwords, 59
server names, in sample partition definitions, 74
changing HYPERION_HOME, 43
character-set files, 41
checklist, installation, 12
client and server compatibility, 83
client directory, 65
client software, directories created, 65
closing Essbase Server See quitting, from Agent
commands, Agent, 59
common components, 40
common directory, contents of, 40
Company database, 70
compatibility
between client and server, 83
components
Application Programming Interface (API), 9
Essbase Server, 8
Essbase Spreadsheet Add-in for Excel
runtime client, 8
sample applications, 8
connections
displaying, 59
troubleshooting, 34
console commands, 59
copying applications or databases. See migrating across
servers
Currency Conversion, sample databases for, 70
custom installation, 37
moving/renaming (caution), 65
directories installed, 40
disk array, supported, 34
displaying
Essbase toolbar, 66
server information, 59
DMDemo application, introduced, 70
documentation, installing, 55
downloading the installer, 37
DUMP command (Agent), 59
dynamic-link libraries (DLLs)
network protocols, 42
E
D
Data Mining
90
Index C
East database, 70
embedded server names, changing, 74
described, 32
environment
API installations, 64
ESSLANG, described, 32
HYPERION_HOME, 40
manually updating, on Windows environment
variables, See environment
sample applications, 73
updating on Windows platforms, 50
error messages
when starting Windows server, 50
Essbase
components of, 8
description of, 8
F
files
cautions against moving/renaming, 65
hardware requirements, 16
default locations, 40
introduction, 8
Essbase Server
changing names in partition definitions, 74
in BIN directory, 65
installation process, 36
moving/renaming (caution), 65
installing, 35
network protocol, 42
security files, 42
SQL Interface, 76
files installed, 40
FTP and migration, 87
H
HAENABLE, 77
hardware requirements, 16
for Windows, 16
HELP command (Agent), 59
Hybrid Analysis
enabling, 75
enabling Essbase Spreadsheet Add-in for Excel, 77
OLAP Catalog
data source, 77
Hyperion Configuration Utility
custom tasks, 46
ESSLANG considerations, 33
described, 46
migrating and, 88
launching, 47
security file, 42
log file, 49
essexcln.xll file
description, 65
order of tasks, 46
reconfiguration, 49
prerequisites, 46
Index F
91
java directory, 41
Java Runtime Environment (JRE) requirements. See Java
requirements
JDK requirements. See Java requirements
JVMMODULELOCATION, setting, 54
task list, 46
troubleshooting, 49
upgrades and, 47
Hyperion Home location, 32
Hyperion Home migration utility, 43
Hyperion Home Tool, 43
Hyperion License Server, 9
Hyperion security platform. See security platform
HYPERION_HOME
files installed in, 40
moving, 43
understanding, 32
uninstallation and, 79
Hyperion_Home setting, 32
I
I/O access mode
cache sizes, 85
changing, 84
preserving, 84
I/O, and upgrading, 84
INCLUDE, setting in Path statement (API), 64
index page size, default, 85
installation
planning, 15
sample applications, 69
what happens during, 39
installation checklist, 12
installation sequence, 12
installer program, launching, 37
installers, 36
installing
client software,Essbase Spreadsheet Add-in for Excel,
64
documentation, 55
Essbase Server, 35 to 36
Essbase Spreadsheet Add-in for Excel, 64
L
launching
installer program on UNIX, 37
installer program on Windows, 37
LIB setting in Path statement (API), 64
License Server, 9
linked objects
upgrading and, 86
VALIDATE and, 86
loading data to sample databases, 71
local client installations, directories created, 65
locale directory and, 41
locale directory, description, 41
localhost server name, 74
LOGOUTUSER command (Agent), 59
M
managing, 33
managing ESSLANG settings, 33
MaxL Perl Module, installation location, 41
Microsoft SQL Server. See SQL Server
migrating across servers
procedure for, 87
using Administration Services, 87
migrating and FTP, 87
migrating users and groups to Shared Services, 82
migration utility, 43
moving applications or databases. See migrating across
servers
moving files and directories, 65
moving HYPERION_HOME, 43
multiple instances of Essbase, 43
Essbase Toolbar, 65 to 66
Integration Services
supported data sources, 29
supported ODBC drivers, 29
Interntl database, sample, 70
92
Index I
N
network protocols
files installed, 42
non-Unicode-enabled client
ESSLANG requirements, 33
Administration Services, 17
OLAP Catalog, 77
OLAP Server. See Essbase Server
opening sample applications, 71
Oracle E-Delivery
launching the installer from, 37
P
partition definitions, 73
partition users, creating, 74
partitioning, sample applications, 70
PASSWORD command (Agent), 59
passwords
automatically entering, 52
changing, 59
introduction, 8
server startup, 51
PATH setting
Application Programming Interface (API), 64
Perlmod directory, 41
planning the installation, Essbase, 15
port number, agent, 44
port numbers, 25
PORTINC setting, 44
PORTS command (Agent), 59
ports, available, displaying, 59
preparing for installation
Essbase Spreadsheet Add-in for Excel, 64
prerequisites. See requirements
program files
Essbase Spreadsheet Add-in for Excel, 65
location of, 65
S
Sampeast application
changing server names, 74
creating partition user, 74
setting up environments, 73
sample applications
accessing, 72
assigning access privileges, 72
description of, 8
included, 70
introduced, 70
introduction, 8
licensing restrictions, 70
setting up environments, 73
Q
QUIT command (Agent), 59
quitting Essbase from Agent, 59
R
RDBMS. See relational databases, 7
release compatibility, 81
releases, upgrading, 81
Remove Shared File prompt, 80
removing, the Agent as automatic service, 54
renaming files and directories, 65
requirements
Index O
93
restoring, 42
security file
backing up and restoring, 42
ESSLANG considerations, 33
migrating and, 88
sequence, installation, 12
server
automating startup, 51
names, changing, 74
Windows servers, 52
STOP command (Agent), 59
stopping Essbase on Windows, 54
support matrix, 19
supported disk array, 34
system passwords
automatically entering, 52
Windows platforms, 51
T
Teradata
connecting to, 76
support, 28
third-party products installed, 40
toolbar (Essbase Spreadsheet Add-in), installing, 66
troubleshooting
connection problems, 34
Essbase Spreadsheet Add-in for Excel, 67
typical installation, 37
U
understanding HYPERION_HOME, 32
Unicode, sample application, 70
Unicode-enabled client, ESSLANG requirements, 33
uninstallation program, location of, 41
uninstalling Essbase
guidelines, 79
instructions, 79
UNIX servers
shutting down, 60
updating environments
Windows, 50
upgrading, 81
and I/O, 84
databases, 85
procedure for, 86
USERS command (Agent), 59
users, logging off, 59
UTF-8 encoded sample application, 70
on Windows, 50
startup errors
Essbase Spreadsheet Add-in for Excel, 67
Windows server, 50
startup settings
94
Index T
V
VALIDATE command
linked objects and, 86
verifying
Essbase Agent running as a service, 53
VERSION command (Agent), 59
version compatibility, 81
versions, upgrading, 81
viewing
Essbase toolbar, 66
server information, 59
W
Windows platforms
API environment setup, 64
automating server startup, 51
environment, manually updating, 50
installing additional instances of Essbase, 44
Windows Service
starting, 53
stopping, 54
X
Xchgrate database, introduced, 70
Index W
95
96
Index X