Add a Python Collector Instance using Configuration Hub

Before you begin

About this task

This topic describes how to add a Python collector instance using Configuration hub.

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 Python Collector, and then select Get Details.
    Note: The INSTALLATION DRIVE and BASE DATA DIRECTORY fields cannot be changed. This is the drive location and the data directory folder that you provided during Collectors installation.
    The INSTALLATION DRIVE and DATA DIRECTORY fields are populated with the drive location and the data directory folder.
  6. 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.

  7. Select the destination to which you want to send data, and then enter the values in the corresponding fields.Collectors can send data to an on-premise or Cloud Historian server as well as cloud destinations.
    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-premise/Cloud 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-premise/Cloud 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.
  8. After you selected the destination, select Next.
    The Collector Initiation section appears.
  9. 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.
  10. 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.

  11. Select Add.
    The collector instance is added. The fields specific to the collector section appear in the DETAILS section.

What to do next

Specify the tags whose data you want to collect using the collector.