Setting up Data Collectors

The Hyperview Data Collector collects and relays data back to the Hyperview platform. It covers the following functional areas: discovery, monitoring, control operations (for example, setting control credentials), and trap listening.

All communication between the Hyperview platform and networked devices must be initiated by the Data Collector. You must register a Data Collector before it can relay information. The registration process can only be triggered from the machine that hosts the Data Collector, and requires a unique key that is generated by the platform for that particular Data Collector.

Once registered, the Data Collector saves the key in a local configuration file in a secure manner. It then polls the Hyperview platform for data collection jobs.

Prerequisites

Hardware and software requirements

You must install the Hyperview Data Collector on at least one server (physical or virtual) that is networked with your devices.

The server must be running Windows Server 2016 (for production or testing purposes) or Windows 10 (testing only), and have a minimum of 2 CPU cores, 4 GB of RAM, and 20 GB of free space.

Note

You cannot install multiple instances of the Data Collector on the same server. For larger organizations we recommend having one or more Data Collector servers per data center.

Network requirements

By default, Hyperview uses the following network ports to monitor and discover devices. You must grant the Data Collector access (unless you have configured other ports for any of the protocols, and have allowed access accordingly).

Protocol Ports Credential Requirements
SNMP 161 (gets, sets), 162 (traps) Community string or user/password
Modbus/TCP 502 Not required
BACnet IP 87808 Not required
IPMI 623, 1900 User/password
SSH 22 User/password or user/key
WMI 135 User/password
VMware 883 User/password

Downloading the Data Collector

  1. Log in to your Hyperview instance as an Administrator.
  2. Go to Discoveries → Data Collectors → Download Data Collector.

The Data Collector zip file will be downloaded to your browser’s default download location. The filename will resemble “dataCollector-9999.zip”, where “9999” represents the version number.

Installing the Data Collector

  1. Extract the downloaded Data Collector zip file to a local folder.

  2. Browse to the folder and double-click “setup.exe”.

    Tip

    Some security software (such as Microsoft Defender SmartScreen) or Windows features (such as UAC) may interrupt the installation. In such cases you will need to manually allow the Data Collector installer to run, typically via a “run anyway” or similar action.

  3. Depending on your environment, you might get prompted to install one or more of the following: .NET framework, Visual C++ runtime libraries, WinPcap. If you do, simply click Install and proceed to install the prerequisite software using default values.

    Note

    While installing WinPCap ensure the “Automatically start the WinPcap drive at boot time” option is selected.

  4. Click Next to start the Data Collector setup.

  5. Accept the license terms by selecting “I accept…”, then click Next.

  6. Choose a different installation folder or click Next to accept the default location.

    dc_install_3

  7. Click Install.

  8. Towards the end of the process, the Data Collector Configuration Tool will appear. You will need to provide details to register your data collector. Refer to the following section (“Registering the Data Collector”) for instructions.

    dc_install_9

  9. Click Finish to complete the installation.

Registering Data Collectors

Once you have installed the Data Collector, you need to register it with Hyperview using a unique registration token. The Data Collector Configuration Tool (which registers the Data Collector) is automatically triggered during the Data Collector installation.

You can also run the Data Collector Configuration Tool from C:\Program Files\Hyperview\Hyperview Data Collector\configurationTool\AgentConfigurer.exe, assuming you have installed the Data Collector at the default location.

To retrieve the registration token from Hyperview:

  1. Log in to your Hyperview instance as an Administrator.

  2. Go to Discoveries → Data Collectors → Add. The “Add Data Collector” modal will open.

  3. Click the copy icon to copy the registration token.

    dc_install_8

  4. Click OK to close the modal.

To configure the Data Collector using the Data Collector Configuration Tool:

  1. Paste the registration token and enter your API hostname (for example, “yourcompany.hyperviewhq.com”).
  2. Click Advanced to specify additional values, or leave as default.
    • If you want the Data Collector to use a specific port to communicate with Hyperview, enter an API Port Number.
    • Specify an alternate API Endpoint Name if applicable. Note that api is the only endpoint name that is currently supported.
    • Deselect the Use HTTPS checkbox if applicable. Note that all our customer-facing APIs are HTTPS-only.
    • In certain scenarios the Data Collector can only communicate via a proxy server. Specify the Proxy URL if applicable.
    • If you are using a custom BACnet device ID, select “Use Custom BACnet Server Device ID” and enter the custom device ID. (If you do not provide the custom device ID the device will still get discovered, but will be assigned a default ID.)
  3. Click Register.

Verifying your Data Collector setup

If your Data Collector was set up correctly, the Services view in Windows (search for the “Services” app from the Windows search bar) will indicate that the Hyperview Data Collector and Hyperview SNMP Trap Listener services are running and set to start automatically, as seen below.

services

Note

Please ensure the default SNMP Service in Windows is disabled to avoid potential errors due to port conflicts.