CygNet FMS ActiveX Controls – ActiveX Properties

This topic describes properties applicable to CygNet FMS ActiveX controls. Properties specific to each control are listed on the control-specific ActiveX page of its Property Sheet seen via CygNet Studio screens and in script editor views for each control in CygNet Studio. See Edit Mode Views in CygNet Studio for more information about accessing script editors. See CxHmiFms in the Scripting section for additional details about scripting properties specific to each FMS control object.

These properties are listed in the comprehensive properties table below, and also in the Properties, Methods, and Events topics specific to each ActiveX control.

The Comprehensive table contains a comprehensive listing of all the CygNet FMS ActiveX control properties.

The Control-Specific list contains links to topics containing tables of the properties, events, and methods specific to each CygNet FMS ActiveX control.

CygNet FMS ActiveX Control Properties: Comprehensive

ActiveX properties for CygNet FMS controls are listed in the comprehensive table below.

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [G]     [H]     [I]     [J]     [M]     [N]     [P]     [R]     [S]     [U]     [V]

Property Description Default Value

(OCXProperties)

In CygNet Studio, ActiveX control properties can be set on the control Property Sheet. Alternatively, many of the properties can also be set in the corresponding CygNet FMS * Control Properties dialog box, accessed via the property sheet.

Options to access CygNet FMS ActiveX control property configuration are as follows.

  • Set property values directly on the CygNet Studio / ActiveX control Property Sheet
  • For many properties, from the CygNet Studio / ActiveX control Property Sheet, double-click (OCXProperties) or click ... to access the CygNet FMS * Control Properties dialog box, and set values on the property pages provided.

See FMS ActiveX Controls for more information about using CygNet FMS ActiveX controls on CygNet Studio and CygNet Vision screens.

See CxHmiFms in the Scripting section for information about scripting FMS control objects.

N/A
AllowMultiSelect In the CygNet FMS Node Chooser control, specifies whether to allow multiple selection of Nodes in the Node list

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use OCXProperties to access the Control Properties dialog box > General page and select/clear the Allow multiple selections check box to define.

Note: See ChooserAllowMultiSelect for usage of this property in other controls.
0 - Flat
Appearance Specifies whether the control will have a 3D effect or a flat appearance

Options are as follows.

  • 0 - Flat
  • 1 - 3D
0 - Flat
AttributeDisplaySettingsXml In the CygNet FMS Dashboard control, specifies the XML string that contains the accumulated display settings for the control

Enter a known XML string.

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then Display Properties) to define.

See Configuring Dashboard Display Properties for more information.

 
BeginDate

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Specifies the start date for the time window displayed in the control

Acceptable values can be in one of the following forms.

  • Absolute date (e.g. 1/31/2023)
  • Relative date, which is an offset from the current day T (e.g. T-14 (14 days prior to today), or T+1 (one day following today)

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, then access the Start date selector) to define.

See Selecting Date and Time for more information.

T-7
BorderStyle Specifies the border style of the control’s boundary

Options are as follows.

  • 0 — None
  • 1 — Fixed Single
0 — None
ButtonText In the CygNet FMS Node Chooser control, specifies the text on the status bar button

Enter desired button text.

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and type desired text into the Button text text box) to define.

Allowable characters (maximum of 20) are A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

Set as Session Node
ChooserAllowMultiSelect For CygNet FMS controls supporting multiple Node display (Dashboard, History Graph, Exceptions, Close Period, Jobs), specifies whether to allow multiple selection of Nodes in the control-embedded Node Chooser

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select/clear the Allow multiple selections check box) to define.

Note: See AllowMultiSelect for usage of this property in the stand-alone CygNet FMS Node Chooser control.
1 - Yes
ChooserFilterString Specifies a partial string of known Node names to populate the Filter text box used to filter the value specified by the ChooserFilterType property, to generate selection options in the control-embedded Node Chooser

Enter a filter string. Wildcard values * (multiple character) and ? (single character) are supported.

Note: Wildcards can be used only when ChooserFilterType = Name or Desc, not when filtering by ID.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and enter text into the Filter text box) to define.

Note: See FilterString for usage of this property in the stand-alone CygNet FMS Node Chooser control.
* (multiple character wildcard) - all
ChooserFilterType Specifies the property type that will be filtered by the string specified by the ChooserFilterString property, to generate selection options in the control-embedded Node Chooser

