Configuring Diagnostics Logging - Signature Deficiencies for Epic - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Signature Deficiencies for Epic

Platform
OnBase
Product
Signature Deficiencies for Epic
Release
Foundation 23.1
License

The Hyland.Integrations.Epic.SignatureDeficiencies.dll.config file allows configuration of diagnostics logging for the Signature Deficiencies for Epic client. To enable diagnostics logging, you must first install and configure the Diagnostics Service and Diagnostics Console. For more information on installing and configuring the Diagnostics Service and the Diagnostics Console as well as for more detailed information on the available configuration settings available for diagnostics logging, see the Diagnostics Service and Diagnostics Console documentation.

To configure the Signature Deficiencies for Epic client to allow diagnostics logging:

  1. Locate the Hyland.Integrations.Epic.SignatureDeficiencies.dll.config file. The default location for this file is C:\Program Files (x86)\Hyland\Integration for Epic\SD4E\.
  2. Open the Hyland.Integrations.Epic.SignatureDeficiencies.dll.config file in a plain text editor, such as Notepad.
    Note:

    The *.config file should only be edited in a plain-text editor, such as Notepad, or a utility specifically designed to edit XML files. It should not be edited in a binary editor, such as Microsoft Word. Using a binary editor can introduce invalid characters to the file and make it unreadable by the software.

  3. Locate the <Hyland.Logging> node.
  4. In the WindowsEventLogging element, replace the sourcename attribute with one that identifies the Signature Deficiencies for Epic client as the source of the event log. For example, <WindowsEventLogging sourcename="Hyland Signature Deficiencies for Epic" /> sets "Hyland Signature Deficiencies for Epic" to appear on event logs for events originating from this application.
  5. In the <Routes> subsection, add the following new route:
    <Route name="DiagnosticsConsole">
    <add key="Http" value="http://localhost:8989" />
    <add key="minimum-level" value="Trace" />
    </Route>
  6. Replace the value http://localhost:8989 with the HTTP endpoint where the Diagnostics Console is located.
  7. Replace the value Trace with another Log Level value listed below:
    Log Level Description
    Critical Logs that describe an unrecoverable application, system crash, or catastrophic failure that requires immediate attention.
    Error Logs that highlight when the current flow of execution is stopped due to a failure. These logs indicate a failure in the current activity but not an application-wide failure.
    Warning Logs that highlight an abnormal or unexpected event in the application flow but do not otherwise cause the application to stop.
    Information Logs that track the general flow of the application.
    Debug Logs that are used for interactive investigation during development. This is the recommended Log Level for production environments.
    None A logging category that does not write any logging messages.
    Note: The Log Level Trace logs the most detailed messages possible. These messages may contain sensitive information. Due to this, Trace should not be used in any production environment.
  8. Save and close the Hyland.Integrations.Epic.SignatureDeficiencies.dll.config file.