UISCommandName

The UISCommandName element defines a UIS command. UISCommandName is a placeholder element for the actual UIS command name; replace its text with the protocol- or user-defined name. Some commands are defined by protocol. Most are user defined. The UISCommandName is protocol- or user-defined. Name (ID) can be a maximum of 10 characters. Valid characters are A-Z, 0-9, dash (-), and underscore (_). ID cannot contain spaces and must start with an alpha character.

This element is:

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

Example

<defUisCmds visible="true" canBeScheduled="true" clientCanInvoke="true" inheritsSecurity="true">

<BASICPOLL desc="Basic Poll">

<uccItems>

<DG_F_DEV dgType="BasicPoll" ordinal="0"/>

</uccItems>

</BASICPOLL>

<DOCOMMAND desc="Do Command">

<uccItems>

<DG_T_DEV dgType="CmdMsg" ordinal="0"/>

</uccItems>

</DOCOMMAND>

<RESETRTU desc="Reset RTU">

<uccItems>

<DG_T_DEV dgType="CmdMsg" ordinal="0">

<uccParms CommandId="0"/>

</DG_T_DEV>

</uccItems>

</RESETRTU>

</defUisCmds>

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.

This attribute is required by the UISCommandName element.

Back to top