Add and Configure a Calculation Collector

About this task

Using the Calculation collector, you can perform data calculations on values already in the archiver. It retrieves data from tags in the Historian archive, performs the calculation, and then stores the resulting values into new archive tags.

You can create a Calculation collector only for an on-premises Historian server, not for a cloud destination.

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, 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 Calculation Collector, and then select Get Details.
    The INSTALLATION DRIVE and DATA DIRECTORY fields are disabled and populated.
  6. Select Next.
    The Source Configuration section appears. The HISTORIAN SERVER field is disabled and populated.
  7. Select Next.
    The Destination Configuration section appears. Under CHOOSE DESTINATION, the Historian Server option is selected by default; the other options are disabled. 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.
  8. If you created security groups or enabled a strict client/collector authentication, enter the USERNAME and PASSWORD of the on-premises 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.
  9. Select Next.
    The Collector Initiation section appears.
  10. 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.
  11. 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.

  12. Select Add.
    The collector instance is added. The fields specific to the collector section appear in the DETAILS section.
  13. Under COLLECTOR SPECIFIC CONFIGURATION, configure values as described in the following table.
    Field Description
    Calculation Timeout (sec) The maximum time a calculation must be performed before being terminated. The default value is 10 seconds. If the calculation takes longer, it is cancelled, and a bad data quality sample is stored in the destination tag with a subquality, calculation error.
    Max Recovery Time (hr) The maximum time, in hours till now, that the collector will attempt to restore data. This is applicable only to event-based tags. The default value is 4 hours.

    If you want to disable automatic calculation of the tag, set the value of this field to 0.
    MTLS Security Indicates whether you want to use Mutual TLS (MTLS) protocol to enforce a secure and strong authentication mechanism.
    MTLS Data Encryption Indicates whether you want to encrypt the data that the collector shares to the data archiver (DA).
    For more information on how to enable MTLS Security, refer to Enable MTLS Security.
  14. If needed, enter values in the other sections.
  15. In the upper-left corner of the page, select Save.
    The changes to the collector instance are saved.
  16. If needed, restart the collector.

What to do next

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