CygNet FMS ActiveX Controls – ActiveX Properties

Important:

This topic has been updated to include additional functionality provided subsequent to the CygNet Software v9.6 release by "Required" FMS patches available in the 96_Patch_Composite.zip via the CygNet Software download site.

These Help documents assume installation of required patches.

Visit the Weatherford software support portal (login required), and access the CygNet Software Download Website to obtain and install required patch files and update your CygNet Measurement system to access the new features (from the support portal select CygNet Software > CygNet Software Download Site [login] > Software > SCADA and Measurement Products > 9.6 > Patches > 96_Patch_Composite.zip). See CygNet Software Downloads for additional access information.

The CygNet FMS ActiveX controls have an additional set of properties that are listed on the ActiveX page of the Property Sheet seen in CygNet Studio/Vision screens. These properties are listed in the comprehensive properties table below, and also in Properties, Methods, and Events topics specific to each ActiveX control. Additionally, many of the ActiveX control properties can also be set in the corresponding CygNet FMS * Control Properties dialog box accessed via (OCXProperties).

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 ActiveX control.

See also CxHmiFms in the Scripting section for additional details about scripting properties specific to each FMS control object.

CygNet FMS ActiveX Control Properties: Comprehensive

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

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

PropertyDescriptionDefault Value

(OCXProperties)

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

From the control Property Sheet, on the ActiveX page, double-click (OCXProperties) or click ... to access the CygNet FMS * Control Properties dialog box for the selected control.

See CxHmiFms for more information about scripting properties.

 
AlarmRecSourceFilterIn the CygNet FMS Alarm control, specifies the source filter for the alarm records in the control

Property Sheet options are as follows.

  • 8 - Event_Alarms
  • 10 - User_Alarms
  • 255 - Any_Alarms

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

255 - Any_Alarms
AppearanceSpecifies whether the control will have a 3D effect or a flat appearance

Property Sheet options are as follows.

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

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.

 
BeginDateSpecifies the start date for the control

Enter a date. Acceptable values can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), 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 Start selector) to define.

See Selecting Date and Time for more information.

T-7
BorderStyleSpecifies the border style of the control boundary

Property Sheet options are as follows.

  • 0 — None
  • 1 — Fixed Single
0 — None
ButtonTextIn the (stand-alone) CygNet FMS Node Chooser control, specifies the text to display on the status bar button

Enter desired text to define the button action.

Alternatively, use the CygNet FMS * Control Properties dialog box (from the Property Sheet, ActiveX page, click (OCX Properties) > General page, then Button text field) 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

AllowMultiSelect (for Node Chooser control)

Specifies whether to allow multiple selection of Nodes in the (embedded or stand-alone) control Node Chooser

Property Sheet 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, then select/clear the Allow multiple selections check box) to define.

1 - Yes
ChooserFilterString

FilterString (for Node Chooser control)

Specifies a partial string of known Node names to populate the Filter text box in the (embedded or stand-alone) control Node Chooser list

Enter a known filter value.

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

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.

* (multiple character wildcard) - all
ChooserFilterType

FilterType (for Node Chooser control)

Specifies the filter type for which the ChooserFilterString value will be applied in the (embedded or stand-alone) control Node Chooser list

Property Sheet options are as follows.

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

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

0 - Name
ChooserGroupSelection

GroupSelection (for Node Chooser control)

Specifies the desired Node group filter to use to display options in the (embedded or stand-alone) control Node Chooser list

Enter a known value.

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

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

  • All Nodes
  • General
  • Station
  • By Category
Depends on the group values configured in your system
ChooserNodeCategorySelection

NodeCategorySelection (for Node Chooser control)

Specifies the desired Node category to display in the (embedded or stand-alone) control Node Chooser list

