ClearSCADA

The page Driver Log Translator Picker Utility describes a small utility that simplifies the translation of log files across all supported ClearSCADA drivers. Users can choose to configure each protocol individually using the mechanism below, or use the Picker Utility depending on requirements.

ClearSCADA's advanced drivers are able to produce 'human readable' translations of their log files in the form of HTML documents. The TX and RX bytes that are recorded in comms log files are interpreted, translated and layed out in HTML format. This images below show an untranslated log file, and then the translated version. You can see that the translated version contains much more information about the communications between ClearSCADA and the device allowing the user to more easily determine the cause of any problems.


DNP3 Comms log file


DNP3 Comms Log Translation

Driver log translation may be added to the Windows Explorer context menu for ".log" files to allow easy translation of log files.


DNP3 Translation in the Explorer Context Menu



Setup the translator by following the steps below:

  1. From Windows explorer, go to Tools -> Options and look at file types.
  2. Find the file type associated with .log files (often the same as .txt files).
  3. Edit the file type by selecting the Advanced Button.
  4. Create a new action called "Translate <driver> Log" where <driver is the name of the driver log files to translate.
  5. Browse to the driver's exe file (usually in c:\Program Files\Schneider Electric\ClearSCADA).
  6. You should now see the path and filename in the "Application used to perform action:" box.
  7. Append the following: /TRANSLATE "%1" /OPEN (including the quotes). The complete string should look as follows:
    "C:\Program Files\Schneider Electric\ClearSCADA\DriverDNP3.exe" /TRANSLATE "%1" /OPEN (using the DNP3 driver as an example)
    
  8. Keep pressing OK until you get back to Windows Explorer.

    There are two types of communications logs available. The driver logs, which are configured from the Server Status - Modules page, and the comms and IO logs.  The driver logs contain information about the current state of the driver. The comms logs show the raw transmitted and received bytes between SCADA and outstation. The IO logs show all data received on the channel, even if it was rejected due to things such as unexpected messages etc. Both IO and comms logging can be configured by right clicking on the outstation channel in ViewX and selecting Enable IO Logs (or Enable Comms Logs).

When you browse to the communications log in Windows Explorer (usually found at c:\Program Files\Schneider Electric\ClearSCADA\Logs\Drivers), you can translate the log file by right-clicking on the file and selecting the "Translate <driver> Log" option. The translated file will automatically open in Internet Explorer (as it is html).

Some drivers provide different options that are available when translating logs.  For example, the SCADAPack Modbus driver has switches to pass in to the executable to specify if it is a ModbusTCP driver log as opposed to Modbus serial.  For example, the SCADAPackModbus translator does correctly support RTU, ASCII and TCP Modbus framing types. However it can not automatically recognize the framing type used in the log file, so you have to specify the framing type with the /PROTOCOL switch.

To translate a Modbus TCP comms log, use the following example:

"C:\Program Files\Schneider Electric\ClearSCADA\DriverSCADAPackModbus.exe" /TRANSLATE "%1" /PROTOCOL:TCP /OPEN


To translate a Modbus RTU comms log, use the following example:

"C:\Program Files\Schneider Electric\ClearSCADA\DriverSCADAPackModbus.exe" /TRANSLATE "%1" /PROTOCOL:RTU /OPEN

The /PROT switch defaults to RTU framing.

For a full list of options available for the protocol being translated, from the command prompt run the driver executable with the /? appended to the string.  For example, for the SCADAPackModbus driver, use:

DriverSCADAPackModbus /?