History Transport Manager Configuration

This page addresses the creation of a History Transport Manager object as well as its essential configuration. The history transfer process is managed on the "Transferring" machine and needs to be configured there.

So make sure to …​

1 Connect DataStudio to the Core on the "Transferring" machine.

Creating a New History Transport Manager

Under which exact object the History Transport Manager object needs to be created depends on the source historian system.

  • If an Aspen InfoPlus.21 system is used as the source historian, the History Transport Manager object needs to be created under the gRPC Datasource object representing this system.

  • If an OSI PI system historian or an Uniformance PHD Server acts as source historian, the History Transport Manager object needs to be created on the Ingress Connector itself, as Bridge Interfaces are involved.

  • For historians communicating through OPC, the History Transport Manager object needs to be created under the Datasource object representing this source historian.

For this example we are using the OSI PI system historian, so the Ingress Connector object will be used as the parent object.

When you have identified the adequate parent object according to the criteria above in the I/O Model, …​

1 Right-click the identified parent object and select Admin  New  History  History Transport Manager.

Create History Transport Manager Wizard - Common Section 2 In the Create Object wizard, enter a Name.
In this example the object is called History Transport Manager

3 Click Create to close the Create Object wizard and create the new History Transport Manager object in the I/O Model.

4 For the next steps, select the newly created History Transport Manager object in the I/O Model to display its properties in the Properties Panel.

Specifying the Tags

The Interface Filter Property

For the History Transport Manager, tags are not selected individually but are specified using a filter string with wildcards in the Interface Filter property. Syntax and wildcards depend on the Source Historian system.
In this example SINUS* is used for which matching tags (named 'SINUSOID' and 'SINUSOIDU') exist on our sample Source Historian machine.

1 Enter an adequate filter for your Source Historian, matching the tags which you want to transfer.

Sharing the Workload

The Parallelism Property The History Transport Manager divides the workload of the history transfer process between a number of worker History Transporter objects. These objects will be created in a dedicated folder called '_Workers', underneath the History Transport Manager object. This number is specified in the Parallelism property.

1 For this example, leave the Parallelism property on it’s default value of 4 workers.

Status Properties

The Parallelism Property Manager Schedule, Manager Browse List, and Manager Assignment are read-only table properties providing information regarding the status of the History Transport Manager and the history transfer process controlled by it. These status tables start filling as soon as the Mode property in the Common compound of the History Transport Manager is set to Operation (and this change of the Object Properties is applied).
To delete information regarding the state of the history transfer process, the checkbox for the Reset Status can be selected. All status information will then be reset as soon as Apply is clicked for the Property Panel.

Resetting the status information for an unfinished history transfer process and starting the process again is likely to produce duplicate data on the Target Historian System.

Specifying the Source Historian

If an Aspen InfoPlus.21 system is used as the source historian or the source historians relies on OPC for communication, this section is not relevant and you can continue at Timing the History Transfer Operations.

For OSI PI system historians and Uniformance PHD Servers the Alternative Interface needs to be configured.

In this example we are using an OSI PI system historian as the Source Historian system so …​

1 Open the Transporter Configuration property compound in the History Transfer Controller and then open the Alternative Interface options. Select appropriate option from the Alternative Interface Selection drop-down menu. Then expand the …​ Connection property compound.

2 The Host Name or IP property can be set to "" or "localhost" if the Bridge service is running on the same host as the Connector service.

  • For the PI Bridge service, the default Port is "5959". It is also necessary to enter the PI-Server name which is wil be dependant on your own system.

    If using the OSI PI AF Client to connect to a remote PI Server, the PI Connection > PI Server property entered in the Alternative Interface settings for the PI Bridge is the same as the PI Server name used at installation of said client.
  • Fort the PHD Bridge, the default Port is "6959".

Timing the History Transfer Operations

The History Transport Manager operates its 'worker' History Transporter child objects in Schedule Mode Scheduler with the History Transport Manager object itself acting like a Scheduler Object. The 'schedule' for the various operations which are executed or triggered by the History Transport manager is defined by the properties in the Operation Options compound.

The Operation Options

For the following operations individual execution frequencies can be specified, immediate executions be triggered and callback functions defined:

  • Browse Options refer to namespace browsing on the Source Historian.

  • Deploy Options control the forwarding of changes in the Transporter Configuration compound to the 'worker' History Transporter child objects.

  • Transport Options refer to the history transfer cycles.

  • Diagnostic Options - control the information updateds in the Diagnostics property compound.

In a development environment it’s helpful to set the …​ Period properties to a small value (e.g. 5 seconds) so that you don’t have to wait too long before the effects of any configuration changes become apparent.

On a production system, set the …​ Period properties to values where the history transfer does not interfere with the other tasks of the system.

The Transporter Configuration Property Compound

Configruation options which affect the behavior of the 'worker' History Transporter objects (which will be created by this History Transport Manager object on its initial execution) are configured in the Transporter Configuration property compound.

Later configuration changes for the 'worker' History Transporter objects should also be made in this property compound of the History Transport Manager object - not on the 'worker' objects themselves. These configuration changes will then be deployed to the child History Transporter objects according to the settings in the Operation Options > Deploy Options property compound.

Setting a Folder for Discovered Tags

The Folder Hierarchy Property

Underneath the History Transport Manager object, objects are created which correspond to the tags on the Source Historian that match the Interface Filter. The Folder Hierarchy property in the Transporter Configuration property compound can be used to specifiy a folder hierarchy (underneath the History Transport Manager object) in which those tags will be created.

1 For this example, enter Discovered Tags.

Processing Mode

The Processing Mode Property

The Transporter Configuration > Processing Mode defines how the historical data is transferred.

1 For this example, since we are using a Bridge Interface to transfer data from the Source Historian, set the Processing Mode property to Continuous.

The Configuration and Operation options are not available in he Transporter Configuration property compound as the history transfer process is started and stopped via the Common > Mode property of the History Transport Manager object.

Defining the Historical Timespan

The Transporter Configuration > Depth property specifies the historical timespan for which tag data shall be transferred.

1 For this example, set the Depth property to "*-30 days" to transfer the last 30 days of history for the selected tags.

Specifying the Target GTSB

The destination for transferring historical data with a History Transport Manager is specified in Transporter Configuration > New Item Preset > Archive Selection.

1 Expand the Transporter Configuration properties compound and navigate to the Acquisition Options > New Item Preset > Archive Selection property and select the DataStore Set to which the GTSB was added previously.

Continue Reading

The History Transport Manager object is now fully configured so that the history transfer process with the History Transport Manager can be started as described on the next page.