Property Sheet options are a subset of the following possibilities, as applicable to the selected control. Applicable controls are noted in parentheses after each variant.

  • 1 - Node_Category1_Device (Node Chooser, 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 (Raw Device Data)
  • 2 - Node_Category1_Group (Node Chooser, Dashboard, Jobs, Report)
  • 2 - Node_Category3_Group (Exceptions)
  • 2 - Node_Category4_Group (Close Period)
  • 3 - Node_Category1_Station (Node Chooser, Dashboard, Jobs, Report)
  • 3 – Node_Category2_Station (History Graph, History Grid)
  • 3 - Node_Category3_Station (Exceptions)
  • 3 - Node_Category4_Station (Close Period)
  • 6 - Node_Category1_Any (Node Chooser, Dashboard, Jobs, Report)
  • 6 - Node_Category3_Any (Exceptions)
  • 8 - Node_Category1_Gas_Device (Node Chooser, 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 (Raw Device Data)
  • 9 - Node_Category1_Liquid_Device (Node Chooser, 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 (Raw Device Data)
  • 13 - Node_Category1_Accessory (Node Chooser, Jobs, Report)
  • 13 - Node_Category3_Accessory (Exceptions)

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

Depends on control
ChooserNodeCategoryVisible

NodeCategoryVisible (for Node Chooser control)

Specifies whether to show the Node Category selector in the (embedded or stand-alone) control Node Chooser

Property Sheet 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, then select/clear the Allow Node category selection check box) to define.

1 - Yes
ChooserPrimarySortColumn

PrimarySortColumn (for Node Chooser control)

Specifies the primary sort column for the columns in the (embedded or stand-alone) control Node Chooser list

Property Sheet 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, then Primary column selector) to define.

2 - Name
ChooserSiteServiceSelection

SiteServiceSelection (for Node Chooser control)

Specifies the value of the FMS [Site.Service] in the (embedded or stand-alone) control Node Chooser

Enter a known value.

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

 
ChooserSiteServiceVisible

SiteServiceVisible (for Node Chooser control)

Specifies whether to show the FMS selector in the (embedded or stand-alone) control Node Chooser

Property Sheet 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, then select/clear the Allow FMS service selection check box) to define.

1 - Yes
CmdDefinitionXmlSpecifies the XML string that contains the accumulated configuration settings for the FMS command definition 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.

 
ColorExceptionsIn the CygNet FMS History Grid control, when a ColorGrid option other than "0 - None" is selected, specifies whether or not to show records with exceptions according to the selected color grid option

Property Sheet 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, then select/clear the Color rows containing exceptions check box) to define.

0 - No
ColorGridIn the CygNet FMS History Grid control, specifies the color options for selected data display

Property Sheet options are as follows.

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

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

See Using the History Grid Control for more information.

0 - None
ColorModeIn the CygNet FMS History Graph control, returns/sets how colors are applied in the graph, whether to individual Nodes or based on acceptability (data quality) level

Property Sheet options are as follows.

  • 0 - ColorModeSingleNode
  • 1 - ColorModeAcceptability
0 - Single Node
ColorXmlIn the CygNet FMS History Graph control, specifies the XML string that contains the accumulated color settings for 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

Columns (for Balance control)

Specifies the XML string that describes the columns 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 Columns selector) to define.

 
CustomColumnsUpdateIntervalIn the CygNet FMS Dashboard control, specifies the update interval, in number of seconds, for the custom data columns (as configured in the Admin Options) displayed in the control

Enter the number of seconds.

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

See Using the Dashboard Control for more information.

Persists as set; initial default value is 60 seconds
DataModeIn the CygNet FMS Dashboard control, specifies the data mode for viewing summary data in the control

Property Sheet options are as follows.

  • 1 - Device_Mode
  • 3 - Station_Mode

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

1 - Device_Mode
DataQualityColorXmlIn the CygNet FMS Balance control, specifies the XML string that contains the accumulated color settings to use 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.

 
DataViewIn the CygNet FMS Configuration control, specifies the type of data view to display in the control

Property Sheet options are as follows.

  • 0 - Data_View_Config
  • 1 - Data_View_Gas_Analysis

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

0 - Data_View_Config
DateFormatSpecifies the date/time format for the data displayed in the control

Property Sheet options are as follows.

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

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

0 - Device_Time
DateTimeDisplayModeIn the CygNet FMS Balance or Dashboard control, specifies the date display convention to use

Property Sheet options are as follows.

  • 0 - LeadingTime
  • 1 - TrailingTime

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

