OnBase Diagnostics Console: Installation Guide & Overview

OnBase Diagnostics Console with RPI Consultants


This article will give a brief overview of the OnBase Diagnostics Console, with advice provided by Senior Solutions Architect and OnBase Practice Lead for RPI Consultants, Sydney Isle. Simply put, the OnBase Diagnostics Console is one of the most powerful tools an OnBase Administrator has available to them. It provides comprehensive visibility into what’s going on “under the hood” in any OnBase environment. It is flexible, easy to use, and can be monitored in real time or run in the background (saving logs to a text file for later review).

Here’s How it Works

1)  Make sure that Hyland Diagnostics has been installed on your application server. If you don’t see an icon on your desktop named “Diagnostics Console”, check the Services module on the server. Look to see if “Hyland Diagnostics Service” is installed and running.

hyland diagnostics service

2)  If you don’t see Hyland Diagnostics Service, you can install it using the Hyland Diagnostics MSI, which you can download from Hyland Community.

  • If you’re uncertain which version you need, check the build number on your application server.
  • If your build number is not available openly on Community, contact your support team for a secure download link.
  • Once you have the installer, the wizard will walk you through installing the Diagnostics Service and Console on your application server. NOTE: If you have multiple application servers in your environment, be sure to install it on each server.

3)  Launch Diagnostics Console. The first time you launch it, you’ll likely receive a couple of prompts.

  • Redirect Server – this gives you the option to monitor a server other than the one on which the Diagnostics Console is installed. Choose “Local” to monitor the application server on the local machine. Choose “Remote” to monitor another machine, and type the machine name of the application server in the “Machine” field. The port number should always be 8989.

diagnostics console

  • Service Not Running – You’ll get this message whenever you launch Diagnostics Console if the service isn’t running on launch. Click “Yes” to start the service automatically.

onbase service not running

  • You may get a couple of additional prompts about needing administrator privileges to start the service. Click through them until you get to the main Diagnostics Console screen.

4)  On the main Diagnostics Console screen, you have a complete UI for monitoring all things in your OnBase environment.

diagnostics console main screen

5)  You can use the Tabs menu to show or hide tabs, based on the type of event tracking you need.

diagnostics console tabs

6)  The Tools menu provides additional functions, including monitoring individual sessions on the app server.

diagnostics console tools

7)  Within the Diagnostics Console window itself, you can drag-and-drop columns so that the information you need most is easily viewed. The columns give you quick access to User IDs, session numbers, error messages, and other information to help you identify and resolve issues with workflows, integrations, scripts and more.

diagnostics console columns

8)  You also have the ability to export logs to Excel, XML or text files, retrieve NTService logs, view previously saved logs, and manage legacy Thick Client services from Diagnostics Console.

There are many more features within the Diagnostics Console than can be covered in one article. Hopefully, this helps to give you a head start on becoming more familiar with this powerful tool for troubleshooting OnBase!