Configuring a Processor Notification - AutoFill Keyword Sets - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

AutoFill Keyword Sets

Platform
OnBase
Product
AutoFill Keyword Sets
Release
Foundation 22.1
License
Standard
Essential
Premier

Once you've created 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 (e.g., when the processor is executed, or when a batch is successfully committed).

Note:

Processor Notifications will only be sent if the processor is run as a scheduled process. If the processor is run manually in OnBase, no notifications will be sent.

  1. Select an existing Processor Notification Group and click Configuration. The Processor Notification Group Configuration dialog box is displayed.
  2. Select a Notification Event from the Notification Event drop-down list. The following options are available:
    • Processor Started- notifications of this type will be sent when an associated process begins.

    • Batch Success- notifications of this type will be sent when an associated process successfully finishes processing a batch.

    • Batch Fail- notifications of this type will be sent when an associated process fails to finish processing a batch.

    • Processor Completed- notifications of this type will be sent when an associated process successfully finishes processing multiple batches configured to run as a single process.

    • Batch Committed- notifications of this type will be sent when an associated process commits a batch of documents.

  3. Type a name for your new Processor Notification in the text field at the bottom of the window, then click Create.
  4. Select your new Processor Notification and click the Configuration button. The Processor Notification Configuration window is displayed.
  5. Enter text in the Subject and Message fields. You can also include Keyword Type symbols that are described in the table below. To add a symbol, either click inside the field and type the symbol, or click the symbol's button from the right side of the dialog box.
    Note:

    In the Message field, you can use HTML tags to format your email notifications (e.g., format the font, embed images and logos). An <html> tag should designate the point you'd like the HTML formatting to begin. For example:

    <html>
    <body>
    <font size="6" face="arial" color="red">Greetings, </font>
    <b>Sincerely,</b> 
    <img src="logo.gif/> 
    </body> 
    </html>

    The client's default email format must be HTML.

    Note:

    If you want to include the percent sign (%) in notification text, you must place 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.

    Note:

    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

    Displays the Batch Date.

    Available for all notification events

    %P

    Displays the name of the processor used to process the documents.

    Available for all notification events

    %N

    Displays the name of the batch of documents.

    Batch Success, Batch Fail, Batch Committed

    %B

    Displays the Batch Number assigned to the batch.

    Batch Success, Batch Fail, Batch Committed

    %G

    Displays the total number of pages processed.

    Batch Success, Batch Fail

    %T

    Displays the total number of documents in the batch.

    Batch Success, Batch Fail

    %S

    Displays the status of the batch.

    Batch Committed

    %W

    Displays the number of warnings generated for the batch.

    Batch Success, Batch Fail

    %E

    Displays the number of errors generated for the batch.

    Batch Success, Batch Fail

    %U

    Displays the user name of the currently logged in user who executed the process.

    Available for all notification events

    %R

    Displays the number of records successfully imported.

    Note:

    This symbol is only applicable to AutoFill Keyword Set processors.

    Batch Success, Batch Fail

  6. Ensure that the Enabled option is selected.
    To disable the processor notification from being sent to users, deselect the Enabled option.
  7. Click the Recipients button. The Recipients dialog box is displayed.
  8. Click Add. The Recipient Configuration dialog box is displayed.
  9. Select a Recipient Type. The following options are available:
    • User Group- select this option to 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- select this option to send the notification to an OnBase user. Select the user to receive the notification by selecting his or her 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- select this option to 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:
    • Internal mail- when this option is selected, notifications will be sent to the selected user(s) via OnBase internal mail.

    • External mail- when this option is selected, notifications will be sent 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- when this option is selected, notifications will be sent to the selected user(s) via both OnBase internal mail and email.

  10. Click Save. You are returned to the Recipients dialog box.
  11. Once you have added all desired recipients, click Close. You are returned to the Processor Notification Configuration dialog box.
  12. Click Save. You are returned to the Processor Notification Group Configuration dialog box.
  13. Click Close. You are returned to the Processor Notifications dialog box.
  14. Click the Processors/Scan Queues button to assign one or more process formats to the configured notification type. The Assign Process Formats/Scan Queues dialog box is displayed.
  15. Select one or more Process Formats from the Available Process Formats/Scan Queues list, then click Add>>.
    To remove a Process Format from the Selected Process Formats/Scan Queues list, select that Process Format and click the <<Remove button.
  16. Click Close. You are returned to the Processor Notifications dialog box.
  17. Click Close.