CygNet Measurement Conversion

Converting to CygNet Measurement

Notes:

CygNet Gas Measurement Repository (GMR) is an obsolete CygNet Software product that has been discontinued effective December 2016.
- Effective with the CygNet v8.5.0 release, GMR applications must be migrated to FMS.
- In CygNet v9.4 and prior releases, GMR services are able to start to accommodate the migration process from Gas Measurement Repository (GMR) installations to CygNet Measurement (FMS).
- Effective with the CygNet v9.5 release, the GMR service will no longer start.

Existing Gas Measurement Repository (GMR) systems can be converted to CygNet Measurement (FMS) systems operating in either REPOSITORY mode or FULL mode, as licensed for use and listed in the service configuration file Service Info keywords. Both modes involve a variety of considerations, including configuration of your system and devices, administrative options and templates, data retrieval and editing processes, data import/export requirements, the sending of data to devices or SCADA, and data reporting considerations. See CygNet Measurement Overview for more information about these modes.

This topic describes how to assess your needs before converting to CygNet Measurement, and how to initially configure and set up various system elements to achieve the desired functionality in your new system. The following tables contain lists of items to consider, and links to further helpful information.

Gathering Information
Configuring Initial Settings
Configuring Scheduled Tasks
Configuring Data Reports
Configuring Data Exports
Configuring Replication and Data Synchronization

See Migrating Files from GMR into FMS for information about using the FMS Toolbox utility to perform the migration tasks to move your data from a GMR service to an FMS service, once you are prepared to embark on the conversion process.

See CygNet Measurement Concepts for explanations of fundamental FMS ideas and general concepts.

See CygNet Measurement Workflow for a comprehensive overview of many common FMS tasks and workflow considerations.

See Installing CygNet Measurement for procedures, requirements, and specific installation instructions.

Gathering Information

