Configuring the OSI PI Collector

Procedure

  1. Start the Historian Administrator.
  2. Select the Collectors screen.
  3. Select the OSI PI Collector instance you wish to configure.
  4. If the collector is not listed in the available collectors list, you must start the collectors manually from the Windows Service Control Panel to register it.
    1. Open the Windows services control panel on the machine that contains the OSI PI collector
    2. Find the service name Historian OSI PI Collector.
    3. Select it and click Start on the top of the Services panel.
      As it is not configured it may start and then promptly stop- this is not an issue. The current step is solely to register it in Historian.
    4. Continue from Step 1 if is not listed in Historian Administrator once restarted, refer to OSI PI Collector Troubleshooting.
  5. Configure the OSI PI Collector's General options.
    1. (Optional) Enter a description for your OSI PI Collector.
    2. (Optional) In the Computer Name field, enter the host name of the computer your collector is running on.
    3. (Optional) If you want to change the default settings for memory usage and free disk space, change the values in the Memory Buffer Size and Minimum Free Space fields.
  6. Configure the OSI PI Collector-specific options.
    1. Click the Configuration tab.
    2. In the PI Server field, enter the OSI PI server name. For example, localhost.
    3. In the PI User name field, enter the OSI PI user name. For example, PiAdmin.
    4. If required, enter the OSI PI password into the PI Password field.
      This field can be left blank if no password is assigned for the OSI PI user.
      Note: If you change the PI Server name, user name or password fields, you must restart the collector service before the new configuration will take effect.
      Note: If the username and password are provided with the PI Collector, it uses explicit login to connect to the PI Server. If the username and password are not provided, then we use the implicit login functionality of PI SDK. In this scenario, either it would look for PI Trust or PI Mapping to connect to the PI Server.
    5. In the Max Recovery Time (hr) field, enter a new Maximum Recovery Time. By default, the maximum recovery time is 4 hours.
  7. Configure the default collection options.
    1. Click on the Tags tab.
    2. Enter a prefix to add to OSI PI Tags in Historian, for example: PI_.
    3. Enter a value for the Collection Interval.
      The default collection interval is 1 second. Note that polled collection is not supported.
  8. Configure the collector's advanced settings.
    1. To delay collection when the collector starts up, enter a value into the Delay Collection at Startup (sec) field.