In this article:

Setting Up Basic Properties and Parameters of Step Description

Setting Up Link between Calculation Algorithm and Process Parameters

Setting Up Events Executed on Step Execution Start or End

Creating the Calculation Step

To create a calculation step:

In the web application:

Select the process stage or stage step and select the Calculation step in the drop-down menu of the Data Entry button. The step selection button looks like the last selected step.
Select the Calculation created step in the working area and click the Settings button on the toolbar. The Calculation parameters panel opens to set up the step.

In the desktop application open the calculation step wizard.

Open the wizard

Setup of the Calculation step includes the following operations:

Setting Up Basic Properties and Parameters of Step Description

Determine basic step properties and also step description parameters:

Web application Desktop application

Set the following parameters on the parameters panel for the Approval step on the Settings tab after determining basic step properties:

Calculation Object. The box is mandatory. Select calculation algorithm in the drop-down list. To quickly search for an algorithm, use the search string. The list contains repository objects tree where calculation algorithms and folders containing them are only displayed.
Execution Method. Select the Manual or Automatic radio button:

Manual. Calculation is executed after manual algorithm startup. The step is also finished manually.
Automatic. Calculation is executed automatically after the previous step is executed. The step is also finished automatically.

By default, automatic execution is selected for the step. Process steps with automatic execution method are marked with the icon. Execution method can be changed in step settings by selecting the step in the working area during business process setup and clicking the Settings button on the toolbar.

Set the following parameters on the Step Description page for the Calculation step after determining basic step properties:

Owner Role. The box is mandatory. In the drop-down list select the user or the group of users responsible for step execution on process execution.

If the list does not contain the required group of users, click the Open Security Manager button. The dialog box of the security manager of Foresight Analytics Platform opens, in which one can create the required group of users.

Calculation Object. The box is mandatory. Select a calculation algorithm in the drop-down list using search. The list contains repository objects tree where calculation algorithms and folders containing them are only displayed. To edit the selected calculation algorithm, click the button. The calculation algorithm opens for edit.

Step Execution Time. Specify the time, in which a step should be executed on process execution. Execution time is counted from step activation.

Enter a numeric value of step execution time and select a time measurement unit in the list: minute, hour, day (default), week, month, quarter, half-year, or year.

To determine time, by which step must be finished, select the Finish Step By checkbox. When the Minute or Hour measurement units are selected, this box is hidden.

If the step is not finished by the scheduled execution period, the step status becomes Expired.

The step execution period impacts the whole process execution period, which is determined during process start.

Step Description. The box is optional. A text box for entering a comment for a step.

After the parameters have been determined on the Step Description page, click the Next button.

Setting Up Link between Calculation Algorithm and Process Parameters

Set a link between calculation algorithm and process parameters to start calculation algorithm with the same parameters as the process step:

Web application Desktop application

NOTE. If calculation algorithm does not contain parameters, the list is displayed as empty.

On the parameters panel, for the Calculation step, on the Link tab for each static field, which displays calculation algorithm parameter name, select the corresponding process parameter name in the drop-down list. If the parameter is not selected, the calculation algorithm opens with the parameter value specified in the default calculation algorithm.

Select one selection type in the Selection Type drop-down list:

Source. It includes elements only of the first hierarchy level.
Child Elements. It includes elements only of child hierarchy levels.
Source + Child. It includes elements only of the first and child hierarchy levels.
By Selection Schema. Previously created selection schema of dictionary elements is used, for example, for the Organization Structure dictionary:

By Function. The selection schema created using Fore function is used, for example:

NOTE. After selecting the unit, specify the method: Function <function name>(selection: IDimSelection): IDimSelection.

To limit the number of parameter values, with which a data entry form is started, execute the following operations:

Click the Fix Calculation Algorithm Values button. The drop-down list displays calculation algorithm parameter dictionary elements.
Select parameter value of the calculation algorithm linked to process step. Multiple selection is available.

If the parameter value is is not selected, selection is absent in the calculation algorithm.

Determine the following for the Calculation step on the Manage Parameters page:

Execution Method. Select the Manual or Automatic radio button:

Manual. Calculation is executed after manual algorithm startup. The step is also finished manually.
Automatic. Calculation is executed automatically after the previous step is executed. The step is also finished automatically.

By default, automatic execution is selected for the step. Process steps with automatic execution method are marked with the icon at the top right corner of the block.

One can change execution method after step setup. To do this, select the step in the working area on business process setup and select the Automatic Step Execution context menu item.

Correspondence Between Algorithm and Process Parameters. Set correspondence between calculation algorithm parameters and process parameters:

Fixed. Select the Fixed dialog box to limit a list with parameters values used on starting calculation.
Algorithm Parameter. The list displays algorithm parameters.
Process Parameters. In the Process Parameter drop-down list select a process parameter that corresponds to the algorithm parameter. If it is required to send values of specific attribute to the algorithm, select dictionary attribute as a parameter. If the attribute is not selected, the default attribute is sent:

If there is no required process parameter, click the Process Parameters button. The Process Settings and Parameters dialog box opens where process parameter can be added.

NOTE. To link a business process parameter, only parameters of the calculation algorithm of the Selection type are available.

Selection Type. Select one selection type in the Selection Type drop-down list:

Source. It includes elements only of the first hierarchy level.
Child Elements. It includes elements only of child hierarchy levels.
Source + Child. It includes elements only of the first and child hierarchy levels.
By Selection Schema. Previously created selection schema of dictionary elements is used, for example, for the Organization. Structure dictionary:

By Function. The selection schema created using Fore function is used, for example:

NOTE. After selecting the unit, determine function name: Function <function name>(selection: IDimSelection): IDimSelection.

