Preparing the Generic Time Series Buffer (GTSB)

The History Transport Manager uses a Generic Time Series Buffer object to transfer the data from inside inmation to the target historian. This document addresses the configuration of this object.

For the sake of brevity, 'Generic Time Series Buffer' is commonly abbreviated as GTSB.

1 In the I/O Model on the "Transferring" machine, right-click on the Connector object for the Target Historian and select Admin  New  Data Stores  Generic Time Series Buffer to create a new object of this type.

2 In the Create Object wizard, provide a Object Name. In this example, the object is called GTSB for History Transport Manager.

3 For the Lua Script Body property, click on the …​ icon to open the Script Editor Display.

4 Copy the following script below into the Script Editor Display.

return function(...)
    local iter, sink = ...
    if iter.length > 0 then
		syslib.log(3, "message received")
        local payload = { id = {}, message = {} }
        for saf_id, prp_id, v, q, t, d in iter() do
            table.insert(payload.id, saf_id)
            table.insert(payload.message, ("%s: %s"):format(prp_id, v))
        end
        local suc, err, context = sink:SEND(payload.message)
        if context.acked > 0 then
            iter:ack(payload.id[context.acked])
        end
        if not suc then error(err) end
    end
end

This is a very basic GTSB script, sending the historical data of the selected tags as a simple string MQTT message. See the Generic Time Series Buffer page for more advanced examples.

5 Click OK to close the editor and navigate to the Interface Extension section.

Configuring GTSB’s Interface Extension

The Generic Time Series Buffer offers two options for the Interface Extesion: the MQTT Publisher and the Kafka Producer.

Using the MQTT Publisher

1 Expand the Interface Extension property compound and for the Extension Selector property select MQTT Publisher from the drop-down list.

2 Expand the now visible MQTT Publisher Parameters properties compound and enter a Topic. For this example "History Transport Manager MQTT" is used.

3 For the Quality Of Service property select 1. This means the publisher will wait for confirmation from Broker that it received a message.

4 Click Create to close the wizard and create the new Generic Time Series Buffer object.

Adding the GTSB to a DataStore Set

6 Select the Core object.

7 In the Properties Panel, expand the DataStore Configuration properties compound and click the table icon for the Data Store Sets property.

8 Add a new line, providing a Name (e.g. DataStore for History Transport Manager) and, in the Data Stores column, select the GTSB object that you just created.

9 Click OK to close the table display and Apply the changes to the Core’s properties.

On the next page, in the section on Specifying the Target GTSB, this DataStore Set will be configured as the target for the history transfer process.

Continue Reading

On the next page the General Configuration of the History Transport Manager is addressed.