SCADA Utilities

CygNet Software provides the following utilities for managing your CygNet installation. Click on the file name for more information about each utility. CygNet utility files are found in the CygNet\Utilities folder on your host server, unless noted otherwise.

Browse by letter:     [A]     [B]     [C]     [D]     [F]     [G]     [H]     [L]     [M]     [O]     [P]     [R]     [S]     [T]     [U]     [V]

Utility Name Utility File Names Description Command-Line Only Services Supported Checks Security

ARS Diagnostic Tool

ArsDiags.exe

The ARS Diagnostic Tool provides administrative statistics on Address Resolution Services (ARS) for advanced administrators, integrators, and CygNet support. Available diagnostic information includes service validation, iterator test, site consistency, cycle times, and CVS metadata file synchronization.

 

ARS

Check

 

ARS Modify Service

ARSModifyService.exe

The ARS Modify Service command-line utility adds, updates, or deletes a record from an ARS.

Check

ARS

Check

 

BSAP Configurable Data Group Migration

BSAPMigration.exe

The BSAP Configurable Data Group Migration utility converts any "Device Specific Data Group" to the new "Configurable Data Group." UIS commands using the previous device-specific data groups are also updated.

Note: Files are located in the CygNet\Bin directory on your host server.
 

EIE

Check

 

BSS Explorer

BssExplorer.exe

The CygNet BSS Explorer client can be used to view, edit, upload and download files from a BSS.

 

Blobs

Check

Check

Business Object Builder

CygBob.exe

An Enterprise Objects (EIS) utility used to produce Business Object Package files.

 

Many

Check

 

CAPRI To DAT

CapriToDAT.exe

The CAPRI TO DAT command-line utility translates platform-neutral database files (CAPRI) to CygNet database files (DAT). See also DATToCapri.exe below.

Check

DBS

Check

 

Client Monitor

CClientMonitor.exe

The CygNet Client Monitor utility checks for updates for specific CygNet applications on the Application Blob Service (APPS) and notifies users if there are new versions.

 

Blobs

Check

 

Comm Director

CommDirector.exe

The CygNet Comm Director utility re-directs TCP/IP traffic and directs communications between various ports.

 

DDS

 

 

Config File Manager

ConfigFileMgr.exe

The Config File Manager is a configuration file management tool used to centrally manage all configuration files in your CygNet system (from both local and remote servers) even if you aren’t currently running the application on the primary host server. The tool will allow you to edit (via manual and mass-modification options) and validate your configuration files in one central location.

Note: Files are located in the CygNet\Bin directory on your host server.
 

All

Check

 

Connect ARS

ConnectARS.exe

The Connect ARS command-line utility connects one Address Resolution Service (ARS) to another ARS.

Check

ARS

Check

 

CRC Generator

CrcGenerator.exe

The CygNet CRC Generator utility is a protocol analyzer used to troubleshoot field device communication responses.

 

UIS

 

 

CygNet Message Sniffer Lite

SnifferLite.exe

A diagnostic tool that captures and evaluates all CygNet message traffic occurring on a CygNet client or host

 

All

Check

 

DAT To CAPRI

DATToCapri.exe

The DAT To CAPRI command-line utility translates CygNet database files (DAT) to a platform-neutral format (CAPRI) for transportation between operating systems or to send to CygNet for support. See also CapriToDAT.exe above.

Check

DBS

Check

 

Database Copy

Dbscopy.exe

The Database Copy command-line utility copies or moves queues from one database service to another, or deletes queues from a database service.

Check

DBS

Check

 

Database Delete Queue

Dbdelq.exe

The Database Delete Queue command-line utility deletes a specific queue and optionally dumps the results to the screen.

Check

DBS

Check

 

Database Dump

Dbdump.exe

The Database Dump utility reads a database queue and dumps the records (in hex) to a file.

Check

DBS

 

 

Database Unlock

Dbunlock.exe

The Database Unlock command-line utility unlocks a specific queue (record).

Check

DBS

Check

 

DBS Consistency Check

DbsConsistencyCheck.exe

The DBS Consistency Check utility performs consistency checking between the database records and index records. Run this utility to check for any logical errors.

 

DBS

Check

 

DBS Restore Backup

DBSRestoreBackup.exe

The DBS Restore Backup command-line utility restores a database backup in the event of a media failure, or recovers CygNet data from a previous backup following an event such as an accidental deletion.

Check

DBS

Check

 

DBS TxLog Management

DbsTxLogManagement.exe

The DBS TxLog Management command-line utility changes the value for the DBS_TRANSACTION_LOG_SIZE keyword in the service configuration file. This keyword specifies the size (in megabytes) of each log file in the txlogs directory, the directory where the service transaction log files are stored.

Check

DBS

Check

 

DDS Check

DdsCheck.exe

The DDS Check utility performs basic validity checking and repairs for common Device Definition Service (DDS) record inconsistencies.

 

