Adding Parameters

To work with the tool in Foresight Analytics Platform 10, use the new interface.

Adding Parameters

To set parameter values that will be used on algorithm calculation, use the parameters panel. The order of parameters display on this panel matches with the order of parameters on the Parameters tab in the Calculation Algorithm Parameters dialog box.

If a calculation algorithm is located in a container or business application, the Parameters tab displays the Use Repository Objects checkbox. The checkbox is deselected by default, and when adding a parameter, one can use as its properties only the repository objects contained in the corresponding container or business application. To use any repository objects as parameter properties, select the Use Repository Objects checkbox.

Add a new or existing parameter.

To add a new parameter:

Click the Add button.
Double-click the empty space of the list of parameters.

The Object Parameter Properties dialog box opens, in which determine parameter settings.

To add existing parameter from another block:

Open a drop-down menu of the Add button. The list containing blocks with parameters will be displayed.
Select a block which parameter must be added to calculation algorithm. List of block parameters will be displayed.
Select one of the parameters.

As a result the parameter, which settings exactly match settings of the selected parameter, will be added to calculation algorithm. Added parameter of calculation algorithm and selected block parameter will be automatically linked.

Edit parameter

Change parameters order

Delete parameter

Setting Up Parameter

A parameter can be set up in the Object Parameter Properties dialog box:

Specify:

Name. A parameter name should be meaningful and explain parameter functionality. The property is mandatory.
Identifier. A parameter identifier should be unique. An identifier should consist of Latin letters. It may contain numbers and underscore characters, and must start with a letter. The property is mandatory.
Parameter Type. Select parameter type:

Selection. Default. Dictionary selection is used as a parameter value.
Hierarchy. Dictionary alternative hierarchy is used as a parameter value.
String. A character string is used as a parameter value.
Integer. An integer number is used as parameter value.
Real. A real number is used as a parameter value.
Date. A date is used as a parameter value.

NOTE. Parameter type can be changed only on creating a parameter.

Source. If required, select the cube containing controlling dimensions that control elements of other dimensions in this cube. The box is available only for the parameters of the Selection and Hierarchy types.

NOTE. After selecting the cube the Dictionary drop-down list will contain only the dictionaries included in the selected cube.

If the dictionary is not displayed in the controlling dimensions list but is included in the cube, dictionary selection or alternative hierarchy is used as parameters values. This dictionary can be selected in the Dictionary drop-down list without specifying the cube in the Source drop-down list.

If the dictionary is displayed in the controlling dimensions list and is a controlled or controlling or controlled and controlling at the same time, add all cube controlling dimensions as calculation algorithm parameters and set selection by the controlling dimension to display dictionary elements selection in the parameter.

Dictionary. Select the dictionary, to which the parameter is linked. Dictionary selection or alternative hierarchy will be used as parameter values. The box is available only for the parameters of the Selection and Hierarchy types, and it is mandatory for them.

NOTE. If a cube is selected in the Source drop-down list, the Dictionary drop-down list displays only the dictionaries contained in the selected cube.

Default Value. Select the default parameter value in the drop-down list or enter it by means of keyboard.

NOTE. If a link with cube parameter is set for the parameter on the parameters panel, parameter's selection will be reset on the parameters panel if the default parameter value changes.

Show on Parameters Panel. Deselect the checkbox to hide the parameter on the parameters panel. The default parameter value will be used during algorithm calculation. The checkbox is selected by default, parameter values can be changed on the parameters panel before algorithm calculation.