View Source

{note}This utility is not part of the ClearSCADA installation and is not supported. It was created by one of our ClearSCADA developers in the hope that it is useful in translating protocol log files.{note}

h2. Overview

Many ClearSCADA drivers contain a protocol translator that can convert raw comms and IO logs into HTML. This utility makes it easy run the appropriate translator for a particular log file from Windows® Explorer.

!TranslateProtocol.png!

[Executable (x86)|^TranslatorPicker.zip]
[Executable (x64)|^TranslatorPicker-x64.zip]

{note}This requires Visual Studio 2010 Redistributable package to be installed. This is installed with the latest version of ClearSCADA, alternatively see this [Microsoft|http://www.microsoft.com/downloads/en/details.aspx?FamilyID=a7b7a05e-6de6-4d3a-a423-37bf0912db84] page.{note}

h2. Setup Windows® Explorer (Vista/2008/7)

To allow easy access to the protocol translators from Windows® Explorer perform the following steps:
* Download NirSoft file types manager from [http://www.nirsoft.net/utils/file_types_manager.html]
* Run 'FileTypesMan.exe'.
* Scroll down the list of extensions to find the 'LOG' extension, you may need to create it if it doesn't already exist.
* Select the 'LOG' extension and select the *Actions/New Action* menu to add a new action:
** Set the name and caption to 'Translate (Default)'.
** Set the command line to *"<path>\TranslatorPicker.exe" /TRANSLATE "%1" /OPEN*, where <path> is the directory where the utility is installed.
* Optionally, select the *Actions/New Action* menu to add a second new action:
** Set the name and caption to 'Translate (Options)'.
** Set the command line to *"<path>\TranslatorPicker.exe" /TRANSLATE "%1" /OPEN /OPTIONS*, where <path> is the directory where the utility is installed.
* Repeat for other file extensions, such as 'LOG_2'.

To allow translator options to be specified perform the following steps:
* Locate 'TranslatorPicker.exe' in Windows Explorer.
* Right-click on the executable file and select 'Properties'.
* Select 'Compatibility' tab and tick 'Run this program as an administrator'.

h2. Setup Windows® Explorer (2000/XP/2003)

To allow easy access to the protocol translators from Windows® Explorer perform the following steps:
* Select the *Tools/Folder Options...* menu from Explorer.
* Select the *File Types* tab.
* Scroll down the list of registered file types to find the 'LOG' extension, you may need to create it if it doesn't already exist.
* Select the 'LOG' extension and click the 'Advanced' button to edit the file type.
* Select the 'New' button to add a new action:
** Set the action to 'Translate (Default)'.
** Set the application used to perform the action to *"<path>\TranslatorPicker.exe" /TRANSLATE "%1" /OPEN*, where <path> is the directory where the utility is installed.
* Optionally, select the 'New' button to add a second new action:
** Set the action to 'Translate (Options)'.
** Set the application used to perform the action to *"<path>\TranslatorPicker.exe" /TRANSLATE "%1" /OPEN /OPTIONS*, where <path> is the directory where the utility is installed.
* Repeat for other file extensions, such as 'LOG_2'.

h2. Translating a Comms Log

You will now be able to right-click on a file in Explorer and select the "Translate (Default)" menu option to translate a comms log file using the default options. If the utility can determine the protocol from the filename it will automatically run the appropriate driver, otherwise it will display a dialog prompting you to select a driver from those that are installed.

!TranslateProtocol.png!

Alternatively, select the "Translate (Options)" menu option to choose the (non-default) options for translating the comms log file. The available options vary depending on the particular driver. For example, the following options are available in the SCADAPack Modbus driver:

!TranslateOptions.png!