Creating the Manual Action Step

Set execution time before/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.

Mandatory parameter.

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.

Mandatory parameter.

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.

Click the In Modal Window button next to the added Message action.

Set execution time before/after deadline disruption on the step parameters panel. To do this:

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

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.

Mandatory parameter.

Enter email address of one or several main recipients separated by the ; character.

Optional parameter.

Enter email address of one or several recipients separated by the ; character to see the message.

NOTE. To show or hide the Copy and Bcc boxes in the Message dialog box, click the Copy button.

Optional parameter.

Enter email address of one or several recipients separated by the ; character. The address will be hidden from other message recipients.

NOTE. To show or hide the Copy and Bcc boxes in the Message dialog box, click the Copy button.

Optional parameter.

Enter message subject.

Execute one of the operations:

Enter message contents in the Message box on the parameters panel.
Enter message contents in the text editor in the Message dialog box. If required, set up message text formatting.

When working with message text use the the following operations:

To copy the selected text, press CTRL+C.
To paste text, press CTRL+V.
To cut the selected text, press CTRL+X.
To delete the selected text, press BACKSPASE or DELETE.

To set up font formatting in the Message dialog box, determine necessary settings:

Font. Select one of the available font styles in the drop-down list.
Font size. Set the required font size. The size is set in points, and it can be selected in the drop-down list or entered manually. The range of available values: [6; 72].
Text color. Select text color in the drop-down palette by clicking the the Font Color button.
Text background color. Select text background color in the drop-down palette by clicking the Text Background Color button.

Select font style in the Message dialog box by clicking the corresponding button:

B. Bold. One can also use CTRL+B to set this option.
I. Italic. One can also use CTRL+I to set this option.
U. Underline. One can also use CTRL+U to set this option.
S. Strikethrough.

Select message text horizontal alignment in the drop-down menu of the Left button in the Message dialog box: The button for selecting text alignment looks like the last selected alignment option.

The following options can be selected:

. Left. Message text is aligned to the editor's left border. It is used by default.
. Center. Message text is centered in the middle of the editor box.
. Right. Message text is aligned to the editor's right border.
. By width. Message text is aligned to fit editor width.

Select list type in the drop-down menu of the Numbered List button in the Message dialog box. The buttons for selecting list format looks like the last selected list format option.

The following options can be selected:

. Numbered list.
. Bulleted list.

To create a new list element, use the ENTER key in the string with characters.

To exit the list setup, click the Numbered List/ Bulleted List button.

When working with multilevel lists:

To move from one nesting level to the next one, press the TAB key in the empty line.
To go back to the previous nesting level, press the ENTER or BACKSPASE key in the empty line.

Execute one of the operations:

Select the repository object, to which a link will be added, on the parameters panel in the Object Link drop-down list. Objects that can be selected: algorithm, regular report, data entry form. Several objects can be selected. When an object is selected, the Message box displays the web application URL in the format: https://app_name/#/app/obj?key=<obj_key>&mode=view&repo=<repo_id>, where app_name - name of opened web application, repo_id - current repository identifier, obj_key - key of selected object.
In the Message dialog box:

Select message text.
Select the required item in the drop-down menu of the Insert Link button. The selection button looks like the last selected item.

The following can be selected:

Insert Link. One can also use CTRL+K to set this option. It is used to add an URL to the required resource or repository object. To do this, in the modal dialog box that opens enter the URL:

To add a link to repository object, enter URL in the format:

http[s]://<IP address or DNS server name>:<port number>/#/app/obj?key=<object key>&mode=view&repo=<repository identifier>

Insert Repository Object. One can also use CTRL+L to set this option. It is used to add a link to repository object. To do this, in the modal dialog box that opens select the repository object in the drop-down list, which opens on hyperlink click:

The list of objects is displayed as a tree with all repository objects available for selection and also contains a field for object search. Only one object can be selected.

To quickly select repository object, use search. Enter the text to be searched in the search string. Search is executed automatically as the searched text is entered in the search string. The list will display only the subjects, which names contain the entered text. To clear the selected object name from the box, click the Clear button.

Confirm the operations by clicking the Add button.

After executing the operations the link specified in the modal dialog box is added to the selected text. The link to the repository object added using the Insert Repository Object item is converted to URL:

To edit the link, click the Edit button in the console dialog box.

To delete the link, click the Delete button in the modal dialog box.

Select substitution in the drop-down list by clicking the Substitution button in the Message dialog box. Values of substitution variables are generated depending on unique parameters of each process instance:

@(STEPROLEBACK). Previous step role. Type: string.
@(STEPNAMEBACK). Previous step name. Type: string.
@(STEPROLENEXT). Next step role. Type: string.
@(STEPNAMENEXT). Next step name. Type: string.
@(STEPNAME). Step name. Type: string.
@(PROCESSNAME). Process name. Type: string.
@(PROCESSCUSTOMER). Process manager. Type: string.
@(PROCESSSTARTTIME). Process start time. Type: date and time.
@(STEPDEADLINE). Step execution deadline. Type: date and time.
@(STEPBACKFINISHUSER). The user who executed previous manual step. Type: string.
@(STEPBACKFINISHCOMMENT). Comment for previous manual step execution. Type: string.
@(STEPDECLINEUSER). The user who rejected manual step. Type: string.
@(STEPDECLINECOMMENT). Comment for manual step rejection. Type: string.

Execute one of the operations:

Click the Add button on the parameters panel in the Attach File box. A standard file selection dialog box opens.

Click the Attach button in the Message dialog box. A standard file selection dialog box opens.

Each attached file is displayed below the edit box/text editor. To remove the file, click the Remove button to the right of the attached file name.

A Fore handler can be attached in the Message dialog box. To do this:

Click the Attach Fore Handler button. The Attach Fore Handler dialog box opens:

In the dialog box that opens specify the parameters:

Assembly. Select Fore unit in the drop-down list. The list contains all units in the repository and folders containing units. Search by unit name is available.
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: IBProcessEmailEventArgs);

Parameter:

Sender. Process instance.

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

NOTE. If the unit contains only one method, it is automatically displayed. If there are several methods, the first unit method is displayed.

Click the Apply button.

Creating the Manual Action Step

Setting Up Basic Properties and Parameters of Step Description

Setting Up Actions Executed When Event Occurs

Setting Up the Fore Method Action

Setting Up the Message Action