RightFax Service Debugging Guide (Versions 9.3–22.2)

RightFax - Debugging RightFax Services (RightFax 9.3–22.2)

This article provides detailed instructions for debugging individual RightFax services across various supported versions. Debugging allows administrators to generate logs that capture in-depth diagnostic information, helping to identify root causes of fax transmission errors, integration failures, or module crashes.

General Debugging Steps:

  1. Stop the target RightFax service in Enterprise Fax Manager (EFM) or Windows Services.

  2. Run the service in debug mode using either command-line options or the “Debug”/“Debug with Options” menu in EFM.

  3. Reproduce the issue or wait for it to occur.

  4. Save any resulting logs and exit debug mode using CTRL+C.

  5. Restart the service normally.

  6. Submit logs to OpenText Support along with relevant metadata (timestamps, usernames, fax numbers, etc.).

IMPORTANT: While running in debug, services show as "Stopped" in EFM—they are running as user applications with slightly reduced performance.


Services That Can Be Debugged

Service NameDebugging Method
Board Server ModuleCommand Line (BoardSrv.exe -D -1)
Conversion EngineEFM Logging Tab → Verbose → Debug
Sync ModuleDebug with Options (-SyncOnceASAP)
Database ModuleDebug with Options or FaxDB.exe CLI
Server ModuleDebug with Options or FaxServ.exe CLI
DocTransport ModuleDebug with Options or DocTransport.exe CLI
eTransport ModuleMimesend.exe CLI
Exchange ConnectorRFExchConn.exe -D
Exchange Email GatewayExchGateway.exe -d -1
Integration ModuleRun bufdir, buffer, parse sequentially
Lotus Notes Email GatewayNotesGateway.exe -d -1
Paging Server ModulePagesrv.exe -d -1
Queue HandlerPorthand.exe -d -1
Remoting ServiceEFM → Verbose Logging → Debug
RPC Server ModuleFaxRPC.exe -d -1
SAP GatewaySAPGate.exe -d -1
SMTP/POP3 GatewaySMTPGateway.exe -d -1
Worker HostEFM → Debug
WorkServer ModuleWorksrv.exe -d -1 -sWorkSrvN

Debug Parameters Overview

ParameterDescription
-dShow diagnostic output
-d=6Show all diagnostics
-1Run in console
-oOutput to log file
-pEnable profiling
-eLog to Windows Event Viewer
-tShow thread/process IDs
-waitWait on stop
-mA, -mOStart with aging/orphan cleanup
-rSuppress recovery on restart
-sGATEWAYnSpecify Email Gateway number (n)
-sWorkSrvnSpecify WorkServer number (n)
-SyncOnceASAPRun sync job immediately

Tips for Submitting Logs

Provide the following (as applicable):

  • Log file path and name (e.g., C:\FaxDB.log, bufdir.txt)

  • Time and date of issue occurrence

  • Fax number(s) involved

  • Affected user or group

  • Transmission history or error message details

  • Any supporting config files (e.g., BTCall.cfg, SAPRFC.ini, Notes.ini)

Refer to KB07222474 for collecting data related to Brooktrout issues.