Understanding and Troubleshooting Hyperion Calculation Manager issues with an emphasis on using Calculation Manager with Hyperion Planning [ID 1497281.1]

---

 

Applies to:

Hyperion Planning
Information in this document applies to any platform.

Purpose

 Troubleshooting Hyperion Calc Manager issues with an emphasis on using Calc Manager with Hyperion Planning.

Troubleshooting Steps

 

Troubleshooting Details

                Overview

The purpose of calculation manager is to offer one common interface to design calculation rules for different products (i.e. HFM, Planning, Essbase).  The graphical flow provides a clearer view of the calculation process.  With reusable rules and components and templates it provides ease of maintenance.  Rules can also be organized in a custom folder structure. 

Calc manager can be used with EPMA and Classic Planning applications while Business Rules is only used with classic applications. 

NOTE: You can see business rules if edit_dim_enabled=true is set in “Manage Properties”.  For EPMA applications this is useful if you need to migrate old business rules into calculation manager. 

                Basic Terms

Rule set contains a collection of rules

Rule contains a combination of formula components or script components, in addition to conditional (i.e. IF/Then) and loop objects 

Formula Component consists of a collection of formula calculation statements.

Script Component consists of a collection of self contained valid VB scripts (for HFM) or calc command/functions(for Essbase and Planning) statements.

Templates are a set of predefined standard calc related to financial Planning, Essbase (i.e. Clear data, Copy Data, Essbase commands, Amount= Rate*Unit, Aggregate, Allocate), and HFM.

General Troubleshooting

I.  Tuning considerations

• In the calcMgrConfig.properties file you may want to increase the HBR.timeout to 60000 and remove the comment # from this row. 
• In addition to traditional java settings of Xms and Xms you may want to consider increasing the default stack size as well –Xss. 
• We recommend rules that take longer than one hour to be run in batch, not on the web but if you have some that take longer, consider increasing the session timeout on the web application server.

II.   Validation / deployment considerations

• Rules are designed against one EPMA or classic Planning application
  • Then the rule needs to be “deployed” to a Planning application to be launched
  • A rule can be shared and deployed to multiple Planning applications

• Rules are validated:
  • Either against the EPMA application
  • Or against the Planning application, if the application is deployed
  • Rules do not necessarily need to be valid in order to be deployed

• Ensure the calc manager service is up and running.

If you delete the rule within Calc Manager, it will not be automatically be removed from the Planning application  To remove the deleted from from the Plannign application, you have to Go in the deployment view in calc mgr. Uncheck the deleted rules from the list of rules to be deployed and run a full deployment, by right clicking on the app name.

 

• If any of your RTP variables do not have a default value, then validation against Planning will fail. Rule can still be deployed and be executed in Planning

 

III.  Migration considerations

• When you migrate from HBR to Calc Manager
  • Sequences become Rule Sets
  • Macros become templates
  • HBR Security can be migrated  using the HBRMigrateSecurity.cmd utility after migration and deployment of rules
  • Projects become folders in business rules security in the Planning administration section, after running the utility defined above
  • Rules must be deployedLaunch LOCATION has been replaced by a deployed application(s)
• Make sure when creating an application that you accurately choose between Calc manager or Business rules depending on your needs.  You can still change this setting after having generated the Planning application. But in Planning, you will not see HBR rules if the calculation engine is Calc manager, and vice versa
• If your source environment is not accessible from Calc Manager, Business Rules can be exported from a source environment (File > Export). Make sure you choose the option “Export to Calc manager” in HBR. The exported XML file can be imported into a target Calculation Manager and the rules deployed to the desired Planning application.

Consider reviewing:

• “Migrating Business Rules to Calculation Manager” in the Installation and Configuration Guide
• "Managing Business Rules” in the Oracle Hyperion Enterprise Performance Management Architect Administrator's Guide
• “Migrating Business Rule Security” in the Oracle Hyperion Planning Administrator's Guide

