Essbase Configuration File Settings (essbase.cfg)


Essbase Configuration Settings

AGENTDELAY
AGENTLOGMESSAGELEVEL
AGENTPORT
AGENTTHREADS
AGTSVRCONNECTIONS
AUTHENTICATIONMODULE
CALCCACHE
CALCCACHEHIGH
CALCCACHEDEFAULT
CALCCACHELOW
CALCHASHTBLMEMORY
CALCLIMITFORMULARECURSION
CALCLOCKBLOCK
CALCMODE
CALCNOTICE
CALCOPTCALCHASHTBL
CALCOPTFRMLBOTTOMUP
CALCPARALLEL
CALCTASKDIMS
CASESENSITIVE
CCTRACK
CLEARLOGFILE
COMMITBLOCKS
DATACACHESIZE
DATACOMPRESS
DATACOMPRESSIONTYPE
DATAERRORLIMIT
DATAFILECACHESIZE
DELIMITEDMSG
DELIMITER
DIRECTIO
DISKVOLUMES
DLSINGLETHREADPERSTAGE
DLTHREADSPREPARE
DLTHREADSWRITE
DYNCALCCACHEBLKRELEASE
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHECOMPRBLKBUFSIZE
DYNCALCCACHEMAXSIZE
DYNCALCCACHEONLY
DYNCALCCACHEWAITFORBLK
EXCLUSIVECALC
EXCEPTIONLOGOVERWRITE
EXPORTTHREADS
GRIDEXPANSION
GRIDEXPANSIONMESSAGES
HAENABLE
HAMAXNUMCONNECTION
HAMAXNUMSQLQUERY
HAMAXQUERYROWS
HAMAXQUERYTIME
HAMEMORYCACHESIZE
HARETRIEVENUMROW
INCRESTRUC
INDEXCACHESIZE
JVMMODULELOCATION
LOCKTIMEOUT
LOGMESSAGELEVEL
LROONSHAREDMBR
MAXLOGINS
MULTIPLEBITMAPMEMCHECK
NETDELAY
NETNPCONNECTTIMEOUT
NETRETRYCOUNT
NODENAME
NOMSGLOGGINGONDATAERRORLIMIT
NUMERICPRECISION
OUTLINECHANGELOG
OUTLINECHANGELOGFILESIZE
PIPEBUFFERSIZE
PORTINC
QUICKLOGIN
QRYGOVEXECBLK
QRYGOVEXECTIME
REPTKBYTEBUF
REPTKBYTESORTBUF
SERVERPORTBEGIN
SERVERPORTEND
SERVERTHREADS
SSAUDIT, SSAUDITR
SSLOGUNKNOWN
SSPROCROWLIMIT
SUPNA
TIMINGMESSAGES
UPDATECALC

New Settings in Release 6.5

Supporting Hybrid Analysis
HAENABLE
HAMAXNUMCONNECTION
HAMAXNUMSQLQUERY
HAMAXQUERYROWS
HAMAXQUERYTIME
HAMEMORYCACHESIZE
HARETRIEVENUMROW
Supporting Parallel Calculation
CALCPARALLEL
CALCTASKDIMS

Miscellaneous
CALCLIMITFORMULARECURSION

New Settings in Release 6.2

AGENTPORT
AGENTTHREADS
AGTSVRCONNECTIONS
AUTHENTICATIONMODULE
CALCMODE
DELIMITEDMSG
DELIMITER
DIRECTIO
DLSINGLETHREADPERSTAGE
DLTHREADSPREPARE
DLTHREADSWRITE
GRIDEXPANSION
GRIDEXPANSIONMESSAGES
MAXLOGINS
MULTIPLEBITMAPMEMCHECK
NOMSGLOGGINGONDATAERRORLIMIT
PORTINC
QUICKLOGIN
QRYGOVEXECBLK
QRYGOVEXECTIME
SERVERPORTBEGIN
SERVERPORTEND

New Settings in Release 6.1

AGENTLOGMESSAGELEVEL
DYNCALCCACHECOMPRBLKBUFSIZE
DYNCALCCACHEBLKRELEASE
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHEMAXSIZE
DYNCALCCACHEONLY
DYNCALCCACHEWAITFORBLK
EXPORTTHREADS
JVMMODULELOCATION

AGENTDELAY

AGENTDELAY specifies the number of seconds an Agent thread waits to perform a specific action.

Syntax

AGENTDELAY n

n The number of seconds an Agent thread waits before performing a specific action. n must be an integer and must be 5 or higher. The default value is 20.

Description

AGENTDELAY specifies the number of seconds an Agent thread waits for a resource to become available so it can perform a specific action. If the resource is still unavailable when the specified value for AGENTDELAY is completely used, the agent times out and does not complete the transaction.

Example

AGENTDELAY 60

Notes

See Also

AGENTTHREADS
AGTSVRCONNECTIONS



AGENTLOGMESSAGELEVEL

AGENTLOGMESSAGELEVEL sets the message types that will be written to the OLAP Server log, essbase.log.

Syntax

AGENTLOGMESSAGELEVEL INFO | WARNING | ERROR

Where INFO, WARNING, and ERROR are levels:

INFO When specified, all three types of messages are written to the OLAP Server log. This is the default.
WARNING When specified, only Warning and Error messages are written to the OLAP Server log.
ERROR When specified, only error messages are written to the OLAP Server log. No Warning or Info messages are written to the OLAP Server log.

Description

AGENTLOGMESSAGELEVEL enables the level of messages written to the OLAP Server log to be specified.

Example

AGENTLOGMESSAGELEVEL WARNING

This example sets the message level at Warning. Only Warning and Error messages are written to the OLAP Server log.

Notes

For more information about the OLAP Server log, see the Database Administrator's Guide.

See Also

SETMSGLEVEL



AGENTPORT

AGENTPORT specifies the port that the Agent uses.

Syntax

AGENTPORT n

n The port number for the Agent. This port number should not be in use by any other process. The default value is 1423.

Description

AGENTPORT specifies the port that the Agent uses.

You may wish to change the default for many reasons. These are two common reasons:

Example

AGENTPORT 1478
SERVERPORTBEGIN 32470
SERVERPORTEND 32600
PORTINC 5

This example would produce these results:

Notes

See Also

SERVERPORTBEGIN
SERVERPORTEND
PORTINC



AGENTTHREADS

AGENTTHREADS specifies how many threads the Agent may spawn.

Syntax

AGENTTHREADS n

n The number of threads the Agent may spawn. n is an integer between 2 and 500.
The default value is 5. It is strongly recommended that you use this default value. See Notes below.

Description

AGENTTHREADS specifies how many threads the Agent may spawn. Some of these threads are used in conjunction with AGTSVRCONNECTIONS to allow initial login via the Agent and to establish the first connection to application and database, negotiated by the Agent and server. The rest of the threads are used for other Agent tasks unrelated to AGTSVRCONNECTIONS. Once connected, these threads are no longer used. Client requests use server threads whose maximum number is governed by SERVERTHREAD and by the number of licensed ports purchased.

When a connection is requested, the Agent assigns a thread to the request and releases the thread when the connection is made.

Example

AGENTTHREADS 15

Notes

See Also

AGTSVRCONNECTIONS
AGENTDELAY



AGTSVRCONNECTIONS

AGTSVRCONNECTIONS specifies the maximum number of threads the OLAP Server can spawn to allow the first connection to an application and database, negotiated between the Agent and server.

Syntax

AGTSVRCONNECTIONS n

n The default value is 5, the minimum value is 2. The maximum value is the value set for AGENTTHREADS.

Description

AGTSVRCONNECTIONS specifies the maximum number of threads that the OLAP Server can create to connect to the Agent. Each connection uses one thread only while logging in and connecting to an application and database. Once connected, client requests are managed by threads whose maximum is controlled by SERVERTHREADS and by the number of licensed ports.

You may wish to adjust this value from the default value 5 if, for example, you are expecting a large number of users to login and select a single application in a short period of time.

The configuration parameter AGENTTHREADS controls the maximum number of threads the agent can create, so keep the value of AGTSVRCONNECTIONS equal to or less than the value of AGENTTHREADS to avoid wasting resources.

Example

AGTSVRCONNECTIONS 7

This example increases the maximum number of simultaneous connections between Agent and server, from the default of 5 to 7.

Notes

See Also

AGENTTHREADS


AUTHENTICATIONMODULE

AUTHENTICATIONMODULE specifies the elements needed for external authentication.

Syntax

AUTHENTICATIONMODULE module_name library_name max_wait_time default_connection_parameters@hostname:port_number

 module_name The name of the authentication module. Use "LDAP" as the value for this protocol.

For Release 6.2, Essbase supplies a standard implementation of the protocol for LDAP V3-compliant servers. Please contact Essbase Product Management for more information about implementing custom authetntication protocols.

 library_name The directory path and name of the library that implements the authentication protocol. For all platforms, the library that implements the authentication protocol is located in ARBORPATH\bin. The library name depends on the operating system where you have installed Essbase:
  • WINDOWS: essldap.dll
  • SOLARIS: libessldap.so
  • AIX: libessldapS.a
  • HP: libessldap.sl
 max_wait_time Use the value "x." Reserved for future use.
 default_connection_parameters The default value is FALSE. Valid values can be anything representing private data needed to authenticate the user with the authentication protocol. For example, in an LDAP schema, default connection parameters would be the portion of the DN (Distinguished Name) other than the user name. Size of ddefault_connection_parameters cannot exceed 256 bytes.
 @host_name:port_number The host name and port number of the server that the authentication protocol contacts to authenticate the user.

For example, this could be the host name and port number of an LDAP server running on the network.

Note:You must type the character "@" before the host name, and type the character ":" between host name and port number.

Examples

Example 1

AuthenticationModule LDAP essldap.dll x cn=Engineers, ou=Groups, dc=yahoo, dc=com@Gorky:389

The entries in this example allow users in the group Engineers from domain yahoo.com to be authenticated on host Gorky, via port number 389.

Notes

For more information about how to create a user with valid external authentication, see the security chapters in the Database Administrator's Guide.



CALCCACHE

CALCCACHE specifies whether Essbase uses a calculator cache when calculating your database.

Syntax

CALCCACHE TRUE | FALSE

TRUE Tells Essbase to use a calculator cache when calculating the database. The default is TRUE.
FALSE Tells Essbase not to use a calculator cache when calculating the database.

Description

Essbase uses the calculator cache to create and track data blocks during calculation. Using the calculator cache significantly improves your calculation performance. The size of the performance improvement depends on your database configuration.

If required during a calculation, you can override this default setting using the SET CACHE command in a calculation script.

You can specify the size of the calculator cache using the SETCACHE command in a calculation script and the CALCCACHE{HIGH | DEFAULT | LOW} settings in the essbase.cfg file.

When the CALCCACHE setting is set to TRUE, Essbase uses the calculator cache providing that:

Example

CALCCACHE TRUE
CALCCACHE FALSE

In essbase.cfg, the parameter is not followed by a semicolon; in a calculation script, the parameter must be followed by a semicolon.

Notes

See Also

SET CACHE (calculation script)



CALCCACHEHIGH

CALCCACHEHIGH sets the high value for the calculation script SET CACHE command.

Syntax

CALCCACHEHIGH n

CALCCACHEHIGH is the level and n is the maximum calculator cache size, in bytes, that a user can choose to use during calculation. The maximum calculator cache size that you can specify is 200,000,000 bytes.

Description

Essbase uses the calculator cache to create and track data blocks during calculation. Using the calculator cache significantly improves your calculation performance. The size of the performance improvement depends on your database configuration.

For detailed information on setting the size of your calculator cache, see the Database Administrator's Guide.

You can specify whether Essbase uses a calculator cache by default using the CALCCACHE TRUE | FALSE command in the essbase.cfg file. If required during a calculation, override this default setting using the SET CACHE command in a calculation script.

Example

Assume the essbase.cfg file contains these settings:

CALCCACHEHIGH  1000000
CALCCACHEDEFAULT 300000
CALCCACHELOW  200000

You could use the following SET CACHE calculator commands in a calculation script:

