Configuring WebFOCUS Hyperstage

The Hyperstage configuration file is called brighthouse.ini and is located in the data subdirectory within the Hyperstage installation directory. The configuration file is a text file containing the Hyperstage configuration parameters. See the Hyperstage installation package for a sample brighthouse.ini file.

Important: To ensure optimal performance, it is critical that you specify increased memory settings for systems running more than 2GB of physical memory.

Each parameter is shown on a separate line and uses the following form:

ParameterName=ParameterValue

If a parameter is not present in the configuration file or if the configuration file does not exist, the default values are used. Blank lines and comments (lines starting with #) are ignored.

Be sure to customize the following parameters to optimize performance. These parameters are case-sensitive and must be typed as shown.

WebFOCUS Hyperstage Tuning Parameters
Parameter Syntax
Value
Description

ServerMainHeapSize=size
Not less than 320
Default: 600
Size of the main memory heap in the server process, in MB. The larger the heap size, the more effectively the server works. However, the sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
LoaderMainHeapSize=size
Not less than 320
Default: 320
Size of the memory heap in the loader process, in MB. The sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
CacheFolder=directory
Directory name
Default: none
This is a mandatory parameter. Path to the directory where temporary files will be created and stored. This is set as one of the installation script parameters.
AllowMySQLQueryPath=number
0, 1
Default: 1
Set to 0 to disable queries that are not supported in the Hyperstage Optimizer from being handled by the MySQL query engine. Queries that take the MySQL path will have reduced performance.

WebFOCUS Hyperstage Tuning Parameters
ServerMainHeapSize=size	Not less than 320 Default: 600	Size of the main memory heap in the server process, in MB. The larger the heap size, the more effectively the server works. However, the sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
LoaderMainHeapSize=size	Not less than 320 Default: 320	Size of the memory heap in the loader process, in MB. The sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
CacheFolder=directory	Directory name Default: none	This is a mandatory parameter. Path to the directory where temporary files will be created and stored. This is set as one of the installation script parameters.
AllowMySQLQueryPath=number	0, 1 Default: 1	Set to 0 to disable queries that are not supported in the Hyperstage Optimizer from being handled by the MySQL query engine. Queries that take the MySQL path will have reduced performance.

Note: The values are commented out (preceded by #) in the brighthouse.ini file which causes them to default to the application minimum allowed values of 600 and 320 for ServerMainHeapSize and LoaderMainHeapSize, respectively.

WebFOCUS Hyperstage Additional Parameters
Parameter Syntax
Value
Description
KNFolder=directory
Directory name
Default: BH_RSI_Repository
Directory where the Knowledge Grid is stored. If not specified, these files are located in a subdirectory of the data directory. Allow free space of at least 1% of database size (compressed).
ControlMessages=number
0, 1, 2, 3, 4, 5
Default: 0 (lowest level of detail)

Set to 2 to turn the control messages on with timestamps. This is usually needed by Hyperstage to support performance investigation.
For descriptions of other Control Messages levels, see https://www.infobright.org/index.php//ICE_Wiki/wiki-4/troubleshooting/query-execution-log/.

WebFOCUS Hyperstage Additional Parameters
KNFolder=directory	Directory name Default: BH_RSI_Repository	Directory where the Knowledge Grid is stored. If not specified, these files are located in a subdirectory of the data directory. Allow free space of at least 1% of database size (compressed).
ControlMessages=number	0, 1, 2, 3, 4, 5 Default: 0 (lowest level of detail)	Set to 2 to turn the control messages on with timestamps. This is usually needed by Hyperstage to support performance investigation. For descriptions of other Control Messages levels, see https://www.infobright.org/index.php//ICE_Wiki/wiki-4/troubleshooting/query-execution-log/.

WebFOCUS

WebFOCUS Hyperstage Tuning Parameters
Parameter Syntax	Value	Description
ServerMainHeapSize=size	Not less than 320 Default: 600	Size of the main memory heap in the server process, in MB. The larger the heap size, the more effectively the server works. However, the sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
LoaderMainHeapSize=size	Not less than 320 Default: 320	Size of the memory heap in the loader process, in MB. The sum of the heap sizes in the server and the loader should not exceed physical memory installed in the machine, otherwise, performance decreases radically.
CacheFolder=directory	Directory name Default: none	This is a mandatory parameter. Path to the directory where temporary files will be created and stored. This is set as one of the installation script parameters.
AllowMySQLQueryPath=number	0, 1 Default: 1	Set to 0 to disable queries that are not supported in the Hyperstage Optimizer from being handled by the MySQL query engine. Queries that take the MySQL path will have reduced performance.