Add and Configure an OSI PI Collector

Before you begin

Install PI AF SDK version 2.7.5 or later.

About this task

The OSI PI collector collects data from an OSI PI server. For more information, refer to Overview of the OSI PI 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 OSI PI 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
    PI SERVER Enter the host name or IP address of the OSI PI server from which you want to collect data. A value is required.
    PI USERNAME Enter the username to connect to the OSI PI server.
    PI PASSWORD Enter the password to connect to the OSI PI server.
  9. Select Next.
    The Destination Configuration section appears. Under CHOOSE DESTINATION, the Historian Server option is selected by default.
  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. The COLLECTOR NAME field is populated with a value in the following format: <host name or IP address of the PI server>_PICollector
  12. If needed, modify the value in the COLLECTOR NAME field. The value must be unique.
  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). By default, this option is selected, and 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 appear in the DETAILS section.
  15. Under Collector Specific Configuration, enter values in the following table.
    Field Description
    Max 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 OSI PI 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.

    The default value is 4 hours.
    Data Source Specify whether you want to collect data from PI archive or PI snapshot:
    • Archive: Stores timeseries-based data.
    • Snapshot: Stores the most recent values of tags.
  16. If needed, enter values in available fields.
  17. In the upper-left corner of the page, select Save.
    The changes to the collector instance are saved.
  18. 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.