Item	Requirements/Values	Comments
FMS product	Verify your licensed product version, e.g. CygNet Measurement v9.8 Verify your licensed product mode, e.g. FULL	Possible CygNet Measurement modes include the following. REPOSITORY FULL See CygNet Measurement Licensing Requirements for more information.
GMR product	Make sure your licensed GMR product version is the same as your licensed FMS product version	If they aren't the same, you may need to complete an upgrade procedure. See theCygNet v9.8 Upgrade Procedure for more information.
Database selection	Determine your database needs. If using the Microsoft SQL Server database, do the following. Verify the name of the Microsoft DB provider Verify the name of the external server hosting your FMS database Verify the name of the SQL database created for your FMS Service If used, the Microsoft SQL Server must meet the requirements listed in the CygNet system requirements.See theCygNet v9.8 System Requirements for more information.	CygNet Measurement can operate utilizing a Microsoft SQL Server database or the FMS internal database. Determine which usage is appropriate for your installation. See FMS Internal Database for a discussion of the differences between database options.
Workflow	Familiarize yourself with general FMS workflow information If you are licensed for a FULL (rather than REPOSITORY) CygNet Measurement system, consider the following desired workflow items Determine what you want your records approval process to be Determine whether multiple levels of approval will be desired for editing data Determine what your requirements will be to close a period Determine how you want edits to be categorized Determine if SCADA users will want to receive finalized measurement data	Although your workflow can be highly customized in CygNet Measurement, some elements are commonly used. See CygNet Measurement Workflow for more information. Once workflow determinations are made, you can configure administrative settings to support desired behaviors
Device locations	Verify the time zone(s) of your devices Verify the DST status of your devices	Time zone and DST information will be needed by the CygNetTimeZones.xml file. See Date and Time for more information.
Data sources	Identify devices that have FMS polling support Identify devices that currently have only GMR polling support Note: In CygNet Measurement (v8.5.0 or later), devices can have FMS or FMS Legacy (formerly GMR-only) polling support, but not both. Identify device import files or other sources you will be accessing for data	Note: Only devices configured with FMS data groups support the "Request New Data" token-based request. To use FMS polling facilities, existing device template files (DTFs) must be updated to include FMS (or FMS Legacy) data groups. See Device Template Files and Electronic Flow Measurement Data Items in the Remote Devices section for more information.
Station data aggregation	Determine which of your existing devices will operate as station meters, and which will belong to station group(s).	Station data can be aggregated in different ways, which is appropriate to different Node types in FMS: Some stations contain multiple meters that are aggregated to form a single point for data reporting purposes. These stations will be configured as "station group Nodes" in FMS. Some stations are single meters that also function as a station for data reporting purposes. These stations will be configured as "station meter Nodes" in FMS. See Creating Gas Meter Nodes and Creating Station Group Nodes for more information.
Production Accounting	Determine what export method(s) are desired to supply data to production accounting	Data can be exported from FMS in the following ways: SCADA exports Database exports Normalization View data CSV exports CFX/TFX exports See Managing CygNet Measurement Data for more information.
Balancing	Determine what virtual station groupings will be needed to support balance reporting in FMS	You can set up virtual Station Group Nodes to support desired balance reporting. See Creating Station Group Nodes for more information.
Auditing	Determine if you want to use a separate audit service for storing FMS audit information	Auditing tasks in CygNet Measurement are performed by the FMS (always) and by the Audit service (optionally), depending on whether you are tracking internal (device) or external (configuration) data. See Auditing in CygNet Measurement for more information.
Report types	Consider what familiar report types you will want to translate into FMS	A variety of standard reports can be produced from FMS. See Running CygNet Measurement Reports for more information.
SCADA screens	Identify any SCADA screens you want to see nested within FMS Explorer	To view SCADA data alongside Measurement data, screens can be accessed via the Vision control (32-bit version only). See Using the Vision Control for more information.
CygNet Studio screens	Decide if you want to place CygNet Measurement controls on your CygNet Studio screens	FMS ActiveX controls can be included on CygNet Studio and CygNet Vision screens. See FMS ActiveX Controls for more information.
Custom Dashboard columns	Identify any polling facility UDC values you want to see in the Dashboard control, such as communication statistics	Optional statistics can be configured for display in the Dashboard control. See Configuring Custom Dashboard Columns for more information.
Replication	Determine your replication needs regarding disaster recovery Determine your replication needs regarding business access Determine your redundancy needs regarding failover support	Data synchronization can be set up to replicate several services from one "master" FMS. Redundancy can be set up for data-center (not local) failover. See FMS Replication and Data Synchronization for more information.

Configuring Initial Settings

Item	Requirements/Values	Comments
Installation mode	Verify or configure the licensed mode for your FMS system REPOSITORY mode FULL mode	In the FMS configuration file (CygNet\Services\FMS\fms.cfg) on your host server, check the value of the FMS_MODE service info keyword. See CygNet Measurement Licensing Requirements for more information.
Devices	Configure devices to return FMS data Install templates Update customized templates	Devices must be configured to return data that can be consumed by CygNet Measurement. This includes EFM (either GMR or FMS) data groups. See Configuring Remote Devices for CygNet Measurement for more information.
	Configure device Nodes	Device-level data is organized via device Nodes. Device Nodes can be created manually via the Nodes menu or automatically via the Detect New Devices command. See Creating CygNet Measurement Nodes for more information.
	Configure group Nodes and/or virtual Station Group Nodes	Nodes are grouped via group Nodes, and can be aggregated for various business purposes via virtual Station Group Nodes. Group Nodes can be created manually via the Nodes menu or automatically via the Generate Smart Groups command. See Creating CygNet Measurement Nodes for more information.
	Consider current GMR Detect New Meters arrangements, if any Note: Detect New Meters criteria do not transfer from GMR to FMS.	Detect New Meters commands do not migrate from GMR to FMS, although previously created meters still exist in the system. FMS does support a Detect New Devices command. You will be able to configure new Detect New Devices commands and criteria in FMS, to provide functionality similar to that previously used in GMR. See Running Detect New Device Commands for more information.
	Consider current GMR Smart Groups arrangements, if any Note: Smart Group definitions do not transfer from GMR to FMS.	Smart Group commands do not migrate from GMR to FMS, although previously created groups still exist in the system. FMS does support a Generate Smart Groups command. You will be able to configure new Generate Smart Group commands and definitions in FMS, to provide functionality similar to that previously used in GMR. See Running Generate Smart Group Commands for more information.
