dataGroups
The dataGroups element is the parent element for all DataGroup elements. Its attributes are default values for its child DataGroup elements; default values can be overwritten at the child DataGroup element(s). Element contents nested between the dataGroups start and end tags define most particulars of a remote device. These element contents include things like data group definitions and command parameters.
This element is:
- Case sensitive
- Required in every CygNet device template file
- Used 1 time per CygNet device template file
To learn about how this element relates to other elements in a CygNet device template file, see Device Template File Hierarchy.
Example
 Click here to see an example of the element
<deviceDefinition desc="Emerson ROC800L" mfg="Emerson" ...> <dataGroups udcCat="~UDCALL" canSend="true" canRecv="true" uccSend="true" ...> <AI800 niceName="Analog Input" devDG="false" ...> <dgElements secLev="4" tlpType="103" fldAccess="RW"> <Tag desc="Point Tag ID" type="string" len="10" tlpParm="0"/> <Units desc="Units Tag" type="string" len="10" tlpParm="1"/> <Scanning desc="Scanning" type="ui1" tlpParm="2"/> </dgElements> </AI800> <.../> <.../> </dataGroups> </deviceDefinition> |
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 |
|---|---|
|
baseOrd |
baseOrd defines the starting point from which to begin numbering data group ordinals. (Each ordinal is a different instance of a data group.) It may be used in conjunction with maxCnt. baseOrd is required for every data group; it must be defined in either the dataGroups or DataGroup element. Value:
|
|
blockOrdLabel |
blockOrdLabel defines the Modbus register ordinal label text that appears in various places in ordinalized data group device editors (for example, Data Group Properties and the ordinal selector in data group data dialog boxes). For example, Modbus Register Ord. Used in conjunction with showBlockOrd. Value:
|
|
canRecv |
canRecv specifies whether or not data groups can be retrieved from a field device. Value:
|
|
canSend |
canSend specifies whether or not data groups can be sent to a field device. Value:
|
|
devDG |
devDG specifies whether or not a data group applies to a parent field device or to one of the field device's child devices, like a meter. For example, date and time are typically device data group items whereas differential pressure is not. Value:
|
|
maxCnt |
maxCnt defines the maximum number of instances (i.e., ordinals) of a data group allowed. Best practice recommends that you always define the maxCnt attribute. When used, it is used in conjunction with baseOrd. Data group instances start at the baseOrd value and increment upwards until they reach the limit set by maxCnt. If you do not use maxCnt, an unlimited number of ordinals is implied. Value:
|
|
ordLabel |
ordLabel defines the ordinal label text that appears in various places in ordinalized data group device editors (for example, Data Group Properties and the ordinal selector in data group data dialog boxes). For example, Run #. Value:
|
|
showBlockOrd |
showBlockOrd indicates whether or not to show the Modbus Register Ord field in the Data Group properties dialog box. If not included in the file, the attribute defaults to "true" to show the field. Used in conjunction with blockOrdLabel. Value:
Note: For several Modbus devices, the registers for meter-based data are organized strictly by meter number. Therefore when the ordinal number in CygNet represents a meter number, it will always be the same as the block ordinal. Because the values are always the same, the following template files include the
Contrast that with Thermo devices, where registers are organized first by meter type, then instance (for example, the first orifice meter or the first turbine meter). In this case, while the ordinal number in CygNet represents a meter number, the block ordinal reflects the instance within a meter type (for example, meter 1 may be the first orifice meter, while meter 2 may be the first turbine meter). See the Ordinalized Data Group topic for the following EIEs for more information: Modbus EFM, Modbus Omni, Modbus Realflo, Prosoft. |
|
uccRecv |
uccRecv specifies whether or not data groups can be retrieved from a field device by means of a UIS command. Value:
|
|
uccSend |
uccSend specifies whether or not data groups can be sent to a field device by means of a UIS command. Value:
|
|
udcCat |
udcCat defines the UDC category used when mapping UDCs to data group elements in a data group. It affects the UDC category field of the Choose UDC for element dialog box in the DDS editor. It helps in filtering possible UDC categories for a given data group. Value:
See Uniform Data Codes. |
|
udcDefFac |
udcDefFac enables a warning message to appear if you change a data group's facility and that data group has one or more UDC mappings. The warning prompts you to change existing mappings to the new facility. UDC mapping is associated with the facility assigned to a data group, so changing a data group's facility disassociates existing UDC mappings from the data group. Value:
See Mapping UDCs. |