Options are as follows.

  • 0 - Name
  • 1 - Description
  • 2 - ID

Select a property type.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select the Name, Desc, or ID radio button) to define.

Note: See FilterType for usage of this property in the stand-alone CygNet FMS Node Chooser control.

0 - Name
ChooserGroupSelection Specifies the desired Node group(s) used to generate selection options in the control-embedded Node Chooser

Options are populated according to groups of the following types, as configured in your system.

  • All Nodes - all Group Nodes
  • General - General Group Nodes
  • Station - Station Group Nodes
  • By Category - by Category value, if configured for the Node

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select a Node group from the selection tree) to define.

Note: See GroupSelection for usage of this property in the stand-alone CygNet FMS Node Chooser control.
Depends on the Group Nodes and Category values configured in your system

ChooserNodeCategorySelection

Specifies the desired Node category used to generate selection options in the control-embedded Node Chooser

Options are a subset of the following possibilities, as applicable to the selected control. (Corresponding controls are noted in parentheses.)

  • 1 - Node_Category1_Device (Dashboard, Jobs, Report)
  • 1 - Node_Category2_Device (History Graph, History Grid)
  • 1 - Node_Category3_Device (Exceptions)
  • 1 - Node_Category4_Device (Close Period)
  • 1 - Node_Category5_Device (Configuration, Raw Device Data)
  • 2 - Node_Category1_Group (Dashboard, Jobs, Report)
  • 2 - Node_Category3_Group (Exceptions)
  • 2 - Node_Category4_Group (Close Period)
  • 3 - Node_Category1_Station (Dashboard, Jobs, Report)
  • 3 – Node_Category2_Station (History Graph, History Grid)
  • 3 - Node_Category3_Station (Exceptions)
  • 3 - Node_Category4_Station (Close Period)
  • 3 - Node_Category6_Station (Balance)
  • 6 - Node_Category1_Any (Dashboard, Jobs, Report)
  • 6 - Node_Category3_Any (Exceptions)
  • 8 - Node_Category1_Gas_Device (Dashboard, Jobs, Report)
  • 8 – Node_Category2_Gas_Device (History Graph, History Grid)
  • 8 - Node_Category3_Gas_Device (Exceptions)
  • 8 - Node_Category4_Gas_Device (Close Period)
  • 8 - Node_Category5_Gas_Device (Configuration, Raw Device Data)
  • 9 - Node_Category1_Liquid_Device (Dashboard, Jobs, Report)
  • 9 – Node_Category2_Liquid_Device (History Graph, History Grid)
  • 9 - Node_Category3_Liquid_Device (Exceptions)
  • 9 - Node_Category4_Liquid_Device (Close Period)
  • 9 - Node_Category5_Liquid_Device (Configuration, Raw Device Data)
  • 9 - Node_Category6_Liquid_Device (Balance)
  • 13 - Node_Category1_Accessory (Jobs, Report)
  • 13 - Node_Category3_Accessory (Exceptions)
  • 16- Node_Category6_Any_Balance (Balance)
  • 17- Node_Category6_Station_Group (Balance)

Enter the string value.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select a value from the Category drop-down menu) to define.

Note: See NodeCategorySelection for usage of this property in the stand-alone CygNet FMS Node Chooser control.
Depends on control
ChooserNodeCategoryVisible Specifies whether to show the Node Category selector in the control-embedded Node Chooser

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select/clear the Allow Node category selection check box) to define.

Note: See NodeCategoryVisible for usage of this property in the stand-alone CygNet FMS Node Chooser control.
1 - Yes
ChooserPrimarySortColumn Specifies the primary sorting mechanism for the columns in the control-embedded Node Chooser

Options are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select a value from the Primary column drop-down menu) to define.

Note: See PrimarySortColumn for usage of this property in the stand-alone CygNet FMS Node Chooser control.
2 - Name ascending
ChooserSiteServiceSelection Specifies the value of the FMS service in the control-embedded Node Chooser

Enter a valid FMS service in the format Site.Service.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and then FMS service to access the Select Service dialog box) to define.

Note: See SiteServiceSelection for usage of this property in the stand-alone CygNet FMS Node Chooser control.
 
ChooserSiteServiceVisible Specifies whether to show the FMS service selector in the control-embedded Node Chooser

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select/clear the Allow FMS service selection check box) to define.

