Hyperion Planning System Properties

Hyperion Planning System Properties [ID 1327171.1]

		Modified 29-NOV-2011 Type REFERENCE Status PUBLISHED

In this Document
  Purpose
  Scope
  Hyperion Planning System Properties
  References

Applies to:

Hyperion Planning - Version: 11.1.2.1.000 to 11.1.2.1.000 - Release: 11.1 to 11.1
Information in this document applies to any platform.

Purpose

This article aims to discuss and provide a reference for all the different system properties that can be set for a Planning Application and Planning Environment via the Planning web following the navigation menu

Administration > Manage Properties (9.3.x)
Administration >Application >Properties (11.1.x)

Scope

These settings can be changed by the Planning Application Administrators and the Planning service needs to be restarted for the settings to take affect.

To set Planning application or system properties:
1 Select Administration, then Application, then Properties.
2 Select:

Application Properties: set properties for the current application.

System Properties: set properties for all Planning applications.

3 To:

Change a property, change its value under Property Value.

Add a property, click Add. Enter a name (avoid using spaces) and value for the property in the blank row.

If you enter a property already on the tab, its name turns red to indicate it is a duplicate.
You can duplicate properties between the application and system tabs.

4 Click Save and confirm your changes.
5 Stop and then restart the application server.

Properties are saved in the HSPSYS_PROPERTIES system database table, which by default is located in the relational database you create when selecting the Configure Database task under Planning in Oracle's Hyperion Enterprise Performance Management System Configurator.

Hyperion Planning System Properties

