Installing Cygnet Collector

About this task

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

Before you begin

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.dll required 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 ?regedit command 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 ?Keys as 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.

What to do next

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.