Calculation Commands Overview

Within Hyperion Essbase, calculation scripts (or "calc" scripts) are used to define calculations that differ from those defined in the database outline. Calculation scripts, as described in the Database Administrator's Guide, can calculate either all or part of a database, rather than the whole-database calculation required by the outline.

Calculation commands and functions are defined within a calculation script to instruct Hyperion Essbase in the exact calculation rules to be used. You can use the Calc Script Editor to create a calc script. Within the Calc Script Editor, a dialog box is available that allows you to paste calculation commands, functions, and operators while you develop formulas. For more information, see the Database Administrator's Guide.

Command Overview

When a database is created, an internal default calculation script is set to CALC ALL;, which means that it calculates all dimensions based on the database outline's hierarchical relationships and formulas.

You can override this default calc script at any time by using a custom calc script. You can override the default script either on a temporary or permanent basis, without actually altering the default script. In the custom calc script, you can refer to calculation rules defined in the database outline or you can specify entirely new formulas, calculation formats, and calculation orders.

A calc script can contain a series of calculation commands. The order of the commands defines the execution order of the calculation.

Calc script commands can be categorized as follows:

Data Declaration Commands

These commands are used to declare, and set the initial values of, temporary variables. The values stored in a variable may not be directly returned from a spreadsheet, because they only exist while the calc script is being processed. If you want to report these values, you need to create members within the database outline, or assign the values from the variables to existing members.

Control Flow Commands

Control Flow commands are used to iterate a set of commands or to restrict the commands' effect to a specified subset of the database. These commands are used to control the calculation flow of a calc script. The FIX...ENDFIX command can be used to restrict a calculation to a particular member or members, while the LOOP...ENDLOOP command allows you to repeat a command as necessary.

Computation Commands

Computation commands are used to perform operations such as calculation, data copying, clearing data, and currency conversion.

Member Formulas

Member Formulas are used to calculate the default outline format on a custom formula within the script.


Copyright (c)1991-2000 Hyperion Solutions Corporation. All rights reserved.