Planning Properties	Why and when its used	Example	Defaults
JDBC_MIN_CONNECTIONS JDBC_MAX_CONNECTIONS	Use this to specify the minimum and maximum number of JDBC connection pools. How you configure these depends largely on the number of Planning users accessing the relational database.	JDBC_MIN_CONNECTIONS = 10 JDBC_MAX_CONNECTIONS = 45	The JDBC connection settings are set by default to a minimum of 2 and a maximum of 10. The Planning application does not function correctly if you lower the maximum JDBC_MAX_CONNECTIONS to less than 2. To optimize performance, Oracle recommends these settings JDBC_MIN_CONNECTIONS = 10 JDBC_MAX_CONNECTIONS = 45
OLAP_PATH_SEPARATOR	Use this to specify the Path Separator for Essbase server installed on Unix Environment	OLAP_PATH_SEPARATOR=/	The default value is \, which is for the Windows environment.
OFFLINE_COMPRESSION_THRESHOLD	Use this to specify the compression for applications taken offline, in bytes, for when to start using compression. Compression is enabled when the server âs response to offline client requests is greater than the Offline Compression Threshold number.	OFFLINE_COMPRESSION_THRESHOLD=2000
SMART_VIEW_DISPLAY_WARNING	Use this to disable the display of warning message that is generated when a different version of Planning and Smart View is used	SMART_VIEW_DISPLAY_WARNING = Yes SMART_VIEW_DISPLAY_WARNING = No
MAX_VALIDATION_RECORDS NOTE: Only available in 11.1.2.x	Use this to specify the maximum number of validation failure entries to display in the Data Validation Messages pane that displays in data forms. When the number of errors exceeds this limit, the entries for lower-priority rules are removed. Higher-priority errors remain, such as rules set to Do Not Promote.	MAX_VALIDATION_RECORDS = 150	MAX_VALIDATION_RECORDS= 100
VALIDATION_CACHE_SIZE NOTE: Only available in 11.1.2.x	Use this to specify the maximum number of data validation rules that are cached to improve performance.	VALIDATION_CACHE_SIZE= 15,000	VALIDATION_CACHE_SIZE= 10,000
MAX_CELL_TEXT_SIZE MAX_CELL_NOTE_SIZE	Use these settings if you need to display additional characters in cell text or comments. Note that, in the database, the column data type is set to varchar(255) and varchar(2000) by default. Updating these settings to more than 2000 requires that you make a corresponding change to the database. If you increase the maximum number of characters allowed for cell text, you must alter the database column size or type to support the changed size.	MAX_CELL_TEXT_SIZE= 500 MAX_CELL_NOTE_SIZE=2000	MAX_CELL_TEXT_SIZE= 255 MAX_CELL_NOTE_SIZE=1500 Changing the column type to CLOB, NCLOB, TEXT, or NTEXT to accommodate large cell text size can affect performance. Do so only if your application requires large cell text entries.
HBR_MAX_WAIT_FOR_RULE	Use this to specify the interval in milliseconds to wait before running business rules in the background (for business rules created with Business Rules or those migrated from Business Rules to this release.)	HBR_MAX_WAIT_ FOR_RULE=300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value. If this property is not set, the feature does not work, and business rules do not run in the background. Note: Business rules that are set to automatically run when a data form is loaded or saved never run in the background
HBR_MONITOR_DELAY	Use this to specify the interval in milliseconds for checking the status of business rules created with Business Rules.	HBR_MONITOR_DELAY=300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
RULE_MAX_WAIT	Use this to specify the interval in milliseconds to wait before running business rules in the background (for business rules created with Calculation Manager.)	RULE_MAX_WAIT =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
RULE_MONITOR_DELAY	Use this to specify the interval in milliseconds for checking the status of business rules created with Calculation Manager	RULE_MONITOR_DELAY =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
CLR_CELL_MAX_WAIT	Use this to specify interval in milliseconds to wait before running Clear Cell Details jobs in the background. If this property is not set, Clear Cell Details jobs do not run in the background.	CLR_CELL_MAX_WAIT =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
CLR_CELL_MONITOR_DELAY	Use this to specify the interval in milliseconds for checking the status of Clear Cell Detail operations.	CLR_CELL_MONITOR_DELAY =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
COPY_DATA_MAX_WAIT	Use this to specify interval in milliseconds to wait before running Copy Data jobs in the background. If this property is not set, Copy Data jobs do not run in the background.	COPY_DATA_MAX_WAIT =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
COPY_DATA_MONITOR_DELAY	Use this to specify the interval in milliseconds for checking the status of Copy Data jobs.	COPY_DATA_MONITOR_DELAY =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value.
PUSH_DATA_MAX_WAIT	Use this to specify interval in milliseconds to wait before running Push Data jobs in the background. If this property is not set, Push Data jobs do not run in the background.	PUSH_DATA_MAX_WAIT =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value
PUSH_DATA_MONITOR_DELAY	Use this to specify the interval in milliseconds for checking the status of Push Data jobs.	PUSH_DATA_MONITOR_DELAY =300000 (for 5 minutes)	The default and minimum value is 180000 milliseconds (3 minutes). If you set a lower value, that value is ignored, and the property is set to the default value
JOB_STATUS_MAX_AGE	Use this to specify The maximum age of a completed job record before Planning deletes it from the database table, HSP_JOB_ STATUS. Planning checks the job records every 30 minutes. For example, if you set the property value to 60,000 (1 minute), a job completes at 3:00, and Planning checks the job records at 3:01, then Planning would delete the completed job record. Removing completed job records can improve performance.	JOB_STATUS_MAX_AGE =300000 (for 5 minutes)	Specify the value in milliseconds. There is no default or minimum value.
DEBUG_ENABLED	Use this to specify the JVM log level to debug for the Planning Server	DEBUG_ENABLED=true	By default this is not set and its added only when troubleshooting a problem
DATA_GRID_CACHE_SIZE	Use this to specify the number of data grids cached per user to allow a user to work in more than one data form at one time. The property applies per user because each user has a data grid cache.	DATA_GRID_CACHE_SIZE=2	By default, this property is set to 1, allowing each user to have one data form open and active at a time. Caution! Keep in mind that increasing this property results in greater memory utilization by the application server. For example, for an application with 100 users, the application server can cache up to 100 data grids by default. If this property is set to 3, up to 300 data grids could be cached. The impact on memory utilization is greater for applications that have very large data forms.
CREATOR_URL	Use this to specify the Planning URL in workflow emails. If this property is not defined or the value of this property is empty then the generated URL would be empty.	CREATOR_URL=http://server1.yourcompany.com:8300/HyperionPlanning/ if Planning is on server1.yourcompany.com and listening on 8300 port
SMARTVIEW_COMPRESSION_THRESHOLD	Use this property to optimize large queries performance for Smart View, the optimal compression setting should be determined based on the load testing and set in the Planning System Properties. It can be set to a value not less than 1. This threshold is the minimum size of the query in which compression will be used. So, a value of 1000 would mean compression would be used for anything greater than 1,000 bytes	SMARTVIEW_COMPRESSION_THRESHOLD=1000