Configuring Logging to the Diagnostics Console for Troubleshooting Purposes - Quick Access - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Premier

General diagnostics information for Quick Access is written to the OnBase logs in the Windows Event Viewer. Additional information is logged to the OnBase Diagnostics Console.

For information on using the Diagnostics Console, see the Diagnostics Service and Diagnostics Console module reference guide. Details on using the Windows Event Viewer are available from Microsoft.

Logging to the Diagnostics Console is enabled by editing the Quick Access logging.json file. In a default installation, this file is located at C:\Program Files\Hyland'av\config\.

CAUTION: Be very careful when updating the JSON configuration files. If a copy exists with a similar naming scheme (for example, appsettings.backup.json), and that copy is not deleted, the incorrect JSON configuration file may be used. Configuration files are read in lexicographic order, or the order in which they are loaded. This means that the last file saved is the first file loaded. The order of precedence for the loading of the configuration sources is: 1) appsettings.json file, 2) appsettings.{AltName}.json file, 3) Key-per-file directories, 4) Environment variables, and 5) Command Line arguments. As a result, if a JSON configuration file is configured with an alternate name, and is the most recently saved version of the JSON configuration file, the file with the alternate name will take precedence, which causes major errors during login.

To set the logging level:

Open the .json file in a plain-text editor.
Within the Hyland.Logging element, locate the Routes element

Locate the element for the logging route that you want to configure. Logging route elements can include the following:

Logging Route Elements	Description
DiagnosticsConsole	Information logged in the Diagnostics Console.
ErrorEventLog	Information logged in the Windows Event Viewer.

In the section for the route you are configuring, ensure that a Minimum-Level attribute is included. Add the attribute if it does not already exist. For example:

This enables detailed messaging to the diagnostics route.
Note:
Depending on the application, this attribute might be included by default but commented out. Remove the /* and */ from the line to uncomment the line.

To refine the severity of messages being received by the diagnostics route, you can edit the attribute for minimum and maximum logging levels:

The Minimum-Level attribute limits the lowest-severity log level that is received.
You can add a Maximum-Level attribute, which limits the highest-severity log level that is received.
The values for these attributes can be set to any of the following log level severities, listed from most severe to least severe.

Note:

Log level names 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, a route in the .json file could be edited to include the following attributes:

"Minimum-Level": "Debug",

"Maximum-Level": "Error"

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 Error.

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 .json file.

Save the file and restart the application.