Note: See SiteServiceVisible for usage of this property in the stand-alone CygNet FMS Node Chooser control.
1 - Yes
CmdDefinitionXml Specifies the XML string that contains the accumulated configuration settings for the FMS command definitions for the control

Enter a known XML string.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Commands page) to define.

See FMS Commands for more information.

 
ColorExceptions In the CygNet FMS History Grid control, when a ColorGrid option other than "0 - None" is selected, specifies whether or not to show record rows according to the selected grid color mode value when the record contains data causing exceptions

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS History Grid Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Grid page and select/clear the Color rows containing exceptions check box) to define.

1 - Yes
ColorGrid

Note: This property is made available for device data views only; the option is disabled (appears dimmed) if Station data view is selected for a station meter Node.

In the CygNet FMS History Grid control, specifies the color mode option for displaying selected data in the grid

Options are as follows.

  • 0 - None
  • 1 - Row background
  • 2 - Row text
  • 3 - Date/Time background
  • 4 - Date/Time text

Selection of a value other than "0 - None" enables definition of the MaxDataQuality, ColorExceptions, and HighlightExceptionCells properties.

Alternatively, use the CygNet FMS History Grid Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Grid page and access the Color mode selector) to define.

See Using the History Grid Control for more information.

1 - Row background
ColorMode

Note: This property is made available for device data views only; the option is disabled (appears dimmed) if Station data view is selected for a station meter Node.

In the CygNet FMS History Graph control, returns/sets how colors are applied on the grid, whether to individual Nodes or based on acceptability (data quality) level

Options are as follows.

  • 0 - ColorModeSingleNode
  • 1 - ColorModeAcceptability

Use ColorXml to define background, line, and data quality colors for display in the graph.

0 - Single Node
ColorXml In the CygNet FMS History Graph control, specifies the XML string that contains the accumulated color settings (background, line, and data quality colors) for graphical display in the control

Enter a known XML string.

Alternatively, use the CygNet FMS History Graph Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Colors page) to define.

 
ColumnsXml In the CygNet FMS controls providing column display selection (Balance, Configuration, Dashboard, Exceptions, History Grid, Raw Data), specifies the XML string that contains the accumulated settings describing the columns to display in the control, as applicable to each Node type

Enter a known XML string.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Control page, then Columns selector) to define.

 
CustomColumnsUpdateInterval In the CygNet FMS Dashboard control, if ShowCustomColumns = 1 - Yes (option is selected for display), specifies the update interval, in number of seconds, for data in the custom columns

Enter number of seconds.

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Dashboard page, then in the Show as fixed columns: list, when the Custom columns option is selected, enter a value in the Update interval text box) to define.

See Using the Dashboard Control for more information.

Note: Custom columns are configured in FMS Explorer via the Admin Options menu. See Configuring Custom Columns for more information.

Persists as set; initial default value is 60 seconds
DataMode

In the CygNet FMS Dashboard, History Graph, and History Grid controls, specifies the data level to display in the control.

In the CygNet FMS Dashboard control, specify the data mode (level of data) for viewing summary data in the control; options are as follows:

  • 1 - Device_Mode - Device data
  • 3 - Station_Mode - Station data

In the CygNet FMS History Graph and History Grid controls, specify the data mode to use for a station meter Node (a gas meter Node set to also function as a station) [supersedes the deprecated MeterStationView property]; options are as follows:

  • 1 - Device_Mode - Device data
  • 3 - Station_Mode - Station data

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Dashboard page, then select a Data mode value from the drop-down menu) to define.

1 - Device_Mode

DataQualityColorXml In the CygNet FMS Balance control, specifies the XML string that contains the accumulated color settings to denote data quality values in the control

Enter a known XML string.

Alternatively, use the CygNet FMS Balance Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Balance page, then Data quality color selector) to define.

 
DataView

In the CygNet FMS Configuration, Dashboard, and Raw Data controls, specifies the type of data view to display in the selected control

In the CygNet FMS Configuration control, specifies the data type to display in the control; options are as follows:

  • 0 - Data_View_Config - Configuration
  • 1 - Data_View_Gas_Analysis - Gas analysis

In the CygNet FMS Dashboard control, specifies the data view option to display in the data grid, depending on the DataMode value (device-level or station-level records) selected [supersedes the deprecated VisibleAttribute property]; options are as follows:

