Configuring a Processor Notification - Hyland Experience Capture Import Processor - Foundation 24.1 - Foundation 24.1 - Ready - OnBase

Once you create a Processor Notification Group, you can configure Processor Notifications for that Processor Notification Group. Processor Notifications can be configured to send messages when a processing event occurs, such as when the processor is executed, or when a batch is successfully committed.

Processor Notifications are only sent if the processor is run as a scheduled process using the Unity Scheduler service. For more information on configuring a scheduled process, see Creating an Import Processor Unity Scheduler Task.

To configure a Processor Notification:

Select an existing Processor Notification Group and click Configuration. The Processor Notification Group Configuration dialog box is displayed.

Select a notification event from the Notification Event drop-down list. The following options are available:

Option	Description
Processor Started	Sends notifications when an associated process begins.
Batch Success	Sends notifications when an associated process successfully finishes processing a batch.
Batch Fail	Sends notifications when an associated process fails to finish processing a batch.
Processor Completed	Sends notifications when an associated process successfully finishes processing multiple batches configured to run as a single process.
Batch Committed	Sends notifications when an associated process commits a batch of documents.

Enter a name for the new Processor Notification in the text field at the bottom of the window and click Create.
Select the new Processor Notification and click the Configuration button. The Processor Notification Configuration window is displayed.

Enter text in the Subject and Message fields. Note the following features of creating notifications:

You can include batch properties symbols that are described in the table below. To add a symbol,either click inside the Subject or Message field and enter the symbol, or click the symbol's button from the right side of the dialog box.
You can use HTML tags in the Message field to format email notifications, such as formatting the font, embedding images and logos, and so on. Use the <html> tag to designate the point at which the HTML formatting begins. For example:
```
<html>
    <body> 
        <font size="6" face="arial" color="red">Greetings, </font> 
        <b>Sincerely,</b> 
        <img src="logo.gif/> 
    </body> 
</html>
```
To include the percent sign (%) in notification text, you must enter two percent signs (%%) to represent that percent sign. If only one percent sign is entered, the percent sign will not display in the notification text.
If you select to send process notifications using OnBase internal mail, only 250 characters of a message are displayed in the internal mail message pane.

The following symbols can be used, depending on the type of notification event:

Symbol	Description	Event Used For
%D	The Batch Date.	Available for all notification events
%P	The name of the processor used to process the documents.	Available for all notification events
%N	The name of the batch of documents.	Batch Success, Batch Fail, Batch Committed
%B	The Batch Number assigned to the batch.	Batch Success, Batch Fail, Batch Committed
%G	The total number of pages processed.	Batch Success, Batch Fail
%T	The total number of documents in the batch.	Batch Success, Batch Fail
%S	The status of the batch.	Batch Committed
%W	The number of warnings generated for the batch.	Batch Success, Batch Fail
%E	The number of errors generated for the batch.	Batch Success, Batch Fail
%U	The user name of the currently logged in user who executed the process.	Available for all notification events
%R	The number of records successfully imported. Note: This symbol is only applicable to AutoFill Keyword Set processors.	Batch Success, Batch Fail

Ensure that the Enabled option is selected.
To disable the processor notification from being sent to users, deselect the Enabled option.
Click Recipients. The Recipients dialog box is displayed.
Click Add. The Recipient Configuration dialog box is displayed.

Select a Recipient Type. The following options are available:

Recipient Type Option	Description
User Group	Send the notification to all members of an OnBase User Group. Select the User Group to receive the notification using the associated drop-down list.
User	Send the notification to a user in OnBase. Select the user to receive the notification by selecting the OnBase user name in the associated drop-down list. Note: If the selected user account is deleted, that user account will be automatically removed from the Recipients list.
Address	Send the notification to the email address specified in the associated field.

If you selected the User Group or User option as the Recipient Type, the Mail Type options are enabled. The following options are available:

Mail Type Option	Description
Internal mail	Send notifications to the selected user(s) via OnBase internal mail.
External mail	Send notifications to the selected user(s) via email. The notification is sent to the email address configured for the user in the User Settings dialog box. For more information, see the System Administration documentation.
Both Internal and External	Send notifications to the selected user(s) via both OnBase internal mail and email.

Click Save.
Once you have added all necessary recipients, click Close.
Click Save.
Click Close.