Setting the Logging Level - Connector for use with SAP ArchiveLink - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Connector for use with SAP ArchiveLink

Platform
OnBase
Product
Connector for use with SAP ArchiveLink
Release
Foundation 22.1
License
Standard
Essential
Premier

To receive logging messages, a logging level must be specified for a logging route in the Hyland.Logging section of the application's .config file. To set the logging level:

  1. Find the logging route you want to configure in the Hyland.Logging section.
  2. Within the Route section for the route, ensure the following line is included:
    <add key="minimum-level" value="Trace" />

    This enables detailed messaging to the diagnostics route.

    Note:

    Depending on the application, this line might be included by default but commented out. Remove the <!-- and --> from the line to uncomment the line.

  3. Change value="Trace" to value="Debug".
    Note:

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

  4. To refine the severity of messages being received by the diagnostics route, you can edit the key and value attributes in the following manners:
    • The key value can be set to minimum-level, which limits the lowest-severity log level that is received. You can add an additional line that includes maximum-level, which limits the highest-severity log level that is received.

    • The value can be set to any of the following log level severities, listed from most severe to least severe.

    Note:

    Log level names in the value attribute are case sensitive.

    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.

    Trace

    Logs that contain the most detailed messages and may include sensitive data. These logs should never be enabled in a production environment.

    None

    A logging category that does not write any logging messages.

    For example, the Hyland.Logging section of the .config file could be edited to:

    <add key="minimum-level" value="Debug" />
    <add key="maximum-level" value="Critical" />

    This example specifies that the logging route only receives logging messages with a severity level of Debug or above, and it receives no messages with a higher severity level than Critical.

    Note:

    The default severity level of a route is a minimum of Information and a maximum of Critical. The route uses these severity levels if it does not include a minimum-level or maximum-level line specified in the .config file.

  5. Save the file and restart the application.