SET CACHE HIGH;

This calculator command sets a calculator cache of 1,000,000 bytes for the duration of the calculation script.

SET CACHE DEFAULT;

This calculator command sets a calculator cache of 300,000 bytes for the duration of the calculation script.

SET CACHE LOW;

This command sets a calculator cache of 200,000 bytes for the duration of the calculation script.

Notes

See Also

CALCCACHEDEFAULT
CALCCACHELOW
SET CACHE (calculation script command)

CALCCACHEDEFAULT

CALCCACHEDEFAULT sets default value for the calculation script SET CACHE command.

Syntax

CALCCACHEDEFAULT n

CALCCACHEDEFAULT is the level and n is the size for the level, default in this example, the default calculator cache size, in bytes.

If you do not set the value of DEFAULT, Essbase uses a default value of 200,000 bytes.

Description

Essbase uses the calculator cache to create and track data blocks during calculation. Using the calculator cache significantly improves your calculation performance. The size of the performance improvement depends on your database configuration.

For detailed information on setting the size of your calculator cache, see the Database Administrator's Guide.

You can specify whether Essbase uses a calculator cache by default using the CALCCACHE setting in the essbase.cfg file. If required during a calculation, override this default setting using the SET CACHE command in a calculation script.

Example

Assume the essbase.cfg file contains these settings:

CALCCACHEHIGH  1000000
CALCCACHEDEFAULT 300000
CALCCACHELOW  200000

You could then use the following SET CACHE commands in a calculation script:

SET CACHE HIGH;

This command sets a calculator cache of 1,000,000 bytes for the duration of the calculation script.

SET CACHE DEFAULT;

This command sets a calculator cache of 300,000 bytes for the duration of the calculation script.

SET CACHE LOW;

This command sets a calculator cache of 200,000 bytes for the duration of the calculation script.

Notes

See Also

CALCCACHEHIGH
CALCCACHELOW
SET CACHE (calculation script command)


CALCCACHELOW

CALCCACHELOW set the HIGH, DEFAULT, and LOW values for the calculation script SET CACHE command.

Syntax

CALCCACHELOW n

CALCCACHELOW is the level and n is the minimum calculator cache size, in bytes, that a user can choose to use during calculation.

Description

Essbase uses the calculator cache to create and track data blocks during calculation. Using the calculator cache significantly improves your calculation performance. The size of the performance improvement depends on your database configuration.

For detailed information on setting the size of your calculator cache, see the Database Administrator's Guide.

You can specify whether Essbase uses a calculator cache by default using the CALCCACHE setting in the essbase.cfg file. If required during a calculation, override this default setting using the SET CACHE command in a calculation script.

Example

Assume the essbase.cfg file contains these settings:

CALCCACHEHIGH  1000000
CALCCACHEDEFAULT 300000
CALCCACHELOW  200000

You could then use the following SET CACHE commands in a calculation script:

SET CACHE HIGH;

sets a calculator cache of 1,000,000 bytes for the duration of the calculation script.

SET CACHE DEFAULT;

sets a calculator cache of 300,000 bytes for the duration of the calculation script.

SET CACHE LOW;

sets a calculator cache of 200,000 bytes for the duration of the calculation script.

Notes

See Also

CALCCACHEHIGH
CALCCACHEDEFAULT
SET CACHE (calculation script command)



CALCHASHTBLMEMORY

CALCHASHTBLMEMORY sets the calculator hash table memory limit.

Syntax

CALCHASHTBLMEMORY MemSize

MemSize Maximum amount of memory (in bytes) that you want the calculator hash table to use. The default is 20 megabytes.

Description

When hash table optimization is in effect, Essbase uses the calculator hash table to optimize the use of the calculator cache when calculating large, flat databases. To turn on hash table optimization, use CALCOPTCALCHASHTBL or SET CALCHASHTBL.

If Essbase reaches the hash table memory limit during calculation, Essbase cannot use the hash table method.

Example

CALCHASHTBLMEMORY 30000000

See Also

CALCOPTCALCHASHTBL
SET CALCHASHTBL(calculation script command)



CALCLIMITFORMULARECURSION

CALCLIMITFORMULARECURSION, when set to true, prevents the server from going beyond 31 formula execution levels.

Syntax

CALCLIMITFORMULARECURSION TRUE | FALSE

TRUE Imposes a limit of 31 on the number of formula execution levels.
FALSE Imposes no limit on the number of formula execution levels. The default setting is FALSE.

Description

CALCLIMITFORMULARECURSION limits the number of execution levels of Essbase formulas.
If a calculation involves formulas referencing one or more members from sparse dimensions and there are formulas along dense dimension members, the formula execution may be recursive (have multiple execution levels). By default, Essbase does not limit the number of formula execution levels. However, formulas with excessive execution levels may crash the server. Setting CALCLIMITFORMULARECURSION to TRUE prevents excessive execution levels from crashing the OLAP Server.

If a formula reaches 31 execution levels and CALCLIMITFORMULARECURSION is set to TRUE, Essbase stops processing that formula and writes error messages in the application log.
If a formula reaches 31 execution levels and CALCLIMITFORMULARECURSION is set to FALSE, Essbase continues processing that formula and writes an information message in the application log.

Example

If you added a member named "Payroll Share In Similar Markets" to Sample Basic and used the following formula to calculate it, you would get a recursion error.

IF (@ISUDA(Market, "Major Market"))
   Payroll / @SUMRANGE(Payroll, @UDA(Market, "Major Market"));
ELSEIF (@ISUDA(Market, "Small Market"))
   Payroll / @SUMRANGE(Payroll, @UDA(Market, "Small Market"));
ENDIF;

If CALCLIMITFORMULARECURSION is set to FALSE, Essbase completes processing the formula, if possible. If the formula requires too many levels of recursion, the OLAP Server may crash. Essbase also writes an error in the application log mentioning that the formula requires more than 31 levels of recursion.

If CALCLIMITFORMULARECURSION is set to TRUE, Essbase stops processing the formula and writes an error in the application log mentioning that the formula requires more than 31 levels of recursion.

Notes

In release 6.1.4, Essbase began imposing a limit on the number of formula execution levels; if you installed 6.1.4 to fix problems with server crashes due to certain spreadsheet retrievals containing member formulas and dynamic calculations, re-enable the formula execution limit.



CALCLOCKBLOCK

CALCLOCKBLOCK {HIGH | DEFAULT | LOW} sets the HIGH, DEFAULT, and LOW values for the calculation script SET LOCKBLOCK command.

This setting specifies the maximum number of blocks that Essbase can fix (get addressability to) when calculating one block.

Syntax

CALCLOCKBLOCKHIGH | CALCLOCKBLOCKDEFAULT | CALCLOCKBLOCKLOW n

Where HIGH, DEFAULT, and LOW are levels:

HIGH Maximum number of blocks that a user can choose to fix concurrently when one data block is calculated.
DEFAULT Default number of blocks that can be fixed concurrently.
LOW Minimum number of blocks that a user can choose to fix concurrently.
n Integer value for each level, representing the total number of blocks that can be locked concurrently.

Description

CALCLOCKBLOCK specifies the number of blocks that can be fixed at each level of the SET LOCKBLOCK HIGH | DEFAULT | LOW calculation script command.

When a block is calculated, Essbase fixes (gets addressability to) the block along with the blocks containing its children. Essbase calculates the block and then releases it along with the blocks containing its children.

By default, Essbase allows up to 100 blocks to be fixed concurrently when calculating a block. This is sufficient for most database calculations.

However, you may want to set a number higher than 100 if you are consolidating very large numbers of children in a formula calculation.

This ensures that Essbase can fix all the required blocks when calculating a data block and that performance will not be impaired.

Example

If the essbase.cfg file contains the following settings:

CALCLOCKBLOCKHIGH 500
CALCLOCKBLOCKDEFAULT 200
CALCLOCKBLOCKLOW 50

then you can use the following SET LOCKBLOCK setting commands in a calculation script:

SET LOCKBLOCK HIGH;

means that Essbase can fix up to 500 data blocks when calculating one block.

SET LOCKBLOCK DEFAULT;

means that Essbase can fix up to 200 data blocks when calculating one block.

SET LOCKBLOCK LOW;

means that Essbase can fix up to 50 data blocks when calculating one block.

In essbase.cfg, a parameter is not followed by a semicolon; in a calculation script, a parameter must be followed by a semicolon.

Notes

For more information on data blocks, see the Database Administrator's Guide.

See Also

SET LOCKBLOCK (calculation script command)



CALCMODE

CALCMODE

Syntax

CALCMODE [application_name [database_name]] [BLOCK| BOTTOMUP]

application_name Optional parameter. If you specify an application, all the databases in that application are affected by the CALCMODE setting. If you leave out the application and database name parameters, the CALCMODE setting applies to the entire server.
database_name Optional parameter. If you specify an application and database, the database you specify is affected by the CALCMODE setting. If you do not specify an application with the database, the CALCMODE setting will fail.
BLOCK This parameter turns on block calculation mode.
BOTTOMUP This parameter turns on bottom-up calculation mode.

Description

CALCMODE allows you to set the calculation mode at the server, application, or database level instead if indicating it in a calculation script using @CALCMODE. For more information, see the calculator command entry for @CALCMODE in the Technical Reference.

Example

CALCMODE BLOCK

This example turns on block calculation mode for all databases and applications in the server.



CALCNOTICE

CALCNOTICE sets the HIGH, DEFAULT, and LOW values for the SET NOTICE calculation command.

The SET NOTICE calculation command monitors the progress of your calculation, displaying completion notices during the calculation.

Syntax

CALCNOTICEHIGH | CALCNOTICEDEFAULT | CALCNOTICELOW n

where HIGH, DEFAULT, and LOW are levels.

HIGH Maximum number of completion notices that a user can choose to display.
DEFAULT Default number of completion notices.
LOW Minimum number of completion notices that a user can choose to display.
n Integer value for each level. It represents the number of notices to be displayed at set intervals during the calculation.

Description

CALCNOTICE defines the values for each of the three levels of the SET NOTICE calculation command.

SET NOTICE HIGH | DEFAULT | LOW provides completion notices during a calculation. The frequency and number of completion notices depends on the level specified.

The interval between notices is approximate. Essbase measures the interval by taking the number of data blocks already calculated as a percentage of the total number of possible data blocks in your database.

For partial calculations and calculations with multiple passes through your database, the interval between completion notices is approximate.

Example

If you use the following settings in the essbase.cfg file:

CALCNOTICEHIGH 50
CALCNOTICEDEFAULT 20
CALCNOTICELOW 5
then SET NOTICE commands in a script produce the following results:

SET NOTICE HIGH;
displays 50 completion notices at 2% intervals.

SET NOTICE DEFAULT;
displays 20 completion notices at 5% intervals.

SET NOTICE LOW;
displays 5 completion notices at 20% intervals.

In essbase.cfg, a parameter is not followed by a semicolon; in a script, a parameter must be followed by a semicolon.

Notes

See Also

SET NOTICE (calculation command)



CALCOPTCALCHASHTBL

CALCOPTCALCHASHTBL specifies whether Essbase optimizes the calculation of large, flat database outlines.

Syntax

CALCOPTCALCHASHTBL TRUE | FALSE

TRUE Optimizes the calculation of large, flat database outlines; for example, where one member has more than 5,000 children.
FALSE Does not optimize the calculation of large, flat database outlines. The default is FALSE.

Description

This setting tells Essbase whether to use a hash table to optimize use of the calculator cache for large, flat databases. A large, flat database is, for example, a database in which one or more members has over 5,000 children. Using this feature may significantly improve the performance of a CALC ALL of the database or CALC DIM of the dimension containing the member with over 5000 children. For more information on the calculator cache, see the Database Administrator's Guide.

You can override the CALCOPTCALCHASHTBL essbase.cfg setting by using the SET CALCHASHTBL command in a calculation script.

If Essbase reaches the hash table memory limit during calculation, Essbase cannot use the hash table method. You can set the limit of the hash table using the CALCHASHTBLMEMORY setting in the essbase.cfg file.

