Add and Configure a HAB Collector

About this task

The HAB collector collects data from Habitat, which is a SCADA application that contains real-time data. The collector interacts with the Habitat Sampler application to fetch data from the Habitat database records and stores the data in a Historian server. For more information, refer to Overview of the HAB Collector.

Procedure

  1. Access Configuration Hub.
  2. In the NAVIGATION section, under the Configuration Hub plugin for Historian, select Collectors.
    A list of collectors in the default system appears.
  3. On the right, next to Settings in the main section, select .
    The Add Collector Instance: <system name> window appears, displaying the Collector Selection section. The MACHINE NAME field contains a list of machines on which you have installed collectors.
  4. In the MACHINE NAME field, select the machine in which you want to add a collector instance.
  5. In the COLLECTOR TYPE field, select Hab Collector, and then select Get Details.
    The INSTALLATION DRIVE and DATA DIRECTORY fields are disabled and populated.
  6. Select Next.
    The Source Configuration section appears.
  7. Enter values as described in the following table.
    Field Description
    SERVER SITE Enter name that you want to assign to the site. A value is required and must be unique. It is used by Habitat to identify the collector instance. By default, this field is populated with a value in the following format: <Historian server name>Hab
    SERVER 1 (under NODE 1) Enter the host name or IP address of the Habitat server in the primary site from which you want to collect data. This server acts as the primary/active server from which the collector receives data. A value is required.
    SERVER 1 (under NODE 2) Enter the host name or IP address of the Habitat server in the second/backup site from which you want to collect data. This server acts as a standby server in case server 1 under node 1 fails. A value is required. If you do not have a secondary/backup site, enter the same value as SERVER 1 under node 1.
    SERVER 2 (under NODE 1) Enter the host name or IP address of the Habitat server that you want to use as a standby server in the same site as server 1. This server acts as a standby server in case server 1 under node 2 fails.
    SERVER 2 (under NODE 2) Enter the host name or IP address of the Habitat server in the secondary/backup site from which you want to collect data. This server acts as a standby server in case server 2 under node 1 fails.
    For example, suppose Machine A and Machine B are in node AB, and Machine X and Machine Y are in node XY. Suppose you want to use Machine A as the primary server and the remaining machines as standby servers. In that case, enter values as follows:
    • SERVER 1 (under Node 1): Machine A
    • SERVER 2 (under Node 1): Machine B
    • SERVER 1 (under Node 2): Machine X
    • SERVER 2 (under Node 2): Machine Y
    If Machine A fails, the Machine B becomes active. If Machine B fails, Machine X becomes active. If Machine X fails, Machine Y becomes active.
    SOCKET The socket number (port number) used by the Habitat Sampler application to connect. Each collector instance can connect to only one socket. The default value is 8040.
    RETRY The duration, in seconds, after which the collector tries to communicate with the site. The default value is 5 seconds.
  8. Select Next.
    The Destination Configuration section appears. Under CHOOSE DESTINATION, the Historian Server option is selected by default. The other options are disabled because you cannot send data to a cloud destination using the HAB collector.
  9. If you want to connect to a remote Historian server, enter values in the USERNAME and PASSWORD fields.
  10. Select Next.
    The Collector Initiation section appears. By default, the COLLECTOR NAME field is populated with a value in the following format: <Historian server name>_Hab
  11. If needed, modify the value in the COLLECTOR NAME field.
    The value that you enter:
    • Must be unique.
    • Must not exceed 15 characters.
    • Must not contain a space.
    • Must not contain special characters except a hyphen, period, and an underscore.
  12. In the SamplerID field, enter the user ID to connect to Habitat Sampler.

    By default, this field contains the Collector Name. You can first provide the Collector Name and update the Sample ID field as this filed will automatically takes the Collector Name.

  13. In the RUNNING MODE field, select one of the following options.
    • Service - Local System Account: Select this option if you want to run the collector as a Windows service using the credentials of the local user (that is, the currently logged-in user). If you select this option, the USERNAME and PASSWORD fields are disabled. By default, this option is selected.
    • Service Under Specific User Account: Select this option if you want to run the collector as a Windows service using a specific user account. If you select this option, you must enter values in the USERNAME and PASSWORD fields.
      If you have enabled the Enforce Strict Collector Authentication option in Historian Administrator, you must provide the credentials of a user who is added to at least one of the following security groups:
      • iH Security Admins
      • iH Collector Admins
      • iH Tag Admins
  14. Select Add.
    The collector instance is added. The fields specific to the collector appear in the DETAILS section.
  15. Depending on whether you want to configure tags or alarms, select next to the corresponding field under Collection Definitions.
    The Data Collections or Alarm Collections section appears.
  16. Select , and then enter values in the available fields for data collection and/or alarm collection. You can also copy a collection definition by right-clicking it and selecting Duplicate.
  17. Under Collector Specific Configuration, enter values as described in the following table.
    Field Description
    Auto Tag Sync If you enable this option, the collector creates tags automatically in Historian based on the key value. In addition, any tag changes in Habitat (such as adding, renaming, and deleting tags) will reflect automatically in Historian. No manual steps are required.

    If you disable this option, any tag changes in Habitat will be captured in the <collector name>_Tag_Unconfirmed.xml file. Only after you approve these changes, they are reflected in Historian.
    Tag Deletion Type Specify whether deleted tags in Habitat that you have approved must be deleted or disabled for data collection in Historian. Enter one of the following values:
    • DISABLE_TAG (this is the default value)
    • DELETE_TAG
  18. As needed, provide values in the remaining fields.
  19. In the upper-left corner of the page, select Save.
    The changes to the collector instance are saved.
  20. Start the collector.

What to do next

If you have disabled the automatic tag sync option in the configuration file, tag changes in Habitat (such as adding, renaming, and deleting tags) are captured in the <collector_name>_tag.xml file. You must approve the changes so that they are reflected in Historian. To do so:
  1. Right-click the HAB collector instance that you have created, and then select Confirm Queued Tags.

    A list of tags that have been changed appears.

  2. Select the check boxes corresponding to the tags whose changes you want to approve, and then select Confirm. You can filter the list using the TAG TYPE field.

    The tag changes are approved. The status of the tags is updated in the <collector_name>_tag.xml file (that is, the Confirmed parameter is set to true).