When DataMode property is set to 1 - Device_Mode, data view options are as follows.

  • 0 - DataQuality - Data quality
  • 1 - HasConfig - Configuration poll
  • 2 - OpenExceptions - Open exceptions
  • 3 - LinkExceptions - Linked exceptions
  • 4 - EditState - Edit state
  • 5 - CollectStatus - Collection status
  • 6 - CollectStatusDetail - Collection details
  • 7 - ExportStatus - Raw data export
  • 8 - AnalystOverview - Analyst overview

When DataMode property is set to 3 - Station_Mode, valid data view options are as follows.

  • 0 - DataQuality - Data quality
  • 2 - OpenExceptions - Open exceptions
  • 4 - EditState - Edit state
  • 8 - AnalystOverview - Analyst overview

See Data view in the Using the Dashboard Control topic for more information about available data view options.

In the CygNet FMS Raw Data control, specifies the data view options to display [supersedes the deprecated DisplayMode property]; options are as follows:

  • 1 - AlarmEntry
  • 11 - ConfigLogRaw
  • 20 - EventEntry
  • 27 - GasQualityRaw
  • 25 - MeteringRaw
  • 57 - BatchRaw
  • 112 - TicketRaw

See Data view in the Using the Raw Data Control topic for more information about available data view options.

Alternatively, use the CygNet FMS [control name] Control Properties dialog box to define:

  1. From the Property Sheet > ActiveX page, double-click (OCXProperties) (or click ...) to access the CygNet FMS * Control Properties dialog
  2. In the control properties dialog, select the [control name] page.
  3. On the control page, select a Data view value from the options in the drop-down menu.

Configuration control:

0 - Data_View_Config

Dashboard control:

8 - AnalystOverview

Raw Data control:

25 - MeteringRaw

DateFormat

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Specifies the date/time format for the time window displayed in the control

Options are as follows.

  • 0 - Device_Time - Device
  • 1 - Contract_Time - Contract
  • 2 - Local_Time - Local

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and access the Format selector) to define.

0 - Device_Time
DateTimeDisplayMode In the CygNet FMS Balance and Dashboard controls, specifies the date display convention for the control

Options are as follows.

  • 0 - LeadingTime - Leading time
  • 1 - TrailingTime - Trailing time

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > [control] page, then Date display selector) to define.

0 - LeadingTime
DecimalPrecision Specifies the decimal precision for data values displayed in the control

Acceptable values include 0 - 10 decimal places.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > [control] page, then Decimal precision selector) to define.

7
DisplayMode
Note: This property deprecated in favor of DataView

In the CygNet FMS Raw Data control, specifies the data view to display

See DataView for details.

 
EndDate

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Specifies the end date for data to display in the control

Acceptable values can be in one of the following forms.

  • Absolute date (e.g. 1/31/2023)
  • Relative date, which is an offset from the current day T (e.g. T-14 (14 days prior to today), or T+1 (one day following today))

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and access the End date selector) to define.

See Selecting Date and Time for more information.

T
FilterConfigXml In the CygNet FMS Alarm, Configuration, Dashboard, or Exceptions controls (those providing optional filtering) specifies the XML string that contains the accumulated filter settings to use for defining what data to display in the control

Enter a known XML string.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Control page, then Filterselector to define.

Valid values are as follows for each control.

In the CygNet FMS Alarm control:

Filter options are as follows.

  • Entry - Event generated
  • User - User generated

Default value is all selected.

In the CygNet FMS Configuration control:

Filter options are as follows.

  • Device - polled from a device
  • Device file - imported from a device-generated file
  • Event generated - data changed due to an event
  • Imported - imported from other measurement system files
  • Linked gas quality - data from linked gas quality sources
  • System generated - system-generated data for non-history records
  • User entered - user-entered or edited, but not replacing calculated values
  • User file - imported from user-generated files

Default value is all selected.

In the CygNet FMS Dashboard control:

Filter options depend on the Data view selected. See Configuring Dashboard Filters for more information.

In the CygNet FMS Exceptions control:

Filter options are as follows.

Show exceptions with status:

  • Open
  • Ignored
  • Resolved manually
  • Resolved automatically