Example

CALCOPTCALCHASHTBL TRUE

See Also

CALCHASHTBLMEMORY
SET CALCHASHTBL (calculation command)



CALCOPTFRMLBOTTOMUP

CALCOPTFRMLBOTTOMUP specifies whether Essbase optimizes the calculation of complex formulas on sparse dimensions in large database outlines. If enabled, this setting tells Essbase to perform a bottom-up calculation on formulas that would otherwise require a top-down calculation.

Syntax

CALCOPTFRMLBOTTOMUP TRUE | FALSE

TRUE Optimizes the calculation of formulas on sparse dimensions in large database outlines by forcing a bottom-up calculation.
FALSE Does not force a bottom-up calculation for formulas on sparse dimensions in large database outlines. The default is FALSE.

Description

This setting tells Essbase whether to optimize the calculation of formulas on sparse dimensions in large database outlines, so that you can efficiently use CALC ALL and CALC DIM commands to calculate the database.

You can override the CALCOPTFRMLBOTTOMUP essbase.cfg setting by using the SET FRMLBOTTOMUP command in a calculation script.

Notes

Example

CALCOPTFRMLBOTTOMUP TRUE

See Also

SET FRMLBOTTOMUP (calculation command)



CALCPARALLEL

CALCPARALLEL enables parallel calculation in place of the default serial calculation.

Syntax

CALCPARALLEL [appname [dbname]] n

appname An optional parameter specifying that parallel calculation applies to all databases on the named application. If you specify a value for appname and do not specify a value for dbname, the setting applies to all databases in the specified application. If you do not specify an application, you cannot specify a database and the setting applies to all applications and databases on the Essbase OLAP Server.
dbname An optional parameter specifying that parallel calculation applies only to the database named. If you specify a value for dbname but do not include appname, the parameter is ignored and parallel calculation is enabled for all applications and databases on the OLAP Server.
n A required parameter, an integer from 0-4, specifying the number of threads to be made available for parallel calculation. The default value, 0, specifies serial calculation: no parallel calculation takes place. Values less than 0 are interpreted as 0, values greater than 4 are interpreted as 4.

Note: Values less than 0 treated differently than SET CALCPARALLEL configuration setting.

You must restart OLAP Server to initialize any change to the configuration file.

Description

CALCPARALLEL enables Essbase to use parallel calculation. Essbase analyzes each pass of a calculation to determine whether parallel calculation would optimize the calculation. If it would not, Essbase uses serial calculation even if CALCPARALLEL is set.

Example

CALCPARALLEL 3

This example enables up to three threads to perform calculation tasks at the same time.

Notes

See Also

CALCTASKDIMS
SET CALCPARALLEL calculation command
SET CALCTASKDIMS calculation command



CALCTASKDIMS

CALCTASKDIMS specifies the number of sparse dimensions included in the identification of tasks for parallel calculation.

Syntax

CALCTASKDIMS [appname [dbname]] n

appname An optional parameter specifying that CALCTASKDIMS applies to all databases on the named application. If you specify a value for appname and do not specify a value for dbname, the setting applies to all databases in the specified application. If you do not specify an application, you cannot specify a database, and the setting applies to all applications and databases on the Essbase OLAP Server.
dbname An optional parameter specifying that CALCTASKDIMS applies only to the database named. If you specify a value for dbname but do not include appname, the parameter is ignored and the setting applies to all applications and databases on the OLAP Server.
n A required parameter, an integer specifying the number of sparse dimensions to be included when Essbase identifies tasks that can be performed at the same time.

The default value, 1, indicates that only the last sparse dimension in the outline is used to identify tasks. A value of 2, for example, indicates that the last and second-to-last sparse dimensions in the outline are used. Because each unique combination of members from selected sparse dimensions is a potential task, the potential number of parallel tasks is the product of the number of members of the selected dimensions. The maximum value is the number of sparse dimensions in the outline.

Any value less than 1 is interpreted as 1, any value greater than the number of sparse dimensions in the outline is converted to the largest valid value.

Note: Values less than 0 treated differently than SET CALCTASKDIMS configuration setting.

You must restart OLAP Server to initialize any change to the configuration file.

Description

CALCTASKDIMS specifies how many of the sparse dimensions in an outline are used to identify potential tasks that can be run in parallel.

Example

CALCTASKDIMS Sample Basic 2

This example specifies that for application Sample and database Basic, the last two sparse dimensions in an outline will be used to identify potential tasks to perform at the same time during a calculation pass.

Notes

See Also

CALCPARALLEL
SET CALCPARALLEL calculation command
SET CALCTASKDIMS calculation command



CASESENSITIVE

CASESENSITIVE determines whether member names are case-sensitive.

Syntax

CASESENSITIVE TRUE | FALSE

TRUE Member names are case-sensitive.
FALSE You need not pay attention to case when entering a member name. The default value is FALSE.

Description

CASESENSITIVE determines whether member names are case-sensitive.

Example

CASESENSITIVE TRUE 

Notes



CCTRACK

CCTRACK controls whether exchange rates are tracked as Essbase calculates currency conversions.

Syntax

CCTRACK TRUE | FALSE

TRUE Causes Essbase to track exchange rates while conversions are calculated. The default value is TRUE.
FALSE Turns off the tracking system.

Description

CCTRACK controls whether exchange rates are tracked while Essbase calculates currency conversions. By default, Essbase tracks exchange rates that are applied to data as conversions are calculated, allowing conversion to occur at report time through the Spreadsheet Add-in or the Report Writer.

Setting CCTRACK to FALSE turns off the tracking system with the following results:

Example

CCTRACK TRUE 

See Also

CCONV (calculation command)



CLEARLOGFILE

CLEARLOGFILE determines whether Essbase overwrites the OLAP Server and application logs.

Syntax

CLEARLOGFILE TRUE | FALSE

TRUE Overwrites the OLAP Server and application logs.
FALSE Appends to the existing logs. The default setting is FALSE.

Description

CLEARLOGFILE determines whether Essbase overwrites the OLAP Server log, essbase.log,whenever OLAP Server is restarted and whether Essbase overwrites the application log, application_name.log, whenever the application is restarted.

Example

If Essbase logs an application message and this setting is in effect:

CLEARLOGFILE TRUE

Essbase logs the message in the application_name.log file in the application directory: ARBORPATH\app\application_name, where application_name is the name of the current application. Essbase replaces the contents of this log with new entries each time the application is started.

If Essbase logs a server message and this setting is in effect:

CLEARLOGFILE FALSE

Essbase logs the message in the essbase.log file in the directory pointed to by ARBORPATH, appending the existing file.

Notes

See Also

SSLOGUNKNOWN



COMMITBLOCKS

COMMITBLOCKS is no longer used.

Essbase offers committed or uncommitted isolation levels. When the isolation level is uncommitted, two related settings are optional: Commit Blocks and Commit Rows. For information about these settings, see the online help for the Application Manager Database Settings dialog box, or for the SetDbStateItem command in ESSCMD. Essbase uses the COMMITBLOCKS setting in essbase.cfg for migration from Release 4.x only.



DATACACHESIZE

DATACACHESIZE defines the initial value for the data cache size for any new databases that are created after Essbase is restarted. The data cache is a buffer in memory that holds data blocks. Essbase allocates this memory during data load, calculation, and retrieval operations, as needed.

Syntax

DATACACHESIZE n

 n
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 3 megabytes (3 M)
  • Maximum value: 2 gigabytes (2 G)
  • Default value: 3 megabytes (3 M)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (10 M).

Description

DATACACHESIZE specifies, in bytes, kilobytes, megabytes, or gigabytes, the size of the data cache for new databases on the server. The specified value takes effect for all new databases that are created after the server is started. To set or change the data cache size for an individual database, choose Database > Settings in the Application Manager and select the Storage tab, or issue SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.

Example

DATACACHESIZE 90M

causes Essbase to define the data cache size of all subsequently created databases as 90 megabytes.



DATACOMPRESS

DATACOMPRESS is no longer used. To enable data compression, use the Application Manager Database Settings dialog box, or SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.



DATACOMPRESSIONTYPE

DATACOMPRESSIONTYPE is no longer used. To set data compression type, use the Application Manager Database Settings dialog box, or SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.



DATAERRORLIMIT

DATAERRORLIMIT determines the number of records that can be written to an error log during a data load or dimension build operation.

Syntax

DATAERRORLIMIT n

n Number of records, per data load or dimension build, that can be written to the error log.

The default setting is 1000. The maximum is 65,000.

Description

DATAERRORLIMIT determines the number of records that can be written to the error log during data load or dimension build operations.

After the specified number of errors have been recorded, Essbase fails the operation and issues an error message.

Example

DATAERRORLIMIT 1000

Notes

See Also

NOMSGLOGGINGONDATAERRORLIMIT



DATAFILECACHESIZE

DATAFILECACHESIZE defines the initial value for the data file cache size for all new databases that are created after Essbase is restarted. The data file cache is a buffer in memory that holds data files. Essbase allocates this memory during data load, calculation, and retrieval operations, as needed.

Syntax

DATAFILECACHESIZE n

 n
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 8 megabytes (8 M)
  • Maximum value: 2 gigabytes (2 G)
  • Default value: 32 megabytes (32 M)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (10 M).

Description

DATAFILECACHESIZE specifies, in bytes, kilobytes, megabytes, or gigabytes, the size of the data file cache for new databases on the server. The specified value takes effect for all new databases that are created after the server is started. To set or change the data file cache size for an individual database, choose Database > Settings in the Application Manager and select the Storage tab, or issue SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.

Example

DATAFILECACHESIZE 800M

causes Essbase to define the the data file cache size of all subsequently created databases as 800 megabytes.



DELIMITEDMSG

DELIMITEDMSG instructs Essbase to use the default tilde (~) as a log delimiter in the OLAP Server log and the application log.

Syntax

DELIMITEDMSG [TRUE | FALSE]

Description

DELIMITEDMSG specifies whether OLAP Server and application logs are delimited in Essbase. If set to TRUE, and no value for DELIMITER is supplied, the default tilde (~) is used to delimit fields, and each entry is on a single line. If set to FALSE, any value specified in DELIMITER is ignored, and no special delimiter is used for logs.

Example

DELIMITEDMSG TRUE
DELIMITER * 

This example produces logs that use the asterisk (*) symbol as a delimiter between fields in a log.

See Also

DELIMITER



DELIMITER

DELIMITER instructs Essbase to use one of five allowed symbols to delimit OLAP Server and application logs.

Syntax

DELIMITER [~ | ^ | * | : | & ]

Description

DELIMITER specifies which of five symbols that Essbase will use to delimit fields in logs. DELIMITER is ignored unless DELIMITEDMSG TRUE is also present in the configuration file.

Example

DELIMITEDMSG TRUE
DELIMITER * 

This example produces logs that use the asterisk (*) symbol as a delimiter between fields in a log.

See Also

DELIMITEDMSG



DIRECTIO

For new databases or databases that will be migrated from Essbase release 6.2 or earlier, DIRECTIO specifies that Essbase will set the file access mode to direct I/O instead of the default buffered I/O.

Syntax

DIRECTIO TRUE

Description

For each database, Essbase stores a setting in its security file whether or not to use buffered I/O or direct I/O when it accesses the database. By default, when Essbase creates a new database or migrates one from release 6.2 or earlier, it sets this I/O access mode setting in the security file to buffered I/O. You can specify the DIRECTIO TRUE configuration setting to change the default setting for new or migrated databases to be direct I/O.

To alter the I/O access mode setting for a database thereafter, use Application Manager or MaxL. See the Application Manager help or MaxL documentation for more information.

Example

DIRECTIO TRUE

With this example setting in the essbase.cfg configuration file, when Essbase is restarted, the OLAP Server sets the file access mode setting to direct I/O when it creates new databases or migrates databases from release 6.2 or earlier.

Notes



DISKVOLUMES

Use DISKVOLUMES only if you need backward compatibility with earlier releases, or if you are setting up a large number of databases at the same time with the same DISKVOLUMES value. Otherwise, to set or change disk volumes, in the Application Manager, select Database > Settings and select the Storage tab, or issue SETDBSTATEITEM in ESSCMD.

