Add and Configure an MQTT Collector

About this task

The MQTT collector collects data published to a topic using an MQTT broker. For more information, refer to Overview of the MQTT 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, select Collectors.
    A list of collectors in the default system appears.
  3. If needed, select the system in which you want to add a collector instance.
  4. 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.
  5. In the MACHINE NAME field, select the machine in which you want to add a collector instance.
  6. In the COLLECTOR TYPE field, select MQTT Collector, and then select Get Details.
    The INSTALLATION DRIVE and DATA DIRECTORY fields are disabled and populated.
  7. Select Next.
    The Source Configuration section appears.
  8. Enter values as described in the following table.
    Field Description
    MQTT BROKER ADDRESS Enter the host name of the MQTT broker using which you want to collect data. A value is required.
    MQTT BROKER PORT Enter the port number of the MQTT broker. A value is required.
    TOPIC Enter the MQTT topic from which you want to collect data. A value is required.
  9. Select Next.
    The Destination Configuration section appears. Under CHOOSE DESTINATION, the Historian Server option is selected by default. In addition, the DESTINATION HISTORIAN SERVER field is disabled and populated with the value you selected in the MACHINE NAME field in the Collector Selection section.
  10. Select the destination to which you want to send data, and then enter values in the available fields. You can send data to an on-premises Historian server or to a cloud destination such as Alibaba Cloud, AWS Cloud, Azure Cloud, Google Cloud, or Predix Cloud.
  11. Select Next.
    The Collector Initiation section appears.
  12. If needed, modify the value in the COLLECTOR NAME field. The value must be unique and must contain the string MQTT.
  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.
    • 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.

  14. Select Add.
    The collector instance is added. The fields specific to the collector section appear in the DETAILS section.
  15. If needed, enter values in available fields.
  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.