Show exceptions of type:

  • Gas device
  • Gas station
  • Gas configuration
  • Gas analysis
  • Liquid metering
  • Liquid configuration
  • Job

Default value is "Open" status exceptions, of all exception types listed.

See the corresponding ActiveX control usage topic (CygNet FMS Alarm Control, CygNet FMS Configuration Control, CygNet FMS Dashboard Control, CygNet FMS Exceptions Control) and control properties topic (CxFmsAlarmLogCtrl Properties, CxFmsConfigCtrl Properties, CxFmsDashboardCtrl Properties, CxFmsExceptionsCtrl Properties) for more information about filter selection options.

 
FilterString In the CygNet FMS Node Chooser control, specifies a partial string of known Node names to populate the Filter text box used to filter the value specified by the FilterType property, to generate Node selection options

Enter a filter string. Wildcard values * (multiple character) and ? (single character) are supported.

Note: Wildcards can be used only when FilterType = Name or Desc, not when filtering by ID.

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page, then enter text into the Filter text box) to define.

Note: See ChooserFilterString for usage of this property in other controls.
* (multiple character wildcard) - all
FilterType In the CygNet FMS Node Chooser control, specifies the property type that will be filtered by the string specified by the FilterString property, to generate Node selection options

Options are as follows.

  • 0 - Name
  • 1 - Description
  • 2 - ID

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page, then select the Name, Desc, or ID radio button) to define.

Note: See ChooserFilterType for usage of this property in other controls.
0 - Name
Font Accesses the MS Font dialog box, allowing specification of the text font and details to use in the control

Click ... to access the Font dialog box to make font selections including type, style, size, and script options.

MS Shell Dlg
FontSize In the CygNet FMS History Graph control, specifies the font size of the text in the grid

Options are as follows.

  • 0 - Large
  • 1 - Medium
  • 2 - Small

Alternatively, use the CygNet FMS History Graph Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Graph page, then Font Size selector) to define.

1 - Medium
GridGroupsXml In the CygNet FMS Exceptions control, specifies the XML string that contains the accumulated settings describing the group hierarchy that will appear in the control 

Enter a known XML string.

Alternatively, use the CygNet FMS Exceptions Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Exceptions page, then Grid groups selector) to define.

 
GroupSelection In the CygNet FMS Node Chooser control, specifies the desired Node group(s) used to generate Node selection options

Options are populated according to groups of the following types, as configured in your system.

  • All Nodes - all Group Nodes
  • General - General Group Nodes
  • Station - Station Group Nodes
  • By Category - by Category value, if configured for the Node

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and select a Node group value from the selection tree) to define.

Note: See ChooserGroupSelection for usage of this property in other controls.
Depends on the Group Nodes and Category values configured in your system
HeightOverride In the CygNet FMS History Graph control, when the UseHeightOverride value is set to 1 - Yes, specifies the height in pixels of the Value Table

Enter a pixel value for the table height.

 
HighlightExceptionCells In the CygNet FMS History Grid control, when a ColorGrid option other than "0 - None" is selected, specifies whether or not to highlight record cells that contain data triggering exceptions

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS History Grid Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Grid page and select/clear the Highlight cells causing exceptions check box) to define.

1 - Yes
IsEditing [Read-only]

In editable CygNet FMS controls (Alarm, Configuration, History Grid), returns whether or not the user is currently editing data

 
JobTypeFilterView In the CygNet FMS Jobs control, specifies the type of jobs to display

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Jobs page, then Job type selector) to define.

Options are as follows.

  • <Any>
  • Auto-calibration
  • Calibration
  • Gas Sample
  • [User-supplied value options]

Note: Job types are configured in CygNet Dispatch or in FMS Explorer via the Extended Command Options on the Job Schedule Configuration page.

<Any>
MaxDataQuality In the CygNet FMS History Grid control, when a ColorGrid option other than "0 - None" is selected, specifies the maximum data quality value below which records will be shown in color

Color will be applied to records in the control with lower data quality than this selected value, according to the color mode value defined by the ColorGrid property.

Enter a known data quality value.

Alternatively, use the CygNet FMS History Grid Control Properties dialog box (from the Property Sheet ActiveX page, click (OCX Properties) > Grid page, then Color data quality below selector) to define.

Possible values for this property are as configured in your system, via the Admin menu. See Configuring Data Quality Settings for more information.