DISKVOLUMES determines where index and data files are stored.

Syntax

DISKVOLUMES [volume_name] [disk_space]...

volume_name The name of the directory where a hard disk is mounted.

On NT, volume_name is a letter corresponding to a disk drive.

On UNIX, volume_name is a UNIX file path that you must specify up to the directory that you are using for Essbase (see Example). Do not specify the /app directory; Essbase appends /app automatically.
disk_space The maximum number of bytes allocated to the volume.
Specify this setting in bytes, kilobytes (K), megabytes (M) or gigabytes (G). Do not use commas or spaces. Avoid decimals (such as 2.5G).

If you enter a value without a qualifier (K, M, or G):
  • Essbase reads it as bytes.
  • The maximum value is 2147483648 (231).
  • If you need to specify a value over 231, you must use a qualifier (K, M, or G); for example, 2000G.
If you enter a value with a qualifier (K, M, or G):
  • The acceptable value range per volume is 0 - 2 terabytes. Do not exceed this amount by specifying, for example, 50000G.
If you do not specify DISKVOLUMES at all, Essbase uses only the volume where your ARBORPATH directory resides.

If you specify volume_name without specifying disk_space, Essbase uses all the disk space on that volume, as needed.

If you do not specify volume_name, Essbase uses the volume where your ARBORPATH directory resides.

DISKVOLUMES, with its values, can be up to 2 kilobytes long. You can specify 64 items per line; for example, DISKVOLUMES D 5M E 2M C 5G contains 7 items.

Description

DISKVOLUMES defines the volumes that can be used to store multiple index and data files, and the amount of space that those volumes can occupy.

Example

On NT:

DISKVOLUMES D 5M E 2M C 5G

causes Essbase to store index and data files as follows:

On UNIX platforms:

DISKVOLUMES /vol2/essbase 5M /vol3/essbase 2M /vol1/essbase 5G

causes Essbase to store index and data files as follows:

Notes



DLSINGLETHREADPERSTAGE

DLSINGLETHREADPERSTAGE specifies that Essbase uses a single thread per stage of data load processing or that it uses the thread values specified in the DLTHREADSPREPARE and DLTHREADSWRITE configuration settings. By working with these three configuration settings you may be able to test and improve data load performance.

You can specify DLSINGLETHREADPERSTAGE for individual databases, all databases within an application, or for all applications and databases on the server.

Syntax

DLSINGLETHREADPERSTAGE [appname [dbname]] TRUE | FALSE

 appname Application name. Optional parameter for applying the TRUE or FALSE setting to one or all databases within the application. If you specify a value for appname and do not specify a value for dbname, the setting applies to all databases in the specified application. If you do not specify an application, you cannot specify a database and the setting applies to all applications and databases on the Essbase OLAP Server.
 dbname Database name. Optional parameter for applying the TRUE or FALSE setting to the specified database within the specified application. If you do not specify a value for dbname, the setting applies to all databases within the specified application. If appname is not specified, you cannot specify dbname.
 TRUE Tells Essbase not to use the values in the DLTHREADSPREPARE and DLTHREADSWRITE configuration settings when it performs a data load. Consequently, it performs all data load processes in single-thread stages.
 FALSE Tells Essbase to use the thread values specified in the configuration settings DLTHREADSPREPARE and DLTHREADSWRITE as the numbers of threads to use in the preparation and write stages of data load processing. The default value is FALSE.

Examples

Example 1

DLSINGLETHREADPERSTAGE Sample Basic TRUE
DLTHREADSPREPARE Sample Basic 3
DLTHREADSWRITE Sample Basic 4

In this example, Essbase ignores any values specified by DLTHREADSPREPARE and DLTHREADSWRITE while loading data to the Sample Basic application and database. As a result, Essbase uses single threads in each stage.

Example 2

DLSINGLETHREADPERSTAGE FALSE
DLTHREADSPREPARE Sample Basic 3
DLTHREADSWRITE Sample Basic 4

Based on the first setting, Essbase uses the number of threads specified by the DLTHREADSPREPARE and DLTHREADSWRITE configuration settings for all data bases on the server. The settings on the second and third lines specify use of 3 processing threads for the preparation stages and 4 processing threads for the write stages when loading the Sample Basic application and database. Assuming that there are no further related settings, the default value 1 (one) is assumed for all other applications and databases on the server.

Example 3

DLSINGLETHREADPERSTAGE Sample FALSE
DLTHREADSWRITE Sample Basic 3
DLTHREADSWRITE Sample Interntl 4

In this example Essbase uses the number of threads specified by the DLTHREADSPREPARE and DLTHREADSWRITE configuration settings for all databases within the application named Sample. To enable usage of different numbers of threads for the write stage for the two different databases, two DLTHREADSWRITE settings are included with different thread values for each specific database. Because no DLTHREADSPREPARE setting is specified, the preparation stage is single-threaded.

Notes

See Also

DLTHREADSPREPARE
DLTHREADSWRITE



DLTHREADSPREPARE

DLTHREADSPREPARE specifies how many threads Essbase may use during the data load preparation stage, which organizes the source data in memory in preparation for storing the data into blocks. Multiple threads, processing in parallel, may improve data load performance.

You can specify DLTHREADSPREPARE for individual databases, all databases within an application, or for all applications and databases on the server.

In order for Essbase to use the value specified for DLTHREADSPREPARE, the configuration setting DLSINGLETHREADPERSTAGE must be set to FALSE.

Syntax

DLTHREADSPREPARE [appname [dbname]] n

 appname Application name. Optional parameter for using the specified number of threads in one or all databases within the application. If you specify a value for appname and do not specify a value for dbname, the setting applies to all databases in the specified application. If you do not specify an application, you cannot specify a database and the setting applies to all applications and databases on the Essbase OLAP Server.
 dbname Database name. Optional parameter for using the specified number of threads when loading the specified database within the specified application. If you do not specify a value for dbname, the setting applies to all databases within the specified application. If appname is not specified, you cannot specify dbname.
 n  The number of threads the data load process may produce for preparing the data to be loaded. Specify an integer between 1 and 16. The default value is 1.
If   n is greater than 16 or a negative number, Essbase assumes the value to be 16.

Example

DLSINGLETHREADPERSTAGE Sample Basic FALSE
DLTHREADSPREPARE Sample Basic 3

Because DLSINGLETHREADPERSTAGE is set to FALSE for the Sample Basic application and database, Essbase uses 3 parallel threads during the preparation stage when loading data to Sample Basic.

Notes

See Also

DLTHREADSWRITE
DLSINGLETHREADPERSTAGE



DLTHREADSWRITE

DLTHREADSWRITE specifies how many threads Essbase may use during the stage of the data load process that writes blocks on the disk. Multiple threads, processing in parallel, may improve data load performance.

You can specify DLTHREADSWRITE for individual databases, all databases within an application, or for all applications and databases on the server.

In order for Essbase to use the value specified for DLTHREADSWRITE, the configuration setting DLSINGLETHREADPERSTAGE must be set to FALSE.

Syntax

DLTHREADSWRITE [appname [dbname]] n

 appname Application name. Optional parameter for using the specified number of threads in one or all databases within the application. If you specify a value for appname and do not specify a value for dbname, the setting applies to all databases in the specified application. If you do not specify an application, you cannot specify a database and the setting applies to all applications and databases on the Essbase OLAP Server.
 dbname Database name. Optional parameter for applying the TRUE or FALSE setting to a specific database within the specified application. If you do not specify a value for dbname, the setting applies to all databases within the specified application. If appname is not specified, you cannot specify dbname.
 n  The number of threads the data load process may produce for writing data blocks to the disk. Specify an integer between 1 and 16. The default value is 1.
If   n > 16 or a negative number, Essbase assumes the value to be 16.
Important: see Notes below.

Example

DLSINGLETHREADPERSTAGE Sample Basic FALSE
DLTHREADSWRITE Sample Basic 3

Because DLSINGLETHREADPERSTAGE is set to FALSE for the Sample Basic application and database, Essbase uses 3 parallel threads during the write stage when loading data to Sample Basic.

Notes

See Also

DLTHREADSPREPARE
DLSINGLETHREADPERSTAGE



DYNCALCCACHEBLKRELEASE

DYNCALCCACHEBLKRELEASE tells Essbase where to store and calculate data blocks that contain Dynamic Calc members when the wait for space in the dynamic calculator cache has exceeded the specified wait time.

Syntax

DYNCALCCACHEBLKRELEASE [appname [dbname]] TRUE¦FALSE

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server
 TRUE Tells Essbase to make room available in the dynamic calculator cache by temporarily storing inactive blocks in a separate, compressed-block buffer.
 FALSE Tells Essbase not to find room in the dynamic calculator cache for a different set of blocks. Instead, if allowed by the DYNCALCCACHEONLY setting, Essbase attempts to perform calculations on these blocks in memory outside the dynamic calculator cache.

The default value is FALSE.

Description

Use the DYNCALCCACHEBLKRELEASE setting to tell Essbase to make room available in the dynamic calculator cache, if needed, by compressing inactive blocks from that cache and attempting to temporarily store them in a separate, compressed-block buffer.

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using the dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations. The size of the improvement depends on your database configuration.

Example

The configuration setting

DYNCALCCACHEBLKRELEASE TRUE

causes Essbase to make needed space available in the dynamic calculator cache by compressing inactive blocks and temporarily storing them in a dynamic calculator cache compressed-block buffer.

Notes

The following sequence of events must occur and settings must be defined before Essbase releases space in the dynamic calculator cache:

See Also

DYNCALCCACHEMAXSIZE
DYNCALCCACHEWAITFORBLK
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHEONLY
DYNCALCCACHECOMPRBLKBUFSIZE



DYNCALCCACHEBLKTIMEOUT

DYNCALCCACHEBLKTIMEOUT specifies the maximum number of seconds that Essbase waits for space to become available in the dynamic calculator cache.

Syntax

DYNCALCCACHEBLKTIMEOUT [appname [dbname]] n

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server.
  n  A number of seconds. May or may not include a decimal point. Any number less than 0.001 will be treated as 0.001. The default value is 10 seconds.

Description

Use DYNCALCCACHEBLKTIMEOUT to specify the maximum number of seconds that Essbase should wait for space in the dynamic calculator cache in order to perform the requested calculation there. If Essbase waits the entire number of seconds specified in this setting, it then checks the DYNCALCCACHEBLKRELEASE setting to determine what to do next:

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using the dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations. The size of the improvement depends on your database configuration.

Example

The configuration setting

DYNCALCCACHEBLKTIMEOUT 20

causes Essbase to wait up to 20 seconds for space in the dynamic calculator cache before checking the DYNCALCCACHEBLKRELEASE setting to determine the next step to take before performing the requested calculation.

Notes

See Also

DYNCALCCACHEMAXSIZE
DYNCALCCACHEONLY
DYNCALCCACHEWAITFORBLK
DYNCALCCACHEBLKRELEASE
DYNCALCCACHECOMPRBLKBUFSIZE



DYNCALCCACHECOMPRBLKBUFSIZE

DYNCALCCACHECOMPRBLKBUFSIZE specifies the size of the buffer area that Essbase temporarily uses to store compressed blocks in order to make more space available in the dynamic calculator cache.

Syntax

DYNCALCCACHECOMPRBLKBUFSIZE   [appname [dbname]]

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server
  n 
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 0 megabytes (0 M). If the value is 0, Essbase does not use the compressed block buffer.
  • Default value: 1 megabyte (1M, which is 1,048,576 bytes)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (1M)

Description

In order to make space available in the dynamic calculator cache, Essbase uses the value specified by the DYNCALCCACHECOMPRBLKBUFSIZE configuration setting to size the dynamic calculator cache compressed-block buffer. Essbase temporarily stores compressed blocks from the dynamic calculator cache into this buffer under the following circumstances:

