CygNet Filter Rules are used to create custom filter options to limit the amount of data that is presented to the user in many CygNet Studio ActiveX controls and other CygNet applications.
Use the Rule Definition dialog box to select and/or build filter rules with variable options to create a logical filter to assist with filtering data. The tool builds a query string to be used to display or filter data when the rule is selected. Rules may be (AND)’ed or (OR)’ed to create a single rule filter, or options are available to combine multiple single rules to (AND) and (OR) rules together to create compound rules.
The CygNet Filter feature is used in the following CygNet editors, controls, and utilities:
| Application or Utility | Item Filtered | Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Alarm | Alarm Record | Audit | Current Values | Custom | Event Info | Facility | Group | History | Note | Notification | Point | ||
|
Canvas |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CygNet Business Object Builder, Business Object Mappings |
|
|
|
||||||||||
|
CygNet Explorer, Energy Load Forecasting Editor, UIS Commands |
|
||||||||||||
|
CygNet Explorer, GCM Device Editor, Group Filters |
|
||||||||||||
|
CygNet Measurement |
|||||||||||||
|
CygNet Report Module |
Reports |
|
|||||||||||
|
CygNet Studio CygNet-Aware tools, [ReferenceFacility] property |
|
|
|
||||||||||
|
CygNet Studio, CAS View Control and CygNet Explorer, CAS pane |
Alarm |
|
|
|
|
||||||||
|
CygNet Studio, CygNet-Aware tools, [ReferenceFacility] property |
|
||||||||||||
|
CygNet Studio, Event Summary Control, Data |
AUD Events |
|
|
|
|
|
|||||||
|
CygNet Studio, Event Summary Control, Data |
ELS Alarms |
|
|
|
|
|
|
||||||
|
CygNet Studio, Event Summary Control, Data |
ELS Events |
|
|||||||||||
|
CygNet Studio, Facility Navigation Bar Control |
Initial Facility |
|
|
||||||||||
|
CygNet Studio, GCM Nomination Grid Control |
|
||||||||||||
|
CygNet Studio, Group Navigation Bar Tool |
|
|
|||||||||||
|
CygNet Studio, Trend Tool |
Display Information |
|
|||||||||||
|
CygNet Explorer, GNS Editor, Messages, Reference Point Tag |
|
|
|
|
|||||||||
|
Point Configuration Manager utility |
Point Attribute |
|
|
||||||||||
|
VHS Recovery utility, Journal File Recovery and Database Recovery |
|
||||||||||||
Each CygNet application or control mentioned above utilizes the same Rule Definition feature to create filter rules; however the comparison items that may be chosen for the rule will vary according to the context.
Each CygNet Studio ActiveX control has a scripting interface that can be used to manipulate the configuration and options of the filter rules. See Scripting for each control for more information about the methods available.
The following scripting options are available for data interface functions related to the Facility Rules dialog box.
| COM API | Description and Link |
|---|---|
|
CxDialogs CxScript |
The ShowFacilityRulesDialog method displays the Facility Rules dialog box.
The ShowFacilityRulesDialogSimple method displays the Facility Rules dialog box.
|
More:
Adding Filter Rule Definitions