What’s New in the CygNet v9.8 Help

The v9.8 Online Help includes many documentation updates to describe the new features and enhancements contained in the CygNet Software v9.8 release.

Changes to the v9.8 Online Help

The following documentation items have been added, removed, or revised in the CygNet Software v9.8 Online Help. Changes are listed in order of the Online Help document sections in which they appear.

Alarms

• Documented a new set of Deviation For Time alarm calculation types. Revised all Alarm Calculation Types topics.

• Clarified documentation for the Deviation For Time alarm calculation types (updated November 15, 2024).

• Enhanced Alarm Configuration (EAC) — added a note about a new CygNet Studio sample screen, CopyEacSettings.csf, which can be configured to copy EAC settings between points.

Canvas

• See the What's New in the v9.8 Canvas Help section in the CygNet Canvas chapter for more information (updated April 12, 2024, November 15, 2024, and April 18, 2025).

CygNet HMI Clients

• The table of contents for the CygNet Software Online Help has been reorganized to group the human machine interface (HMI) clients under a single node: CygNet HMI Clients. The four clients are:

  • CygNet Studio is CygNet's original HMI client application for creating operational screens to control and monitor devices, display data, alarms, and trends. Studio is a desktop HMI application, part of the suite of CygNet components. See CygNet Studio for more information.
  • CygNet Vision is is the runtime companion application to CygNet Studio.
  • Canvas is CygNet's primary desktop HMI application, providing high-quality screen design functionality and viewing, utilizing a variety of specialized tools and controls, which you can use to create user screens to operate with CygNet services and data. You can also view CygNet Studio screens in Canvas. See CygNet Canvas for more information.
  • CygNet Thin Web Client (TWC) is CygNet's browser-based HMI client application for viewing operational screens and workflows in a Web browser using sophisticated web-based technologies. Currently the designer for building web-based screens is a web-enhanced version of the Canvas desktop application. See CygNet Thin Web Client for more information.
  • CygNet Operator for CygNet Mobile is a mobile app for viewing critical CygNet SCADA data on an Apple iOS or Android mobile device. It is the HMI component of the CygNet Mobile Application Suite. You can use the CygNet Operator to view a set of fixed screens including: a map of relevant equipment and facilities, current data, trend historical data, and view and acknowledge both CAS alarms and GNS notifications in a single operation. See CygNet Operator for more information.

CygNet Measurement

• Updated information in the CygNet Measurement Software Components, FMS Service, FMS Explorer, Installing and Starting FMS Explorer, Using the Vision Control, and Installing CygNet Measurement topics to reflect the introduction of the new 64-bit FMS service and 64-bit FMS Explorer, and to describe usage distinctions between the 32- and 64-bit versions of FMS Explorer.

• Updated information in the FMS Configuration File Keywords topic to add new DB_PROVIDER value options, to accommodate the newly supported OLE DB Driver for SQL Server and indicate recommendations.

• Updated information related to SQL server installations in the Using the Internal Database, Installing CygNet Measurement, and CygNet Measurement Software Components topics to clarify the 1:1 relationship between an FMS Service and SQL server, support for the OLE DB Driver for SQL Server, and to list the number of supported FMS Nodes per SQL server.

• Added a topic describing the new Thin Data command (available via the Admin menu) and updated associated topics.

• Added descriptions of a new parameter available to select whether or not to include archived data when configuring update normalization views system commands or running the command.

• Added a note clarifying selection of "Gas quality history" when creating gas meter Nodes for devices that combine gas metering and live gas quality into a single data transaction.

• Added multiple liquid configuration validation rules to the tables in the FMS Validation Rules topic.

• Added tokens for Configuration Audit category, comment, and username values to the tables in the Liquid Device QTR Report Templates topic.

• Updated information in the Balance control and CygNet FMS Balance control topics to reflect the addition of an embedded Node chooser to the control.

• Updated information in the Configuration control and CygNet FMS Configuration control topics to reflect the addition of an embedded Node chooser to the control.

• Updated information in the Dashboard control and CygNet FMS Dashboard control to reflect a property change from "Visible Attribute" to "Data View".

• Updated information in the Raw Data control and CygNet FMS Raw Device Data control to reflect a property change from "Display Mode" to "Data View" and added the "Show only most recent records" option to the ActiveX property page.

• Updated information in the History Graph control and CygNet FMS History Graph control to reflect a property change from "Station Meter View" to "Data Mode".

• Updated information in the History Grid control and CygNet FMS History Grid control to reflect a property change from "Station Meter View" to "Data Mode".

• For CygNet Dispatch users, updated information in the Jobs control to reflect the addition of a "Job name" column.

CygNet Release Documents — Added language to the following documents to clarify the relationship between Microsoft SQL Server and the FMS Service for CygNet Measurement:

• CygNet v9.8 System Requirements

• CygNet v9.8 Upgrade Procedure

CygNet Studio — Added a link to a Canvas topic that lists all CygNet Studio, Canvas, and Thin Web Client Controls.

CygNet Thin Web Client