DDS

Check

 

DDS Command Copy

DDSCommandCopy.exe

The CygNet DDS Command Copy utility copies UIS command(s) from one remote device to other remote device(s).

 

DDS

Check

Check

DDS Data Group Copy

DDSDataGroupCopy.exe

The CygNet DDS Data Group Copy utility copies data group(s) from one remote device to other remote device(s).

 

DDS

Check

Check

DDS Import Export

DDSLoad.exe

The CygNet DDS Import/Export utility imports and exports device header information (Device ID, Facility ID, and Ordinal) in CSV file format. Options are available to force synchronization of the (DDS) with the Facility Service (FAC) and to update Facility ordinals.

 

DDS

Check

 

DDS Transaction Viewer

DdsViewer.exe

The DDS Transaction Viewer utility provides DDS device and transaction information.

 

DDS

 

 

Device Copy

DeviceCopy.exe

The Device Copy utility can be used as a bulk device copy utility. The source device (that is, the device to copy) must be in the DDS. The source file (information for the new devices) must be a text file. The utility has an option to create a source text file from the existing device(s).

 

DDS

Check

 

Device Template Manager

DtfMgr.exe

The CygNet Device Template Manager verifies XML structure of device template files for Modbus and other templated EIEs. It can be used to upload device template files to the DDS. For overview information about device template files, see Device Template Files.

 

DDS

Check

 

Directory Sync

CDirectorySync.exe

The CygNet Directory Sync utility compares file versions and replaces files based on selected criteria.

This utility does not compare file sets. As such, use the DOS "Comp" command to compare file lists.

 

All

Check

 

Domain Connection

CygConn.exe

The CygNet Domain Connection utility connects a user computer to an ARS via the ARS IP address.

 

ARS

Check

 

Facility Import/Export

FacLoad.exe

The CygNet Facility Import/Export imports and exports Facility attributes in CSV file format.

 

FAC, GRP

Check

Check

File Check ESE

FileChkESE.exe

The File Check ESE command-line utility performs internal logical consistency checks for the ESE-based datastore file (.dat.edb). The utility primarily checks for several different types of errors including record length inconsistencies, two types of orphaned records, and database record count mismatches.

Check

DBS

Check

 

Gateway Client

GatewayClient.exe

The Gateway Client command-line utility is an Enterprise Objects (EIS) utility used to process diagnostic requests or operation requests.

Check

Many

Check

Check

Global Attribute Changer

GlobalChanger.exe

The CygNet Global Attribute Changer utility is used to change facility and UDC attributes globally.

 

FAC, PNT

Check

Check

GNS Configuration Tester

GnsConfig.exe

The GNS Configuration Tester utility is used to define, encrypt, and test configuration properties for GNS email (Email tab) and voice messaging (VoIP tab) in the GNS configuration file.

 

GNS

Check

 

GNS Responses Editor

ResponsesEditor.exe

The CygNet GNS Responses Editor utility modifies the standard responses from the GNS voice and WAV address notifications.

 

For example, a user can add a phrase such as “Press 1 to acknowledge.”

 

GNS

Check

 

Group Manager

GrpMgr.exe

GrpMgr64.exe

The Group Manager utility is used to builds hierarchies in the Group service.

 

GRP

Check

Check

History Export

CExport.exe

The CygNet History Export utility exports data from the VHS to a comma-separated values (CSV) file.

 

VHS

Check

 

Host Manager

CHostMgr.exe

The CygNet Host Manager is the control panel for all CygNet services.

 

All

Check

 

Host Updater

CHostUpdater.exe

The CygNet Host Updater utility updates the CygNet host.

 

All

Check

 

License Manager

LicenseManager.exe

The CygNet License Manager utility provides a method to control the license records in your CygNet system as well as to activate your host(s). To make changes, the user must have administrator security level access.

 

ARS

Check

Check

Log File Viewer

LogFileViewer.exe

The Log File Viewer utility shows log file information.

 

All

Check

 

Meter Database Fix

MeterDbFix.exe

The Meter Database Fix command-line utility clears the "dirty" shutdown flag in the ARS meter database.

Note: See Metering Keywords in ARS Configuration Keywords for usage.

Check

ARS

Check

 

MssViewer

MssViewer.exe

The MSS Viewer utility provides a way to schedule tasks and blackouts.

 

MSS

Check

Check

OPC Check

OpcCheck.exe

The CygNet OPC Check utility is a diagnostics program that validates OPC server connectivity. 

Usually used when attempting connections to third-party OPC servers.

 

OPCIS

Check

 

OPC Sync

OpcSync.exe

The CygNet OPC Sync command-line utility loads a PNT with all points obtained by iterating the tags in a running OPC Server. The utility lacks filtering, but can be useful for demonstration purposes in some cases.

Check

OPCIS

Check

 

Point Configuration Manager

PointCfgMgr.exe

