Tools & Samples

[sbeadle1]

📖 Home  

New Items to this page:

26/7/22 Add Severity Cleaner tool reference

26/7/22 Reference to CS File Analyser

16/5/22 Update Bulk Edit version

11/3/22 Tidy and move downloadable files to single zip attachment to this page

18/2/22 Bulk Edit tool has moved from the ISO image to this page.

18/2/22 Added Multi Database User Manager tool.

This page contains a number of Tools for Geo SCADA Expert / ClearSCADA that extend beyond the core functionality in specific areas, as well as Samples to give you a helping hand.

There are no warranties or support for these tools. Please seek help via the Forum at: Forum for ClearSCADA

Geo SCADA Expert Tools

Bulk Edit Tool

The bulk reconfiguration tool previously on the Geo SCADA ISO download image has now been moved to this page. This tool enables you to change the properties of multiple items through a spreadsheet import/export process. Download and find in the zip file attached at the bottom of the page "BulkEditInstaller...msi".

For an alternative please also see the Spreadsheet-based Configuration Import Tool below which can create, delete and rename items too.

Excel Language/Dictionary Manager

Managing dictionary strings for a multi-lingual ClearSCADA configuration can be a burden if more than a handful of strings need to be translated. This tool is a software extension to Excel which makes the process of adding and maintaining the dictionary much simpler. The tool has a Windows installer and documentation file included.

Download and find in the zip file attached at the bottom of the page "ExcelDictionaryInstaller....msi".

Triple Standby Synchronization Tool for Permanent Standby Servers

When using one or more Permanent Standby servers with a Triple Standby setup, the Permanent Standby servers can only be configured to synchronize their configuration from two of the Main/Standby servers. This software is a system service which monitors the state of the three Main/Standby servers and re-configures the synchronization according to their state. It will cause a restart of the Permanent Standby if necessary.

This tool is a software installation kit plus documentation.

Installer: Download and find in the zip file attached at the bottom of the page "PermStdbyServerStateMonitorInstaller.msi".

Document: Download and find in the zip file attached at the bottom of the page "ESD-385 Perm Stdby Server State Monitor.pdf".

Spreadsheet-based Configuration Import Tool

This Excel spreadsheet contains a set of VB macros for creating and modifying ClearSCADA configuration. It makes the process of creating objects and setting properties very simple. There is a sample sheet which shows the 'commands' supported, including renaming objects and instancing templates too.

Spreadsheet: Download and find in the zip file attached at the bottom of the page "CSimportV7.zip".

Documentation:  Download and find in the zip file attached at the bottom of the page "Using CSImportV7.docx".

Multi Database User Manager Tool

Managing users on more than one Geo SCADA system can be time-consuming. Each user on each system has a
different password entry, and you need to reset the password on every system when a user forgets it.
(This is not an issue if you can use Active Directory, but this option is not applicable to all).

If some systems are remote and not available at the time you want to change the password, you would
need to remember to go back to it. This GS Multi Manager tools solves these problems by managing
password change. It is designed to be used by an administrator.

This tool has a Windows service which sets user passwords across Geo SCADA Systems, and a user interface
tool to enter new password data.

A version of this has been compiled.

Download and find in the zip file attached at the bottom of the page: "GSMMInstaller-....zip"

The source code for this open-source tool is at: https://github.com/GeoSCADA/GSMultiManager 

Severity Cleaner Tool

Alarm priorities are configured as numbers from 1 to 1000. These are mapped in server configuration
to named severities with colors and behaviors. You can remove severities but the numbers used by
them in the database will remain, and when alarms occur the next lowest severity will be used.

However, the severity drop-down field on the database item may appear blank when it is not mapped to a
severity. This tool can be used to:

a) Tidy severities by remapping the priorities which are unmapped to the next lowest severity.
b) Allow you to remap all items using one severity into another severity.

Please follow this link to the page describing the tool and download links.