• Updated the CygNet online help to document changes to the CygNet Thin Web Client v2.0, released April 18, 2025.
• Updated the CygNet online help to document changes to the CygNet Thin Web Client v1.6, released November 15, 2024.
• Updated the CygNet online help to document changes to the CygNet Thin Web Client v1.4, released April 12, 2024.

Device Definition Service (DDS) — Documented a new service configuration keyword, SUPPRESS_SCRUBBER_REPL.

Devices — Remote Devices

• All Data Group topics — added usage notes:
  • Point Processing on History data groups
  • UDC and Point Processing on FMS data groups
  • Clarified support and native data groups in Glossary and EFM Data Groups.
• All Configurable Data Group topics — cleanup and standardization across these topics:
  • Allen Bradley CIP EIE
  • AutoCom EIE
  • DNP3 EIE, DNP3 Emerson EIE
  • EProdRPC EIE
  • IOT EIE, IOT Sparkplug EIE
  • ModBus EFM EIE, ModBus Omni EIE, ModBus Pickford EIE, ModBus Realflo EIE, ProSoft EIE, Thermo EIE
  • OPC EIE, OPC Lufkin EIE, OPC Weatherford EIE.
• Allen Bradley CIP EIE — added a Configurable Data Group topic.
• DNP3 Emerson EIE

  • Changed Listen Mode in the Specifications table to Yes, (updated April 18, 2025).

  • Added a section about mapping non-EFM Items into FMS History.

  • Added support for FMS History data groups.

  • Added FMS support for FB1x and FB2x series devices.

• Emerson ROC EIE
  • Added support for an updated Emerson firmware for the FloBoss 107 devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. Added features include:
    • Modifications to the Device page of the Emerson ROC EIE device editor to support the configuration of the secure login credentials. The new Login secure field on the Device page will display only for the ROC 107 devices that support the new firmware.
    • An enhanced security data group, LoginSec ("Login Secure Enhanced Request"), using the Emerson Opcode 17. The EmersonRoc_107.dtf has been modified to include the new LoginSec data group.
    • A new UIS command "component type" LOGINSEC (Login Secure), to send enhanced security credentials to the device. The UIS command uses the login credential information from the Login secure section of the Device page on the remote device editor.
  • Added a note to FMS History Data Group Mapping indicating that the Emerson FloBoss 107 device uses Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History and FMS Hourly History data. Opcode 136 is only available on the FloBoss 107, ROC800, and ROC800L devices.
• Emerson ROCPlus EIE
  • Added support for an updated Emerson firmware for the ROC800 and ROC800L devices, which complies with enhanced security features stipulated by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. Added features include:
    • Modifications to the Device page of the Emerson ROC EIE device editor to support the configuration of the secure login credentials. The new Login secure field on the Device page will display only for the ROC800 and ROC800L devices that support the new firmware.
    • An enhanced security data group, LoginSec ("Login Secure Enhanced Request"), using the Emerson Opcode 17. The EmersonRocPlus_800.dtf and EmersonRocPlus_800L.dtf have been modified to include the new LoginSec data group.
    • A new UIS command "component type" LOGINSEC (Login Secure), to send enhanced security credentials to the device. The UIS command uses the login credential information from the Login secure section of the Device page on the remote device editor.
  • Added a Logout ("Logout Request") data group for ROC800 and ROC800L devices. The logout request is issued to the device via Opcode 17.
• EProdRPC EIE — Renamed the EProdRPC topics to better match the supporting drivers, editors, and template files.

• IoT CygNet Link EIE — Documented a new IoT Sparkplug-based EIE, a Weatherford Link-enabled EIE that supports bidirectional communication between a CygNet enterprise system and a CygNet instance running on a ForeSite Edge device via Weatherford Link (updated April 18, 2025).

• IoT Sparkplug EIE 
  • Updated the Command-Type Data Groups topic to describe three new command types for the "Command – Device" (CmdDev) and "Command – Edge Node" (CmdNode) data groups to write a topic using a Sparkplug command (DCMD/NCMD). The new command types support the backfill of missing data (data group transaction history data and/or point history) in the case where the Link service becomes unavailable for an extended period of time (e.g., Link goes down for any reason or loses network connectivity), and to send UIS commands to a remote system, e.g. to an EDGE device. The new command types are:
  • DgHist — to send and retrieve data group transaction history
  • History — to send and retrieve point history
  • UisCmd — to send a UIS command to a remote EDGE device.
  • Updated the UIS Command Component Parameters topic to add a new parameter, EmbedParms, to the CmdDev and CmdNode data group types for sending a list of multiple command parameters to a UIS running on a remote device, e.g., an EDGE device.
  • Added information about the strictBdSeqMatch attribute, which can be used to determine how to handle NDEATH messages with respect to matched or mismatched BIRTH and NDEATH bdSeq numbers.

• Updated the Specifications table for each EIE remote device to include the corresponding eieType eieType identifies the CygNet EIE type associated with a template (in the deviceDefinition element); it links a device driver with a template. It typically refers to the name of the protocol according to which an EIE conforms. A value includes a CygNet-defined string, up to 20 characters, alphabetical characters only, and no spaces. The default value is supplied in the template and is not typically changed. (updated April 18, 20255).