None
MaxRecords In the CygNet FMS Exceptions control, specifies the maximum number of exceptions records to be returned for display in the control

Alternatively, use the CygNet FMS Exceptions Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Exceptions page, then Max exceptions per node text box) to define.

100
MeterStationView
Note: This property deprecated in favor of DataMode

In the CygNet FMS History Graph or History Grid controls, specifies the data mode to be displayed for a Node that is a station meter (a Gas Meter Node set to also function as a station)

See DataMode for details.

 
NodeCategorySelection In the CygNet FMS Node Chooser control, specifies the desired Node category used to generate Node selection options

Options are as follows.

  • 1 - Node_Category1_Device
  • 2 - Node_Category1_Group
  • 3 - Node_Category1_Station
  • 6 - Node_Category1_Any
  • 8 - Node_Category1_Gas_Device
  • 9 - Node_Category1_Liquid_Device
  • 13 - Node_Category1_Accessory

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and select a value from the Node category drop-down menu) to define.

Note: See ChooserNodeCategorySelection for usage of this property in other controls.
 
NodeCategoryVisible In the CygNet FMS Node Chooser control, specifies whether to show the Node Category selector in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and select/clear the Allow Node category selection check box) to define.

Note: See ChooserNodeCategoryVisible for usage of this property in other controls.
1 - Yes
NodeOverride In the CygNet FMS Report control, specifies the Node name against which to run the report, when Use Session Node is is set to 0 - No.

Alternatively, use the CygNet FMS Report Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page, then (with the Use Session Node check box cleared) enter a Node name into the Node text box) to define.

 
PITDateTime Specifies the Point in Time to use for the data presented in the control

Acceptable values can be in one of the following forms.

  • Absolute Date/Time (e.g. 1/31/2023 7:10:14 AM)
  • Relative Date/Time (e.g. y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day, which is an offset from the current day T (e.g. T-10)

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page, then select the Use Point in Time mode check box, and select a PIT (C) value using the date and time selector) to define.

See Using the Home Menu for more information about PIT mode.

See Selecting Point in Time for more information about time selection.

T - Current
PrimarySortColumn In the CygNet FMS Node Chooser control, specifies the primary sorting mechanism for the columns in the control

Options are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > General page and select a value from the Primary column drop-down menu) to define.

Note: See ChooserPrimarySortColumn for usage of this property in other controls.
2 - Name ascending
ProcessVarXml In the CygNet FMS History Graph control, specifies the XML string containing the accumulated settings describing which process variables will be displayed in the control 

Enter a known XML string.

Alternatively, use the CygNet FMS History Graph Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Graph page, then in the Process Variables: section click Modify... to access the Process Variables configuration list) to define.

 
RecordOrder In the CygNet FMS Dashboard or History Grid controls, specifies the order for display of records

Options are as follows.

  • 0 - Oldest_First
  • 1 - Newest_First

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Control page, then Record order selector) to define.

0 - Oldest_First
RecordSpan In the CygNet FMS History Graph or History Grid controls, specifies the record span to display in the control

Options are as follows.

  • 1 - Hourly
  • 2 - Daily
  • 3 - Native - appears for Device data view only; not applicable to Station data view

Alternatively, use the CygNet FMS History * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Control page, then Record span selector) to define.

Depends on control
ReportDefinitionXml In the CygNet FMS Report control, specifies the XML string containing the accumulated settings describing the user-configured report definition

Enter a known XML string.

Alternatively, use the CygNet FMS Report Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Report page, then select a report type and access the Report parameters definitions) to define.

See Managing Report Definitions for more information.

<XML/>
ReportSelection In the CygNet FMS Report control, specifies the name of the report to run

Enter a known report name.

Alternatively, use the CygNet FMS Report Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Report page, then use the Type drop-down menu) to define.

 
SessionNodeClickOption In the CygNet FMS Dashboard control, specifies the Session Node selection behavior

Options are as follows.

  • 0 - SingleClick
  • 1 - DoubleClick

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet ActiveX page, click (OCX Properties) > Dashboard page, then use the Set Session Node drop-down menu) to define.

1 - DoubleClick
SessionBeginDate

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Specifies the Session start date for the time window displayed in the control, when using the Session options

Acceptable values can be in one of the following forms.

  • Absolute date (e.g. 1/31/2023)
  • Relative date, which is an offset from the current day T, e.g. T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

 