PointCfgMgr64.exe

The Point Configuration Manager utility modifies in batch, if desired, fields and deletes points based on filters, such as Facility ID, Site.Service, UDC, etc. The utility also has an import and export point function, to and from a CSV file.

 

PNT

Check

 

Point Script Copy

PointCfgScriptCopy.exe

The CygNet Point Script Copy utility copies scripts from a file to a point and from a point to a file, and also from a point to a point.

 

PNT

Check

 

ReIndex ESE

ReIndexESE.exe

The ReIndex ESE command-line utility rebuilds the ESE Index file (inx.edb).

Check

DBS

Check

 

ReplValidator

ReplValidator.exe

The ReplValidator utility validates replication data.

 

All

Check

 

ReReg

ReReg.exe

The ReReg command-line utility causes a service to re-register with the ARS.

 

Syntax:

ReReg Site.Service [ArsName]

Check

All

Check

 

RSM Control Service

RsmControlSvc.exe

The RSM Control Service command-line utility controls services on a host (start, stop, restart, or report service status).

Check

RSM

Check

Check

RSM Diagnostic Tool

RsmDiags.exe

The RSM Diagnostics Tool is an administrative utility that verifies the consistency of redundancy relationship definitions and services and their owners across RSMs in a redundancy environment.

 

RSM

Check

 

RSM Get File

RsmGetFile.exe

The RSM Get File command-line utility gets files from the machine running the specified RSM.

Check

RSM

 

Check

Service Diagnostics

SvcDiags.exe

The CygNet Service Diagnostics utility shows service, site, and machine statistics.

 

All

Check

 

Service Migration

SvcMigration.exe

The CygNet Service Migration utility performs database transformation.

 

All

Check

Check

ServiceMon Administration

SvcmonAdmin.exe

The CygNet ServiceMon Administration utility creates Service Monitoring Service (SVCMON) points.

 

SVCMON

Check

Check

SetPoint

SetPoint.exe

The SetPoint command-line utility sets a point value in a CVS.

Check

CVS

Check

Check

Sniffer Lite

SnifferLite.exe

The CygNet Message Sniffer Lite is a diagnostic tool that captures and evaluates all CygNet message traffic occurring on a CygNet client or host.

 

All

Check

 

SocketMan

SocketMan.exe

The CygNet SocketMan utility is used to diagnosis TCP/IP communication problems.

 

UIS

 

 

SQL Executor

SqlExecutor.exe

The CygNet SQL Executor utility shows the results of SQL statements.

 

ODBC

 

Check

Text-to-Speech Registry Changer

GNSTextToSpeechFixRegistry.exe

The CygNet Text-to-Speech Registry Changer utility is used to grant permission to the CygNet server user to use the Microsoft Text-to-Speech technology on Windows Server 2016 only. It is not required on Windows Server 2019 or later.

The utility must be run on the CygNet host server.

Note: File are located in the CygNet\Bin directory on your host server.
  GNS

Check

 

Thread Timer

ThreadTimer.exe

The ThreadTimer command-line utility provides thread statistics for executables.

Check

Operating System

 

 

Touch BSS Files

TouchBss.exe

The Touch BSS Files utility updates the timestamps of files in a BSS.

 

BSS

Check

Check

TRS Import/Export

TRSLoad.exe

The CygNet TRS Import/Export utility imports and exports records from the Table Reference Service (TRS).

 

TRS

Check

Check

UIS Statistics

CUisStats.exe

The CygNet UIS Statistics utility displays the load statistics for remote device and communication devices in the Universal Interface Service (UIS).

 

UIS

Check

Check

UIS TCP Driver Manager

CUisTcpMgr.exe

The UIS TCP Driver Manager utility displays load statistics from the UIS.

 

UIS

 

 

Version Info

CVersionInfo.exe

The CygNet Version Info utility displays and exports file names and versions to a text file.

 

All

Check

 

VHS Check

VhsCheck.exe

VhsCheck64.exe

The VHS Check utility perform a data integrity check on the VHS database.

 

VHS

Check

 

VHS Data Analyzer

VhsDataAnalyzer.exe

The VHS Data Analyzer utility analyzes VHS disk usage

 

VHS

Check

Check

VHS Data Thinner

VhsDataThinner.exe

The VHS Data Thinner utility thins VHS database according to rules set using VHS Data Analyzer.

 

VHS

Check

Check

VHS Import/Export

VhsImportExport.exe

VhsImportExport64.exe

The VHS Import/Export utility exports data from one VHS to another.

 

VHS

Check

Check

VHS Missing Data Detector

VhsMissingDataDetector.exe

The VHS Missing Data Detector utility searches the VHS and produces a report for data missing for the specified interval.

 

VHS

Check

 

VHS Recovery

VhsRecover.exe

The VHS Recovery utility writes VHS journal or database files to a VHS.

 

VHS

Check

 

Back to top