FMS Toolbox	If you have an existing GMR system, you can use the FMS Toolbox utility to set up a GMR Migration of existing GMR meters and data into FMS. Note: Alternatively, in CygNet Measurement you can use Detect New Devices to create new FMS device Nodes.	You can migrate existing files from GMR into FMS utilizing the GMR Migration tool from the FMS Toolbox. See FMS Toolbox, Migrating Files from GMR into FMS, and Detect New Devices for more information.
FMS Toolbox	If you do not have an existing GMR system, but you already have polling facilities set up in the CygNet FAC service, you can use the FMS Toolbox utility to set up an Import into FMS. Note: Alternatively, in CygNet Measurement you can use Detect New Devices to create new FMS device Nodes.	You can create templates to import .csv files into FMS utilizing the Import tool from the FMS Toolbox. See FMS Toolbox, Importing Files into FMS, and Detect New Devices for more information.
Commands	Configure Node and System commands as needed	You can set up customized commands in FMS, to be scheduled or run on an ad hoc basis. This includes the option to set up automatic Node creation commands in FMS. If you have previously used automatic device detection and grouping commands in GMR (Detect New Meters and/or Generate Smart Groups) you can optionally configure new customized FMS Node creation commands in CygNet Measurement (Detect New Devices and/or Generate Smart Groups) to perform similar functions. See FMS Commands, Detect New Devices, and Generate Smart Groups for more information.
Validation	Configure validation engines as needed	You can set up multiple validation processes in FMS to verify data against a variety of standards. Data failing validation will then generate exceptions, helping you to identify and manage the data anomalies. See Managing Validation Engines for more information.
Estimation	Configure estimation engines as needed	You can set up multiple estimation routines in FMS to compensate for data that might be missing, late, or of insufficient quality. See Managing Estimation Engines for more information.
Reports	Configure report templates as needed Ad hoc reports Scheduled reports	A variety of standard reports can be set up to be run on-demand, or on a scheduled basis, in FMS. See Running CygNet Measurement Reports for more information.
Administrative Settings (optional)	Configure administrative settings for your system, as applicable Audit categories Composition splits Custom dashboard columns Custom device data Data quality settings Email options Normalization views System options Unit set definitions	A number of system administrative functions can be configured via the Admin menu in FMS Explorer. See Using the Admin Menu for more information.
Workspaces	Create and save custom workspaces Configure customized FMS Node commands Configure permissions for selected users/groups as needed Save desired workspaces	The working environment you create in FMS Explorer can be saved and/or loaded automatically via Workspace (.few) files. See Using the File Menu for more information.
Security	Configure security access and control as needed FMS Service security FMS Node security	You must have proper security authorization to perform certain actions in CygNet Measurement. Security can be set up on an Application and Event basis. See FMS Security for more information.
Replication	Configure replication relationships as needed Master DR (disaster recovery) slave Business slave(s) Configure redundancy relationships as needed	Data synchronization can optionally be set up to replicate multiple services from one "master" FMS. Redundancy can be set up for data-center (not local) failover. See FMS Replication and Data Synchronization for more information.

Configuring Scheduled Tasks

