Tag Configuration

The Tag Configuration property is a fixed schema table property that is used when configuring History Transfer objects, particularly the History Transporter configuration. The Tag Configuration table contains information about the tags that historical data will be transferred from. The columns are explained below.

Column Descriptions

Table 1. Tag Configuration Table - Columns
Label Data Type Column Description Mandatory

ExternalID

string

This field is the only mandatory field in all the configurable columns of the table property. It qualifies the tag (or symbolic name in general) which will be used in queries for contextual information, historical data and snapshot data. It must be provided in exactly the syntactical format to be understood by the external historian system.

Example for AspenTech IP.21:

FIC_0999_PV

or

DefinitionRecords.IP_AnalogDef.FIC_0999_PV

or

“DefinitionRecords.IP_AnalogDef”.FIC_0999_PV

NOTE: It is strongly suggested to omit the Definition Record name. History Transporter will determine the matching Definition Record automatically (also applies to custom/user-defined Definition Records)

Example for OSI PI:

FIC_0999_PV

or

\\piservername\FIC_0999_PV

Yes

Aggregate

string

Not supported in the current release

-

NodeName

string

Decides about the location of a data object for a particular Tag Configuration entry.

Despite its singular name it can either contain a single Node name or a combination of multiple. If the data object shall reside beneath a multi-node structure, the Node Names have to be separated by a forward slash. In case, one or multiple Node Names shall contain a forward slash in their names, those forward slashes have to be escaped with a leading caret (“^”) sign. Relative Node Names are possible pointing “upwards” the hierarchy, but limited to the scope of the Connector hosting the History Transporter object. Node Names are translated to either Generic Folders or I/O Nodes, depending on the mode of the History Transporter. In Subscription mode, I/O Nodes are created, in Continuous mode, Generic Folders are created. See below for examples.

No

ObjectName

string

The Object Name at destination Node (as described above). It may contain any characters including dots and forward slashes. Forward slashes must not be escaped. This will automatically happen in case the Object Name contains one or multiple forward slashes. If left empty, History Transporter will apply the External ID as an Object Name.

No

Expected Frequency

string

Not supported in the current release

-

Target ID

string

If specified, the entry will be transferred to a History Sink Item object which in turn will include it with each data record transmitted to an external data receiver. If a particular History Transporter is not part of a “History Chain”, including a History Transfer Controller and a History Sink Item object, the Target ID has no function

No

Description

string

If specified, the entry will be supersede a potentially existing Description retrieved from the external historian system. This can be used if the description regime in the external historian is not satisfying the expectations of a particular data receiver, e.g. only providing localized descriptions.

No

Refetch

string

This column is only used by the History Transfer Controller object controlling a particular History Transporter (if configured in a chain accordingly). Changes in a Tag Configuration in a particular History Transfer Controller will be reflected in the Tag Configuration property of the History Transporter. Changes will reload the History Transporter, but the setting changes will have no further effect.

-

Examples

NodeName Examples

The type of object created that corresponds to the NodeName column entry depends on whether the Processing Mode of the History Transporter is set to "Subscription" or "Continuous".

Table 2. Examples of object type created for different History Transporter Processing Modes
NodeName Entry Mode Result

Motor

Subscription

The data object receiving historical data will be created as an I/O Item object below the History Transporter object in an I/O Node object called “Motor”

Motor

Continuous

The data object receiving historical data and near-time continuous history data will be created as a Data Holder Item object below the History Transporter object in a Generic Folder object called “Motor”

Here are some examples of expected results when the NodeName column entry contains characters that refer to relative paths or potentially ambiguous path names. These examples follow the rules described in the Relative Paths and Lua path disambiguation explanations.

Table 3. Examples of object type created for different History Transporter Processing Modes
NodeName Entry Result

1.2/3.4

Two Nodes will be created below the History Transporter object, one called “1.2” and the child of it will be called “3.4”.

../Motor

A Node called “Motor” will be created in the same Node, History Transporter resides in (below the parent object of History Transporter).

../../Motor

A Node called “Motor” will be created on the same Node, the parent object of History Transporter resides in (below the parent object of the parent object of History Transporter).

../../Motor/A/B

Relative to the above explained “Motor” Node, two Nodes will be created, called “A” and “B” as a child to “A”.

Motor/A^/B

The data object will be placed in a Node called “A/B” below the “Motor” Node, which in turn will reside below the History Transporter object.