Thursday, January 19, 2012

Locations of Major Configuration Information in Oracle Hyperion System 9.3.3, EPM 11.1.1.3, and EPM 11.1.2.1



Locations of Major Configuration Information in Oracle Hyperion System 9.3.3, EPM 11.1.1.3, and EPM 11.1.2.1 [ID 1313155.1]

 Modified 25-JUL-2011     Type TROUBLESHOOTING     Status PUBLISHED 


Applies to:

Hyperion BI+ - Version: 9.3.3.0.00 to 11.1.2.1.000 - Release: 9.3 to 11.1
Hyperion Essbase - Version: 9.3.3.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Hyperion BI+ - Version: 9.3.3.0.00 to 11.1.2.1.000   [Release: 9.3 to 11.1]
Information in this document applies to any platform.
Microsoft Registry (regedit) holds many configuration settings for installations on various versions of Microsoft Windows.
Files in Unix/Linux home directories are analogous locations for configurations held in the Registry on Windows installs.
Files with extensions *.ini, *.cfg, *.config, *.properties, *.instance, and *.xml dominated configuration settings in the Oracle Hyperion System 9.x series and earlier.
Some settings in the Oracle Hyperion System 9.x series were embedded in *.bat or *.sh scripting files.
Hyperion Shared Services held product registration information using the WebDAV protocol in *.instance files until Oracle Hyperion EPM 11.1.2.0.
In Oracle Hyperion EPM 11.1.2.1 most of the configuration information is stored in database tables.

Purpose

Problems relating to Java memory heap, fully qualified domain names, port conflicts, rehosting, passwords, application registration, and many other issues can be resolved by configuration setting changes. On the other hand, faulty setting changes can cause significant harm in an installation, so be sure to back up the environment and keep a record of such changes, place, and date when making modifications. 

Last Review Date

April 13, 2011

Instructions for the Reader

A Troubleshooting Guide is provided to assist in debugging a specific issue. When possible, diagnostic tools are included in the document to assist in troubleshooting.

Troubleshooting Details

(1) Oracle Hyperion System 9.3.3

FilenameLocationDescription
server.xml\Hyperion\BIPlus\common\config\server.xmlThe \Hyperion\BIPlus\common\config\server.xml file holds JDBC URL connectivity, process monitoring, TRCP server parameterizing, and other information. It is supplemented in the same directory by irmconfig.xml and config.dat for IR/DAS/job/TRCP parameters. Interactive Reporting configuration files in the same directory include localized files of the format: bqformat_xx_XX.ini, intelligence_xx_XX.ini

Windows Start menu > All Programs > Hyperion > Foundation Services > the Configuration UtilityFrom the Microsoft Windows Start menu > All Programs > Hyperion > Foundation Services > the Configuration Utility may be used to modify some configuration settings, but that might require changing the related _1_config.xml file subsettings from Configured to Pending. Avoid overwriting the database repositories for Foundation > Hyperion Shared Services or Hyperion Reporting and Analysis ("Configure Database").
config.bat\Hyperion\BIPlus\bin\config.bat\Hyperion\BIPlus\bin\config.bat (Microsoft Windows Start menu > All Programs > Hyperion > Reporting and Analysis > Utilities and Administration > Servlet Configurator) may be used to start the Servlet Configurator. In a firewall situation one might uncheck "Pass data using streams instead of files" under Properties > Internal > Transfer to strictly limit dynamic port allocation. Localization Properties may also be changed here.
default-domain.cfg\Hyperion\BIPlus\lib\default-domain.cfg\Hyperion\BIPlus\lib\default-domain.cfg may be customized for IIOP network issues.

