Running the History Transfer with the History Transfer Controller

When you have finished the configuration of the Transporter and Sink objects in the History Transfer Controller Object Properties panel, you can start the history transfer process.

Starting the History Transfer

  1. Make one final check of the configuration of the History Transfer Controller to make sure mandatory properties have been selected (Object Names, Connector or Datasource selection, Connection settings etc.) and check for any typos or other errors that might cause problems.

  2. When ready, change the History Transfer Controller Processing Mode to "Operation" and click Apply to start the transfer.

The Initialization Phase

Once activated, the History Transfer Controller creates a History Transporter object underneath the designated Datasource and the History Sink object underneath and the designated destination Connector.

The History Transporter then creates the I/O Nodes and I/O items using the entries in the NodeName and ObjectName columns of the Tag Configuration table.

The transfer of the 30 days of historical data (as configured in the Transporter Configuration > Depth property) proceeds in the background.

The History Transporter and History Sink objects will show one green "good" light (indicating an overall good object state) initially and will show 2 green lights (indicating an overall good object state AND good communication state) when the first successful transfer cycle is completed.
If any of the objects shows a red "bad" state then the Diagnostics section of the Object Properties panel should be checked for errors (see below for more information).

Diagnostics

The Diagnostics property compound provides information regarding the most recent run (including data size, runtime, errors and end time of last run).

The Process State property displays the time remaining until the next run. When in operation, it shows what the Controller is currently doing (for example, "Waiting for HistorySink").

The Diagnostics property compound of the History Transporter object displays the progress of the history transfer from the source historian to the I/O items historizing in the MongoDB repository only.

This History Transporter progress will normally be completed before the complete transfer is shown on the History Transfer Controller. This is due to the relative fast speed of transfer and writing to the system’s MongoDB compared to the History Sink’s output to file or an external target historian.

Status Table

The Controller Status table in the History Transfer Controller object’s properties panel provides information about the progress of the history transfer on a tag by tag basis.

The table contains information about the start and end time of the up to date (UTD) values (these are the values that have been transferred as subscription or near time values from the moment the history transfer was started) and the history (HIS) values that are transferred and backfilled to the Depth value specified during the Transporter configuration.

Statistics

When a new History Transfer Controller is created, the Statistics checkbox is selected by default. This leads to the creation of a series of performance monitoring Variable objects underneath the Controller object which can be used to analyze all aspects of the transfer.

Statistics objects are also created underneath the Transporter and Sink objects giving more specific performance data for their individual functions.

Checking the Result of the History Transfer and Exported Files

Once Diagnostics indicates that the transfer is complete, the tags underneath the History Transporter can be checked for transferred history data by adding them to a History Trend or History Grid display.

The data exported by the History Sink object can be checked by navigating the Windows File Explorer to the location specified in the Sink Configuration > File Path property and opening the exported history data files in a text editor.

The files are named with the timestamp of each cycle of the export. For each transfer cycle a new file is created - until the transfer is completed.

Each file contains a JSON with all the historical VQT data transferred during this transfer cycle, organized by tag.