0 - Leading Time
DecimalPrecisionSpecifies the decimal precision for data values displayed in the control

Acceptable values include 0 - 10 decimal places.

Enter a value up to 10.

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

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

Property Sheet options are as follows.

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

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

25 - Metering Raw
EndDateSpecifies the end date for the control

Enter a date. Acceptable values can be in one of the following forms.

  • Absolute date - for example: 1/31/2022
  • Relative date - for example: T (today), 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 End selector) to define.

See Selecting Date and Time for more information.

T
FilterConfigXmlIn the CygNet FMS Alarm, Configuration, Dashboard, or Exceptions control, specifies the XML string that contains the accumulated filter settings 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) > Control page, then Filter or Log source selector, as available in the control) to define.

See the usage topic and properties list for the selected control for more information about filter selection options.

 
Font

Accesses the MS Font dialog box, allowing specification of the text 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
FontSizeIn the CygNet FMS History Graph control, specifies the font size of the text displayed in the control

Property Sheet 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
GridGroupsXmlIn the CygNet FMS Exceptions control, returns/sets the XML specifying 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.

 
HeightOverrideIn 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 the number of pixels for the table height.

 
HighlightExceptionCellsIn 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

Property Sheet 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, then select/clear the Highlight cells causing exceptions check box) to define.

1 - Yes
IsEditingIn the editable CygNet FMS controls (Alarm, Configuration, or History Grid), returns whether or not the user is currently editing data in the control  
JobTypeFilterViewIn the CygNet FMS Jobs control, specifies the type of jobs to display in the control

Enter a known job type name, as saved in your system, to filter the view as desired.

Property Sheet options are as follows.

  • <Any>
  • Auto-calibration
  • Calibration
  • Gas Sample
  • [User-supplied value options] - see Note* for configuration information

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

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

<Any>
MaxDataQualityIn 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
MaxRecordsIn the CygNet FMS Exceptions control, specifies the maximum number of exceptions records to be returned in the control

Enter a numerical value.

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

100
MeterStationViewIn the CygNet FMS History Grid or History Graph control, for a Node that is a station meter (a Gas Meter Node set to also function as a station), specifies the station meter data view to be displayed in the control

Property Sheet options are as follows.

  • 8 - Gas_Devices_Mode
  • 3 - Stations_Mode

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

8 - Gas_Devices_Mode
NodeOverrideIn the CygNet FMS Report control, if Use Session Node is cleared (not selected), specifies the Node name against which to run the report

Enter a known Node name.

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

 
PITDateTimeIf UsePIT is selected, specifies the Point in Time PIT (C) to use for data presented in the control

Enter a Point-in-Time (PIT) date and time.

Acceptable values can be in one of the following forms.

  • Absolute Date/Time (e.g. 1/31/2022 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 (OCX Properties) > General page, select the Use Point in Time mode check box and then access the Select Date and Time dialog) 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
ProcessVarXmlIn the CygNet FMS History Graph control, returns/sets the XML string specifying which process variables will be displayed in the graph

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 use the Process Variables configuration list) to define.

 
RecordOrderIn the CygNet FMS Dashboard or History Grid control, specifies the order for display of records

Property Sheet 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 use the Record order selector) to define.

0 - Oldest_First
RecordSpanIn the CygNet FMS History Graph or History Grid control, specifies the record span to display

Property Sheet options are as follows.

  • 1 - Hourly
  • 2 - Daily
  • 3 - Native - 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 use the Record span selector) to define.

Depends on control
ReportDefinitionXmlSpecifies the XML of the user-configured report definition for use by the CygNet FMS Report control

Enter a known XML string.

<XML/>
ReportSelectionSpecifies the name of the report to run from the CygNet FMS Report control

Enter a known report name.

 
SessionNodeClickOptionIn the CygNet FMS Dashboard control, specifies the Session Node selection behavior to use

Property Sheet 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 (OCXProperties) > Dashboard page, then use the Set Session Node selector) to define.

1 - DoubleClick
ShadingBackColorIn 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

Access the pop-up Color selector to configure the 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)