SessionDateFormat

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Specifies the date/time format for the time window displayed in the control, when using the Session options

Options are as follows.

  • 0 - Device_Time
  • 1 - Contract_Time
  • 2 - Local_Time

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

0 - Device_Time
SessionEndDate

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Specifies the Session end date for the time window displayed in the control, when using the Session options

Acceptable values can be in one of the following forms.

  • Absolute date (e.g. 1/31/2023)
  • Relative date, which is an offset from the current day T, e.g. T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

 
SessionNodeTag

Note: This property is only used if the UseSessionNode property is set to 1 - Yes.

Specifies the Session Node used for data display in the control, when using the Session Node

This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540).

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

 
ShadingBackColor In the CygNet FMS Alarm or Configuration control, when the ShowShading value is 2 - Background or 3 - Both, specifies the background (cell) color for a selected cell

Use the pop-up color selector in the property sheet to define a cell color.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Control page, then select/clear the Shade background (cell) check box) to define.

See Configuring Color for more information.

RGB 255.250.205

(pale yellow)

ShadingForeColor In the CygNet FMS Alarm or Configuration control, when the ShowShading value is 1 - Foreground or 3 - Both, specifies the foreground (text) color for a selected cell

Use the pop-up color selector in the property sheet to define a text color.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Control page, then select/clear the Shade foreground (text) check box) to define.

See Configuring Color for more information.

RGB 0.0.0 (black)
ShowApprovedJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Approved" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Approved check box) to define.

1 - Yes
ShowBlockedJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Blocked" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Blocked check box) to define.

1 - Yes
ShowChooserPane Specifies whether to show the Chooser pane in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, and select/clear the Show Chooser pane check box) to define.

1 - Yes
ShowCompletedJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Completed" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Completed check box) to define.

1 - Yes
ShowCustomColumns In the CygNet FMS Dashboard control, specifies whether to show configured "Custom columns" as fixed columns in the control, as configured in the Admin Options (Custom Dashboard Columns page)

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then in the Show as fixed columns: list, select/clear the Custom columns check box) to define.

Note: If custom columns are to be displayed, also configure the CustomColumnsUpdateInterval value to be used.

0 - No
ShowExceptionCount In the CygNet FMS Dashboard control, specifies whether to show the total number of exceptions "Exception count" as a fixed column in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then in the Show as fixed columns: list, select/clear the Exception count check box) to define.

1 - Yes
ShowHourly In the CygNet FMS Balance control, specifies whether to show hourly records in addition to daily and monthly rollups in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Balance Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Balance page, and select/clear the Show daily and monthly rollups only check box) to define.

Selected means hourly records will not be shown (ShowHourly = 0 - No); cleared means hourly records will also be shown (ShowHourly = 1 - Yes).

1 - Yes
ShowLegend In the CygNet FMS History Graph control, specifies whether to show the color-coded device legend at the top of the control display

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS History Graph Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Graph page, and select/clear the Show legend check box) to define.

1 - Yes
ShowMissingDataJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Missing Data" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Missing Data check box) to define.

1 - Yes
ShowMostRecentRecords in the CygNet FMS Raw Data control, specifies whether to show only the most recent record for each hour in the control

Options are as follows.

  • 0 - No
  • 1 - Yes
1 - Yes
ShowNodeDescription In the CygNet FMS Dashboard control, specifies whether to show the "Node description" as a fixed column in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then in the Show as fixed columns: list, select/clear the Node description check box) to define.

1 - Yes
ShowNodePriority In the CygNet FMS Dashboard control, specifies whether to show the "Node priority" as a fixed column in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then in the Show as fixed columns: list, select/clear the Node priority check box) to define.

0 - No
ShowOpenJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Open" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Open check box) to define.

1 - Yes
ShowOptionsPane Specifies whether to show the Options pane in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, and select/clear the Show Options pane check box) to define.

1 - Yes
ShowPendingApprovalJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Pending Approval" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Pending Approval check box) to define.

1 - Yes
ShowPercentMissing In the CygNet FMS Dashboard control, specifies whether to show the percentage of missing data "% missing data" as a fixed column in the control

Missing data means records with anything other than a "Good" or "Partial" collection status value.

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Dashboard Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > Dashboard page, then in the Show as fixed columns: list, select/clear the % missing data check box) to define.

