Configuring the Diagnostics Service for Remote Access - Diagnostics Service and Diagnostics Console - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Diagnostics Service and Diagnostics Console

Diagnostics Service and Diagnostics Console
Foundation 23.1

When the Diagnostics Service is installed or upgraded it is only enabled for local machine access by default. In some cases, it may be necessary to include diagnostics information from remote machines.


The data collected by the Diagnostics Service may contain sensitive system information. Enabling remote access can pose a security risk if your environment is not adequately configured to prevent unauthorized users from gaining access to the data received from remote Diagnostics Services.

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 enable remote access for a Diagnostics Service:

  1. Locate the appsettings.json file. In a default installation, this file is located at C:\Program Files (x86)\Hyland\Services\Diagnostics.
  2. Open the configuration file in a plain-text editor, such as Notepad.

    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 "Urls" element.
  4. To enable remote access, set the element to ""

    HTTPS is also supported. For more information see Configuring Remote Access Using HTTPS.

  5. Save and close the configuration file.
  6. Restart the Diagnostics Service for the changes to take effect.

    Each remote Diagnostics Service you need to collect data from must be enabled for remote access.