Environment Locations in the Essbase Platform

Review common server locations related to the Essbase installation, including Oracle Home, application / domain locations, server and log file locations. Essbase does not set these locations as variables, but documentation references them frequently. Optionally, you can create aliases for these locations in your shell.

Oracle Home

<Oracle Home> is the directory under which your Oracle products are hosted or installed.

When you're installing Essbase, it's installed to a pre-existing <Oracle Home>. It must be the same one that was set when you installed Fusion Middleware, which is a prerequisite to installing Essbase.

Essbase Product Home

The directory under which Essbase software is hosted or installed. The value is always equivalent to <Oracle Home>/essbase.

Domain Root

The location in which the Oracle WebLogic Server domain information and configuration artifacts are stored.

<Domain Root> = <Oracle Home>/domains

Example

/scratch/user/oracle_home/domains

To learn the value of your <Domain Root>, you can check the domain location value in <Oracle Home>/domain-registry.xml.

Domain Name

The name of the Oracle WebLogic Server domain you specify during Essbase configuration.

<Domain Name> is created at the end of the <Domain Root> path.

Example

essbase_domain

Domain Home

The domain home is equivalent to <Domain Root>/<Domain Name>. Example:

<Oracle Home>/domains/essbase_domain

Essbase Config Path

<Essbase Config Path> is an Essbase configuration directory. It should be in a separate location from the directory where Essbase software is installed (<Essbase Product Home>). Example:

<Domain Root>/<Domain Name>/config/fmwconfig/essconfig/essbase

<Essbase Config Path> is the location of the essbase.cfg configuration file. For information about its use, see Set Server-Level Configuration Properties.

Essbase Path

<Essbase Path> is the directory of the Essbase Server. The value is typically equivalent to <Oracle Home>/essbase/products/Essbase/EssbaseServer.

Application Directory

<Application Directory> is the full path you selected to store Essbase application artifacts. Formerly known as <ARBORPATH>, it is equivalent to:

<Oracle Home>/applications/essbase

In an environment set up for failover, the application directory must be a shared network mount accessible by both hosts.

Linux Example

/u01/essbase_data/applications/essbase

Windows Example

z:\essbase_mount\essbase_data\applications\essbase

When Essbase documentation refers to the cube directory, it means <Application Directory>/app/<Application Name>/<Cube Name>. For example, the cube artifacts for the cube named Basic within the application named ASOSamp are stored in the cube directory, which is <Domain Root>/applications/essbase/app/ASOSamp/Basic.

ESS ES Home

<ESS ES Home> is a working folder for Essbase Java API configuration, buffering, and caching requirements. It is equivalent to:

<Domain Root>/<Domain Name>/config/fmwconfig/essconfig/aps

Select a separate location away from the directory where Java API and Provider Services software is installed (away from <Essbase Product Home>).

The Java API configuration file, essbase.properties, should be located in <Ess ES Home>/bin.

EAS Home

<EAS Home> is the location of the optional managed server for Essbase Administration Services (EAS) Lite, if you configured it. The value is always equivalent to <Essbase Product Home>/products/Essbase/eas.

Log Files

<Log Home> is the main directory for Essbase server logs. It is equivalent to:

<Domain Home>/servers/<Essbase-Managed-Server-Name>/logs

Example

<Oracle Home>/domains/essbase_domain/servers/essbase_server1/logs

Within <Log Home>,

  • /aps/apsserver.log is the Provider Services log

  • /essbase/platform.log is the Essbase platform log

  • /essbase/jagent.log is the Essbase agent log

  • /essbase/essbase/app/<application-name>/<application-name>_ODL.log is the Essbase application log