In this article:
Setting Up Basic Properties and Parameters of Step Description
To create a step for starting one or several nested subprocesses with specific parameters:
In the web application:
Select the process stage or stage step and select the Subprocess Call step in the drop-down list of the Data Entry button. The step selection button looks like the last selected step.
Select the Subprocess Call created step in the working area and click the Settings button on the toolbar. The Subprocess Call parameters panel opens to set up the step.
In the desktop application open the subprocess call step wizard.
Setup of the Subprocess Call step includes the following operations:
Determine step basic properties and step description parameters:
Set the following parameters on the parameters panel for the Subprocess Call step on the Settings tab after determining basic step properties:
Process. The box is mandatory. Select the subprocess for starting in the drop-down list. To quickly search for a subprocess, use the search string. The list contains repository objects tree that displays only processes and folders containing them.
Rejection. Select the First or Last radio button:
First. The first step will be active in subprocesses after the current step is rejected for the Subprocess Call finished step.
Last. The last step will be active in subprocesses after the current step is rejected for the Subprocess Call finished step.
Execution Method. Select the Manual or Automatic radio button:
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.
Subprocess Version. Date and time of creating the latest subprocess version are displayed.
Set the following parameters on the Step Description page for the Subprocess Call 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.
Subprocess. The box is mandatory. Select the start subprocess in the drop-down list, when selecting you can use search. The list contains repository objects tree where processes and folders containing them are only displayed.
To edit the selected subprocess, click the Edit Process button. The Set Up Business Process dialog box opens to edit a subprocess.
If the required subprocess is absent in the list, click the Create Process button. A new process creation dialog box opens.
Subprocess Version. Date and time of creating the latest subprocess version are displayed.
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.
Set a link between parameters of subprocess and process to start the process with the same parameters as the process step:
Determine the following on the parameters panel for the Subprocess Call step on the Link tab:
Group Call. Select the Group Call checkbox to start several subprocesses and set parameters in the drop-down lists:
Splitting Parameter. Subprocess parameters are used as splitting parameter. Select the dictionary subprocess parameter, which elements will be used for multiple start of subprocess instances.. For each dictionary element selected on process start, single subprocess instance will be started.
Splitting Schema. Select subprocess dictionary selection method for elements, for which subprocess single instances will be started. A subprocess is split by subprocess parameter elements. Dependency between subprocess parameters and parent process is set in the Link between Subprocess Parameters and Process Parameters area:
Source. Subprocesses are started for each selected dictionary element. Subprocesses are not started for dictionary child elements.
Child Elements. Subprocesses are started only by dictionary child elements.
By Function. Subprocesses are started by elements obtained after Fore method execution. Determine the following settings for the Fore method:
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.
To filter subprocess start by splitting parameter attributes or by its values, set up subprocesses call conditions using the Filter button.
Link between Subprocess Parameters and process Parameters. For each static field, which displays subprocess parameter name, select the corresponding process parameter value in the drop-down list. If the parameter is not selected, selection is absent in the subprocess parameter.
To limit the number of parameter values, with which the subprocess will open, execute the following operations:
Click the Fix Subprocess Parameter Values button. The drop-down list displays subprocess parameter dictionary elements.
Select parameter value of the subprocess parameter linked to process step. Multiple selection is available.
If a parameter value is is not selected, selection is absent in the subprocess.
Determine the following for the Subprocess Call step on the Manage Parameters page:
Group Call. Select the Group Call checkbox to start several subprocesses and set parameters from the Splitting Parameter and Splitting Schema drop-down lists.
The Group Call checkbox is selected by default with unselected splitting parameter value that is required to be filled. If during process execution there is not necessity to split a subprocess by a parameter, deselect the checkbox.
Splitting Parameter. The splitting parameter can be selected only when the Group Call checkbox is selected. Subprocess parameters are used as splitting parameter. Select the dictionary, which elements will be used to start subprocesses. For each dictionary element selected on process start, single subprocess instance will be started.
To filter subprocess start by splitting parameter attributes or by its values, set up subprocesses call conditions using the Filter button.
Splitting Schema. The splitting schema can be selected only when the Group Call checkbox is selected. Select a step splitting method to subprocesses. Subprocesses are split by main process parameter elements specified in the Correspondence between Process and Subprocess Parameters area. For each dictionary element that was selected as splitting parameter selected on startup, the subprocesses will be started depending on the splitting schema selection:
Source. Subprocesses are started for each selected dictionary element. Subprocesses are not started for dictionary child elements.
Child Elements. Subprocesses are started only by dictionary child elements.
NOTE. If selected dictionary elements have no child elements, on executing subprocess, the step will finish without subprocesses start.
Example of splitting schema use
Fore Method. Subprocesses are started by elements obtained after Fore method execution. For Fore method determine assembly and method.
By default, automatic execution is selected for the step. The steps of the process with automatic execution method are marked with the icon at the top right corner of the block.
It is possible to change execution option after step setup. To do this, select the step in the workspace on business process setup and select the Automatic Step Execution context menu item
First Step. The first step will be active in subprocesses after the current step is rejected for the Subprocess Call finished step.
Example of restarting subprocess from the first step
Last Step. The last step will be active in subprocesses after the current step is rejected for the Subprocess Call finished step.
Example of restarting subprocess from the last step
NOTE. To restart single instances of subprocess with automatic execution method on rejecting the current step for the Subprocess Call finished step select the Selective Subprocesses Rejection checkbox and manually start required subprocess instances.
Correspondence Between Process and Subprocess Parameters. Specify:
Fixed. To limit the list of parameters values used for nested subprocess start, select the Fixed checkbox.
Subprocess Parameter. The list of subprocesses parameters is filled in automatically.
NOTE. If the empty value was fixed for subprocess parameter, which is a splitting parameter, on the process execution the step finishes without subprocesses start.
Process Parameter. In the Process Parameter drop-down list select parameter or parameter attribute of the main process. If the Group Call checkbox is selected, select a dictionary corresponding to subprocess parameter in the drop-down list. The dictionaries selected as a process and subprocess must have identical structure. If one dictionary is a splitting parameter by several process parameters, add it several times in the Process Settings and Parameters dialog box for each parameter.
If the drop-down list of process parameters does not contain the required value, click the Process Parameters button. The Process Settings and Parameters dialog box opens where process parameter can be added.
After the parameters have been determined on the Manage Parameters page, click the Next button.
Set up actions executed automatically on step execution start or end:
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.
After creating the process steps, proceed to setting up steps execution conditions.
See also: