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

defUisCmds

The defUisCmds element is the parent node for default UIS commands. A default UIS command is one that is listed under the UIS Commands page in the remote device Properties dialog box. Attributes of defUisCmds can serve as default values for individual default UIS commands. However, default values can be overwritten at the individual command level.

Note: Default UIS commands only affect a remote device when it is created for the first time. Subsequent alterations of the device template file default UIS commands have no effect. Remote device copies only reflect the remote device as it appears in the remote device editors; its default UIS commands are not "reset."

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

 

<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

canBeScheduled

canBeScheduled specifies that a command can be scheduled using the Master Scheduling Service (MSS).

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

clientCanInvoke

clientCanInvoke specifies that the Execute button in the DDS editor is enabled.

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

inheritsSecurity

inheritsSecurity specifies whether or not security is inherited.

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

visible

visible specifies whether or not default commands are visible in the DDS editors.

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.