Data Groups
With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.
CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.
For information about data group definitions and device template files, see Device Template Files.
For more information about data group dependencies, see Data Group Dependencies.
Note: The SuperFlo II template is highly specialized. Its data groups and data group elements cannot be altered; only minor alterations can be made to the SuperFlo II template (for instance, to default UDC mappings).
For AutoMATE, AutoPILOT, AutoPILOT PRO, and AutoEXEC devices, Modbus data groups can be added and deleted. For relevant data group elements, units must be defined in the template. See your field device's manufacturer documentation for supported unit types. Enron data groups must contain the correct number and types of data group elements per the Enron EFM standard. The following standards must also be met:
- Enron Events: This data group's dgCat attribute must be set to "enronEvents". For example:
<EnrEvents niceName="Enron Events" dgCat="enronEvents">. You do not need to explicitly define this data group's register number because it is always assumed to be 32 according to the Enron standard. If used, this data group must also be referenced in the supportDg section of the "FMS Alarms" and/or "FMS Events" data groups.
- Enron EventsS: (Applies only to AutoPILOT PRO and AutoEXEC devices.) This data group is only required if you support devices that have an audit/alarm buffer at register 33. If used, this data group's dgCat attribute must be set to "enronEvents", and its regNum attribute must be set to "33". For example:
<EnrEventsS niceName="Enron Events Supplemental" dgCat="enronEvents" regNum="33">. If used, this data group must also be referenced in the supportDg section of the "FMS Alarms" and/or "FMS Events" data groups.
For SuperFlo II devices, only "Configurable Modbus Data Group" data groups may be added or modified. No other data groups may be added or modified for SuperFlo II devices.
Notes:
-
When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
- Best practice recommends that you do not perform UDC and point processing on FMS data groups. The DEIDs specified in FMS data groups are generic and use the eFMS enumeration to identify the CygNet-defined FMS items referenced in the device template file. No polling is done on these data groups — all data is coming from the native data groups. Points should be mapped to the native data groups since that is the data group that is actually processing the device data. While point processing may work on the FMS data groups, it is not supported, not tested, not consistent across EIEs, and is not recommended practice.
Thermo EIE Data Groups
Browse by letter: [A] [C] [D] [E] [F] [G] [H] [I] [M] [P] [R] [S] [T]
| Data Group Type | Usage Notes |
|---|---|
|
"Accumulator Inputs (Exec)" |
|
|
AccInPro |
"Accumulator Inputs (Pro)" |
|
AIExec |
"Analog Inputs (Exec)" |
|
AIPro |
"Analog Inputs (Pro)" |
|
AnlgInput |
"Analog Inputs" |
|
AOExec |
"Analog Outputs (Exec)" |
|
AOPro |
"Analog Outputs (Pro)" |
|
The "Configurable Data Group" data group provides a flexible way to create custom data groups on a per-device basis. "Configurable Data" See Configurable Data Group. |
|
|
Composite Data Group |
The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group. |
|
"Date and Time" |
|
|
DIExec |
"Discrete Inputs (Exec)" |
|
DIPro |
"Discrete Inputs (Pro)" |
|
DOExec |
"Discrete Outputs (Exec)" |
|
DOPro |
"Discrete Outputs (Pro)" |
|
DpCfg |
"DP Meter Config" |
|
DpData |
"DP Meter Data" |
|
"DP Daily Hist" "DP Hist Support" must be added before polling this data group. One "DP Hist Support" data group is required for each "DP Daily Hist" data group. They must use the same Run# and Modbus Register Ord values. |
|
|
"DP Hourly Hist" "DP Hist Support" must be added before polling this data group. One "DP Hist Support" data group is required for each "DP Hourly Hist" data group. They must use the same Run# and Modbus Register Ord values. |
|
|
DpMtrNm |
"DP Meter Name" |
|
Add the "DP Hist Support" data group before retrieving history for the "DP Daily Hist" and "DP Hourly Hist" data groups. One "DP Hist Support" data group is required for each "DP Daily Hist" and "DP Hourly Hist" data group. They must use the same Run# and Modbus Register Ord values. |
|
|
"Enron Daily Hist" See Enron History Data Groups. |
|
|
"Enron Daily Hist w/Gas" See Enron History Data Groups. |
|
|
The "Enron Events" data group's dgCat attribute must be set to "enronEvents". For example: You do not need to explicitly define this data group's register number because it is always assumed to be 32 according to the Enron standard. This data group must also be referenced in the supportDg section of the "FMS Alarms" and/or "FMS Events" data groups. Note: When changing the transaction retention settings for this data group type, you will be prompted to confirm the change. CygNet recommends that data be retained for at least 40 days to be available for CygNet Measurement. Either change the transaction retention settings to retain more data, or accept the settings, which may cause CygNet to lose data that cannot be retrieved again. See Enron Events Supplemental and Enron Events data groups. |
|
|
The "Enron Events Supplemental" data group is only required if you support devices that have an audit/alarm buffer at register 33. If used, this data group's dgCat attribute must be set to "enronEvents", and its regNum attribute must be set to "33". For example: This data group must also be referenced in the supportDg section of the "FMS Alarms" and/or "FMS Events" data groups. See Enron Events. |
|
|
"Enron Hourly Hist" See Enron History Data Group. |
|
|
"Enron Hourly Hist w/Gas" See Enron History Data Group. |
|
|
EnrSupt |
"Enron Hist Support" See supportDg and SupportDataGroup. |
|
The "FMS Alarms" data group must include a supportDg section. Typically, the supportDg section includes EnrEvents and/or EnrEventsS. Dependencies:AutoPILOT and AutoMATE devices only:
AutoPILOT PRO and AutoEXEC devices only:
-AND/OR-
|
|
|
FmsConfig |
"FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal. The "FMS Configuration" data group must include a supportDg section. Typically, the supportDg section includes EnrEvents and/or EnrEventsS. See FMS Configuration Data Group. Dependencies:AutoPILOT and AutoMATE devices only:
AutoPILOT PRO and AutoEXEC devices only:
|
|
The "FMS Events" data group must include a supportDg section. Typically, the supportDg section includes EnrEvents and/or EnrEventsS. See FMS Events. Dependencies:AutoPILOT and AutoMATE devices only:
AutoPILOT PRO and AutoEXEC devices only:
-AND/OR-
|
|
|
The "FMS Daily History" data group must include a supportDg section. Typically, the supportDg section includes EnrEvents and/or EnrEventsS. Dependencies:AutoPILOT and AutoMATE devices only:
-OR-
AutoPILOT PRO and AutoEXEC devices only:
-OR-
|
|
|
The "FMS Hourly History" data group must include a supportDg section. Typically, the supportDg section includes EnrEvents and/or EnrEventsS. Dependencies:AutoPILOT and AutoMATE devices only:
-OR-
AutoPILOT PRO and AutoEXEC devices only:
-OR-
|
|
|
"Gas Analysis" |
|
|
GasQlty |
"Gas Quality" |
|
"Historical Avg Curr Val" |
|
|
HistIdx |
"History Support (Index)" |
|
"History Records (Trend)" |
|
|
"Instant Data" |
|
|
"Meter Data - Stacked Orifice" |
|
|
MeterOrU |
"Meter Data - Unstacked Orif/Cone" |
|
MeterStCal |
"Meter Station Curr Values" |
|
MeterTr |
"Meter Data - Turbine" |
|
MeterTrA |
"Meter Data - Turbine Auto Adjust" |
|
"Physical Honeywell DE Inputs" |
|
|
PID |
"PID" |
|
PlgrCfg |
"Plunger Lift Configuration" |
|
"Plunger Cycle Hist" |
|
|
PlgrHist |
"Plunger History (Last 10)" |
|
"Plunger Minute Hist" |
|
|
PlgrSupt |
Add the "Plunger Hist Support" data group before retrieving "Plunger Cycle Hist". |
|
A valid "RTU Configuration" data group must be retrieved before other data groups can be retrieved or sent. |
|
|
"Scanner Data" |
|
|
"Single Read-Only Coil". See Single-Element Data Group. |
|
|
"Single Read/Write Coil". See Single-Element Data Group. |
|
|
"Single Read-Only Register". See Single-Element Data Group. |
|
|
"Single Read/Write Register". See Single-Element Data Group. |
|
|
StCtlCV |
"Station Control Current Values" |
|
SXdcIExec |
"Smart XDucer Input (Exec)" |
|
SXdcIPro |
"Smart XDucer Input (Pro)" |
|
SysControl |
The "System Control" retrieves, displays, and edits various system-level control parameters. |
|
SysStatus |
"System Status" |
|
"Tank Levels" |
|
|
TrbCfg |
"Turbine Meter Config" |
|
TrbData |
"Turbine Meter Data" |
|
"Turbine Daily Hist" "Turbine Hist Support" must be added before polling this data group. One "Turbine Hist Support" data group is required for each "Turbine Daily Hist" data group. They must use the same Run# and Modbus Register Ord values. |
|
|
"Turbine Hourly Hist" "Turbine Hist Support" must be added before polling this data group. One "Turbine Hist Support" data group is required for each "Turbine Hourly Hist" data group. They must use the same Run# and Modbus Register Ord values. |
|
|
TrbMtrNm |
"Turbine Meter Name" |
|
Add the "Turbine Hist Support" data group before retrieving history for the "Turbine Daily Hist" and "Turbine Hourly Hist" data groups. One "Turbine Hist Support" data group is required for each "Turbine Daily Hist" and "Turbine Hourly Hist" data group. They must use the same Run# and Modbus Register Ord values. |