1 - Yes
ShowReviewJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Review" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Review check box) to define.

1 - Yes
ShowShading In the CygNet FMS Alarm or Configuration controls, specifies whether to show color shading in the grid data cells

Options are as follows.

  • 0 - None
  • 1 - Foreground
  • 2 - Background
  • 3 - Both

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > [control] page, then select/clear the Shading foreground (text) and/or Shading background (cell) check box) to define.

3 - Both
ShowUnits In the CygNet FMS History Grid or Raw Data controls, specifies whether to show units in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > [control] page, then select/clear the Show units check box) to define.

0 - No
ShowUseFilterButton In the CygNet FMS Dashboard control, specifies whether to show the Use filter button

Options are as follows.

  • 0 - No
  • 1 - Yes
1 - Yes
ShowVerifiedJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Verified" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Verified check box) to define.

1 - Yes
ShowWaitingForEventsJobs In the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Waiting for Events" in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Jobs Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCXProperties) > Jobs page, then in the Display the following job statuses: list, select/clear the Waiting for Events check box) to define.

1 - Yes
SiteService In the CygNet FMS PPA control, specifies the value of the FMS service in the control

Enter a valid FMS service in the format Site.Service.

Alternatively, use the CygNet FMS PPA Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and then FMS service to access the Select Service dialog box) to define.

 
SiteServiceSelection In the CygNet FMS Node Chooser control, specifies the value of the FMS service in the control

Enter a valid FMS service in the format Site.Service.

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and then FMS service to access the Select Service dialog box) to define.

Note: See SiteService for usage of this property in the PPA control. See ChooserSiteServiceSelection for usage of this property in other controls.
 
SiteServiceVisible In the CygNet FMS Node Chooser control, specifies whether to show the FMS service selector in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS Node Chooser Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select/clear the Allow FMS service selection check box) to define.

Note: See ChooserSiteServiceVisible for usage of this property in other controls.
1 - Yes
UnitSet Specifies the system unit set definition to use for data presented in the control

Enter a known unit set name.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > [control] page and select a configured Unit set from the drop-down menu) to define.

See Configuring Unit Set Definitions for more information.

<Default>
UseFilterConfig In the CygNet FMS controls providing filtering (Alarm, Configuration, Dashboard, Exceptions), specifies whether or not to use the configured control filter

Options are as follows.

  • 0 - No
  • 1 - Yes

0 - No: CygNet FMS Alarm, Configuration, Dashboard controls

1 - Yes: CygNet FMS Exceptions control

UseHeightOverride In the CygNet FMS History Graph control, specifies whether to use the configured HeightOverride property for the height, in pixels, of the Value Table

Options are as follows.

  • 0 - No
  • 1 - Yes
0 - No
UsePIT Specifies whether to use the configured Point in Time (PITDateTime) value for data presented in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page and select/clear the Use Point in Time mode check box) to define. If selected, define a PITDateTime value.

0 - No
UseSessionNode Specifies whether to use the SessionNodeTag property to determine the active Node for data presented in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, and select/clear the Use Session Node check box) to define.

Note: Default value varies by control type.

The Use Session Node property default value is 1 - Yes for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data).

The Use Session Node property default value is 0 - No for Summary controls (Dashboard, Exceptions) and Admin controls (Balance, Jobs; not applicable to Close Period, PPA).

See Note
UseSessionOptions Specifies whether to use the Session options, SessionBeginDate and SessionEndDate (and SessionDateFormat for controls where applicable) properties [if set to 1 - Yes], instead of the BeginDate and EndDate (and DateFormat for controls where applicable) properties [if set to 0 - No] for data presented in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, and select/clear the Use Session options check box) to define.

Note: Default value varies by control type.

The Use Session options property default value is 1 - Yes for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data).

The Use Session options property default value is 0 - No for Summary controls (Dashboard, Exceptions) and Admin controls (Balance, Jobs, PPA; not applicable to Close Period).

See Note
VisibleAttribute

Note: This property deprecated in favor of DataView

In the CygNet FMS Dashboard control, specifies the data view for displaying summary data in the control

See DataView for details.

 

Back to top

CygNet ActiveX Control Properties: Control-Specific

See one of the following topics for a listing of the properties, events, and methods applicable to a specific CygNet FMS ActiveX control.

Back to top