The dynamic calculator cache compressed-block buffer is an area in memory where Essbase compresses and temporarily stores blocks from the dynamic calculator cache to free space for other blocks for other calculations. When space is again available, Essbase decompresses blocks stored in the compressed-block buffer and returns them to the dynamic calculator cache.

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using the dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations. The size of the improvement depends on your database configuration.

Example

The configuration setting

DYNCALCCACHECOMPRBLKBUFSIZE 1000000

causes Essbase to set 1,000,000 (one million) bytes as the size for the dynamic calculator cache c ompressed-block buffer.

Notes

Essbase uses the temporary compressed-block buffer only when the DYNCALCCACHEBLKRELEASE configuration parameter is set as TRUE and the DYNCALCCACHECOMPRBLKBUFSIZE setting is greater than 0.

See Also

DYNCALCCACHEMAXSIZE
DYNCALCCACHEONLY
DYNCALCCACHEWAITFORBLK
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHEBLKRELEASE



DYNCALCCACHEMAXSIZE

DYNCALCCACHEMAXSIZE defines, for each database on the server, the maximum amount of memory that Essbase can allocate for its dynamic calculator cache.

Syntax

DYNCALCCACHEMAXSIZE [appname [dbname]]

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server
 n
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 0 megabytes (0 M). If the value is 0, Essbase does not use dynamic calculator cache.
  • Default value: 20 megabytes (20M, which is 20,971,520 bytes)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (10 M).

Description

DYNCALCCACHEMAXSIZE specifies, in bytes, kilobytes, megabytes, or gigabytes, the maximum amount of memory that Essbase can allocate for the dynamic calculator cache for each database. The specified value takes effect for all databases that are opened after the server is started.

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations.

When the DYNCALCCACHEMAXSIZE setting is not equal to 0, you should also consider the following settings that affect how Essbase uses dynamic calculator cache:

Example

DYNCALCCACHEMAXSIZE 30M

causes Essbase to set 30 megabytes as the maximum size for the dynamic calculator cache.

Notes

Use DYNCALCCACHEWAITFORBLK and DYNCALCCACHEONLY to set or change how Essbase handles the situation when it has reached the maximum dynamic calculator cache size and needs more memory in the dynamic calculator cache to store dynamically calculated blocks.

See Also

DYNCALCCACHEONLY
DYNCALCCACHEWAITFORBLK
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHEBLKRELEASE
DYNCALCCACHECOMPRBLKBUFSIZE



DYNCALCCACHEONLY

For situations when the dynamic calculator cache has no more room, the DYNCALCCACHEONLY setting specifies whether or not Essbase may perform Dynamic Calc calculations in memory outside the dynamic calculator cache.

Syntax

DYNCALCCACHEONLY [appname [dbname]] TRUE ¦ FALSE

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server.
 TRUE Disallows the use of memory outside the dynamic calculator cache. If space for blocks with dynamically calculated members cannot be obtained from the dynamic calculator cache, Essbase generates an error message.
 FALSE Allows the use of memory outside the dynamic calculator cache, if necessary, for blocks containing dynamically calculated members. The default value is FALSE.

Description

When no room is available in the dynamic calculator cache, the DYNCALCCACHEWAITFORBLK and DYNCALCCACHECOMPRBLKBUFSIZE configuration settings provide options that could result in Essbase using memory outside the dynamic calculator cache to store blocks that contain dynamically calculated members. If you are experiencing a severe memory shortage, you can use the DYNCALCCACHEONLY setting to disallow the use of memory outside the dynamic calculator cache. If DYNCALCCACHEONLY is set to TRUE, instead of using memory outside the dynamic calculator cache, Essbase generates the error message, "Allocation outside the dynamic calculator cache is disallowed."

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using the dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations. The size of the improvement depends on your database configuration.

Example

The configuration setting

DYNCALCCACHEONLY TRUE

specifies that the dynamic calculator cache is the only memory area that Essbase may use to store blocks that contain dynamically calculated blocks. If a retrieval requires space that is not available in the dynamic calculator cache, the execution of the retrieval is aborted. The user sees an error message that is also posted to the application log.

Notes

The default value of this setting is FALSE. Only set this value to TRUE for one or more of the following circumstances:

See Also

DYNCALCCACHEMAXSIZE
DYNCALCCACHEWAITFORBLK
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHECOMPRBLKBUFSIZE
DYNCALCCACHEBLKRELEASE



DYNCALCCACHEWAITFORBLK

DYNCALCCACHEWAITFORBLK defines, for all databases on the server, how Essbase handles the situation when it has fully allocated the amount of memory in the dynamic calculator cache defined by the DYNCALCCACHEMAXSIZE configuration setting.

Syntax

DYNCALCCACHEWAITFORBLK [appname [dbname]] TRUE¦FALSE

 appname If you supply an application name, the setting applies to all databases within the application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname If you supply a database name, the setting applies only to the database. If you do not also provide an application name, the setting applies to all applications and databases on the server.
 TRUE Tells Essbase to wait for memory to be freed in the dynamic calculator cache.
 FALSE  
  • If allowed by the DYNCALCCACHEONLY setting, tells Essbase attempt to perform calculations on these blocks in memory outside the dynamic calculator cache.
  • If the DYNCALCCACHEONLY setting is TRUE, tells Essbase to generate an error message instead of using memory outside the dynamic calculator cache.

The default setting is FALSE.

Description

Use DYNCALCCACHEWAITFORBLK to set or change how Essbase handles the situation when it needs additional memory to store blocks in the dynamic calculator cache for the database.

When the setting is TRUE, Essbase waits to store and calculate data blocks in the dynamic-calculator-cache area that is currently in use by other queries.

When the setting is FALSE, if the DYNCALCCACHEONLY setting is FALSE, instead of waiting for area in the dynamic calculator cache, Essbase attempts to store and calculate data blocks for the current query in memory outside the dynamic calculator cache. If the DYNCALCCACHEONLY setting is TRUE, Essbase generates an error message instead of using memory outside the dynamic calculator cache.

The dynamic calculator cache is a memory buffer that holds data blocks that are expanded to include dynamically calculated members. Essbase allocates memory in the dynamic calculator cache to store these blocks during retrievals or calculations that involve dynamically calculated members.

Using the dynamic calculator cache may improve retrieval performance by reducing the number of calls to the operating system to do memory allocations. The size of the improvement depends on your database configuration.

Example

The configuration settings

DYNCALCCACHEONLY FALSE
DYNCALCCACHEWAITFORBLK FALSE

cause Essbase attempt to perform the block calculation in memory outside the dynamic calculator cache instead of waiting for space to become available in the dynamic calculator cache.

Notes

Use the DYNCALCCACHEBLKTIMEOUT setting to specify the maximum number of seconds that Essbase waits for space in the dynamic calculator cache.

See Also

DYNCALCCACHEMAXSIZE
DYNCALCCACHEONLY
DYNCALCCACHEBLKTIMEOUT
DYNCALCCACHEBLKRELEASE
DYNCALCCACHECOMPRBLKBUFSIZE



EXCLUSIVECALC

EXCLUSIVECALC determines whether Essbase allows concurrent calculations.

Syntax

EXCLUSIVECALC TRUE | FALSE

TRUE Means that if a calculation operation (command or script) is running, Essbase fails any other calculation operations.
FALSE Means that Essbase allows concurrent calculation operations. The default value is FALSE.

Description

EXCLUSIVECALC determines whether Essbase runs calculations concurrently in the same database. Essbase prevents any other calculation operations from executing on the same database.

Example

EXCLUSIVECALC TRUE 


EXCEPTIONLOGOVERWRITE

EXCEPTIONLOGOVERWRITE determines whether Essbase overwrites the existing exception log or creates a new exception log.

Syntax

EXCEPTIONLOGOVERWRITE TRUE | FALSE

TRUE Causes Essbase to overwrite the existing exception log.
FALSE Causes Essbase to keep the existing exception log and create new logs for every exception. The default value is FALSE.

Description

EXCEPTIONLOGOVERWRITE determines whether Essbase overwrites existing exception log data or creates a new log for each exception condition. The exception log name is normally log00001.xcp.

When EXCEPTIONLOGOVERWRITE is FALSE:

Example

EXCEPTIONLOGOVERWRITE FALSE 

The Essbase exception handler writes the information into the exception log on the local disk in an ASCII file as follows:

D:\essbase
D:\essbase\app. 
D:\essbase\app\app1.
D:\essbase\app\app1\db1.

Notes

See Also

The Database Administrator's Guide.



EXPORTTHREADS

EXPORTTHREADS sets the the default number of export threads at the application or database level that the PAREXPORT utility can produce.

Syntax

EXPORTTHREADS appname dbname n

  appname This is the name of the application. You can also use xxxxx as a wildcard to indicate all application names.
  dbname This is the name of the database. You can also use xxxxx as a wildcard to indicate all database names.
  n This integer, between 1 and 8, inclusive, sets the default for the number of export threads that can be used to export data. This number should generally be equal to the number of processors on your machine that you wish to commit to doing parallel export. The default is 1.

Description

EXPORTTHREADS enables the user to specify the number of threads. The export process is then executed in parallel, and multiple threads can retrieve data and write to their corresponding export files concurrently. If EXPORTTHREADS is not specified, or is not followed by its arguments, then the default value of 1 is used.

Example

EXPORTTHREADS sample basic 4

Notes

For more information about the Export Utility, see the Database Administrator's Guide.

See Also

PAREXPORT



GRIDEXPANSION

GRIDEXPANSION improves performance for queries on transparent partitions.

Syntax

GRIDEXPANSION TRUE | FALSE

The default value is TRUE.

Description

GRIDEXPANSION improves performance for some queries. If all the following conditions are met, however, client queries may receive incorrect results:

In these cases, if the client queries receive incorrect results, set GRIDEXPANSION to FALSE.

See Also

GRIDEXPANSIONMESSAGES



GRIDEXPANSIONMESSAGES

GRIDEXPANSIONMESSAGES prevents grid expansion-related messages from being displayed to Spreadsheet Add-in users and written to the application log.

Syntax

GRIDEXPANSIONMESSAGES ON | OFF

The default value is ON.

Description

If a Spreadsheet Add-in user retrieves data from a partition, the following message may be displayed repeatedly and written to the application log:

Grid expansion enabled for this query

To prevent this message from appearing, set GRIDEXPANSIONMESSAGES to OFF.

See Also

GRIDEXPANSION



HAENABLE

HAENABLE turns on or off the ability to retrieve members of a Hybrid Analysis Relational Source.

Syntax

HAENABLE TRUE|FALSE

TRUE Essbase retrieves all members of a Hybrid Analysis Relational Source through API's, reports, or Spreadsheet Add-in. If HAENABLE is on, requests can transparently span across the Hybrid Analysis Relational Source.
FALSE Essbase turns off retrieval of members of a Hybrid Analysis Relational Source for all clients. The default setting is FALSE.

Description

HAENABLE globally turns on or off the ability to retrieve members of a Hybrid Analysis Relational Source.

Example

HAENABLE FALSE



HAMAXNUMCONNECTION

HAMAXNUMCONNECTION determines the maximum number of connections per Essbase database that Essbase can keep active against the relational database.

Syntax

HAMAXNUMCONNECTION n

n The value of n specifies the number of connections per Essbase database that Essbase can keep connected to a relational database. The default is 25.

Description

HAMAXNUMCONNECTION determines the maximum number of connections per Essbase database that Essbase can keep active against the relational database. This optimizes the overhead involved in opening a relational database connection for every Hybrid Analysis report.

Example

HAMAXNUMCONNECTION 10

Note

You may need to set the value for the HAMAXNUMCONNECTION higher if, in Essbase Integration Services Console, you set the security mode to use the Essbase user ID to connect to the source database. Refer to Essbase Integration Services online help for more information on the security mode setting.



HAMAXNUMSQLQUERY

HAMAXNUMSQLQUERY determines the maximum number of SQL queries that can be issued against the fact table(s) in the relational database per Essbase query session.

Syntax

HAMAXNUMSQLQUERY n

n The value of n is the number of simultaneous SQL queries per Essbase query session. The default is 50.

Description