ShadingForeColorIn 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

Access the pop-up Color selector to configure the 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)
ShowApprovedJobsIn the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Approved"

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
ShowChooserPaneSpecifies whether to show the Chooser pane in the control

Property Sheet 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, then select/clear the Show Chooser pane check box) to define.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
ShowCustomColumnsIn the CygNet FMS Dashboard control, specifies whether to show custom columns, as configured in the Admin Options (Custom Dashboard Columns page), as a fixed column

Property Sheet 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.

0 - No
ShowExceptionCountIn the CygNet FMS Dashboard control, specifies whether to show the total number of exceptions for the selected Node as a fixed column

Property Sheet 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
ShowHourlyIn the CygNet FMS Balance control, specifies whether to show hourly records in addition to daily and monthly rollups in the control

Property Sheet 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, then select/clear the Show daily and monthly rollups only check box) to define.

Selecting the Show daily and monthly rollups only check box means hourly records will not be shown (ShowHourly = 0 - No); clearing the Show daily and monthly rollups only check box means hourly records will also be shown (ShowHourly = 1 - Yes).

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

Property Sheet 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, then select/clear the Show legend check box) to define.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

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

Property Sheet options are as follows.

  • 0 - No
  • 1 - Yes
1 - Yes
ShowNodeDescriptionIn the CygNet FMS Dashboard control, specifies whether to show the description of the selected Node as a fixed column

Property Sheet 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
ShowNodePriorityIn the CygNet FMS Dashboard control, specifies whether to show the Node priority of the selected Node as a fixed column

Property Sheet 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
ShowOpenJobsIn the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Open"

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
ShowOptionsPaneSpecifies whether to show the Options pane in the control

Property Sheet 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, then select/clear the Show Options pane check box) to define.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
ShowPercentMissingIn the CygNet FMS Dashboard control, specifies whether to show the percentage of missing data as a fixed column

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

Property Sheet 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
ShowReviewJobsIn the CygNet FMS Jobs control, specifies whether to show jobs with a status of "Review"

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
ShowShadingIn the CygNet FMS Alarm or Configuration control, specifies whether to show color shading for a selected cell

Property Sheet options are as follows.

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

If a value other than 0 - None is selected, also configure values for ShadingBackColor and/or ShadingForeColor, as applicable.

3 - Both
ShowUnitsSpecifies whether to show units in the control

Property Sheet options are as follows.

  • 0 - No
  • 1 - Yes
Depends on control
ShowUseFilterButtonIn the CygNet FMS Jobs control, specifies whether to show the Use filter button in the control

Property Sheet options are as follows.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

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

Property Sheet 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 (OCX Properties) > Jobs page, then Display the following job statuses check box list) to define.

1 - Yes
SiteServiceIn the CygNet FMS PPA control, specifies the value of the FMS service to use for data display

Enter a known Site.Service value.

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

 
UnitSetSpecifies the system unit set definition to use for the data presented in the control

Enter a known unit set name, as saved in your system.

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

See Configuring Unit Set Definitions for more information.

<Default>
UseFilterConfigIn the CygNet FMS Alarm, Configuration, Dashboard, or Exceptions controls, specifies whether or not to use the configured FilterConfigXml property

Property Sheet 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 Log source or Filter selector) to define.

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

Property Sheet options are as follows.

  • 0 - No
  • 1 - Yes
0 - No
UsePITSpecifies whether to use the configured PITDateTime for the data presented in the control

Property Sheet 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, then select/clear the Use Point in Time mode check box) to define.

0 - No
UseSessionNodeSpecifies whether to use the Session Node for data presented in the control

Property Sheet 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, then select/clear the Use Session Node check box) to define.

0 - No
UseSessionOptionsSpecifies whether to use the Session options for the data presented in the control object

Property Sheet 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, then select/clear the Use Session options check box) to define.

0 - No
VisibleAttributeIn the CygNet FMS Dashboard control, specifies the data view option selected from the context menu, depending on the DataMode selected

Select from the Property Sheet options made available in the drop-down selector.

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

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

 

Back to top

CygNet ActiveX Control Properties: Control-Specific

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

Back to top