CygNet

.NET AGENT

Overview

The CygNet connector enables Seeq to access data from the CygNet SCADA platform.

Prerequisites

The CygNet connector is only compatible with CygNet versions 8.0 to 9.5.

The agent host must be configured with CygNet client software for the latest version of CygNet that will be connected to Seeq. The CygNet installation media should include a Bin folder, as shown:

This folder contains executables CygConn.exe and CInstall.exe. Right-click the files, then choose Properties and examine the Details tab. Check that the version number in the File version field is correct:

Then copy these files to the Seeq agent host, using CygConn.exe to establish a connection to a CygNet server running the intended version. After successfully connecting to the CygNet server, run CInstall.exe to download UTILS\CygNet VHS Import Export - 64bit, which will ensure that the correct version of DcInd64.dll is available to the connector when it starts up. DcInd64.dll is typically found in the C:\CygNet\Support64 folder.

Some CygNet dynamically-linked libraries (.dll files) must be placed in the plugins\lib subfolder of the Seeq data folder to allow the connector to function. The default location is C:\ProgramData\Seeq\data\plugins\lib. The list or required CygNet libraries is as follows:

CODE

CygNet.API.Points.dll
CygNet.API.Points64.dll
CygNet.Core.dll
CygNet.Core64.dll
CygNet.Data.Core.dll
CygNet.Data.Facilities.dll
CygNet.Data.Historian.dll
CygNet.Data.Points.dll
CygNet.API.Core.dll
CygNet.API.Core64.dll
CygNet.API.Facilities.dll
CygNet.API.Facilities64.dll
CygNet.API.Historian.dll
CygNet.API.Historian64.dll

Be sure to check the Details tab in the Properties of these files to ensure the correct CygNet version.

Configuration

This is an example configuration template that is displayed in the Additional Configuration box that appears when you click Configure for an existing datasource (or if a new datasource is being created, in the Create new datasource connection modal that appears after clicking Add Datasource) on the Datasources administration page.

CODE

{
    "IndexFacilites": true,
    "IndexSignalQuality": false,
    "ParentFacilityKey": "Facility Link",
    "NotFoundGroup": "Cygnet Root Assets",
    "FacilityGroupView": [
      "Company",
      "System/Division",
      "Area",
      "Field",
      "Route"
    ],
    "SignalSearchFilters": {
      "SiteService": [
        "TIGA"
      ]
    },
    "DomainId": 15411,
    "Site": "TIGA"
}

CygNet Additional Configuration

Property Name	Default Value	Data Type	Description
`Site`	null	String	This is the CygNet site name.
`DomainId`	null	String	This is the CygNet domain ID.
`IndexFacilites`	true	Boolean	Set to true to index facilities. If set to false, only signals will be visible in Seeq. Note: The CygNet connector only indexes facilities with point references and its parents.
`IndexSignalQuality`	false	Boolean	Set to true to enable additional indexing for signal quality data. Each CygNet Point time-series event has value and state. While primary signals represent CygNet Point time-series values, quality signals represent CygNet Point time-series event states.
`ParentFacilityKey`	null	String	In some setups, CygNet facilities can be configured to have a specific facility attribute represent the link to the parent facility. In these cases, set the `ParentFacilityKey` to the name of the facility attribute that identifies the parent facility.
`NotFoundGroup`	`Unknown Facility`	String	This field defines the name of the Seeq asset that includes facilities with missing parent group view information. This parameter is applicable only when `FacilityGroupView` parameter is defined.
`FacilityGroupView`	`[]`	A List of Strings	This field defines the Seeq asset parent-child hierarchy based on facility attribute descriptions. The hierarchy is generated based on the order in the array. For each facility, the connector performs attribute lookup by description. On successful match, the attribute value is used as the name of Seeq asset.
`SignalSearchFilters`	An empty dictionary	A dictionary of key-array pairs	This field limits the signals synched from CygNet. The filters are defined in form of key-array pairs. Multiple key-value pairs are treated with OR logic. Each key represents CygNet API property id (not case sensitive) used in point search filter. Example: UDC, PointLogId, UDCDescription, PointDataType, SiteService, etc. For more information on possible property ids, please refer to the CygNet API documentation.

Known Issues

Only Analog Input/Output, Digital Input/Output, Enumeration Input/Output, and String Input/Output data types can be converted into Seeq data types. Any other tag type is incompatible and will not be indexed.

Please report any other issues you find to our support portal.

Troubleshooting

If you are running into issues with connecting to or access data from CygNet, view our guide for troubleshooting datasource issues.

Performance considerations

The CygNet connector does not have any special performance considerations. View our guide on optimizing datasource performance for general guidance.