In 11.1.2.2 you are no longer able to use HBR so be sure to review the following documentation before an upgrade to that release

• 11.1.2.2 Installation and Configuration guide http://docs.oracle.com/cd/E17236_01/epm.1112/epm_install_1112200.pdf
  • Page 22:  About Migrating Business Rules to Calculation Manager Rules
  • Page 127: Business Rules Maintenance Release and Upgrade Installation Prerequisites
  • Page 145
  • Page 166, 244: Importing Business Rules to Calculation Manager for use with Essbase
  • Page 169, 255: Migrating Business Rules to Calculation Manager for use with Planning
  • Page 170, 256: Migrating Business Rule Security

 

• Calculation Manager guide      http://docs.oracle.com/cd/E17236_01/epm.1112/cmgr_admin.pdf
  • Page 253: Migrating Business Rules (Financial Management and Planning Users only)

 

• How to Migrate an EPMA Application that uses Business rules in Version 9.3.1 to version 11.1.1.3.x to Use Calculation Manager (as it is an EPMA application)? (Doc ID 1362715.1)

 

IV.  Debug / Launch considerations

• Most issue with calculation manager will be capture in one of the following logs by default:
  • hyperion\logs\services\HyS9CALC-sysout.log
  • hyperion\logs\services\HyS9CALC-syserr.log
  • hyperion\logs\  calcmgr\calcmgrserver.log

 

• You may also find useful information in these logs:
  • hyperion\logs\Planning\calcmgrdeploy.log
  • hyperion\logs\Planning\calcmgrexecution.log
  • hyperion\logs\Planning\calcmgrlaunch.log
  • hyperion\logs\Planning\hbrserver.log

 

• However if you still aren’t sure what is going wrong, these properties files can also be adjusted
  • Hyperion/deployments/weblogic9/servers/calcmgr/webapps/calcmgr/web-inf/conf/calcmgrlog4j.properties
  • Hyperion/deployments/weblogic9/servers/calcmgr/webapps/calcmgr/web-inf/conf/calcmgrconfig.propeties

 

The calcmgrconfig.properties contains DEBUG_METHODS=true which is similar to the old DEBUG_ENABLED=true as well as HBR.maxconn , HBR.timeout, and DATABASE_CACHE_REFRESHRATE, and quite a few other settings.

 

The calcmgrlog4j.properties sets the level of logging for JVM OUTPUT .  INFO is usually sufficient unless directed by development to request DEBUG, which will write many extra unnecessary records to the logs.  You can set any of these components to log more information.

• log4j.logger.com.hyperion.awb=INFO
• log4j.logger.com.hyperion.calcmgr=INFO
• log4j.logger.com.hyperion.GenericLogger=INFO

The following are commented out by default:

• log4j.logger.com.hyperion.common.DefaultLogger=DEBUG
• log4j.logger.com.hyperion.common.JSON=DEBUG
• log4j.logger.com.hyperion.web.common.BaseAction=DEBUG
• log4j.logger.com.hyperion.database.DBImport=DEBUG
• log4j.logger.com.hyperion.web.common.DimensionServerService=DEBUG
• log4j.logger.com.hyperion.core.CalcMgrSession=DEBUG
• log4j.logger.com.hyperion.security.ObjectPrivilege=DEBUG
• log4j.logger.com.hyperion.database.DBConnectionManager=DEBUG

 

For debugging purposes you can enable options to copy xml files that are generated during import, migration, validation, or deployment by uncommenting these lines and providing the valid directory (# eg: c:\\temp\\deploy. Double backslash as a separator is required) in the CalcMgrConfig.properties file

 #IMPORT_DIR=<import debug directory>

#MIGRATE_DIR=<migrate debug directory>

#VALIDATE_DIR=<validation debug directory>

#DEPLOY_DIR=<deploy debug directory>

 

Please note, these properties will eventually moved into the Shared services registry