CygNet Data Collector

Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

Overview of CygNet Data Collector

The Historian CygNet Data Collector gathers data samples from a CygNet Server and stores the corresponding data entries into the Historian Server. This collector supports collecting of Analog, Digital and String type of data from CygNet Server. This collector supports a distributed model, where the CygNet Server, the Collector, and Historian are installed on different machines. Typically, however, the collector is installed on the same computer as the CygNet Server and sends data to a remote Historian server.

The CygNet collector uses unsolicited collection, whereby changes to the CygNet tags are detected, and are forwarded to the Historian server. The collector is intended to duplicate raw samples from the CygNet into the Historian data archive.

At the time of collector browse, CygNet-Collector connects with CygNet using CxScript64.dll API component and queries the CygNet FAC (Facility Service) and PNT (Point Service) services associated with the CVS (Current Value Service).

The CygNet Point Value is mapped to the GE Historian server as a Collector tag for data collection. CygNet Collector stores VHS (Value History Service) points UDCs(Uniform Data Codes) as Tag source address.

Once all CygNet Points associated with the selected CVS/VHS have been mapped to Historian tags, the collector begins querying from VHS service to pull data from CygNet to Historian.
Note: The CygNet ODBC Driver (Client tools) is required for the CygNet Collector service to start, however, the CygNet ODBC Driver does not ship with Historian. If the CygNet ODBC Driver for CygNet is not installed, the CygNet Collector will not connect to the CygNet server. If you install the CygNet Collector on a machine that does not contain your CygNet Server, be sure to install the CygNet ODBC Driver for CygNet on the machine with the CygNet Collector.

Refer to the following topics for more information:

Summary of CygNet Collector Features

The following table outlines the features of the CygNet Collector.

Feature Capability
Browse Source for Tags Yes (on CygNet Server that supports browsing)
Browse Source for Tag Attributes Yes
Polled Collection Yes
Unsolicited Collection Yes
Timestamp Resolution 100ms
Floating Point Data Yes
Integer Data Yes
String Data Yes
Python Expression Tags No
Note: You must set Time Assigned by field to Source as CygNet collector prefers to support unsolicited tags.

Installing Cygnet Collector

The Cygnet Data Collector consists of System API as well as the Collector Toolkit components.

Installation Prerequisites The following must be installed on the system before the Cygnet Collector can be started:
  • Cygnet 64 Bit API (installed and registered)
  • Cygnet 64 Bit ODBC Driver

    The following error is reported by the collector, if the Cygnet 64 Bit APIs are not installed:

    Error Setting Cygnet GlobalFunctions object: 'Class not registered'

    Follow the step below to manually install the CxScript64.dllrequired by Cygnet Collector: regsvr32 "C:\...\8.1.2 Install\Cygnet 812\Support64\CxScript64.dll"
    Note: The install location of the CxScript64.dll file may differ from that specified above.

Installing Cygnet Collector via the installer

Note: The Cygnet Collector Service must be setup to run from an account that has access to the Cygnet system.
  1. On the Historian installer wizard, select Cygnet collector option.

  2. Click Next.
  3. Click Finish at the end of the wizard to install Cygnet Collector.

Uninstalling Cygnet Collector

To uninstall Cygnet Collector installed via the installer, go to Add/Remove programs, select Historian Collectors and click Uninstall.
Note: Be informed that this will uninstall any other collector installed on your computer!

Installing Cygnet Collector manually

