RecParmName, SendParmName

RecParmName and SendParmName elements define the get and send parameters for a data group. RecParmName and SendParmName are placeholder tags for an actual receive or send parameter; replace their tag text with the protocol- or user-defined ID. Most receive parameter and send parameter names are defined by specific protocols. However, some device template files (for example, Modbus) allow the addition of user-defined names. The RecParmName or SendParmName can be a maximum of 10 characters. Valid characters are A-Z, 0-9, dash (-), and underscore (_). RecParmName and SendParmName cannot contain spaces and must start with an alphabetical character.

These elements are:

Case sensitive; must match the case of the receive or send parameter they reference
Not required in a CygNet data group
If used, used 1 or more times per CygNet data group

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

Example

See also: the Single-Element Data Group topic for your device type.

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
desc	desc is the user-defined description of a data group element, typically used as a name or title. Depending on implementation, sometimes this attribute's value appears in remote device editors and sometimes it does not. Value User-defined string, no character limit.
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.
required	required specifies whether or not a parameter is required. Value: Must be a Boolean value true or false.
type	type defines the appropriate data type for one or more DataGroupElement elements; it can be inherited from a parent element. Value: bin.hex: Binary hex boolean: Boolean i1: Character i2: Short integer i4: Integer i8: Integer r4: Float r8: Double ui1: Byte ui2: Unsigned short integer ui4: Unsigned integer ui8: Unsigned integer string: String struct: Structure See also sourceType.