History Transfer Controller - Transporter Configuration

The properties in this property compound correspond to properties on properties of the History Transporter object which will be created by the History Transfer Controller when it is started for the first time. Once this History Transporter object exists, all configuration changes made in the History Transfer Controller’s Transporter Configuration property compound will automatically be relayed to the managed History Transporter object.

To avoid confusion, do not make any configuration changes directly on History Transporter objects which are managed by History Transfer Controller objects. Always use the Transporter Configuration property compound of the managing History Transfer Controller object to change the behavior of managed History Transporter objects.

Adding a Transporter Configuration

In the properties panel of the History Transfer Controller object, go to the Transporter Configuration property compound and click the + button by to add a new Transporter Configuration.

  • The History Transfer Controller can be used to oversee history transfer options for multiple History Transporters (transporting history from different interfaces and sources). Clicking the + button will add another Transporter.

  • If you intend to use multiple History Transporter objects for the same source, for the purpose of load balancing, using the History Transport Manger object instead of the History Transfer Controller object is recommended.

Name, Description, Folder Hierarchy

Enter a unique Object Name for the Transporter.

It’s good practice set some kind of marker (either in the Object Name or in the Object Description), that the History Transporter object that will be created based on the settings in this Transporter Configuration property compound is managed by the History Transfer Controller object.

When configuration is eventually finished, the Transporter will be created beneath the inmation.OpcServer.1.

If you wish to also create a Folder/Node hierarchy to place the Transporter in, this can be specified in the Folder Hierarchy property.

Selecting the Data Source

For the Datasource property click on the …​ icon to open the Object Picker dialog for this property.

If the source historian uses OPC, select the Datasource object for this historian.
For this example, select the inmation.OpcServer.1 and click OK to confirm selection.
In this case there is no need to configure the Alternative Interface so you can skip this step and continue with the Tag Configuration.

If the source historian uses different communication (like OSI PI or the Uniformance PHD Server), select the Connector object next to the source historian as the Datasource. In this case the Alternative Interface property needs to be configured as described in the following section on Alternative Interface Configuration.

Alternative Interface Configuration

In this case there is no need to configure the Alternative Interface so you can skip this step and continue with the Tag Configuration.

The Alternative Interface Configuration is only relevant for other Source Historian systems like the OSI PI system historian or the Uniformance PHD Server. If you are using an inmation system as Source Historian (as we are in this example), you can skip this section and continue at the section on Tag Configuration.

The system offers a number of interfaces to connect ot external historians. Which one is to be used for the history transfer is specified in the Alternative Interface property.

For the connection to the OSI PI system historian or the Uniformance PHD Server the fitting Bridge Interface should be used. The service for the Bridge Interface needs to be installed on a Connector instance which is either running on the same machine as the source historian itself, or on a local machine which also has a suitable client for the historian running, e.g. the OSI PI AF Client. Information on the OSI PI Asset Framework and installation of the OSI PI AF Client can be found on the OSIsoft website.

The installation of the Bridge services is described in detail on dedicated pages for the inmationPIBridge (for the OSI PI system historian) and the PHDBridge (for the Uniformance PHD Server).

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".

Selecting the Tags

For the History Transfer Controller object, the tags for which historical data is to be transferred need to be specified in the Tag Configuration table property.

1 Click on the Table icon for the Tag Configuration property to open the Tag Configuration table.

In this table the tags from the external historian for which historical data should be transferred are specified.

2 With this table open, for each tag for which historical data should be transferred …​

  1. Locate the tag underneath the External Historian Datasource object ('inmation.OpcServer.1' in this example) in the I/O Model. (on the left side of the illustration)

  2. Copy the Item ID of this tag into the ExternalID column in the table.

  3. Enter an ObjectName for each tag row.
    This will be the name of the newly created I/O Item/DataHolder that will historize the transferred data in the "Local" system

  4. Optionally, a NodeName can be added to group the tags in folders on the "Local" system.
    In this example the NodeName column is used to group the tags by data types.

The completed Tag Configuration table looks like this:

Completed Tag Configuration table

3 Click OK to close the table.

Processing Mode

Make sure that the Processing Mode property is set to Subscription since the Source Historian for this example provides its data using OPC.

The Configuration and Reset options are not available in he Transporter Configuration property compound as the history transfer process is started, stopped and reset via the Common > Processing Mode property of the History Transfer Controller object.

Defining the Transfer Period

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

Setting the History Transfer Cycle Frequency

The Recurrence property defines when and how often a history transfer cycle is triggered. For example, with the 'Each Day' option, a history transfer cycle is triggered daily, at midnight ('00:00:00 UTC').

For the purposes of demonstration, set the Recurrence property to "Each minute" so that the results of history transfer can be seen and evaluated more quickly. For a production environment a more suitable option should be used.

Continue Reading

The next page addresses the configuration of the Sink Congfiguration property compound of the History Transfer Controller object .