To install multiple instances of Cygnet collector manually through a command line interface:

  1. Copy ihCygnetCollector.exe to the right folder:
    • If the Historian Data Archiver is installed, then the path is: C:\Program Files\Proficy\Proficy Historian\x64\Server .
  2. Start a command prompt and Run it as an administrator.
  3. From the command prompt, register the service:
    Note: binPath will depend on the installation. See step 1 above.
    C:\Windows\SysWOW64\ sc create "IHCygnet_01" binpath= "C:\Program Files\GE Digital\Historian Cygnet Collector\Server\ihCygnetCollector.exe REG=Cygnet_01" DisplayName= "Historian Cygnet Collector 1".

    [you should see CreateService SUCCESS message]

    • If required, repeat step 3 as needed to create additional instances. For example, to create a second instance:

      From the command prompt(C:\Windows\SysWOW64\)

      sc create "IHCygnet_02" binpath= "C:\Program Files\Proficy\Proficy Historian\Server\ihCygnetCollector.exe REG=Cygnet_02" DisplayName= "Historian Cygnet Collector 2"

      [you should see CreateService SUCCESS message].

  4. Verify if the Historian Cygnet Collector is visible in the service control.


  5. From the Services panel do the following:
    • Set the Startup type to Automatic.


    • Set the Log on as property to use a system account that has rights to read from the Cygnet application.
  6. Create a key with the registry name used, for example, "Cygnet_01".
    • Run the regeditcommand to open the Registry Editor. Navigate to: HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\Historian Cygnet Collector\iHistorian\Services\CygnetCollector\.
    • Right click on CygnetCollector and Create key called Cygnet_01.
    • Create the following registry entries with String value type.


    • Modify the following Keysas needed:
    • HistorianNodeName - Name of Proficy Historian where the collector sends the data.
    • InterfaceName - Name of the collector as it will be identified in the Proficy Historian Archiver (must be unique). The interface name must include Cygnet(Eg: CygnetCollector, MyCygnetCollector, TestCygnet are all acceptable)
    • ServiceSite - This must be populated with the correct Cygnet site before re-starting the collector.
  7. Start the Cygnet Collector to create the full set of registry key. The Service should continue to run if you have configured the above keys properly and have access to the Cygnet services.
Uninstalling manually installed Cygnet Collector

To uninstall\delete the multiple instances of Cygnet collector installed manually from command line running as admin:

  1. sc getkeyname to get the proper key for deletion.
  2. sc delete <keyname>

    For example: sc getkeyname Historian Cygnet Collector[SC] GetServiceKeyName SUCCESS Name = IHCygnetOne sc delete "IHCygnetOne[SC] DeleteService SUCCESS

    Note: A machine reboot may be required for the removal of service and registry entries to take affect.

Configuration Tab for CygNet Collectors

To display the Configuration Tab for a CygNet Collector, select the CygNet Collector from the list on the left of the Administrator Tool Collectors section and click the Configuration Tab. The following screen appears:

Collector Specific Configuration for CygNet Collector

Enter the value for the CygNet Collector-specific field parameters through the CygNet Collector Maintenance - Configuration tab of the Historian Administrator.

Configuring a recovery time

To configure a recovery time, perform the following:

  1. Start the Historian Administrator.
  2. Select the Collectors screen.
  3. Select the CygNet Collector.
  4. Click the Configuration tab.
  5. In the Recovery Time (hr) field, enter a recovery time, in hours.
Descriptions for collector specific fields are listed in the following table.
Note: Changes to any of these parameter require a restart of the CygNet Collector.
Field Description
Recovery Time(hours) Maximum recovery time, data collector should collect from server, at the time of collector startup.
Recovery logic is activated when the CygNet Collector and CygNet Server reestablish a connection after a connection loss, or when the CygNet Collector is started. The CygNet Collector will attempt to recover all data samples between the current time and the last known write time, up to a maximum number of hours configured for the collector. Continuous collection resumes only after the previous data has been recovered.
Note: The default recovery time available is 0 hours and maximum value is 7 days.
Thread Count

Maximum number of threads span for reading data from CygNet server.

That is, number of threads to be used by collector for querying data from cygnet. Collector must be restarted for change to take effect.

CygNet Debug Mode Debug Mode for CygNet Collector.
This will enable verbose logging to the CygNet Collector log. Details of CygNet query transactions can be enabled by setting the value to 255. A value of 0 turns off the Cygnet Debug Mode.
Note: Do not leave Cygnet Debug Mode on for an extended period. a maximum of 10 minutes is recommended. Leaving it on will create very large log files and could use up a great deal of disk space.
General Optimized Whether to apply optimization on the tag data reads.
Cygnet Collector parameters can be modified in the registry under HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\iHistorian\Services\CygnetCollector:
  • General2 = Recovery Time(hours)
  • General3 = Thread Count
  • General4 = Cygnet Debug Mode
  • General5 = General Optimized

Tag Attributes Available on a Browse (CygNet Collector)

Following table outlines the tag attributes available when browsing.

Attribute Capability
Tagname Yes
Source Address Yes
Engineering Unit Description Yes
Data Type Yes. See Selecting Data Types.
Hi Engineering Units Yes, applicable for Analog, Discrete not for String type
Lo Engineering Units Yes, applicable for Analog, Discrete not for String type
Hi Scale No
Lo Scale No
Is Array Tag No
Note: While some of these attributes are queried on a browse, they are not shown in the browse interface. These attributes are used when adding a tag, but are not visible to you, regardless of attributes available from the server.

