How to enable email notification of PaperVision Capture errors


Version: R74.1

Article ID: PC000056

How to enable email notification of PaperVision Capture errorsmain image

Description

A useful feature of PaperVision Capture is the ability to receive an email notification from a PaperVision Capture service when the service encounters an error. By default, these errors are written only to the Windows event log, but with email notification enabled, users can also be directly notified of problems in their PaperVision Capture environment.


Summary

Enabling email notifications requires a few modifications to the logging settings for each of the PaperVision Capture services: Process Initiator, Process Worker, Gateway Server, and Data Transfer Agent. Also, an SMTP server is required for email notifications.

Follow these steps to enable email notifications for PaperVision Capture services:

  1. Open the configuration file for a PaperVision Capture service in Notepad. These configuration files are usually located in C:\Program Files (x86)\Digitech Systems\PaperVision Capture. The following is a list of applicable configuration files:
  • DSI.PVECommon.PVProcInit.exe.config
  • DSI.PVECommon.PVProcWork.exe.config
  • DSI.Gateway.GatewayServer.exe.config
  • DSI.DataTransferAgent.Service.exe.Config
  1. Find each of the “listener” sections (in each configuration file, there is a listener section for each category of error) in the configuration file. Here is an example: <add name="Application" switchValue="Error"><listeners> <!--Commented listeners will NOT log and uncommented listeners will log.--> <add name="Event Log Destination"/> <!--<add name="Flat File Destination" />--> <!--<add name="Email TraceListener" />--> </listeners> </add>
  2. To enable email notifications, in all of the listener sections, change: <!--<add name=”Email TraceListener” />-->

To:<add name=”Email TraceListener” />

  1. Once email notifications are enabled, the settings for these notifications must be modified. Find the following line: <add name="Email TraceListener" smtpServer="127.0.0.1" smtpPort="25" toAddress="to@example.com" fromAddress="from@example.com" subjectLineStarter="PaperVision Process Worker Event:" subjectLineEnder="" formatter="Text Formatter" listenerDataType="Microsoft.Practices.EnterpriseLibrary.Logging.Configuration.EmailTraceListenerData, Microsoft.Practices.EnterpriseLibrary.Logging, Version=2.0.0.0, Culture=neutral, PublicKeyToken=469958bca2e00646" traceOutputOptions="None" type="Microsoft.Practices.EnterpriseLibrary.Logging.TraceListeners.EmailTraceListener, Microsoft.Practices.EnterpriseLibrary.Logging, Version=2.0.0.0, Culture=neutral, PublicKeyToken=469958bca2e00646"/>
  2. Within this section, find smtpServer=”127.0.0.1” and change the IP address to the IP address of your SMTP server
  3. Find smtpPort=”25” and change the port to the SMTP port being used by the SMTP server
  4. Find toAddress=”to@example.com” and change the email address to any email address to which these notifications must be sent; multiple email addresses can be specified by separating them with a semi-colon (;)
  5. Find fromAddress=”from@example.com” and change it to the email address from which these notifications will be sent
  6. Save and close the configuration file
  7. Restart the service for the changes to take effect (No services need to be restarted for changes made to the Process Worker.)