Add and Configure an ODBC Collector Using Configuration Hub

About this task

The ODBC collector collects data from an application based on an ODBC driver. For more information, refer to Overview of the ODBC Collector.

This topic describes how to add a collector instance using Configuration Hub. You can also add a collector instance using the RemoteCollectorConfigurator utility, which does not require you to install Web-based Clients.

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. In the upper-right corner of 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 ODBC 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
    ODBC SERVER Enter the host name or IP address of the ODBC server from which you want to collect data. A value is required.
    USERNAME Enter the username to connect to the ODBC server. A value is required.
    PASSWORD Enter the password to connect to the ODBC server. A value is required.
  8. Select Next.
    The Destination Configuration section appears. The collector machine name provided by you is selected as the Source Configuration by default.

    Under CHOOSE DESTINATION, the Historian Server option is selected by default. In addition, the DESTINATION HISTORIAN SERVER field is disabled and populated with the collector machine name.

  9. Select the destination to which you want to send data, and then enter the values in the corresponding fields. You can send data to an on-premises Historian server or to a cloud destination.
    1. If you need to send data to a cloud destination, select the cloud destinations as needed.
      • Predix Timeseries- Select this if you need to send data to Predix cloud. For more information, refer to Predix Cloud.
      • Azure IoT Hub- Select this if you need to send data to Azure Cloud in KairosDB format. For more information, refer to Azure IoT Hub (KairosDB format).
      • MQTT- Select this if you need to send data to any of the following cloud destination.
        • Alibaba cloud. For more information, refer to Alibaba Cloud.
        • AWS cloud. For more information, refer to AWS Cloud.
        • Google cloud. For more information, refer to Google Cloud.
    2. If you need to send data to an on-premises Historian server, select Historian Server.
      If you created security groups or enabled a strict client/collector authentication, enter the USERNAME and PASSWORD of the on-premises Historian server that you created during the installation of the collector.
      If you entered the USERNAMEand PASSWORD, select Test Connection. This will help you to test if the Historian server that you are trying to connect is valid or if the credentials that you entered are valid.
      If the entered credentials are valid, a successful connection message appears.
  10. Select Next.
    The Collector Initiation section appears.
  11. If needed, modify the value in the COLLECTOR NAME field.
    The value that you enter:
    • Must be unique.
    • Must contain the string ODBC.
    • 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 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.
    • 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

    You can also configure the collector to start automatically when you start the computer.

  13. Select Add.
    The collector instance is added. The fields specific to the collector appear in the DETAILS section.
  14. In the COLLECTOR SPECIFIC CONFIGURATION section, configure values as described in the following table.
    Field Description
    Recovery Time (hours) Enter the maximum time, in hours, for which the collector will attempt to recover data after the collector is started or when connection between the collector and the ODBC server is re-established. This time is calculated as the duration between the current time and the last known write time.

    Continuous data collection is resumed only after the previous data has been recovered.

    By default, this value is set to 0, which means data recovery is not attempted. The maximum value you can provide is 168 hours (that is, 7 days).
    Throttle (Milliseconds) Enter the frequency, in milliseconds, at which you want the ODBC collector to query the ODBC server for tag data. This will minimize the load on the ODBC server. You can enter a value up to 16 hours.
    Note: If this field is blank, enter the required minimum value of 100 milliseconds.
    MTLS Security Indicates whether you want to use Mutual TLS (MTLS) protocol to enforce a secure and strong authentication mechanism.
    MTLS Data Encryption Indicates whether you want to encrypt the data that the collector shares to the data archiver (DA).
    For more information on how to enable MTLS Security, refer to Enable MTLS Security.
  15. As needed, enter values in the other sections common to all collectors.
  16. In the upper-left corner of the page, select Save.
    The changes to the collector instance are saved.
  17. If needed, restart the collector.

What to do next

Specify the tags whose data you want to collect using the collector. In the CHOOSE CONFIGURATION field,
  • If you have selected Historian Configuration, specify the tags using Configuration Hub.
  • If you have selected Offline Configuration, modify the offline configuration file of the collector. By default, the file is available in the following location: <installation folder of Historian>\GE Digital\<collector name>. For information, refer to Offline Configuration for Collectors. This option is applicable only if you have selected a cloud destination.