Benchmark EIE – FMS Legacy History Data Group

FMS Legacy History Data Group

The "FMS Legacy History Data" (GmrHist) data group is used to send specific historical data to the FMS. Only one instance of an "FMS Legacy History" data group in a device template file is possible. It gets its data from one or more history support data groups.

Support data groups are found in the supportDg section of your sample template. Mapping between "FMS Legacy History" data group elements and FMS Legacy data items is within the histItems section of gmrMaps in the device template file.

Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time.

FMS Legacy History Data Group (DataGroup) Attributes

The following table describes "FMS Legacy History" data group attributes. All attributes in CygNet templates are case sensitive, but the case sensitivity of attribute values is based on context.

For information about available generic attributes, see DataGroup.

Attribute	Description	Value	Required
dgProtocol	Native and Internal data group types, as defined by the dgProtocol attribute, are not user-editable aside from mapping UDCs. To add a custom data group using the native protocol, set dgProtocol to "NativeRipn" and add RIPN elements as defined in Benchmark documentation.	Internal, NativeRipn	Yes
ptTime	ptTime is only applicable in Modbus-based FMS Legacy history data groups. It specifies which timestamp to associate with a historical value used in point processing. The FMS Legacy history data group has two timestamps: start time and end time. The time range represents the time span from which an average value is calculated. Value: start: The start time of a time range (for example, 10:00:00). endExclusive: The exclusive end time of a time range (for example, 10:59:59). endInclusive: The inclusive end time of a time range (for example, 11:00:00). Default is start.

Attribute

Description

Value

Required

dgProtocol

Native and Internal data group types, as defined by the dgProtocol attribute, are not user-editable aside from mapping UDCs.

To add a custom data group using the native protocol, set dgProtocol to "NativeRipn" and add RIPN elements as defined in Benchmark documentation.

Internal, NativeRipn

Yes

ptTime

ptTime is only applicable in Modbus-based FMS Legacy history data groups. It specifies which timestamp to associate with a historical value used in point processing. The FMS Legacy history data group has two timestamps: start time and end time. The time range represents the time span from which an average value is calculated.

Value:

start: The start time of a time range (for example, 10:00:00).
endExclusive: The exclusive end time of a time range (for example, 10:59:59).
endInclusive: The inclusive end time of a time range (for example, 11:00:00).
Default is start.

Support Data Groups (supportDg)

The following table describes "FMS Legacy History" support data groups.

Support Data Group	Description	Required
TBD	Your "FMS Legacy History" data group requires at least one support data group. Support data groups are user configurable for this EIE. Exactly what support data group(s) you choose depends on your unique setup and needs. Although you can choose which history data group will serve as a support data group for "FMS Legacy History," the history data group protocol (dgProtocol) must be "History".	Yes

Support Data Group

Description

Required

TBD

Your "FMS Legacy History" data group requires at least one support data group.

Support data groups are user configurable for this EIE. Exactly what support data group(s) you choose depends on your unique setup and needs.

Although you can choose which history data group will serve as a support data group for "FMS Legacy History," the history data group protocol (dgProtocol) must be "History".

Yes

Support Data Group (supportDg) Attributes

The following table describes "FMS Legacy History" support data group (supportDg) attributes. All attributes in CygNet templates are case sensitive, but the case sensitivity of attribute values is based on context.

Attribute	Description	Value	Required
N/A	At this time, there are no attributes unique to the supportDg section.	N/A	N/A