Devices > Remote Devices > Device Template Files > Elements and Attributes > SupportDataGroup

SupportDataGroup

The SupportDataGroup element defines support (i.e., referenced) data groups and elements. SupportDataGroup is a placeholder tag for an actual support data group type; replace its tag text with the protocol- or user-defined data group type. A support data group type defines individual referenced data groups and/or data group elements. SupportDataGroup element functionality is not available in a device template file for all EIEs. When available, it can be used on a data group-by-data group basis.

This element is:

To learn about how this element relates to other elements in a CygNet device template file, see Template File Hierarchy.

Example

ClosedClick here to see an example of the element

 

<DpHrlyGQ niceName="DP Hourly Hist GQ" dgCat="enronHistory" forceSave="true" baseOrd="1" maxCnt="12" leadingTime="true" recordMinutes="60" queueSize="840">

<supportDg>

<DpSupt deidIndex="HrlyIdx"/>

</supportDg>

<dgElements byteOrder="bigEndian" secLev="4" type="r4">

<HistDate desc="Date" off="0" hidden="true"/>

<HistTime desc="Time HHMMSS" off="4" hidden="true"/>

<DateTime desc="DateTime" type="r8"/>

</dgElements>

<modbusReadBlocks regByteLen="4">

<block1 regNum="704" ordIncrement="2" regCnt="1" funcCode="3"/>

</modbusReadBlocks>

<uccRecvParms>

<SDate required="false" desc="Start Date" type="string"/>

<EDate required="false" desc="End Date" type="string"/>

</uccRecvParms>

</DpHrlyGQ>

...

<DpSupt niceName="DP Hist Support" forceSave="true" baseOrd="1" maxCnt="12">

<dgElements byteOrder="bigEndian" secLev="4" type="r4">

<DlyIdx desc="Current Daily Hist Index" regDef="1:0"/>

<HrlyIdx desc="Current Hourly Hist Index" regDef="1:1"/>

</dgElements>

<modbusReadBlocks regByteLen="4">

<block1 regNum="7101" ordIncrement="2" regCnt="2" funcCode="3"/>

</modbusReadBlocks>

</DpSupt>

Attributes

The following table lists and describes attributes generally applicable to this element. However, not all of the attributes listed here are applicable to all EIEs. Additionally, some attributes are required for use in every device template file of a certain EIE, but others may be used on a case-by-case or device-by-device basis, depending on your specific needs. All attributes in templates are case sensitive; but the case sensitivity of attribute values is based on context.

Note: Occasionally, device template files for different EIEs use attributes of the same name that do different things. Efforts are made in this document to highlight cases where an attribute by one name does different things in different EIEs.

Attribute Description

deidIndex

deidIndex specifies the data group element in the support data group that contains the last record index written.

Attribute can be meter-specific: append _ord1 for meter run 1, _ord2 for meter run 2, and so on.

Value:
  • Referenced element name.

deidSize

deidSize identifies the data group element in the support data group that contains the maximum number of history records maintained on the device.

Include this attribute if the device can report the maximum number of history records maintained on the device, or set the queueSize attribute in the device template file to a fixed number.

Attribute can be meter-specific: append _ord1 for meter run 1; _ord2 for meter run 2, and so on.

Value
  • User-defined string.

ord

ord represents the support data group ordinal; omit to use the same ordinal as the history data group.

Value
  • Integer value only.

required

required specifies that the data group or data group element in the SupportDataGroup element in which it is referenced must be used. It is not one of several alternative sources of referenced data.

Value:
  • Must be a Boolean value true or false.
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.