CygNet FMS Exceptions Control

CygNet Measurement > FMS ActiveX Controls > CygNet FMS Exceptions Control

CygNet FMS Exceptions Control

Exceptions Control icon The CygNet FMS Exceptions Control is an ActiveX control used to quickly view, sort, and filter exceptions.

See Using the Exceptions Control for more information about configuring and using this control.

See CxFmsExceptionsCtrl Object in the Scripting section for more information about scripting this control.

Adding an Exceptions Control to a Screen

To Add and Configure a CygNet FMS Exceptions Control in CygNet Studio

Create a new CygNet Studio screen.
Click the ActiveX tool on the Standard Tools palette.
Click and drag the outline of a box on the screen. When the mouse button is released, an Insert OLE Control dialog box appears.
In the dialog box, double-click on CygNet FMS Exceptions Control to place an Exceptions control on your screen.
Right-click the control to open its property sheet.
On the ActiveX page, click ... or double-click (OCXProperties) to access the CygNet FMS Exceptions Control Properties dialog box.
The CygNet FMS Exceptions control contains a General tab, an Exceptions tab, and a Commands tab.
Configure properties on each page as desired, click Apply, and then click OK.
Close the property sheet, save, and then switch to Run mode to use the control.

General Properties

The General page of the CygNet FMS Exceptions Control Properties dialog box contains the following properties.

General Properties

Property	Description
General
FMS service	Type the name of the Site.Service to which to connect in the control's Chooser, or click ... to access the Select Service dialog box.
Use Point in Time mode	Click the check box to select/clear the option to use the Point in Time mode.
PIT (C)	If Use Point in Time mode is selected, do one of the following. Type the desired date/time value into the text box. Click ... to access the Select Date and Time dialog box, then enter the date/time, in Contract time (C), from which you want to view data. Default value is T, date and time today. See Using the Home Menu for more information about PIT mode.
Use Session Node	Click the check box to select/clear the option to Use Session Node instead of using the Node chooser. Default value is cleared.
Use Session options	Click the check box to select/clear the option to Use Session options instead of entering a time window and time format. Default value is cleared.
Show Chooser pane	Click the check box to select/clear the option to display the Chooser pane in the control. Default value is selected.
Show Options pane	Click the check box to select/clear the option to display the Options pane in the control. Default value is selected.
Node Chooser
Allow FMS service selection	Click the check box to select/clear the option to show the FMS service selector in the control's Chooser.
Allow Node category selection	Click the check box to select/clear the option to show the Node category selector in the control's Chooser.
Allow multiple selections	Click to allow multiple selection of Nodes in the control's Chooser list.
Category	Select the desired Node Category to display in the control's Chooser from the drop-down menu. Options are as follows. <Any - Gas> Group Gas Device Station
Group	Select the desired Node Group type to display in the control's Chooser from the drop-down menu. Options are as follows. All Nodes General Station By Category
Filter	Select a filter. First type a partial string of known Node name/description/ID characters to populate the filter text box in the control's Chooser. Wildcard values * (multiple character) and ? (single character) are supported. Default value is * (multiple character wildcard) - all. Note: Wildcards can be used only when filtering by Name or Desc, not when filtering by ID. Then select a Node option to filter for results. Options are as follows. Name Desc ID
Primary column	Select the desired primary sort column in the control's Chooser from the drop-down menu. Options include the following Type ascending Name ascending Description ascending Type descending Name descending Description descending Default value is Name ascending
Date
Start	Date selections are in Contract days (C). Enter the starting date (absolute or relative date) in the text box or click ... to access the Select Date dialog box. See Selecting Date and Time for more information.
End	Date selections are in Contract days (C). Enter the ending date (absolute or relative date) in the text box or click ... to access the Select Date dialog box. See Selecting Date and Time for more information.
Format	Select the desired time format from the drop-down menu. Options are as follows. Device Contract Local Note: Selecting a time format of Device or Contract time does not affect the format in which you view Generated Date/Time timestamp values, which are always in Local time (L). The view of other data displayed in the grid will reflect your time format selection.

See Using the Exceptions Control for more information about configuring these properties

Exceptions Properties

The Exceptions page of the CygNet FMS Exceptions Control Properties dialog box contains the following properties.

Exceptions Properties

Property	Description
Unit set	Select a Unit set in which to view the data. Options appear in the drop-down menu, which is populated by the unit sets defined in the service, and includes a default unit set.
	Refresh the available unit set list
Columns	Click ... to access the Exceptions Columns dialog box to select what columns to display in the control. Options are as follows. Node Name Exception Status Exception Description Severity Node Priority Exception Date/Time (D) Value Limit Generated Date/Time (L) Ignored Audit Record Node Description Exception Type Units See Using the Exceptions Control for more information about columns.
Grouping hierarchy	If used, click ... to access the Groups dialog box to select a custom grouping heirarchy to sort results displayed in the control. Click the check box(es) to select/clear each item to use for sorting results, and then click and drag the selected items into the hierarchical order desired for sorting. Options are as follows. Exception Date/Time (D) Exception Description Exception Status Exception Type Generated Date/Time (L) Ignored Audit Record Limit Node Description Node Name Node Priority Severity Units Value
Max exceptions per Node	Type the number for the maximum quantity of exceptions records to display. Note: Once the exceptions within this number of records are handled, the screen can be updated, and another set of records returned. Default value is 2000
Log source	Click to access the Configure Filter dialog box to select/clear the check boxes for exception statuses and exception types (that caused the exception) to include in the records displayed in the control. Show exceptions with status: Open Ignored Resolved manually Resolved automatically Show exceptions of type: Gas device Gas station Configuration log Default value is "Open" exceptions of all exception types selected.

See Using the Exceptions Control for more information about configuring these properties.

Commands Properties

The Commands page of the CygNet FMS Exceptions Control Properties dialog box contains the following options.

Commands Properties

See Managing Node Commands for more information about configuring commands for the FMS Exceptions control.

CygNet FMS Exceptions Control – Properties, Methods, and Events