http://www.davexplorer.org/download.htmlIf attempts in the Configuration utility to "Deregister from Shared Services" and reregister  do not succeed, one can modify those settings via the WebDAV protocol using a tool such as that available at this URL: http://www.davexplorer.org/download.html
ServiceConfig.bat\Hyperion\BIPlus\bin\ServiceConfig.bat\Hyperion\BIPlus\bin\ServiceConfig.bat (Microsoft Windows Start menu > All Programs > Hyperion > Reporting and Analysis > Utilities and Administration > Service Configurator) provides access to Remote Service Configurator (even all TRCP services on distributed computers) and Local Service Configurator (in this later case if there are two or more separate homes [BIPlus# where # is an integer] it is best to run the tool from the command line from each separate home).
configfileadminC:\Hyperion\BIPlus\bin>configfileadminC:\Hyperion\BIPlus\bin>configfileadmin is a special configuration tool which can be used to update System 9 with a new password which will be used in the repository database (among other functions).
startCommonServices.bat
A multitude of Java-based flags may be set within batch files such as startCommonServices.bat/.sh or services.bat/.sh including those for Java heap settings. 

HKEY_LOCAL_MACHINE > SOFTWARE > HyperionOn Microsoft Windows systems important configuration information will also be placed in HKEY_LOCAL_MACHINE > SOFTWARE > Hyperion or Oracle or Brio Software.
.oracle.instanceC:\Documents and Settings\\.oracle.productsFiles which point to the installation (used for upgrades) include .oracle.instance or .hyperion. or .oracle.products in a Unix/Linux home directory. On Microsoft Windows look for C:\Documents and Settings\\.oracle.products and set_hyphome_1.bat. On Microsoft Windows also look for C:\Program Files\Oracle\Inventory.
essbase.properties\Hyperion\products\Essbase\aps\bin\Hyperion\products\Essbase\aps\bin contains essbase.properties.

Life Cycle Management is purely a command line tool in System 9.3.1+, so its configuration settings are made by manual changes to a configuration file. 

Hyperion Shared Services configuration settings are limited to user/group/external authentication/product registration issues in this version and those preceding it.

There was no relational database-based Hyperion Registry in this version (nor the regedit.bat/epmsys_registry.bat tool).

 
  

(2) Oracle Hyperion Enterprise Performance Management 11.1.1.3

FilenameLocationDescription
reg.properties\Hyperion\common\config\9.5.0.0\reg.properties\Hyperion\common\config\9.5.0.0\reg.properties contains the initial JDBC URL where on startup the Workspace Agent (Core) looks for the database repository.

epmsys_registry.bat\Hyperion\common\config\9.5.0.0\epmsys_registry.bat\Hyperion\common\config\9.5.0.0\epmsys_registry.bat (earlier in the EPM 11 system this was called regedit.bat) generates a registry.html report which contains a more complete record of the Hyperion Registry than the CMC utility displays. The epmsys_registry.bat|.sh tool can also be used to view, create, or change individual configuration settings.
configtool.shHYPERION_HOME/common/config/9.5.0.0/configtool.shHYPERION_HOME/common/config/9.5.0.0/configtool.sh or on Microsoft Windows GUI: Start menu > All Programs > Oracle EPM System > Foundation Services > EPM System Configurator does many 'macro' configuration tasks (creating database repositories after initial install; deploying web applications to application servers, et cetera). Records of its actions are often stored in \Hyperion\common\config\9.5.0.0\product\\9.5.0.0\_1_config.xml files. If reconfiguration of a product is required in the EPM |System Configurator, the value of 'Configured' in the matching_1_config.xml file may need to be set to 'Pending'.
CSS.xml, Domain.xml, WorkflowEngine.propertiesC:\Hyperion\deployments\Tomcat5\SharedServices9\config\C:\Hyperion\deployments\Tomcat5\SharedServices9\config\ contains CSS.xml, Domain.xml, and WorkflowEngine.properties configuration files relating to Hyperion Shared Services. The path would change depending on which Java application server is used.
ServiceConfig.sh/Hyperion/products/Foundation/workspace/bin/ServiceConfig.sh/Hyperion/products/Foundation/workspace/bin/ServiceConfig.sh|.bat or in the Microsoft Windows GUI: Start menu > All Programs > Oracle EPM System > Workspace > Utilities and Administration > Service Configurator and Remote Service Configurator option is especially useful for configuring SQR and generic jobs (TRTC settings).
essbase.properties \Hyperion\products\Essbase\aps\ \Hyperion\products\Essbase\aps\ contains essbase.properties and datasources.xml. 
servletLog4jconfig.xml \Hyperion\deployments\Tomcat5\Workspace\webapps\workspace\WEB-INF\config\servletLog4jconfig.xml The Servlet Configurator is no longer present as a separate entity in EPM 11.1.1.3.

For installations on Microsoft Windows, the Windows Registry (HKEY_LOCAL_MACHINE > SOFTWARE > Hyperion Solutions or ORACLE or Brio Software) contains relevant configuration information. It can be accessed by running 'regedit' from the command line. 

Shared Services continues to offer user/group/external authentication configuration/application registration settings in this version. However a wealth of new configuration options will be added in EPM 11.1.2.x. For read-only configuration information  http://:28080/interop/content

Early versions of EPM 11 introduced the Configuration and Monitoring Console (CMC; but that disappeared as a separate entity in EPM 11.1.2.x). The needed background application is started by running HYPERION_HOME/common/workspacert/9.5.0.0/bin/startUI.bat|.sh or in Microsoft Windows via Start menu > All Programs > Oracle EPM System > Workspace > Utilities and Administration > Start Workspace Agent UI. Subsequently log into http://:55000/cmc/index.jsp Note that the startUI.bat|.sh in a distributed environment needs to be run on the same machine as Workspace Web in order to be accessed within Workspace in "Administer > Configuration Console". Log in as an administrative user to change a wide variety of configuration settings and detect whether various servers are up and running. If there are problems starting or using the CMC, attempt to log in using http://host:55000/cmc?diagnostic=true or http://servername:55000/cmc?debug and check the logs: \Hyperion\logs\config\cmc-config.log and \Hyperion\common\workspacert\9.5.0.0\logs\cmcui.log. The settings configured in the CMC are stored in the Shared Services Registry/Hyperion Registry in six database tables. 

Provide credentials (by default: admin/password) and navigate as follows Files > Products > HUB-9.5.0 > Published > HSS.Instance and Files > Products > HUB-9.5.0 > Published > HSS.Product.

Log4J logging is configured in \Hyperion\products\Foundation\workspace\common\config\log4j\* and \Hyperion\deployments\Tomcat5\Workspace\webapps\workspace\WEB-INF\config\servletLog4jconfig.xml (path is dependent upon the Java application server used). 

 
  

(3) Oracle Hyperion Enterprise Performance Management 11.1.2.1

FilenameLocationDescription
reg.properties/Oracle/Middleware/user_projects/epmsystem1/config/foundation/11.1.2.0/reg.properties/Oracle/Middleware/user_projects/epmsystem1/config/foundation/11.1.2.0/reg.properties contains the initial JDBC URL where on startup Hyperion Shared Services looks for the database repository and registry.
epmsys_registry.sh/Oracle/Middleware/user_projects/epmsystem1/bin/epmsys_registry.sh/Oracle/Middleware/user_projects/epmsystem1/bin/epmsys_registry.sh|.bat may be used to display or modify Hyperion registry settings. Run on its own it generates an HTML dump of the Hyperion registry in /Middleware/user_projects/epmsystem1/diagnostics/reports/registry.html
logging.xml\Oracle\Middleware\user_projects\epmsystem1\config\Oracle Diagnostic Logging is configured in \Oracle\Middleware\user_projects\epmsystem1\config\\logging.xml

For installations on Microsoft Windows, the Windows Registry (HKEY_LOCAL_MACHINE > SOFTWARE > Hyperion Solutions or ORACLE or Brio Software) contains relevant configuration information. It can be accessed by running 'regedit' from the command line. 

The former CMC functionality shifted to the Hyperion Shared Services User Interface. 

 
 

2 comments: