How to Enable Log to File for Diagnostic Console in OnBase

Wondering how to enable log to file for diagnostic console in OnBase? You’re in the right place! The Diagnostics Console is an application used to troubleshoot any module that accesses the application server, like the Unity client, which we’ll explore in this blog. Read on or watch the video below to get a step-by-step guide on how to enable log to file for diagnostic console in OnBase.

How to Enable Log to File for Diagnostic Console

How to Enable Log to File for Diagnostic Console

1. Launch the Diagnostics Console

Let’s start by launching the diagnostics console. You’ll be presented with a dialog box asking for a service location, which will auto-populate to the local host. If you want to capture diagnostics for the local server, go ahead and click okay, which is what we’ll do for this example. However, if you’re looking to use the console to monitor a remote server, you’ll need to enter the URL of that server. We’ll go ahead and click okay.

Once open, the diagnostics console will capture data whenever you access the application server and will automatically open tabs ranging from service to error message depending on the activity. Here, you’ll see some tabs and some activity being recorded by the diagnostics console.

2. Configure the Web.config File

To automatically capture and save the data captured by the diagnostics console to a file, you’ll need to manually configure the web.config file. This file is located in the install directory for your application server, typically found within the inetpub folder under wwwroot and then app server 64. Open the web.config file and search for the Hyland diagnostics section. Under routes, add the following keys:

• Specify the path where the log will be generated. If the directory doesn’t exist, one will be created.
• Specify the type of file to generate, such as a .json file.
• Set the file size limit for each log.
• Set an interval for generating new logs (e.g., day, hour, minute).
• Specify the maximum number of logs to generate before stopping.
• Specify the type of activity to log (e.g., trace).

3. Save Your Log.config File

Next, save your log .config file and minimize it.

And once that’s done and the activity starts being monitored, it’ll also create that lock wherever you specify. Next, you can go to that location, which you specified on the local drive, under Hyland Logs. Here, you can see that this log.json file was generated by the console. When you open that up, you should be able to take a look and view see various different logs there.

4. Enable the Service

Know that if the diagnostics console is not logging properly, you may need to enable the service. Open the run dialog via the start menu, type in services.msc, and hit “OK.” Scroll down to Hyland Diagnostics and ensure the service is running. So this one, you want to make sure that that’s running.

5. View Logs in the Console

Because the logs are specified to be in the JSON file format in your configuration, programs like notepad and even the diagnosis console can open the files to view them. To do that, find a file that’s under Hyland Logs and open it. Then, a new window will pop up containing all the different tabs with the different activities.

This is a really handy resource for when you want to isolate a specific error or process that you might encounter. And that’s it, it’s locked to file.

Want More Content Like This?

Subscribe to the Naviant Blog. Each Thursday, we’ll send you a recap of our latest info-packed blog so you can be among the first to access the latest trends and expert tips on workflow, intelligent automation, the cloud, and more.