Item	Requirements/Values	Comments
Device Communication	Set up scheduled device communication tasks to poll devices configured with FMS or GMR data groups (devices associated with GMR/FMS facilities)	Note: Only devices configured with FMS data groups support the "Request New Data" token-based request. See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Managing Node Commands for information about the commands.
Export	Set up scheduled tasks to export files PPAs CSV Normalization View Data CSV (requires a configured normalization view) Flow-Cal Data CFX (if installed) Flow-Cal Ticket Data TFX (if installed) Flow-Cal Transaction Queue (if installed)	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Configuring File Export Commands and Running File Export Commands for information about the PPA and Normalization View data commands. See Managing Node Commands for information about the optional Flow-Cal commands.
Import	Set up scheduled tasks to import files Configuration CSV files EmersonRoc Laptop files Gas Analysis CSV files History CSV files Gas Quality CSV files Totalflow Laptop files	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Configuring File Import Commands and Running File Import Commands for information about the commands.
Reports	Set up scheduled report tasks to produce a variety of standard reports from your FMS system. You can optionally configure scheduled reports to be emailed. See Configuring Email Options for more information.	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Running CygNet Measurement Reports for information about report types, template files, and commands.
System	Set up scheduled estimation command tasks Estimate Station Data	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Managing Estimation Engines for information about the command.
Set up scheduled normalization command tasks Update Normalization Views	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Running Update Normalization Views Commands and Configuring Normalization Views for information about the command.
Configure your Smart Group definitions Simple Advanced	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Configuring Smart Group Definitions and Running Generate Smart Groups Commands for more information about the command.
Configure your Detect New Devices options	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Configuring Detect New Devices Options and Running Detect New Devices Commands for more information about the command.
Set up scheduled command tasks to archive your database records beyond a specified retention period Archive Data Select an off-site database location for archived files Determine the desired data retention period, beyond which data records will be archived Enable archiving in the FMS configuration file (CygNet\Services\FMS\fms.cfg), and define the Archiving Keywords	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Archiving CygNet Measurement Data and Archive Data for more information about the command.
Set up scheduled command tasks to keep your database maintained, and establish retention periods for command and transaction logs Perform Database Maintenance Delete expired command history Delete change queue entries Purge expired device data Compact the internal database Reindex the internal database	See Scheduling FMS Command Tasks in the MSS for information about scheduling. See Configuring Database Maintenance Retention Periods and Perform Database Maintenance for more information about the command.

Item

Requirements/Values

Comments

Device Communication

Set up scheduled device communication tasks to poll devices configured with FMS or GMR data groups (devices associated with GMR/FMS facilities)

Note: Only devices configured with FMS data groups support the "Request New Data" token-based request.

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Managing Node Commands for information about the commands.

Export

Set up scheduled tasks to export files

PPAs CSV
Normalization View Data CSV (requires a configured normalization view)
Flow-Cal Data CFX (if installed)
Flow-Cal Ticket Data TFX (if installed)
Flow-Cal Transaction Queue (if installed)

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Configuring File Export Commands and Running File Export Commands for information about the PPA and Normalization View data commands.

See Managing Node Commands for information about the optional Flow-Cal commands.

Import

Set up scheduled tasks to import files

Configuration CSV files
EmersonRoc Laptop files
Gas Analysis CSV files
History CSV files
Gas Quality CSV files
Totalflow Laptop files

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Configuring File Import Commands and Running File Import Commands for information about the commands.

Reports

Set up scheduled report tasks to produce a variety of standard reports from your FMS system. You can optionally configure scheduled reports to be emailed. See Configuring Email Options for more information.

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Running CygNet Measurement Reports for information about report types, template files, and commands.

System

Set up scheduled estimation command tasks

Estimate Station Data

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Managing Estimation Engines for information about the command.

Set up scheduled normalization command tasks

Update Normalization Views

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Running Update Normalization Views Commands and Configuring Normalization Views for information about the command.

Configure your Smart Group definitions

Simple
Advanced

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Configuring Smart Group Definitions and Running Generate Smart Groups Commands for more information about the command.

Configure your Detect New Devices options

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Configuring Detect New Devices Options and Running Detect New Devices Commands for more information about the command.

Set up scheduled command tasks to archive your database records beyond a specified retention period

Archive Data