HAMAXNUMSQLQUERY sets the maximum number of SQL queries that can be executed during an Essbase query session from Report Writer or from the Spreadsheet Add-in extractor. If a query cannot be split into pieces in such a way as to not violate the limits set by this command, the query execution fails. The user has to submit a smaller version of the query, or the administrator must raise the value of this setting. HAMAXNUMSQLQUERY does not refer to the number of users performing queries; rather, it refers to the number of SQL queries in a complex statement.

Example

In the following example, the maximum number of SQL queries per Essbase query session is set to 10.

HAMAXNUMSQLQUERY 10

See Also

HAMAXQUERYROWS
HARETRIEVENUMROW
QRYGOVEXECBLK
QRYGOVEXECTIME



HAMAXQUERYROWS

HAMAXQUERYROWS determines the maximum number of rows returned per SQL query issued on behalf of an Essbase query.

Syntax

HAMAXQUERYROWS n

n The value of n determines the maximum number of rows retrieved per SQL query. The default is zero, meaning that no row limit is applied.

Description

HAMAXQUERYROWS determines the maximum number of rows retrieved per SQL query issued on behalf of an Essbase query. HAMAXQUERYROWS is a specific limit to an Essbase query and is set in the essbase.cfg file. The setting provides a way of controlling queries that retrieve too much data.

Example

In the following example, Essbase processes up to 100,000 rows per SQL query.

HAMAXQUERYROWS 100000

Notes

An important distinction exists between the purposes of HAMAXQUERYROWS and HARETRIEVENUMROW. Whereas HAMAXQUERYROWS controls the number of total rows to return, HARETRIEVENUMROW affects memory consumption by controlling how many rows to process at one time.

HAMAXQUERYROWS and HARETRIEVENUMROW should not be confused with QRYGOVEXECBLK which sets the maximum number of blocks that a query can access before the query is terminated.

See Also

HAMAXNUMSQLQUERY
HARETRIEVENUMROW
QRYGOVEXECBLK
QRYGOVEXECTIME



HAMAXQUERYTIME

HAMAXQUERYTIME determines the maximum time limit per query.

Syntax

HAMAXQUERYTIME n

n The value of n determines the time limit per query in seconds. The default is zero, meaning that no time limit is applied.

Description

HAMAXQUERYTIME determines how much time an SQL query operation can take before it is forcefully terminated. HAMAXQUERYTIME is a specific limit to an Essbase query that spans the Hybrid Analysis Relational Source and is set in the essbase.cfg file. The value set is dependent on how long an SQL query issued on behalf of an Essbase query can take to complete.

An important distinction exists between the purposes of HAMAXQUERYTIME and QRYGOVEXECTIME. Note that QRYGOVEXECTIME affects the entire query, such as from the time a user double-clicks a cell to retrieve data in Spreadsheet Add-in to the time the results are displayed. HAMAXQUERYTIME, on the other hand, affects only a portion of the Essbase query, such as the individual SQL queries from the Hybrid Analysis Relational Source. When a query spans Hybrid Analysis data, QRYGOVEXECTIME is disabled for the rest of the overall query, and the query timer controlled by HAMAXQUERYTIME takes effect.

Example

HAMAXQUERYTIME 300

See Also

HAMAXNUMSQLQUERY
HARETRIEVENUMROW
QRYGOVEXECBLK
QRYGOVEXECTIME



HAMEMORYCACHESIZE

HAMEMORYCACHESIZE determines the amount of memory that is reserved to cache queried members that are within the Hybrid Analysis Relational Source.

Syntax

HAMEMORYCACHESIZE [appname [dbname]] n

 appname Optional parameter. If you supply an application name, the setting applies to all databases within the named application. If you do not supply an application name, the setting applies to all applications and databases on the server.
 dbname Optional parameter. If you supply a database name and an application name, the setting applies only to the named database. If you do not also provide an application name, the database is ignored and the setting applies to all applications and databases on the server.
 n
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 1048576 B (1 M). Any value less than this minimum value causes HAMEMORYCACHESIZE to default to 1 M.
  • Default value: 1 megabytes (1 M, which is 1048576 bytes)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (10 M).

Description

HAMEMORYCACHESIZE is a memory buffer that holds relational data during the execution of spread sheet or report scripts that drill into Hybrid Analysis Relational Sources. When you specify the cache size, you control the memory used to cache relational members during execution. A larger cache size optimizes the usage of relational members during execution and increases the speed of metadata retrieval from the metaoutline. Thus, more memory allocated to the cache means fewer SQL queries to resolve member names, resulting in improved performance.

Example

HAMEMORYCACHESIZE 1M

Notes

Examples

In the following example, all databases in the application "Test" have a cache value of 1500K, and all other applications have a cache value of 2M.

HAMEMORYCACHESIZE 2M

HAMEMORYCACHESIZE Test 1500K

In the following example, all applications and databases have a cache value of 2M because the application cache value is overriden.

HAMEMORYCACHESIZE Test 1500K

HAMEMORYCACHESIZE 2M

This ordering is needed only for global and unspecified (untitled) applications.



HARETRIEVENUMROW

HARETRIEVENUMROW determines the number of rows, resulting from an SQL query, to process at one time.

Syntax

HARETRIEVENUMROW n

n The value of n specifies how many rows to process at a time. The default is 100.

Description

HARETRIEVENUMROW sets the number of rows to process at a time. A low value may degrade performance and increase query time, but reduce memory usage.

Example

In the following example, an Essbase query processes rows from each SQL query in sets of 50 rows.

HARETRIEVENUMROW 50

Notes

An important distinction exists between the purposes of HARETRIEVENUMROW and HAMAXQUERYROWS. Whereas HARETRIEVENUMROW affects memory consumption by controlling how many rows to process at one time, HAMAXQUERYROWS controls the number of total rows to return.

HARETRIEVENUMROW and HAMAXQUERYROWS should not be confused with QRYGOVEXECBLK which sets the maximum number of blocks that a query can access before the query is terminated.

See Also

HAMAXNUMSQLQUERY
HAMAXQUERYROWS



INCRESTRUC

INCRESTRUC specifies whether incremental restructuring is enabled for a database. You can enable incremental restructuring for individual databases or for all databases.

Syntax

INCRESTRUC [ appname [ dbname] ] TRUE | FALSE

appname Application name. Optional parameter for enabling incremental restructuring for one or all databases in an application. This parameter may be used in combination with dbname. If you omit appname, you cannot specify dbname, and INCRESTRUC will be enabled for all applications and databases. See Example below.
dbname Database name. Optional parameter for enabling incremental restructuring for an individual database. This parameter must be used in combination with appname. If you specify dbname, you must also specify appname. See Example below.
TRUE When you make certain outline or dimension changes that normally result in immediate database restructuring, Essbase defers restructuring until the next time it accesses the affected blocks. See Notes below.
FALSE Essbase immediately restructures the database whenever an outline or dimension change calls for it. The default value is FALSE (for all databases).

Description

INCRESTRUC specifies whether incremental restructuring is enabled for a database. You can enable incremental restructuring for individual databases, for all databases in an application, or for all databases on a server.

If you make certain outline or dimension changes that normally result in immediate database restructuring, Essbase defers restructuring until the next time the affected block is accessed, or until a full restructure is forced (e.g., by a full calculation). For example, if you add a member to any dimension, or delete a member from a dense dimension, Essbase defers restructuring when you enable INCRESTRUC.

Example

INCRESTRUC Sample Basic TRUE

causes Essbase to defer restructuring the Basic database in the Sample application, whenever certain outline or dimension changes are made, until the next time Essbase accesses the affected blocks; that is, it enables incremental restructuring for that database.

INCRESTRUC Sample TRUE

causes Essbase to defer restructuring for all databases in the Sample application, whenever certain outline or dimension changes are made, until the next time Essbase accesses the affected blocks; that is, it enables incremental restructuring for those databases.

INCRESTRUC TRUE

causes Essbase to defer restructuring all databases, whenever certain outline or dimension changes are made, until the next time Essbase accesses the affected blocks; that is, it enables incremental restructuring for all databases in all applications on that server.

INCRESTRUC FALSE

causes Essbase to immediately restructure all databases whenever an outline or dimension change calls for it; that is, it disables incremental restructuring for all databases in all applications on that server.

Notes

When Incremental Restructuring is enabled, Essbase defers restructuring if you change the database outline or a dimension in a way that does not cause structural changes.

The following changes result in incremental (deferred) restructuring:

Restructuring for Dynamic Calc members is different from restructuring for Dynamic Calc And Store members. In general, Dynamic Calc And Store members have a greater impact on restructuring.

The following changes result in immediate restructuring, regardless of whether Incremental Restructuring is enabled:

For more information about incremental restructuring, see the Database Administrator's Guide.



INDEXCACHESIZE

INDEXCACHESIZE defines the initial value for the index cache size for any new databases that are created after Essbase is restarted. The index cache is a buffer in memory that holds index pages. Essbase allocates this memory at startup of the database.

Syntax

INDEXCACHESIZE n

 n
  • An integer expressed in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G)
  • Minimum value: 1 megabyte (1 M)
  • Maximum value: 2 gigabytes (2 G)
  • Default value: 10 megabytes (10 M)
  • If a value is given without a B, K, M, or G qualifier, it is assumed the value is in bytes.
  • The qualifier can be in upper or lowercase and can be entered adjacent to the value (10M) or separated by a space (10 M).

Description

INDEXCACHESIZE specifies, in bytes, kilobytes, megabytes, or gigabytes, the size of the index cache for new databases on the server. The specified value takes effect for all new databases that are created after the server is started. To set or change the index cache size for an individual database, choose Database > Settings in the Application Manager and select the Storage tab, or issue SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.

Example

INDEXCACHESIZE 100M

causes Essbase to define the the index cache size of all subsequently created databases as 100 megabytes.



JVMMODULELOCATION

JVMMODULELOCATION pathToJVM specifies a Java Virtual Machine library.

Syntax

JVMMODULELOCATION pathToJVM

pathToJVM A fully-qualified path and filename of a Java Virtual Machine library to be used by Essbase

Description

JVMMODULELOCATION allows you to specify a specific Java Virtual Machine (JVM) library to be used by Essbase. This parameter is useful if you have more than one version of the JVM library installed on the computer running Essbase.

If you do not include this command in the essbase.cfg file, or if you include this command with an incorrect path and filename, Essbase searches the PATH (library path on UNIX systems) for a version of the JVM library and uses the first version that it finds. If you include this command without any parameters, Java Virtual Machine functions, including custom-defined macros and custom-defined functions in the Calculator module, are disabled in the product.

Example

JVMMODULELOCATION C:\Progra~1\JavaSoft\JRE\1.3\bin\hotspot\jvm.dll


// The following statement (with no parameters) disables JVM-dependent functions
JVMMODULELOCATION

The path name cannot include spaces. In essbase.cfg, a parameter is not followed by a semicolon. Do not enclose the path parameter in quotation marks.

Notes

For more information about setting up the Java Virtual Machine, see the Installation Guide.



LOCKTIMEOUT

LOCKTIMEOUT For newly-created applications, limits the amount of time a Spreadsheet Add-in user can hold an exclusive lock.

Syntax

LOCKTIMEOUT n

n A number of seconds. The default value is 3600 seconds (60 minutes).

Description

LOCKTIMEOUT specifies, in seconds, the maximum amount of time a Essbase Spreadsheet Add-in user can hold an exclusive lock on a block. This essbase.cfg setting specifies a default value for newly-created applications. To override this default value for a specific application, specify the Lock Timeout value in the Application Settings dialog box in Application Manager.

Example

LOCKTIMEOUT 300

For newly-created applications, causes Essbase to commit locked data and release the exclusive lock after the lock has been held for 300 seconds (five minutes).



LOGMESSAGELEVEL

LOGMESSAGELEVEL sets the message types that will be written to the application log.

Syntax

LOGMESSAGELEVEL INFO | WARNING | ERROR

Where INFO, WARNING, and ERROR are levels:

INFO When specified, all three types of messages are written to the application log. This is the default.
WARNING When specified, only Warning and Error messages are written to the application log.
ERROR When specified, only error messages are written to the application log. No Warning or Info messages are written to the application log.

