Setting Up Events: Business Processes

Process events with automatically executed operations can be set up on the Events tab in the Settings dialog box.

Fore Method Message

Set mandatory parameters:

Assembly. 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.
Method. 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.

Available parameters:

Mandatory parameter.

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

Copy

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 parameters, click the Copy button.

BCC

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 parameters, click the Copy button.

Subject

Optional parameter.

Enter message subject.

Message text

Enter message text in the text editor. 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 clear formatting, select message text and click the Clear Formatting button.

Message text formatting settings:

Font

To set up font, determine the following:

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.

Font style

Select the font style 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.

Alignment

Select message text horizontal alignment in the drop-down menu of the Left button: The text alignment option selection button looks like the last selected alignment option.

The following 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.

List formatting

Select list type in the drop-down menu of the Numbered List button. The list format selection button looks like the last selected list format.

The following 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 format, 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.

Text editor operations:

Insert hyperlink/link to object

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 modal dialog box.

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

Set substitution

Select substitution in the drop-down list by clicking the Substitution button. 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.

Attach Fore handler

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 a 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's method is displayed.

Click the Apply button.

Attach file

Click the Attach button. 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.

To change the order of operation execution, use the

Move Up and

Move Down buttons on the toolbar on the Events tab, to delete - use the

Delete button.