Index | Prev | Next

Command Notes

In addition to a proxy point “forceUpdate” action, note by default “normal right-click” commands appear on the action menu for Obix proxy points—providing the source R2 object has commands. Actions display mirroring the configured R2 object’s “commandTags” property strings, where applicable.

If a source R2 control object has “empty” (blank) commandTags properties, note that (by design) corresponding actions do not appear—the same as on the R2 object’s right-click command menu. However, note that those actions do exist on the slot sheet of the Obix proxy point with the Hidden config flag set, by default.

Also by default, note that some additional hidden actions may also exist, depending on the source R2 object type. See “Hidden actions” on page 2-14 for related details.

 NOTE: Actions for R2 object commands that are operator level (“Cmd, Std”) automatically default with the Operator config flag set. See the figure below for how these defaults look from the slot sheet of a proxy point.
Figure 26.   Obix proxy point from its slot sheet, showing Operator flag set on manual-level actions
Image
 

Such “manual” (often level 8) commands on R2 objects include:

  • manualSet (AnalogOutput, MultistateOutput)
  • manualAuto (AnalogOutput, BinaryOutput, MultistateOutput)
  • manualActive, manualInactive (BinaryOutput)
  • override, cancel, setOverrideValue (AnalogOverride, MultiStateOverride, BinaryOverride)

Note for a few R2 object types, due to the unique “string” content for command names, operator-level actions do not have the operator flag automatically set—for example an Obix proxy point for an R2 “Command” object, or for a BinaryOverride object’s “overrideActive” and “overrideInactive”. If needed, you can explicitly set the operator flags on these actions.

Hidden actions

Other hidden actions may also exist on the Obix proxy point’s slot sheet, including commands normally accessible only on the “Command menu” of the JDE (WorkPlace Pro), when that R2 object’s property sheet is displayed in the JDE for an admin-level user.

Examples of such commands for various control objects include:

  • resetAckedTransitions — For all alarm capable objects. Rarely used, it sets any cleared flags in the object’s ackedTransitions property.
  • resetChangeOfStateCount — For BI, BO, MSI, MSO objects. Zeroes out any accumulated COS value (numerical changeOfStateCount).
  • resetActiveTime — For BI, BO, MSI, MSO objects. Zeroes out any accumulated runtime value (numerical elapsedActiveTime).
  • setChangeOfStateAlertLimit — For BI, BO, MSI, MSO objects. To change the numerical COS limit for generating an alert (changeOfStateAlertLimit).
  • resetTotal — For a Totalizer object. Zeroes out any accumulated statusTotal value.
  • resetCounter — For an NdioHighSpeedCounterInput object. Zeroes out any accumulated totalOutput and countOutput.

If needed, you can expose any of these type actions by going to the slot sheet of the Obix proxy point, and clearing the “Hidden” config flag. These hidden actions appear listed with an “h” in the Flags column. However, it is anticipated that typically such actions will be left hidden. Note if hiding or unhiding command actions, you should hide the forceUpdate action too.

Related Links

  • About Obix proxy points (Parent Topic)

    • Index | Prev | Next