The Runtime Diagnostics page provides comprehensive diagnostic tools including Property Watch, Trace Window, and Module Information for monitoring and troubleshooting running solutions.

Access: Runtime → Diagnostics

Parent Page: Runtime Designer UI (Reference)



Interface Components

The Runtime Diagnostics interface consists of three main elements:

1. Module Status

Control panel with command buttons to Start, Stop, or Pause execution of any module.

2. Run Tools

Launch additional diagnostic tools:

  • Property Watch
  • Trace Window
  • Module Information
  • Performance Test

3. Runtime Connection State and Synchronization

Shows runtime connection status and whether Designer configuration is synchronized with runtime configuration in memory.


Configuration-Runtime Synchronization

Offline Configuration

In Offline Configuration mode, saved changes only update to runtime if Hot Update is used. Otherwise, changes take effect at next solution start. This mode is useful when you want to make multiple changes without immediately affecting the running system.

Online Configuration

With Designer connected to Runtime and online configuration enabled, all modifications apply immediately as you edit tables or save documents.

Limitations: Some operations cannot be applied online:

  • Tag type modifications
  • Client-Server domain changes for scripts
  • Major structural changes requiring compilation

These changes take effect at next system initialization.

Synchronization Status

The synchronization table shows if configuration file matches running solution. Common mismatch scenarios:

ScenarioCauseResolution
Offline changes pendingRunning application older than fileHot Update or restart
Remote modificationsAnother user modified runtimeHot Update to sync
Backup recoveryFile restored but runtime unchangedHot Update or restart

Hot Reload Command

Hot Reload applies updated configuration to runtime without shutdown, preserving tag values and objects in memory.

Process:

  1. Identifies all modified objects (listed in synchronization table)
  2. Briefly pauses affected modules
  3. Applies changes to loaded modules
  4. Resumes execution

Property Watch

Tool designed to access and modify system tags and internal properties with IntelliSense support.

Interface Elements

IndexDescription
1Overlay window checkbox
2Browser tab for object selection
3Personalized monitoring list
4Logged-in username display
5Show all properties option
6Selected object name
7Module control panel

Usage

Object Selection:

  • Type object name in Object column
  • Use IntelliSense (type "tag." for suggestions)
  • Select from browser tab
  • Build custom monitoring list

Value Modification:

  • Select property
  • Enter new value (if permitted)
  • Changes apply immediately

Module Control:

  • Start/stop individual modules
  • Monitor module status
  • Test configuration changes

Trace Window

System message display tool providing status information about system operations.

Interface Elements

IndexDescription
1Data header with filters
2Message details
3Auto-scroll option
4Overlay checkbox
5Settings window
6Clear notifications
7Stop/pause updates
8Export (XML/CSV)
9Close window
10Error message details

Settings Configuration

Message Types:

  • Info: User notices and status
  • Error: Operation failures
  • Debug: Developer information
  • Warning: Potential issues

Module Selection: Choose specific modules to monitor for targeted diagnostics.

Output Options:

  • Grid: Display in Trace Window
  • File: Export to log file

Object Monitoring:

  1. Enter object name in field
  2. Select property from list
  3. Click "Add" to monitor
  4. Changes trigger trace messages

Device Communication

Common use for finding device information:

  • Read/write status
  • TX frames (sent)
  • RX frames (received)
  • Invalid addresses (ControlLogix)

Note: For Devices, enable only error, info, and warning. Debug creates excessive data.

CallStack Display: Enable Debug in Settings and Debug Information in Runtime → Build and Publish.


Module Information

Provides detailed operation information for all modules, including communication channels, reading groups, and error reports.

Module Types

ModuleInformation Displayed
AlarmAlarm module specifics
TCPServerConnected modules, clients, devices
ScriptTaskClientClient expression/task statistics
Device ModuleCommunication channel details
DatasetDatabase access configurations
Script Task ServerServer expression/task statistics

Device Module Diagnostics

Read Groups Information:

  • Virtual reading groups
  • Runtime per item
  • Successful/failed reads
  • Error codes and timestamps

Troubleshooting Steps:

  1. Check Read Groups Information for communication blocks
  2. Systematic errors indicate access issues - verify node address
  3. Block-specific errors - check tags and addresses
  4. Use Trace Window for detailed error information
  5. OPC discarded items show wrong addresses

Controls

ControlFunction
SettingsChange display theme
PauseStop data updates
CloseExit Module Information

Performance Test

Diagnostic feature to measure system performance through intensive resource usage simulation.

Access: Runtime → Diagnostics → Run Tools → Performance Test

Test Methodology

The test executes memory-intensive operations:

csharp

DateTime t = DateTime.Now;
for (int x = 0; x < 100; x++)
{
    int size = 1024 * 1024;
    int[] memAlloc = new int[size];
    for (int i = 0; i < size; i++)
    {  
        memAlloc[i] = i;
    }
}
result = DateTime.Now - t;

Performance Benchmarks

ResultAssessmentRecommendation
< 300msGoodSuitable for most applications
300-500msAcceptableMonitor for large applications
> 500msPoorReview system configuration

Virtual Machine Note: VM configuration significantly impacts performance. Adjust VM settings if results are inadequate.


Synchronization Table Columns

ColumnDescription
ModuleSpecific module being monitored
TableTypeType of diagnostic table
DesignerVersionIDDesigner module version
RuntimeVersionIDRuntime module version
Designer ModifiedLast designer modification
Runtime ModifiedLast runtime modification
DescriptionModule purpose and status

Launching Diagnostic Tools

Three methods to open diagnostic tools:

  1. Startup Window (Server side)
    • Shows module status
    • Launch buttons for each tool
    • Tools run in separate windows
  2. Runtime Diagnostics Page
    • Designer → Runtime → Diagnostics
    • Run Tools section
  3. Client Side
    • Available from client applications
    • Remote diagnostics capability

Note: Tools may minimize to taskbar when launched.


Best Practices

Online Configuration

  • Enable for real-time testing
  • Monitor synchronization status
  • Use Hot Reload for safe updates
  • Test one module at a time

Troubleshooting

  • Start with Module Information for overview
  • Use Trace Window for detailed errors
  • Property Watch for specific values
  • Performance Test for system capability

Enterprise Test Mode

System only reads from field devices in test mode, even with write configuration present.


See Also