Connecting Custom Functions

Custom functions and methods can be used to enhance expression capabilities due to the use of custom calculation methods. Custom functions are available for use:

Custom functions are not connected to the tools by default. They should be entered manually each time to be used. Foresight Analytics Platform enables the user to connect custom functions to system functions in all tools defined above.

NOTE. Connecting custom functions is available for the users included in the Administrators group.

For example, in the expression editor custom functions are displayed on the functions panel in the Custom Functions category:

To connect custom functions, use the Methods tab in the Custom Metadata section of the Parameters dialog box. All methods added on this tab will be connected to the custom functions section in the Foresight Analytics Platform tools.

The Methods tab contains custom functions grouped by folders. Folders are categories that are used to arrange and group functions.

NOTE. A custom function should have a unique name. If after a unit or assembly is selected that contains a function, which name matches with any function or system method or function added before, an exception is thrown. The use of such a unit or assembly will be unavailable.

To add a category:

In the web application select the Category item in the drop-down menu of the Add button.
In the desktop application:

Select the Category item in the drop-down menu of the Add button.
Select the Add Category method item in the context menu of the list of methods.

The category will be added to the Methods tab. If required, change category name.

Note that the category cannot be added to another category.

To add a method:

Select category, to which the method will be added. If no category is selected, the method will be added without category.
Add a method:

In the web application select the Method item in the drop-down menu of the Add button.
In the desktop application:

Click the Add button.
Select the Method item in the drop-down menu of the Add button.
Select the Add method item in the context menu of the list of methods.

The method will be added to the selected category on the Methods tab. Set up the method and rename it if required.

NOTE. To connect a custom function using the Fore language, use the IForeMethods.Add method.

To set up method:

In the web application click the Actions button next to the method and select the Settings item. The Method Settings dialog box opens:

In the desktop application determine method settings in the corresponding boxes.

Set the parameters:

Assembly, Unit or Form. Select a Fore form, unit, or assembly in the drop-down list.
Method. Select the procedure or function that implements the method in the drop-down list. The list contains all available procedures and functions from the object selected in the Assembly, Unit or Form list.
Type. Select method type in the drop-down list:

Arithmetic. It is used by default. It is used to calculate single values.
Pointwise. Each data series point is calculated individually.
Series. The entire data series is calculated.

Note that the method type is used for its classification and not to determine method calculation mode. The calculation mode is predefined and depends on the tool in use.

NOTE. The Modeling and Forecasting tool provides only series methods.

Description. Specify brief description for a method that will be visible to the user. The description is displayed in the expression editor, function wizard in the Reports tool and formula editor in the Calculation Algorithms tool.

If the method is parametric, one can set up method parameters.

To set up method parameters:

In the web application click the Actions button next to the method and select the Parameters item. The Parameters dialog box opens:

In the desktop application:

Click the Parameters button.
Select the Method Parameters item in the method's context menu.

The Parameters dialog box opens:

The dialog box contains the list of all method parameters:

Data Type. The box displays the parameter's data type specified in the method. Parameter's data type cannot be changed.
Value. Set default parameter value. The specified value's data type should match the parameter's data type. If on creating a method, the default value was set for the parameter, it will be displayed in the Value box. This value can be changed.
Description. Specify brief description for the parameter, which will be visible to the user. The description is displayed in the expression editor, function wizard in the Reports tool and formula editor in the Calculation Algorithms tool.

To rename the selected method or category:

In the web application:

Click the Actions button next to the method and select the Rename item.
Double-click the method or category name.

In the desktop application:

Press F2.
Select the Rename context menu item.
Click the method or category.

The name will be opened for edit. Enter a new name of method or category and press the ENTER key.

To set up order of the selected method or category:

Use the Up and Down buttons.
Move up or down a method or category in the list. Use this method to change method category.

Note that the category cannot be added to another category.

To delete the selected method or category:

In the web application:

Click the Delete button.
Click the the Actions button next to the method or category and select the Delete item.

In the desktop application:

Click the Delete button.
Select the Delete item in the method or category's context menu.
Press CTRL+DELETE.

A confirmation dialog box opens. If the answer is positive, the method or category will be deleted. If the category contained methods, they will be kept and moved to the list of methods without category.

Connecting Custom Functions

Example of Custom Function Syntax