Start/notes.ini Parameters/DEBUG_CONSOLE

DEBUG_CONSOLE

Parameter: DEBUG_CONSOLE
Short description: Writes debug output to the console window or the server console — a standard companion parameter for almost every Domino debug setup.

Profile

Parameter
DEBUG_CONSOLE
Category
Logging / Debug
Component
Server, Client
Available since
9.0.1 (and earlier)
Supported versions
9.0.1, 10.0, 11.0, 12.0, 14.0, 14.5, 14.5.1
GUI equivalent
notes.ini only (no GUI)
Possible values
0 = disabled (default), 1 = enabled

Description

DEBUG_CONSOLE=1 enables the output of internal debug messages to the server console or the Notes client console window. The parameter is itself not a subsystem-specific trace, but an overarching activation switch: only when DEBUG_CONSOLE=1 (or alternatively a Debug_Outfile=… is set) are outputs from other DEBUG_*/logging parameters such as Log_Authentication, WEBAUTH_VERBOSE_TRACE (client side), DEBUG_SAML, LDAPDebug, and many more, actually visible.
In HCL support KBs on auth diagnostics, DEBUG_CONSOLE=1 is part of almost every „Debug Settings“ instruction — e.g. KB0038983 „Debug settings for Notes Federated Login“ and KB0086631 „Debug settings for SAML authentication“.
On the Notes client, with DEBUG_CONSOLE=1 active, an additional console window opens in which running debug output is displayed. On the server, the entries take effect in the existing server console and — if enabled — also land in the console log (Console_Log_Enabled=1).

Example configuration

Server-side (typical auth debug bundle):
DEBUG_CONSOLE=1
Log_Authentication=1
WEBAUTH_VERBOSE_TRACE=1
Debug_Outfile=c:\debug\auth.txt
Runtime activation:
set config DEBUG_CONSOLE=1
Deactivation after analysis is complete:
set config DEBUG_CONSOLE=0
Client-side analogously in the Notes client notes.ini (typically for diagnosing Notes Federated Login, NRPC auth issues, or Designer/Debugger sessions).

Notes & pitfalls

  • Set on its own, the parameter does not yet produce debug output — you also need topic-specific trace parameters enabled (e.g. Log_Authentication, DEBUG_SAML, LDAPDebug).
  • For persistent recording, additionally set Debug_Outfile=… — without an outfile, the console content is lost after a server restart (unless Console_Log_Enabled=1 is set).
  • On the Notes client, the popping-up console window can confuse end users — coordinate with the user before productive use.
  • Takes effect immediately via set config DEBUG_CONSOLE=1; a server restart is not required.
  • After diagnostics are complete, always disable again, since console output costs performance (additional I/O or UI refresh) and grows log files unnecessarily.

Sources (HCL Product Documentation)