Description

LOGMESSAGELEVEL enables the level of messages written to the application log to be specified.

Example

LOGMESSAGELEVEL WARNING 

This example sets the log message level to Warning. Only Warning and Error messages are written to the application log.

Notes

For more information about the application log, see the Database Administrator's Guide.

See Also

SETMSGLEVEL



LROONSHAREDMBR

LROONSHAREDMBR specifies whether shared members have Linked Reporting Objects that are unique from those of their corresponding regular members.

Syntax

LROONSHAREDMBR TRUE | FALSE

TRUE LROs related to regular members are unique, and not shared by shared members. The default is TRUE.
FALSE Shared members have the same LROs as corresponding regular members.

Description

A Linked Reporting Object (LRO) is an external file, cell note, or URL that you link to a cell in a Essbase database. Users can then retrieve the object from the Spreadsheet Add-in.
An LROONSHAREDMBR setting of TRUE tells Essbase to make shared member LROs unique from the LROs of regular members.
For example, assume the LROONSHAREDMBR option is FALSE. If you link an LRO to the data cell related to Diet Colas (100-20) under the parent member Colas (100), the corresponding data cell for Diet Colas (100-20) under the parent member Diet shares the same LRO.

Example

LROONSHAREDMBR FALSE

MAXLOGINS

MAXLOGINS specifies the limit on the number of user sessions that can be connected to the OLAP Server at any one time.

Syntax

MAXLOGINS n

n Any integer from 1 to 1048575 is valid. The default value is 1000.

Description

MAXLOGINS limits the maximum number of user sessions allowed to connect to the OLAP Server at any one time. This number includes multiple instances of the same user.

You may wish to adjust the value of MAXLOGINS to match computer resources, or to more closely manage concurrent ports and user sessions. A concurrent port is used for each unique combination of client machine, OLAP Server and login name. For example, the same user with five open Excel worksheets connected to the same OLAP Server use one port, but five sessions.

Example

MAXLOGINS 5000

This example increases the maximum number of simultaneous logins possible, from the default of 1000 to 5000.

Notes

See Also

SERVERTHREADS



MULTIPLEBITMAPMEMCHECK

MULTIPLEBITMAPMEMCHECK enforces the size limit for the amount of memory that is used for the calculator cache when Essbase selects the multiple bitmap cache option.

Syntax

MULTIPLEBITMAPMEMCHECK TRUE

Description

If the setting is present and its value is TRUE, then any time the memory limit is exceeded for the calculator cache in multiple bitmap cache mode, it will switch to single bitmap mode and enforce the size limit that you selected.

configuration setting is not present or has any other value than TRUE, then the limit is not strictly enforced, and your server process may grow too large.

Example

MULTIPLEBITMAPMEMCHECK TRUE

See Also

CALCCACHE



NETDELAY

NETDELAY specifies the network request delay time.

Syntax

NETDELAY n

n Integer value of 100 or above, expressed in milliseconds. The default value is 200 milliseconds.

Description

NETDELAY defines the network request delay time in milliseconds.This is the amount of time an unsuccessful operation waits before Essbase retries the operation.

Example

NETDELAY 500

See Also

NETRETRYCOUNT



NETNPCONNECTTIMEOUT

NETNPCONNECTTIMEOUT limits the amount of time a Named Pipes network continues to try to connect after an unsuccessful attempt.

Syntax

NETNPCONNECTTIMEOUT n

n Integer value, expressed in seconds. The default value is 30 seconds.

Description

NETNPCONNECTTIMEOUT limits the amount of time allowed a Named Pipes network to establish a connection to your server. This time period is usually greater than, and never less than, the product of NETDELAYmultiplied by NETRETRYCOUNT.

If NETNPCONNECTTIMEOUT value is exceeded, Essbase fails the connect attempt and reports an error.

Example

Assume NETDELAY = 200 and NETRETRYCOUNT = 600.

200 x 600 = 120,000 milliseconds.

To allow more time to connect, in this example the value is rounded up to 150,000 milliseconds (150 seconds):

NETNPCONNECTTIMEOUT 150

See Also

NETRETRYCOUNT
NETDELAY



NETRETRYCOUNT

NETRETRYCOUNT specifies the number of times the network will retry a connection.

Syntax

NETRETRYCOUNT n

n An integer value.
The default value is 600 retries.
The minimum value is 300.

Description

NETRETRYCOUNT specifies the number of times the network will retry a connection before failing and reporting an error.

Example

NETRETRYCOUNT 400

causes the network to attempt connection 400 times before reporting an error.

See Also

NETDELAY
NETNPCONNECTIMEOUT



NODENAME

NODENAME identifies the server where your Essbase application runs.

Syntax

NODENAME server_name

server_name The name of the server where your Essbase application runs.
NODENAME uses the current server by default.

Description

NODENAME identifies the server where your Essbase application runs. You must specify a NODENAME setting on Named-Pipe networks. If you specify a NODENAME setting on TCP/IP, the value must be a name in the host file or a TCP/IP address. If you use another value for NODENAME and try to use this value to log into Essbase, Essbase cannot log you in and will display an error.

Notes

Example

NODENAME ARBOR1

identifies the server named "ARBOR1" to Essbase.



NOMSGLOGGINGONDATAERRORLIMIT

NOMSGLOGGINGONDATAERRORLIMIT prevents data load or dimension build errors from being written to the application log after the limit described by the value of DATAERRORLIMIT is reached.

Syntax

NOMSGLOGGINGONDATAERRORLIMIT TRUE | FALSE

The default value is FALSE.

Description

DATAERRORLIMIT controls the maximum number of error messages written to the data load error log per data load and the dimension build error log per dimension build. This configuration setting, NOMSGLOGGINGONDATAERRORLIMIT, stops any data load or dimension build error messages from being written to the application log after the DATAERRORLIMIT value has been reached.

The default value for DATAERRORLIMIT is 1000, so if you do not set DATAERRORLIMIT, only the first 1000 errors will be written to the data load error log or the dimension build error log.

Example

DATAERRORLIMIT 50000
NOMSGLOGGINGONDATAERRORLIMIT TRUE

This sets the limit on data load or dimension build error messages written to the error log at 50,000, and further prevents any error messages after the first 50,000 from being written to the application log.

See Also

DATAERRORLIMIT



NUMERICPRECISION

NUMERICPRECISION defines the number of precision digits used by the Essbase Report Writer for numerical comparison.

Syntax

NUMERICPRECISION n

n Number of precision digits to be considered in the numerical comparison.
Acceptable values for n are -1 through 15. A value of -1 causes Essbase to perform a full comparison.
The default value is 4.

Description

NUMERICPRECISION defines the number of precision digits used by the Essbase Report Writer for numerical comparison.

The numeric comparison function subtracts one value from the other, and compares the absolute value of the result with 10- n. If 10- n is greater than the absolute value of the subtraction result, the numbers are equal.

Example

Suppose we compare the values 3.289999 and 3.290000 with a numeric precision of 2:

NUMERICPRECISION 2

Is 3.289999 == 3.290000 given a numeric precision of 2?

| 3.289999 - 3.290000 | = 0.000001 (the absolute value)

10-2 = 0.01

0.01 > 0.000001, so the numbers are equal.

Notes

See Also

RESTRICT Report Writer Command



OUTLINECHANGELOG

OUTLINECHANGELOG logs all outline changes into the file database_name.olg. OUTLINECHANGELOG allows database administrators to review the outline revision history and gather enough information to roll back changes if needed.

Each Essbase database contains a separate outline change log file in the same location as the database. The file is stored in the database directory on the server.

The data format of the outline change log is:

Syntax

OUTLINECHANGELOG TRUE | FALSE

TRUE Essbase logs outline changes into the file database_name.olg.
FALSE Essbase does not log outline changes. The default is FALSE.

Notes



OUTLINECHANGELOGFILESIZE

OUTLINECHANGELOGFILESIZE sets the maximum file size of the outline change log in bytes. When the outline change log reaches the maximum file size, Essbase copies the contents of the file to a separate backup file with the same name as the outline change log file (database_name.olg), but with an . olb extension.

Syntax

OUTLINECHANGELOGFILESIZE n

n Number of bytes to allocate for the change log. The default is 64,000 bytes. The minimum is 8,092 bytes. The maximum is 2 megabytes.

Notes



PIPEBUFFERSIZE

PIPEBUFFERSIZE defines the size of the buffer used for communication between Essbase Spreadsheet Extractor and Report Writer.

Syntax

PIPEBUFFERSIZE n

n Integer value from 2,048 to 65,534, expressed in bytes.
The default value is 4K (4,096 bytes).

Description

PIPEBUFFERSIZE defines the size of the buffer used for communication between Essbase Spreadsheet Extractor and Report Writer on the network.

Example

PIPEBUFFERSIZE 20000

defines a 20-kilobyte buffer to store pipes.



PORTINC

PORTINC specifies the value of the increment in between port numbers used by the Agent.

Syntax

PORTINC n

n The value of n specifies the increment between port numbers that the Agent used to try and find an available port. The default value is 1.

Description

PORTINC specifies the increment value between ports used by the Agent when it tries to find an available port.

You may wish to change the default for many reasons. These are two common reasons:

Example

AGENTPORT 1478
SERVERPORTBEGIN 32470
SERVERPORTEND 32600
PORTINC 5

This example would produce these results:

Notes

See Also

AGENTPORT
SERVERPORTBEGIN
SERVERPORTEND



QUICKLOGIN

Enables Essbase to start with parallel login processing.

Syntax

QUICKLOGIN

Description

QUICKLOGIN improves performance enabling parallel login processing during startup. This ensures that the security file is cached and written to disk at specified time intervals.

Notes

An alternative to enabling parallel login processing in the configuration file is to issue individual Essbase startup commands with the quicklogin option:

essbase password -quicklogin -b 


QRYGOVEXECBLK

QRYGOVEXECBLK sets the maximum number of blocks that a query can access before the query is terminated.

Syntax

QRYGOVEXECBLK [appname [dbname]]

appname This optional parameter applies the query block limit to the application specified. If you specify appname, you must also specify a value for n, or OLAP Server ignores QRYGOVEXECBLK. If you do not specify an application, you cannot specify a database, and the query block limit applies to all applications and databases on the server. If you specify a value for appname and do not specify a value for dbname, the query time limit applies to all databases in the specified application.
dbname This optional parameter must be used with appname and n, or OLAP Server ignores QRYGOVEXECBLK. If you specify dbname, appname, and n, the query block limit is applied only to the specified database.
n The value of n specifies the number of blocks that OLAP Server allows a query to access before the query is terminated. You must specify this parameter or the server ignores QRYGOVEXECBLK. If you do not specify appname or dbname, the query block limit applies to the entire server.

Description

QRYGOVEXECBLK specifies the maximum number of blocks that a query can retrieve before OLAP Server terminates that query (a request for information sent to a database). You can apply this setting to an entire server, to all the databases in a single application, or to a single database.

When a query exceeds the block limit and is terminated, an error message is written to the application log of the application accessed for the query.

Restarting OLAP Server after adding or changing this setting activates the new setting values.

Use QRYGOVEXECBLK to prevent these types of queries:

Use QRYGOVEXECBLK, for example, if you have users who try to retrieve so much data in a single query that their query appears to hang for minutes at a time. A query launched against the database involving attribute dimensions, for example, may be larger than the user realizes.

Example

QRYGOVEXECBLK Sample Basic 3

This example sets three blocks as the maximum number of blocks that a query to Sample Basic can access before being terminated. A block is created for each unique combination of sparse dimension members. If a user issues a query that accesses four unique combinations of sparse dimensions, OLAP Server terminates the query and writes a message to the application log.

QRYGOVEXECBLK 5

This example sets five blocks as the maximum number of blocks that a query can access before being terminated. The query time limit applies to all applications and databases on OLAP Server that correspond to the essbase.cfg file containing this setting.

Notes

See Also

QRYGOVEXECTIME
HAMAXQUERYROWS
HAMAXQUERYTIME

