History Export

This document addresses how the History Transfer Controller is used to transfer historical data from the system to 3rd-party historians.

Prerequisites

To be able to transfer Historical Data to an external historian, the system requires a Connector component to be installed on the machine hosting the external historian. If a Bridge Interface is needed for the connection to the external historian, this also needs to be configured beforehand.

Depending on the target historian system, it might be necessary that the target historian has tags/points configured which correspond to the objects for which historical data is to be exported, before the export is launched.

Creating a History Transfer Controller

The History Transfer Controller object manages a connection between the system and an external historian.

  1. In the I/O Model, right-click the Core object and in the context menu, select Admin  New  History  History Transfer Controller.

  2. In the Create Object wizard, provide a name, and optionally a description.

  3. The Recurrence property defines how often historical data is transferred. For testing, set this to 'Each 5 Seconds'. For real application, set this property to a suitable value.

  4. Click OK to close the dialog.

  5. Then click Create.

History Sink Configuration (in the History Transfer Controller object)

The connection between the system and the target historian is established by a History Sink object. Normally, this object is created automatically by the History Transfer Controller object but it’s also possible to reference an existing History Sink object using the properties which are addressed in the next steps. In this case, the previous configuration of this History Sink object will be overridden by the History Sink Configuration settings of the History Transfer Controller object.

Specifying the History Sink object

  1. Select the History Transfer Controller object in the I/O Model.

  2. In the Object Properties Panel, expand the Sink Configuration compound.

  3. Click on the …​ button for the Connector property and in the dialog select the Connector object on the host machine of the external historian.

  4. In the Object Name property, specify the name of the History Sink object. If no object of this name exists in the Folder Hierarchy (see next step) underneath the Connector, a new History Sink object with this name will be created at this location in the I/O Model.

  5. Optionally, set the Folder Hierarchy property to specify a folder structure underneath the select Connector object, where the History Sink object is located or shall be created. If this structure yet doesn’t exist underneath the selected Connector object, it will be created there.

Setting the configuration of the specified History Sink object

  1. Expand the Configuration property compound.

  2. For the Interface property select a suitable option for the target historian from the drop-down list.

  3. An individual property compound for the selected Interface will be displayed. See the following table for specific configuration instructions for these compounds.

    Table 1. Interface-specific configuration requirements
    Interface Configuration

    PI Bridge

    The properties in the PI Connection property compound can be left on their default settings.
    On the OSI PI System, 'Points' need to be configured which correspond to the objects for which historical data is to be exported.

    Disk (JSON Dump Files)

    Enter a directory path to export the file to.

    Kafka Producer

    Minimum configuration consists of providing the Topic in the Kafka Producer Parameters as well as a Bootstrap Server in the Global Configuration Properties sub-compound.
    Additional information on the Kafka-related properties can be found in the librdkafka Configuration documentation.

    MQTT Publisher

    Minimum configuration consists of providing the Topic in the MQTT Publisher Parameters as well as a Broker Address and Broker Port (default is '1883') in the Connection Parameters sub-compound.
    For detailed information, also see History Transfer Controller with MQTT Publisher.

    Aspentech IP.21

    This is an ODBC connection; see the Hands On for Relational Dababase ODBC Datasource for a step-by-step guide.

Editing the History Sink Configuration

If the Sink Configuration compound of an History Transfer Controller object is edited when the specified History Sink object already exists, these settings will override the configuration of this History Sink as soon as the Processing Mode of the History Transfer Controller object is set to 'Operation'.
When the configuration of the History Sink is to be changed, these changes should be made via the History Transfer Controller object and not directly on the History Sink object.

Specifying the Objects for History Export

To export data from the system to an external historian, the objects for which data which is to be exported, need to be specified in the Object Configuration property compound of the History Transfer Controller. There, related data is grouped in so called 'blocks'.

  1. In the I/O Model, select the History Transfer Controller object.

  2. For the Object Configuration property compound, click on the + icon to create a new block.

  3. Expand the newly added block and provide a Block Name.

  4. Click on the table button for the Block Configuration property.

    In the Block Configuration dialog, a new line needs to be added for each object from the I/O Model which is to be transferred to the historian.

    1. Drag-and-drop the object for which the historical data should be exported into the 'Object Path' column on the line with the + icon on the left hand side.

    2. In the 'Target ID' column provide the name of the tag ('Point' on the OSI PI System) to which the data should be transferred on the target system.

  5. When all objects are configured in the Block Configuration, click OK to close the dialog.

Starting the Data Transfer

To start the data transfer, go to the Common section of History Transfer Controller’s properties and set the Processing Mode property to 'Opperation', then click Apply for the Properties Panel.