Select an off-site database location for archived files
Determine the desired data retention period, beyond which data records will be archived
Enable archiving in the FMS configuration file (CygNet\Services\FMS\fms.cfg), and define the Archiving Keywords

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Archiving CygNet Measurement Data and Archive Data for more information about the command.

Set up scheduled command tasks to keep your database maintained, and establish retention periods for command and transaction logs

Perform Database Maintenance

Delete expired command history
Delete change queue entries
Purge expired device data
Compact the internal database
Reindex the internal database

See Scheduling FMS Command Tasks in the MSS for information about scheduling.

See Configuring Database Maintenance Retention Periods and Perform Database Maintenance for more information about the command.

Configuring Data Reports

Item	Requirements/Values	Comments
Reports	FMS reports commands utilize templates to produce the various reports configured in your system. They can be run on an on-demand basis or the report generation can be scheduled. Create report template files for each report type you want to produce. Schedule reports in the MSS, and configure email recipients. Create reports to view, print, or export, using the Reports control in your FMS Explorer client.	See Running CygNet Measurement Reports for information about report types and template files. See FMS Commands for information about specific report commands.

Item

Requirements/Values

Comments

Reports

FMS reports commands utilize templates to produce the various reports configured in your system. They can be run on an on-demand basis or the report generation can be scheduled.

Create report template files for each report type you want to produce.
Schedule reports in the MSS, and configure email recipients.
Create reports to view, print, or export, using the Reports control in your FMS Explorer client.

See Running CygNet Measurement Reports for information about report types and template files.

See FMS Commands for information about specific report commands.

Configuring Data Exports

Item	Requirements/Values	Comments
Normalized Data	Data associated with a defined normalization view, can be exported out of FMS for various other business applications CygNet SCADA Value History Service (VHS) SQL database queries Normalization View data CSV files Device-level data, when associated with a defined normalization view, can be exported out of FMS via the MSS or scripting Device data CSV files	See Running Normalization View Data Export Commands for more information about normalized data. See Export: Device Data CSV for more information about device-level data.
Raw Data	Determine if you will be exporting raw data from your CygNet Measurement system Device data CSV files Raw data exports to Flow-Cal via CFX/TFX files or transaction queue (if installed; provided as an optional feature)	See Export: Device Data CSV for more information. See Managing Node Commands for more information about optional Flow-Cal exports.

Item

Requirements/Values

Comments

Normalized Data

Data associated with a defined normalization view, can be exported out of FMS for various other business applications

CygNet SCADA Value History Service (VHS)
SQL database queries
Normalization View data CSV files

Device-level data, when associated with a defined normalization view, can be exported out of FMS via the MSS or scripting

Device data CSV files

See Running Normalization View Data Export Commands for more information about normalized data.

See Export: Device Data CSV for more information about device-level data.

Raw Data

Determine if you will be exporting raw data from your CygNet Measurement system

Device data CSV files
Raw data exports to Flow-Cal via CFX/TFX files or transaction queue (if installed; provided as an optional feature)

See Export: Device Data CSV for more information.

See Managing Node Commands for more information about optional Flow-Cal exports.

Configuring Replication and Data Synchronization

Item	Requirements/Values	Comments
Replication	Optionally identify your data replicating source Master service	The Master service (maximum of one) is the designated source for other replicated services, containing complete system data. See FMS Replication and Data Synchronization for more information.
Optionally identify your replicating disaster recovery service DR (Disaster Recovery) Slave service	The DR Slave (maximum of one) is the replicating disaster recovery service, containing all of the data in the Master service. See FMS Replication and Data Synchronization for more information.
Optionally identify your replicating business service(s) Business Slave service(s)	Each Business Slave (maximum of three) is a replicating business service, containing a subset of the data in the Master service. See FMS Replication and Data Synchronization for more information.
Optionally enable data-center redundancy	Redundancy can be set up for data-center (not local) failover. See FMS Replication and Data Synchronization for more information.

Item

Requirements/Values

Comments

Replication

Optionally identify your data replicating source