For more information about the application log, see the Essbase Database Administrator's Guide.



QRYGOVEXECTIME

QRYGOVEXECTIME sets the maximum amount of time a query can use to retrieve and deliver information before the query is terminated.

Syntax

QRYGOVEXECTIME [appname [dbname]] n

appname This optional parameter applies the query time limit to the application specified. If you specify appname, you must specify a value for n, or OLAP Server ignores QRYGOVEXECTIME. If you do not specify an application, then you cannot specify a database, and the query time limit applies to all applications and databases on OLAP Server. If you specify a value for appname and do not specify a value for dbname, the query time limit applies to all databases in the specified application.
dbname This optional parameter must be used with appname and n, or OLAP Server ignores QRYGOVEXECTIME. If you specify dbname, appname, and n, the query time limit is applied only to the specified database.
n The value of n specifies the number of seconds that OLAP Server allows a query to run before the query is terminated. You must specify this parameter or OLAP Server ignores QRYGOVEXECTIME. If do not specify appname or dbname, the query time limit applies to the entire server.

Description

QRYGOVEXECTIME specifies the maximum amount of time that a query can run before OLAP Server terminates the query (a request for information sent to a database). You can apply this setting to an entire server, to all the databases in a single application, or to a single database.

When a query exceeds the time limit and is terminated, an error message is written to the application log of the application accessed for the query.

Restarting OLAP Server after adding or changing this setting activates the new setting values.

Use QRYGOVEXECTIME to prevent these types of queries:

Use QRYGOVEXECTIME, for example, if you have users who try to retrieve so much data in a single query that their query appears to hang for minutes at a time.

Example

QRYGOVEXECTIME Sample Basic 20

This example sets 20 seconds as the maximum time that a query can run before being terminated. In this example the restriction applies only to the Basic database in the Sample application.

QRYGOVEXECTIME 45

This example sets 45 seconds as the maximum time that a query can run before being terminated. The query time limit applies to all applications and databases on the server that correspond to the essbase.cfg file containing this setting.

Notes

See Also

QRYGOVEXECBLK
HAMAXQUERYROWS
HAMAXQUERYTIME

For more information about the application log, see the Essbase Database Administrator's Guide.



REPTKBYTEBUF

REPTKBYTEBUF is no longer used in essbase.cfg. This setting is now called Retrieval Buffer Size and must be set on a per-database basis. To set or change this setting, use the Application Manager Database Settings dialog box, or issue SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.



REPTKBYTESORTBUF

REPTKBYTESORTBUF is no longer used in essbase.cfg. This setting is now called Retrieval Sort Buffer Size and must be set on a per-database basis. To set or change this setting, use the Application Manager Database Settings dialog box, or SetDbStateItem in ESSCMD. For more information, see the online help or HTML documentation for those items.



SERVERPORTBEGIN

SERVERPORTBEGIN specifies the first port number the Agent will try to use for its first server process.

Syntax

SERVERPORTBEGIN n

n The value of n specifies the port number that the Agent will try to use for its first server process. This port number should not be in use by any other process. The default value is 32768.

Description

SERVERPORTBEGIN specifies the first port that the Agent will try to use for the first server process it tries to start.

You may wish to change the default for many reasons. These are two common reasons:

Example

AGENT PORT 1478
SERVERPORTBEGIN 32470
SERVERPORTEND 32600
PORTINC 5

This example would produce these results:

Notes

See Also

AGENTPORT
SERVERPORTEND
PORTINC



SERVERPORTEND

SERVERPORTEND specifies the highest value Essbase will try to use for a port when it tries to start a server process. If the value is unavailable, the server process will fail.

Syntax

SERVERPORTEND n

n The value of n specifies the highest value for a port number that the Agent will try to use for a server process. If the port is unavailable, the server process will fail. This port number should not be in use by any other process. The default value is 33768.

Description

SERVERPORTEND specifies the highest port number that the Agent will use when trying to start a server process.

You may wish to change the default for many reasons. These are two common reasons:

Example

AGENT PORT 1478
SERVERPORTBEGIN 32470
SERVERPORTEND 32600
PORTINC 5

This example would produce these results:

Notes

See Also

AGENTPORT
SERVERPORTBEGIN
PORTINC



SERVERTHREADS

SERVERTHREADS overrides the default value for the number of threads the Server Application may spawn. The default value is defined by the number of licensed ports. Use this setting to make the maximum number of threads higher than the default value. See Notes below.

Syntax

SERVERTHREADS n

n The number of threads the Server Application may produce.
Specify an integer between 20 and 500, inclusive. If you use the .CFG setting to specify a number lower than 20, it is interpreted as 20. If you use the .CFG setting to specify a number higher than 500, it is interpreted as 500.
Important: see Notes below.

Description

SERVERTHREADS overrides the default value for the number of threads the Essbase Server may spawn.

When a transaction is requested, the Server Application assigns a thread to the transaction and releases the thread when the transaction is complete.

Example

SERVERTHREADS 25

Notes

Number of licensed ports Default number of threads
5 or fewer 5
6 - 11 10
11 or more 20

See Also

AGENTDELAY
AGENTTHREADS



SSAUDIT, SSAUDITR

SSAUDIT and SSAUDITR enable spreadsheet update logging. The two settings are identical in function except that SSAUDITR automatically clears update logs after archiving, and SSAUDIT appends logs after archiving. The ENDARCHIVE ESSCMD command signals SSAUDITR to clear the log.

Syntax

The syntax is identical for both settings, so this section uses SSAUDIT for syntax description.

SSAUDIT appname [ dbname [ log_path] ]

appname Application name.
dbname Database name. Optional.
log_path Full directory path where you want the information stored. Optional. Do not provide a log_path value unless you have also provided a value for dbname.

Default behavior:

Use the value xxxxx to indicate "all" for any argument.

You can issue up to ten (total) SSAUDIT and SSAUDITR statements per application.

Description

SSAUDIT enables Essbase to log successfully completed spreadsheet update transactions. The resulting logs can be used as a source of input data upon recovery after archive operations or other server interruptions.

Example

SSAuditR demo

enables logging with refresh (clear) for all databases belonging to the Demo application. The log is stored in the default directory.

SSAudit xxxxx xxxxx c:\sslog

enables logging for all applications and databases, storing the log in the path c:\sslog. This example assumes that you do not have duplicate database names (see Notes below).

Notes

See Also

BEGINARCHIVE (ESSCMD)
ENDARCHIVE (ESSCMD)
The Database Administrator's Guide



SSLOGUNKNOWN

SSLOGUNKNOWN controls whether Essbase logs error messages when it encounters an unknown member name during a spreadsheet operation.

Syntax

SSLOGUNKNOWN TRUE | FALSE

TRUE Essbase displays and logs an error message for each unknown member name that it encounters during a spreadsheet operation. The default is TRUE.
FALSE Essbase does not display error messages when it encounters unknown member names.

Description

SSLOGUNKNOWN controls whether Essbase logs error messages when it encounters an unknown member name during a spreadsheet operation. It enables you to get a specific list of every unknown member name, or to repress error messages of this type.

Example

SSLOGUNKNOWN TRUE

causes Essbase to generate and log an error message each time it encounters any number of unknown member names during a spreadsheet operation.

Notes

SSLOGUNKNOWN creates an entry in the application log, application_name.log, in the application directory.

See Also

CLEARLOGFILE
TIMINGMESSAGES



SSPROCROWLIMIT

SSPROCROWLIMIT specifies the maximum number of spreadsheet rows the server processes on a user spreadsheet request.

Syntax

SSPROCROWLIMIT n

n An integer value between 16,384 and 500,000, inclusive.
The default value is 250,000.

Description

SSPROCROWLIMIT specifies the maximum number of spreadsheet rows the server processes on a user request. This value is taken before suppression; that is, it includes missing rows and rows containing zero values. Note that the rows processed limit is not the same as the rows displayed limit. SSPROCROWLIMIT does not limit the number of rows displayed in the spreadsheet. The maximum number of rows that can be displayed is determined by the limits defined in Excel and Lotus. For example in 32-bit Excel, if you set the SSPROCROWLIMIT value to 20,000, the spreadsheet may still return more than 20,000 rows because in Excel the maximum number of rows that can be displayed is 64,000.

This setting enhances performance by preventing excessive memory consumption by spreadsheet operations.

Example

SSPROCROWLIMIT 300000

Notes




SUPNA

SUPNA specifies whether the Suppress #Missing Rows option in the Essbase Spreadsheet Add-in suppresses the display of cells for which a user has no access (in addition to suppressing #MISSING rows).

Syntax

SUPNA ON | OFF

ON The Suppress #Missing Rows option in the Essbase Spreadsheet Add-in suppresses the display of cells for which a user has no access.
OFF The Suppress #Missing Rows option in the Essbase Spreadsheet Add-in does not suppress the display of cells for which a user has no access. The default is OFF.

Description

The Suppress #Missing Rows option in the Essbase Spreadsheet Add-in (Essbase Options dialog box, Display page) suppresses the display of data rows that contain only missing values. SUPNA specifies whether or not Essbase also suppresses the display of cells for which a user has no access. The Spreadsheet Add-in does not provide an equivalent for the SUPNA option.

Example

SUPNA ON

Essbase suppresses cells for which a user has no access, in addition to suppressing rows that contain only missing data.

SUPNA OFF

Essbase does not suppress cells for which a user has no access. These cells appear in the spreadsheet as #NoAccess. Only rows that contain missing data are suppressed.



TIMINGMESSAGES

TIMINGMESSAGES controls whether Essbase logs the duration of each spreadsheet and report query in the application log.

Syntax

TIMINGMESSAGES TRUE | FALSE

TRUE Essbase logs these items:
  • The duration of all spreadsheet and report queries in the application log.
  • The log also records a timestamp of the query's execution.
  • Messages about dynamic calculator cache usage for each data retrieval.
The default setting is TRUE.
FALSE Essbase does not log these items:
  • The duration of all spreadsheet and report queries in the application log.
  • The log also records a timestamp of the query's execution.
  • Messages about dynamic calculator cache usage for each data retrieval.

If you have not created a .CFG file, or if you do not have this parameter specified in your .CFG file, Essbase automatically records and logs the duration of queries in the application log. You must set TIMINGMESSAGES to FALSE to disable this feature.

Description

TIMINGMESSAGES controls whether Essbase logs the duration of each spreadsheet and report query in the application log. Setting TIMINGMESSAGES to FALSE disables the logging of query durations in the application log. If the timing of queries is disabled, Essbase does not have to communicate with the operating system to get query start and finish times. As a result, query execution times may be improved in environments with many concurrent users. Disabling this parameter also decreases the size of the application log.

Example

TIMINGMESSAGES TRUE causes Essbase to time and log the duration of queries in the application log. For example: [Thu Mar 19 14:55:32 1998]Local/Sample/Basic/admin/Info(1020055) Spreadsheet Extractor Elapsed Time : [0.078] seconds

TIMINGMESSAGES FALSE

disables the logging of query durations.

See Also

SSLOGUNKNOWN



UPDATECALC

UPDATECALC specifies whether intelligent calculation is turned on or off by default.

Syntax

UPDATECALC TRUE | FALSE

TRUE Intelligent calculation is turned on. Essbase calculates only updated blocks and their dependent parents.
FALSE Intelligent calculation is turned off. Essbase calculates all data blocks, regardless of whether they have been updated.

Description

UPDATECALC specifies whether intelligent calculation is turned on or off by default.

If required during a calculation, you can override this default setting and turn intelligent calculation on and off using the SET UPDATECALC command in a calculation script.

Using intelligent calculation, Essbase calculates only updated data blocks and their dependent parents. Therefore, the calculation is very efficient.

Example

UPDATECALC TRUE
UPDATECALC FALSE

In essbase.cfg, a parameter is not followed by a semicolon; in a calculation script, a parameter must be followed by a semicolon.

Notes

See Also

SET CLEARUPDATESTATUS (calculation command)
SET UPDATECALC (calculation command)


 

Copyright 1991-2002 Hyperion Solutions Corporation. All rights reserved.