Selecting Data Types

The following table lists the data types recommended for use with Historian.

CygNet Data Types Recommended Data Type in Historian
Analog Float
Enumeration Integer
Digital Bool
String Variable String

Hierarchical CygNet Collector Browsing

CygNet Server supports hierarchical organization of your tags in a tree structure, then Historian will use the server's hierarchy when browsing CygNet Collector in the Non-Web Administrator.

To browse for CygNet Collector tags in a hierarchy:
  1. Open the Non-Web Administrator and select Add Tags From Collector. The Add Multiple Tags from Collector dialog opens.
  2. From the Collector drop-down, select the CygNet Collector associated with the Cygnet Server you wish to browse. A hierarchical tree appears in the Browse Results window.
  3. Browse your CygNet data source for new tags.


  4. To limit the displayed tags to only those that are not collected, from the Show Only list, select Source Tags Not Collected.
  5. To limit the displayed tags to match a tag name or tag description, enter the value to match in the Source Tag Name or Description text boxes.
  6. Navigate to the node in the tree you want to browse, and then click Browse. The tags within the selected portion of the CygNet tag hierarchy will be displayed.
    • To browse automatically, select the Auto Browse checkbox. The available tags display in the Browse Results window whenever a node is selected in the tree.
    • To show all child elements within a hierarchy, enable the Show All Children checkbox. All tags at, or below the hierarchical level of the selected node in the tree display in the Browse Results window.
  7. Select the tag(s) you want to add to Historian, and click Add Selected Tags. Collected tags appear in black text in the tag list.

Manual Recalculation and Bad Offline Values

CygNet Collector supports Manual recalculation of tags. See Historian EBook for details.

The CygNet collector by default will add a bad offline value when the collector is started. To disable this feature, add the following registry key to HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\CygnetCollector\<entry>
  • WriteBadOfflineAtStartup (DWORD) set this to 0to disable adding the bad offline at startup.
  • DeleteBeforeRecalc (DWORD) By default, before performing a recalculation on an interval, the collector will delete any previously stored values in Proficy Historian. To disable this feature, set this key to 0

The CygNet collector also inserts a bad offline while a tag is modified. It may stay as the current value until new values are read from cygnet the by collector.

Modification of Cygnet Collector Parameters

Cygnet Collector parameters can be modified in the registry under HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\iHistorian\Services\CygnetCollector.

  • General2 = Recovery Time(hours)
  • General3 = Thread Count
  • General4 = Cygnet Debug Mode
  • General5 = General Optimized

Troubleshooting the CygNet Collector

The CygNet Data Collector generates logs during initialization, configuration, and general operation. These can be found in the general logging folder C:\Proficy Historian Data\LogFiles.

Troubleshooting Tips

Troubleshoot the collector using one or more of the following:

  • Examining the log files for information.
  • Examining the Windows Event Viewer for error/warnings.
  • Be sure to run the CygNet Server before the CygNet Data Collector starts up.
  • Be sure CygNet ODBC Client tools are installed.

Additional log information can be gathered by using the Cygnet Debug Mode described above for debugging the CygNet to Collector interface.

To turn on debug mode for the Collector:

  • From the Start menu, select Run and enter Regedit.
  • Open the following key folder: HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\iHistorian\Services\CygnetCollector\<entry>
  • Double-click DebugMode DWORD value.
  • Select Base as Decimal.
  • In the Value data field, type 255.
  • Click OK.
  • Restart the CygNet Collector service for the Historian debug mode to take effect.
  • Close the Registry Editor and open the Proficy OPC HDA Server trace log file.
    Note: Do not turn on both Cygnet Debug Mode and DebugMode at the same time!

The following error is reported by the collector if the Cygnet 64 Bit APIs are not installed:

Error Setting Cygnet GlobalFunctions object: 'Class not registered' Follow the step below to manually install the CxScript64.dll required by CygNet collector: regsvr32 "C:\...\8.1.2 Install\CygNet 812\Support64\CxScript64.dll"
Note: Do not turn on CygNet Debug Mode or the DebugMode key for an extended period, 10 minutes should be more than sufficient. Leaving it on will create very large log files and that could use up a great deal of disk space.