Object Parameters

Parameters enable the user to dynamically generate object contents. For example, on creating a calendar dictionary you may not determine specific start and end dates. When such a dictionary is opened, its start and end date are determined by the user. Parameterized objects enable the user to set up parameter control in such a way that one object controls parameters of another object, and so on. For example, selection in the territory dictionary may affect the contents of organization dictionary.

Foresight Analytics Platform supports the following parameter types: string, integer, float, date/time, and custom.

General appearance of the Object Parameters page using the example of the Dictionary object:

Click the Add button.
Double-click the free space of parameter list.

The Object Parameter Properties dialog box opens:

All fields of the dialog box are set to default values.

Determine the following attributes to create a new parameter:

Name. Parameter name
Identifier. A sequence of Latin letters, numbers, and underscore characters starting with a letter. An identifier must be unique within the object.
Data Type. Select one of the available types in the drop-down list.
Default Value. If required, set default parameter value. Features of default value for the following data types:

String. It may contain up to 2 Gb of data. String text is specified without quotes.
Integer. An integer number is allowed in the range [-2147483648; 2147483647].
Decimal. A decimal number with no more than 28 places after the point in the range [-179228162514264337593543950335; 179228162514264337593543950335].
Real. A real number is allowed in the range [-5.0 x 10-324; 1.7 x 10308].
Date. Minimum date - 1 January 100 year (AD) 00:00:00, maximum date - 31 December 9999 year (AD) 23:59:59.
Custom. A set of unstructured data is allowed that is an array of binary or character data. Values of parameters that have a custom data type can be passed only when working with an object in application code.

Display Parameters. Select appearance and behavior for the parameter value editor. Display parameters are determined as a special string containing editor type, default value, and so on. The string can be edited directly in the input box or using the Value Editor Parameters dialog box. To open the dialog box, click the button. By default, display parameter is selected in accordance with the selected parameter type.

Click the Edit button.

Double-click the parameter in the list.

The Object Parameter Properties dialog box opens.

Click the Delete button.

Press CTRL+DELETE.

Deletion confirmation appears. Click the Yes button to delete parameter.

Opening Parametric Object

The appearance of the parameter edit boxes depends on parameter type. If a default value has been determined for the parameter, the value is displayed in the corresponding box.

Enter or select (depending on parameter type) values for other parameters and click the OK button.

NOTE. On working with object parameters, the last entered values are automatically saved. On the next opening of the object the saved parameters values are displayed.