• Updated dgElements attributes (updated April 18, 2025).

• Updated secLev definition to indicate that you cannot apply security to an individual dgElement (updated April 18, 2025).

Glossary of Terms

• Updated information in the Glossary of Terms and related topics about naming standards and character limits for the following entities:

Glossary Entry	Related Topic
Device ID	many
Facility ID	Facility Identifier
Long Point ID	Point Identifiers
Point	Point Identifiers
Service	Installing and Deleting Services
Site	Services Overview
UDC	Naming UDCs

History

• VHS Import/Export utility — added a note about a new CygNet Studio sample screen, TransferPointHistory.csf, which invokes multiple instances of the VhsImportExport utility to more quickly transfer a large amount of VHS data from one historian service to another.

Link — Moved Link documentation to its own URL to coincide with release of Link 2.0.

Notifications

• Added a link to Microsoft Graph permissions reference in the Configuring Microsoft 365 Server to work with Graph API topic.

• Documented new keywords in the GNS service configuration file (Gns.cfg) related to a new feature to retry to send notification emails that previously failed to send:
  • EMAIL_SEND_FAIL_RETRY_DELAY — EMAIL_SEND_FAIL_RETRY_DELAY specifies the delay in seconds between retries when resending a failed notification email. Valid values are 1 to 999; default value is 1.
  • EMAIL_SEND_FAIL_RETRY_MAX_ATTEMPTS — EMAIL_SEND_FAIL_RETRY_MAX_ATTEMPTS specifies the maximum number times the GNS will attempt to resend a failed notification email. Valid values are 0 to 999; default value is 0.

• Documented a new "Retrying On Fail" state in the Status column in the GNS Queue Viewer dialog box to report when the GNS is planning on resending an email notification that has previously failed. The "Retrying On Fail" feature applies only to email notifications at this time.
• Updated the GNS Queue Viewer topic to accurately show Status column options for Notification Queue and Resend Queue.

• Documented new keywords in the GNS service configuration file (Gns.cfg) to optionally configure the maximum number of notification threads. Previously the number of notification threads was fixed at 10:
  • NOTIFICATION_THREAD_COUNT — NOTIFICATION_THREAD_COUNT specifies the maximum number of active notification threads. Valid values are 1 to 99; default value is 10. The GNS_NOTIF_THRDS_MAX (Notif threads max) info item will report the value of this keyword.

• Added a note to clarify the testing behavior of GNS messages when using CygNet Tokens (updated September 1, 2025).

Points

• Documented histvaluecount attribute, which specifies the number of values for all enabled historized config bits that can be stored in the CVS, and used by any alarm calculations implemented in a Cygnet Enhanced Point Scheme.
• Clarified TagFormat values in CxPnt.CxPntClient.GetPointTagList method (updated November 15, 2024).

Scheduler — Updated MSS Scripting topic to include references to CygNet.Schedules.API.

Service Monitoring — Documented new service info items:

• DDS_NO_SCRUB_REPL
• GNS_NOTIF_THRDS_ACT

• GNS_NOTIF_THRDS_MAX.

Scripting

• Added a note to CxUis.UisClient.SendSingleUDC to describe a suggested solution to a use case when a Facility ID linked to a data group and the UDC point mapped to a data element in the same data group are different.
• Added notes and links to reflect updated scripting values for CygNet FMS Dashboard control properties to describe a change from (deprecated value) "VisibleAttribute" to (new value) "DataView".
• Added notes and links to reflect updated scripting values for CygNet FMS Raw Device Data control properties to describe a change from (deprecated value) "DisplayMode" to (new value) "DataView".
• Added notes and links to reflect updated scripting values for CygNet FMS History Graph control properties to describe a change from (deprecated value) "MeterStationView" to (new value) "DataMode".
• Added notes and links to reflect updated scripting values for CygNet FMS History Grid control properties to describe a change from (deprecated value) "MeterStationView" to (new value) "DataMode".
• Removed the Delete method from the CxAudEditor API. Deleting audit records is not supported (updated September 1, 2025).

UIS

• Added note to UIS System UDCs about 20-minute statistics (updated November 15, 2024).

Well Test

• Test performance and action execution have been significantly improved in the CygNet Well Test module (updated April 18, 2025).

• See the CygNet v9.9 Release Notes for a complete list of Well Test changes. Several topics have been updated to record new functionality (updated April 18, 2025).

• Updated Headers configuration topics and images with new UDCs: ContinuousMode, PendingWellQueue, and ActiveWellContinuousMode (updated April 18, 2025).

• Clarified Idle status for Abort and Complete header commands for the Pending Well Queue (updated April 18, 2025).

• Updated the description for the Exit command check box on an Exit action (updated April 18, 2025).

CygNet Web

• Notice of Status Change (NSC) — The CygNet Web application has reached its End of Life with the release of CygNet v9.8. The Web chapter has been removed from the CygNet Help. There are a few places in CygNet where Web is still configurable; a note has been added in those topics to indicate that the option has been deprecated, but remains configurable for backwards compatibility.