Before You Begin

Software Requirements

If you are using Historian 7.0 SP4, the following configuration is required:
  • OSI PI Data Archive (version 3.2\3.3\3.4)
  • OSI PI v1.3.4 or greater
  • OSI PI SDK (About PI-SDK) v1.4.2 or greater
    Note: The OSI PI SDK is required for running OSI PI Collector, however, the OSI PI SDK does not ship with Historian. If the OSI PI SDK is not installed, the OSI PI Collector will not start. If you install the OSI PI Collector on a machine that does not contain your PI Server, be sure to install the OSI PI SDK on the machine with the OSI PI Collector.
  • Historian 3.0 or greater
If you are using 7.0 SP5, the following configuration is required:
  • OSI PI AF Server version 2015 R2 SP1 or greater
  • OSI PI Data Archiver v 3.4.380 or greater
  • OSI PI AF SDK 2.7.0 or greater
    Note: The OSI PI AF SDK is required for running OSI PI Collector or PI Distributor, however, the OSI PI AF SDK does not ship with Historian. If the OSI PI AF SDK is not installed, the OSI PI Collector or PI Distributor will not start. If you install the OSI PI Collector or PI Distributor on a machine that does not contain your PI Server, be sure to install the OSI PI AF SDK on the machine with the OSI PI Collector and the PI Distributor. PI SDK is no longer supported with the 7.0 SP5 version of the PI Collector. If you are using the OSI PI Collector or PI Distributor from the 7.0 SP5 (or greater) installer, the PI AF SDK or greater is now required.

    The PI AF Software Development Kit (PI AF SDK or AFSDK) is installed with the PI AF Client and provides programmatic access to PI Server data (PI Data Archive and AF).

  • About-PI SDK utility

Hardware Requirements

There are no additional hardware requirements for the OSI PI Collector or PI Distributor.

Configuring the OSI PI Data Archive

By default, no specific configuration is required for the OSI PI Data Archive to allow the OSI PI Collector to collect data and archive it to the Historian Server or Predix Cloud. However, a user with read permissions must be configured in the OSI PI data server for the OSI PI Collector.

Note: The OSI PI Collector reads data directly from the OSI PI archives and attempts to maintain a near real-time operation. It has been tested up to 25,000 events per second. However, performance is dependent on hardware and network capabilities, so if the collector begins to fall significantly behind real-time, it may be more suitable to partition the data retrieval into two or more collectors.

Upgrading and Using the PI Snapshot Collection

In some scenarios you may wish to run the collector in the same way as in the previous versions (Pre-6.0) of PI Collector. For example, you may upgrade from an older version of the collector and still want to retain the existing, original behavior.

If this is not the case then you do not need to configure anything and may skip this section.

Use the following steps where you want to retain the existing original behavior.

To configure the newly added OSI PI Collector to retrieve data from the OSI PI snapshot cache:
  1. Run the Registry Editor (regedit.exe).
  2. Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\PICollector.
  3. In the case of a 64-bit system this may be found at HKEY_LOCAL_ MACHINE\SOFTWARE\Wow6432Node\Intellution, Inc.\iHistorian\Services\PICollector
  4. If you have multiple collectors, each would have to be configured to allow for snapshot operation, and the key would be the name of the other collector.
  5. Locate the registry key name General5.
  6. Change it from Archive to Snapshot.
  7. Restart the Historian PI Collector service from the Windows services control panel.

    The latest log file will indicate that the collector is using the snapshot database for collection. Refer to OSI PI Collector Troubleshooting, for information about tracing operational issues with the OSI PI Collector log files.

To configure existing OSI PI Collector to retrieve data from the OSI PI snapshot cache
  1. Access Historian Administrator.
  2. Select the Collectors page.
  3. Select the OSI PI Collector.
  4. Select Configuration.
  5. In the Data Source field, enter the data source as snapshot.