PLC Conversion Tool

ClearSCADA software versions up to 2013 R2.2 had an option of an integrated Kepware Technologies KEPServerEX4 PLC driver; however with the evolution of ClearSCADA this integrated PLC driver suite previously is no longer available within ClearSCADA 2014 R1 or later versions. To ensure the continuous, long-term operation of your system we recommend that you migrate to an external installation of KepServerEX5 (Kepware's latest version) prior to the upgrade to ClearSCADA 2014 R1 or later. This migration will require the conversion of any existing 'PLC' database objects into corresponding OPC database objects, for which a software tool has been prepared.

An upgrade to ClearSCADA 2014 R1 should be performed only after all PLC database objects have been migrated to corresponding OPC database objects.

This tool is a software installation kit within a zip file.

Download and find in the zip file attached at the bottom of the page "PLCConversionInstaller.zip".

Export and Import History Tool

This is a simple tool which can be used to export history from a running database, and then import it back into a different database. It creates text files named by point (so you can rename them if you want to import to a different point name).

Run the .exe file, complete the top connection data and the pink export data, then click 'Export to Files'. Check the log in the same folder if something goes wrong. It saves settings between runs in a .ini file so that the exports and imports can be repeated easily.

Download and find in the zip file attached at the bottom of the page "ExportHistoryToTSV.zip".

Windows 10 Menu font size utility

Windows 10 no longer provides a direct way to set the font size of menus. Since ClearSCADA 2013 the Custom Menus feature has also not been available. It is possible to set menu size using registry settings, but the process is difficult. Consequently we are making this utility available. It includes a registry backup feature which we recommend you use.

Download and find in the zip file attached at the bottom of the page "LargeMenus.zip".

Monitor Origin Utility

This simple .exe program will advise the co-ordinates of the upper left origin of all monitors connected to the PC. It can be used to help set up the Startup Configuration XML file for ViewX with Geo SCADA 2019 and up. 

Download and find in the zip file attached at the bottom of the page "MonitorOrigin.zip".

Server Snapshot Log Analyzer

Snapshot files are periodic logs of server activity, showing many different aspects of what the server is doing, such as database queries, synchronization and database lock performance. This tool allows you to select one or more snapshot files and examine the database behavior of your system across multiple snapshot files; with the ability to write data to Excel via a CSV file for further analysis. This will uncover how the database is handling its different load types and can be used to improve system performance. Please read the 'read me' file in the linked zip file. For best results when analyzing database load, use the 'Database Read/Write Lock Diagnostics' data. For this to work, you will need to enable Read/Write Lock Diagnostics in the Server Status Tool (find in the Database section, right-click to enable), and also ensure the ClearSCADA server log file settings will retain several logs of adequate size.

Link

Download and find in the zip file attached at the bottom of the page "SnapshotViewer.zip"

The Snapshot Viewer tool provides a means of analysing ClearSCADA DBSnapshot_XXX.log log files. The tool was initially produced to analyse the 'Database Read/Write Diagnostic' section, to order and filter DB lock usage statistics. The section is only available if enabled. It is recommended that the section is enabled. It provides a summary of lock information, and is not as verbose as the DB_XXX.log 'LCK' logging category. 

The tool aims to assist reading of multiple snapshot instances, and be able to export the information to CSV files, allowing more complex filtering and ordering of information in Microsoft Excel. The tools contains an option 'Replace Commas' which substitutes field values' commas to avoid corruption of CSV exports. Time fields contain UTC time values (unless otherwise stated); the same as DBSnapshot logfiles themselves.

General purpose analysis of sections of a Snapshot - To use the tool:

• 'Open' one or more DBSnapshot_XXX.log files.
• Select a 'Snapshot'
• Select a section of that snapshot using the 'Table' selector.

This will populate the Excel-like grid in the lower pane of the tool. The results can be ordered by clicking a column heading - multiple clicks to change ordering, Low-High to High-Low.

• With a specific section / table selected, it is possible to concatenate all instances of that section/table from the snapshot instances in all the opened snapshots (not just the selected 'Snapshot'). To do this concatenation, click 'View Table in all Snapshots' (That button will then become 'Return to single snapshot'.
• With 'View Table in all Snapshots', 'Save' becomes a saving of that concatenation of table instances. This is very useful to create a CSV which facilitates multiple column sorting or filtering, using Microsoft Excel.

Analysis of 'Database Read/Write Lock Diagnostics' - To use the tool:

There are two buttons in the top-right of the Snapshot View - 'Database Read/Write Lock Diagnostics' 'Analyse Current Snapshot' and 'Analyse Multiple Snapshots' - and these provide a simplified means of getting headline information relating to 'Database Read/Write Lock Diagnostics'. (This section can be sorted and filter like any other section/table, as described in 'a) General purpose analysis of sections of a Snapshot')

• 'Open' one or more DBSnapshot_XXX.log files.
• Click 'Database Read/Write Lock Diagnostics' 'Analyse Current Snapshot'
• A dialog to 'Select snapshots for Analysis' and this allows certain category of DB Lock usage can be included/excluded from the analysis.
• Select categories of DB Lock usage, and click 'OK'

The 'Analysis' dialog displays the headline information for the columns of the 'Database Read/Write Diagnostic' section

Right-clicking records can choose to exclude the current headline value and then click 'Re-analyse' to determine the next headline value with the earlier one excluded.

Log File Analyzer

The CS File Analyser utility can be used to help with log analysis when investigating product and configuration issues. It has a number of log file parsing and abnormal situation analysis rules. These rules are primarily aimed at ClearSCADA but some others are included such as basic Citect log analysis and SCADAPack E-Series DNP3 byte log translations.

Go to this page for details and download link.

Driver Development Kit Driver Samples

MQTT Driver

MQTT is an IoT protocol used to interchange data via a broker. This ClearSCADA driver can be used to connect to the broker and exchange point data. You can use any broker with this driver.

Please find downloads for the driver on various releases of ClearSCADA at this link. There are also installation notes and a registry file.

Basic MQTT Sample Driver

Sparkplug B Driver

Sparkplug B is an MQTT payload protocol. This sample driver supports that protocol with some automatic configuration features.

Sparkplug B Sample Driver

Schneider Electric 4G LTE DataLogger Driver

A driver to the cloud web services of the Schneider Electric Data Logger.

DataLogger Driver

Alarm Redirection to Cloud Voice and SMS Services

This is a driver and gateway with sample code for raising voice alarm calls using the Twilio cloud services.

Notify Driver and Gateway

AddIn Utility Driver for Lookup Tables

This driver adds methods for lookup tables, two, three-dimensional and time based.

AddIn Driver

ClearSCADA Configuration Samples

Radar Graphs

Capture.PNG
A radar graph shows several variables as a polygon, enabling an operator to see quickly the health of a process. This folder contains a series of radar graph mimics suitable for embedding. A simple and an advanced version of each is included, with the advanced version containing alarm limits, colored markers and a shadow to show previous values. There are named parameters for each mimic. An example is included to demonstrate how they are used.

Download and find in the zip file attached at the bottom of the page "Radar Graphs.sde"

Performance Statistics - Server Load as Points

This configuration brings out the overall system loading figures into individual points. Figures such as point processed, historic values stored, events stored etc. Suitable for ClearSCADA 2015 R2 onwards.

PerfImage.JPG
Processes figures every minute, but the interval can be altered by changing the Logic execution interval.

Download and find in the zip file attached at the bottom of the page "Performance Stats.sde"

SameGame

This file is a demonstration of advanced ClearSCADA mimic scripting.

Download and find in the zip file attached at the bottom of the page "SameGame.sde"


Home

Tools and Samples Downloads.zip