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:

Case sensitive
Required if you want to use support data groups in the structure illustrated below
Used 1 or more times per CygNet supportDg element

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

Example

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.
forceSave	forceSave specifies whether or not to save a data group’s transactions to the DDS whenever a data group request is issued by a UIS command. (Data group transactions are created for all requests issued directly from device editors in CygNet Explorer.) There are cases where the device driver forces every transaction of a particular data group to be saved to the DDS, regardless of the use of forceSave. For example, some device restrictions allow data to be retrieved only once, and FMS data groups always save transactions. If this attribute is not defined in a given data group, that data group uses its default save behavior, which varies by data group. Value: Must be a Boolean value true or false.
ord	ord represents the support data group ordinal; omit to use the same ordinal as the history data group. Value Integer value only.
ordIncrement	ordIncrement specifies how many registers make up an increment of registers. It is always used in combination with regNum, which specifies a starting register number from which to increment.These two attributes are used to specify one or more groups of registers that correspond to data group ordinals. ordIncrement always depends on regNum, but regNum does not depend on ordIncrement. Optionally, use regNum_ordn in place of ordIncrement + regNum.Value:Must be an integer.
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.