The Calculated Facts Page: Standard Cube

The Calculated Facts page is used to set formulas for calculated facts. Calculated facts is a function from values of other facts, calculated facts or relations.

Web application Desktop application

To specify or change a formula, execute one of the operations:

In the web application:

Select the calculated fact and select the Calculated Fact Formula item in the drop-down menu of the Actions button next to the fact.
Click the formula.

In the desktop application:

Double-click the calculated fact.
Select a calculated fact and click the Edit button.

After executing the operations the Calculated Fact Formula dialog box opens in the web application or the Calculated Fact dialog box opens in the desktop application.

Web application Desktop application

Set the parameters:

Formula. Enter the expression, by which calculated fact value will be calculated, using the keyboard or create it in the expression editor. To do this:

In the web application click the Insert Formula button.
In the desktop application click the Insert Formula button.

After executing one of the operations the Calculated Fact Formula/Expression Editor dialog box opens. To create an expression, one can use existing cube parameters, relations, facts and special functions.

As a formula value, one can also specify the path to a user function that will be used to calculate the calculated fact value. The path in the following format: [<unit/form identifier>].[<function name>]. Access to the cube data, which can be used to calculate values, is executed by the CubeClass class.

Calculated by Physical Data. Select the checkbox to calculate the specified formula by physical data: first, the matrix with source data will be estimated which is extracted according to the specified selection, then the calculation is executed only in the points with data.

NOTE. The selected checkbox affects the calculation of cube relations if the relation is set as a custom function. For example, if the ForeVariantType.Matrix array containing integer values is set as an input T parameter, the custom function also process and return array of integer values on relation calculation.

If the checkbox is deselected, the calculation will be executed according to the specified dimension selection: calculation in each point of obtained Cartesian product of selected elements.

Features of calculated fact calculation:

If a calculated fact formula uses special functions (DIF, FIL, SUM, and so on), the calculated fact value will be calculated only at the points with required data in the source matrix.
If a calculated fact formula uses relations that execute shift or take specific fact value, the calculated fact value will be calculated only at the points with required data in the source matrix.
If shift must be executed from the selection that is not contained in the matrix, the value is not calculated.

Always Insert to Selection. Select the checkbox to include the calculated fact during cube output matrix calculation. The checkbox does not affect the visual selection on working with a cube in various tools of Foresight Analytics Platform, and it is relevant on working with a cube on application macros that calculate the cube and work with cube data. The calculated facts, for which the checkbox is selected, are always calculated on calculation of output cube matrix. If the checkbox is deselected, the calculated fact is calculated if it is included in the selection in the application macro.
Permit Data Editing. Select the checkbox to change other fact value and set additional parameters:

Fact. Select the cube fact, which value will be changed, in the drop-down list.
Formula. To create the expression, according to which value of the fact selected above will be changed, click the Insert into Formula button. The expression editor opens. If a formula is not specified, changed values of the calculated fact are not saved to the cube.

NOTE. The parameter is available only in the desktop application.

Lags are used for correct calculation of cube facts.

NOTE. It is available only in the desktop application if a calendar dimension is set in the cube.

To set lags, click the Set Lags button. The Calculated Fact Lags dialog box opens:

Set the parameters:

Calendar Level. Select calendar level in the drop-down list.
Backward Lag. When this parameter is set, the selection by the corresponding calendar level is increased backwards; the default value is 0.
Forward Lag. When this parameter is set, the selection by the corresponding calendar level is increased forward; the default value is 0.

Expression Editor

Formulas can be set up using the expression editor:

The expression editor in the desktop application is uniform for all platform tools and objects. Description of the uniform expression editor is given in the Creating Formulas and Expressions document.
The expression editor in the web application differs depending on the configured tool or object.

The expression editor window for setting up calculated facts of standard cube in the web application looks as follows:

Operands, arithmetic operations, functions, numbers, comparison characters and round brackets can be used in a formula. There are some features of use:

All element types, except for numbers, can be inserted both using the keyboard or special panels.
Numbers are inserted only using the keyboard.

Operands are displayed on the expression editor's operands panel:

The following is used as operands:

To insert an operand to the formula area, execute one of the operations:

Using the operands panel:

Select the operand and click the Insert into Formula button.
Double-click the operand.
Drag the operand to the formula area.

Using the formula area:

Enter the operand name in the formula area.
Click in the formula area in the place where the operand should be put, press CTRL+SHIFT and select the required operand on the pop-up panel.

To quickly search for an operand, start typing partial or full name of the operand in the search string. After executing the operation the operands panel displays the operands, which names satisfy search conditions.

To set up displaying of the operands list, use items in the drop-down menu of the Display Settings button:

Name. Default value. Only operand names are displayed.
Identifier. Only operand identifiers are displayed.
Name and Identifier. Operand names and identifiers are displayed in the format: <name> (<identifier>).

To hide the operands panel, click the Hide Operands Panel button. To show the panel, click the Show Operands Panel button.

Functions and statements are displayed on the functions and statements panel on the corresponding tabs:

To set up calculated facts, along with standard functions, one can use special functions.

To insert a function or a statement to the formula area, execute one of the operations:

Using the functions and statements panel:

Select the function or statement. The panel with description opens:

Click the Insert to Formula button.

Double-click the function or statement.
Drag the function or statement to the formula area.

Using the formula area:

Enter the function or statement in the formula area.
Click in the formula area where the function or statement should be inserted, press CTRL+SHIFT and select the required function or statement on the pop-up panel.

To quickly search for a function or statement, start typing partial or full name of the function or statement in the search string. After executing the operation the functions and statements panel displays the functions or statements, which names satisfy search conditions.

To hide the functions and statements panel, click the Hide Functions and Statements Panel button. To show the panel, click the Show Functions and Statements Panel button.