Get Under the Driver's Hood
with Protocol Diagnostics




Communications Diagnostics

The Communications Diagnostics feature in the TOP Server provides a streaming protocol view and real-time performance data for your TOP Server communications driver.  All read and write operations can be viewed in the diagnostic display window or can be tracked directly in your Client Application using TOP Server’s built-in Statistics tags.  These diagnostics make it easy to debug tough communication issues. See the guide to Using the TOP Server Channel Diagnostics for detailed information on using the Channel Diagnostics.

Starting with TOP Server V5.9, communications diagnostics at both the channel and device level can be persisted to file for longer term troubleshooting purposes.

Starting with TOP Server V5.8, communications diagnostics are available both at the overall channel level for all devices and also at the individual device level for most drivers.  This allows greater flexibility in troubleshooting issues with specific devices.  Drivers NOT supporting device-level communications diagnostics at this time are:

  • AB Unsolicited Ethernet
  • Advanced Simulator
  • Dataforth IsoLynx
  • DDE Client
  • DNP Master Suite (Ethernet and Serial)
  • GE Ethernet Global Data (EGD)
  • GE Focas1 Ethernet
  • GE Focas1 High Speed Serial Bus (HSSB)
  • Hilscher Universal
  • InTouch Client
  • Memory Based
  • Mettler Toledo Serial
  • Modbus Unsolicited Serial
  • ODBC Client
  • OPC Client Suite (OPC DA And OPC UA)
  • Simulator
  • Siemens TCP/IP Unsolicited Ethernet
  • Telemecanique Uni-Telway Slave

V5_CommDiags_ViewThe TOP Server Communications Diagnostics can be found under the  Diagnostics for any channel or device (if supported) configured.  The diagnostics must be enabled in the channel properties to take effect.  Right click on your channel and choose Properties and under the General tab you check the box “Enable diagnostics”. Click here for more details.  You must be in Runtime Mode in the Configuration to be able to access the diagnostics.  See Offline Editing for more information.

Once enabled, you can view the diagnostics using the menu as shown.  This will open the Diagnostics for the channel or device that is currently highlighted.

Settings for configuring persistence to file for channel or device diagnostics are accessed from the TOP Server Administration Settings under the Event Log tab, as shown here:

Communications Diagnostics Persistence Settings

Communications Diagnostics Log Settings:

  • Persistence Mode
    • Memory (no persistence) - The default option follows the legacy behavior of communications diagnostics and are not persisted to file in this mode.
    • Single File - All diagnostics records will be persisted to one file only.
    • Extended Data Store - Enables spanning of diagnostics records across multiple files based on the other settings.
  • Max Records - Maximum number of records that the log can contain before the oldest records start being overwritten (Only available for Memory or Single File modes).
  • Log File Path - File system directory where log files will be stored
  • Max single file size (KB) - Maximum size in KB that any one log file can contain. (Only available for Extended Data Store Mode).
  • Min days to preserve - Once log files are older than this number, they will be deleted. (Only available for Extended Data Store Mode).

Right click on the black area of the window and you can change your options and save or copy the protocol information shown.  Sending this to our support team allows them to see exactly what communications is happening between your hardware and the TOP Server.

Communications Diagnostics Window



P: 1-888-665-3678 (US-Sales) or +1-704-849-2773 (Support & International), F: +1-704-849-6388
148A East Charles Street, Matthews, North Carolina, USA 28105
Copyright Software Toolbox, Inc., 1996-2009, All Rights Reserved Worldwide.

Wonderware, InTouch, and Invensys are registered trademarks of Invensys plc.  All  other marks are the property of their respective owners.
The Software Toolbox name and logo are registered trademarks of Software Toolbox Inc.