The calculation algorithm in the given example is started with fixed value of the Plan Version parameter: Year plan 2018. For fixed parameter value, selection type is not selected.

After the parameters have been determined on the Manage Parameters page, click the Next button.

Setting Up Events Executed on Step Execution Start or End

Set up actions executed automatically on step execution start or end:

Web application Desktop application

To create a list of executed operations:

Select the configured event on the parameters panel on the Events tab. The following events are available:

Before Execution. The list of actions will be started before executing the current step in the specified order.
After Execution. The list of actions will be started after executing the current step in the specified order.
On Rejection. The list of actions will be started on the current step rejection. The list is available for steps with manual execution. If the step is executed automatically, the tab is not displayed.
On Deadline Disruption. The list of actions will be started on deadline disruption to execute the current step in the specified order. To execute the actions:

When the server execution of processes is selected, select the Check Deadline Disruption of Steps checkbox on the Scheduler page and set check frequency.
When the client execution of processes is selected, select the Check Deadline Disruption item on the Administration page.

Click the Add button on the toolbar and select the added action:

Fore Method. Fill in mandatory boxes highlighted with rose:

Execution. Set execution time before/after deadline disruption. To do this:

NOTE. Execution time can be set only for the On Deadline Disruption event.

Select action execution type in the drop-down list:

Before. The action will be executed in the specified time interval before deadline disruption. It is set by default.
After. The action will be executed after the specified time interval after deadline disruption.

Specify the time interval. The default value is 0.
Select measurement units in the drop-down list. The list contains the values: Minute, Hour, Day, Week, Month. The Minute value is set by default.

Assembly. The box is mandatory. In the drop-down list select a Fore unit, the list contains all repository units and folders containing units. Search by unit name is available.

Method. The box is mandatory. Select a method in the drop-down list. The list contains all unit methods corresponding to the signature:

Sub <Fore-method name>(Sender: IBProcessInstance; Args: IBProcessStepStateEventArgs);

Parameter:

Sender. Process instance.

Args. Event information: step, step old state, new state.

Message. Set message parameters:

Execution. Set execute time before or after deadline disruption. To do this:

NOTE. Execution time can be set only for the On Deadline Disruption event.

Select the action execution type in the drop-down list:

Before. The action will be executed in the specified time interval before deadline disruption. It is set by default.
After. The action will be executed after the specified time interval after deadline disruption.

Specify the time interval. The default value is 0.
Select measurement units in the drop-down list. The list contains the values: Minute, Hour, Day, Week, Month. The Minute value is set by default.

To. Enter one or several main recipient addresses separated by the ; character. The box is mandatory.
Copy. Enter address of one or several recipients separated by the ; character.
BCC. Enter address of one or several recipients separated by the ; character. Address will be hidden from other message recipients.

Subject. Enter message subject.
Object Link. Add a link to the step object in the drop-down list: algorithm, regular report, data entry form. Multiple selection is available.

When an object is selected, the web application URL is inserted in the Subject box as follows: http://app_name/#/app/obj?key=<obj_key>&mode=view&repo=<repo_id>», where app_name - name of opened web application, repo_id - identifier of the current repository, obj_key - key of the selected object.

Message. Enter message text.
Attached File. Attach files to the message. Each attached file is displayed below the edit box. To remove the file, click the Remove button to the right of the attached file name.

NOTE. The number of added actions is unlimited.

To change the order of executed actions, use the Move Up and Move Down buttons on the toolbar on the Events tab; to delete, use the Delete button.

The list of automatically executed actions can be empty.

To create a list of executed operations:

Select the tab with the configured event on the Events wizard page. The following events are available:

Before Execution. The list of actions will be started before executing the current step in the specified order.
After Execution. The list of actions will be started after executing the current step in the specified order.
On Rejection. The list of actions will be started on the current step rejection. The list is available for steps with manual execution. If the step is executed automatically, the tab is not displayed.
On Deadline Disruption. The list of actions will be started on deadline disruption to execute the current step in the specified order. To execute the actions:

When the server execution of processes is selected, select the Check Deadline Disruption of Steps checkbox on the Scheduler page and set check frequency.
When the client execution of processes is selected, select the Check Deadline Disruption item on the Administration page.

Click the Add button on the toolbar and select the added action:

Execute Fore Method. Determine:

Unit. In the drop-down list select a unit written in the Fore language, the list contains all repository units and folders containing units. Search by unit name is available.

To edit the selected unit, click the Edit button.

To create a unit, click the Add button.

Method. Select method in the drop-down list. The list contains all unit methods corresponding to the signature:

Sub <Fore-method name>(Sender: IBProcessInstance; Args: IBProcessStepStateEventArgs);

Parameter:

Sender. Process instance.

Args. Event information: step, step old state, new state.

To refresh the methods list, click the Refresh List button.

To copy method signature, click the Copy Signature button.

Send Email. Set message parameters:

To. Enter one or several main recipient addresses separated by the ; character. The box is mandatory.
Copy. Enter address of one or several recipients separated by the ; character.
BCC. Enter address of one or several recipients separated by the ; character. Address will be hidden from other message recipients.

Subject. Enter message subject.
Contents. Enter message contents using the option of variables values substitution with step parameters, links to step objects to view in the web application, file attachments.

NOTE. The number of added actions is unlimited.

To change the order of executed actions, use the Move Up and Move Down buttons on the toolbar of the Events wizard; to delete, click the Delete button.

The list of automatically executed actions can be empty.

To determine parameters on the Events page, click the Finish button.

NOTE. To speed up resource-intensive reports, select the Execute Calculation and Fore Methods Steps on BI Server checkbox in process settings.