Device CSV Files

CygNet Measurement > FMS Utilities > FMS Toolbox > Configuring and Editing CSV Files for FMS Import > Device CSV Files

Configuring and Editing Device CSV Files

Once your device .csv file has been created, the next step of the migration process is to configure and edit the file to prepare it for the subsequent step, where you will import the file into FMS.

Preparing Device CSV Files for Import to FMS

The file can be configured with the appropriate columns, and edited for accuracy and completeness, prior to import into FMS. Use the following procedure to prepare the generated .csv file for successful import into FMS.

To Configure and Edit a Device CSV File for Import to FMS

Open the device .csv file you created for the migration.
Insert required (as noted) columns into your file, using your .csv editor. All required device .csv columns are listed in tables below.
Insert additional columns into your file, as desired. All available device .csv columns are listed in a table below.
Edit any export items desired (e.g. description, etc.) at this time, in preparation for importing the file to FMS.
Save and then Close the .csv file when you are done, so that the prepared file can be accessed in the subsequent step.

Required Device CSV Columns

The following tables list the minimum required columns (as described for each item) for which values must exist in the device import .csv file in order for the FMS import to succeed.

Required Columns for All Device Types
Additional Required Columns for Chromatographs
Additional Required Columns for Gas Meters (or Station Meters)
Additional Required Columns for Liquid Devices

(A complete list of columns available for device import .csv files is contained in the Available Device CSV Columns table.)

Required Columns for All Device Types

All device types minimally require columns supporting the following data items.

Column	Description
Name	Input from GMR: The device name. Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS. Valid characters (maximum of 20) are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.
NodeType	User input: Enter the FMS Node type. Options are as follows. 1 or Meter - Gas meter 2 or Chromatograph - Chromatograph 3 or Station Meter - Station meter (a Gas Meter Node set to also function as a station) 8 or Liquid Device - Liquid device
FmsImportStatus	The value for this field is generated at import into FMS. This column indicates the status of an attempted import into FMS. Results displayed include the following. OK — Import was successful. Error: X — Import failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the import again. See Importing Device CSV Files into FMS for more information.
InstallDateTime	Input from GMR: The GMR installation date, in Device time (D).
TimezoneKey	User input: Enter a numerical value for the CygNet time zone key. This information is contained in the CygNetTimeZones.xml file located in the CygNet\Services\ARS folder on your host server. See CygNetTimeZones.xml File for more information.

Additional Required Columns for Chromatographs

Chromatograph devices also minimally require columns supporting periodic quality data.

Column	Description
HasPQHistory	User input: Enter Y. This column indicates when Periodic Quality configuration process variable data is present in GMR. Options are as follows. Y = Has PQ history data N = Does not have PQ history data
PQRecordSpan	User input: Enter 60 (hourly). The PQ record span is required when Periodic Quality process variable data is present in GMR (HasPQHistory = Y). Note: This value can optionally be reset to 1440 (daily) after it exists in FMS, if desired.

Column

Description

HasPQHistory

User input: Enter Y.

This column indicates when Periodic Quality configuration process variable data is present in GMR.

Options are as follows.

Y = Has PQ history data

N = Does not have PQ history data

PQRecordSpan

User input: Enter 60 (hourly).

The PQ record span is required when Periodic Quality process variable data is present in GMR (HasPQHistory = Y).

Note: This value can optionally be reset to 1440 (daily) after it exists in FMS, if desired.

Additional Required Columns for Gas Meters (or Station Meters)

Gas meters or station meters (gas meters set to also function as stations) also minimally require columns supporting at least one of these history types: periodic metering and/or periodic quality.

Column	Description
HasPMHistory	User input: Enter Y or N; the default value is Y when exporting from GMR. Notes: At least one value, HasPQHistory and/or Has PMHistory, must be present and equal Y. If HasPMHistory = Y then PMRecordSpan is also required. This column indicates when Periodic Metering history data is present in GMR. Options are as follows. Y = Has PM history data N = Does not have PM history data
PMRecordSpan	When Periodic Metering process variable data is present in GMR (HasPMHistory = Y), this column is also required. The Periodic Metering record span default value is set to 60 (hourly) when exporting from GMR. Notes: This value can optionally be reset to 1440 (daily) after it exists in FMS, if desired. When exporting from GMR, PMRecordSpan and PQRecordSpan must be configured to be the same value when both parameters are applicable. If they are not the same value, the PMRecordSpan value, for which the default value is set to 60 (hourly), will be applied to both.
HasPQHistory	User input: Enter Y or N. Notes: At least one value, HasPQHistory and/or Has PMHistory, must be present and equal Y. If HasPQHistory = Y then PQRecordSpan is also required. This column indicates when Periodic Quality process variable data is present in GMR. Options are as follows. Y = Has PQ history data N = Does not have PQ history data
PQRecordSpan	When Periodic Quality process variable data is present in GMR (HasPQHistory = Y), this column is also required. User input: Enter 60 (hourly). Notes: This value can optionally be reset to 1440 (daily) after it exists in FMS, if desired. When exporting from GMR, PMRecordSpan and PQRecordSpan must be configured to be the same value when both parameters are applicable. If they are not the same value, the PMRecordSpan value, for which the default value is set to 60 (hourly), will be applied to both.

Additional Required Columns for Liquid Devices

Liquid devices also minimally require columns supporting at least one of these history types: periodic metering, batch, and/or ticket.

Column	Description
HasPMHistory	User input: Enter Y or N; the default value is Y when exporting from GMR. Notes: At least one value, HasPMHistory and/or HasBatchHistory and/or HasTicketHistory, must be present and equal Y. If HasPMHistory = Y then PMRecordSpan is also required. If the CollectionMethod value is 3 - FMS Legacy Polling Engine, this property must be set to Y. This column indicates when Periodic Metering history data is present in GMR. Options are as follows. Y = Has PM history data N = Does not have PM history data
PMRecordSpan	When Periodic Metering process variable data is present in GMR (HasPMHistory = Y), this column is also required. The Periodic Metering record span default value is set to 60 (hourly) when exporting from GMR. Note: This value can optionally be reset to 1440 (daily) after it exists in FMS, if desired.
HasBatchHistory	User input: Enter Y or N. The default value is N when exporting from GMR. Note: At least one value, HasPMHistory and/or HasBatchHistory and/or HasTicketHistory, must be present and equal Y. This column indicates whether or not the device has batch history data. Options are as follows. Y = Has batch data N = Does not have batch data
HasTicketHistory	User input: Enter Y or N. The default value is N when exporting from GMR. Note: At least one value, HasPMHistory and/or HasBatchHistory and/or HasTicketHistory, must be present and equal Y. This column indicates whether or not the device has ticket history data. Options are as follows. Y = Has ticket data N = Does not have ticket data
HasProduct	User input: Enter Y or N. The default value is N when exporting from GMR. This column indicates whether or not the device has liquid product data. Options are as follows. Y = Has product data N = Does not have product data

All Available Device CSV Columns

In addition to the minimally required columns, other columns are available to accommodate a variety of meaningful device data. The following list contains all available columns that can appear in FMS device import .csv files.

(A list of minimum columns required for device import .csv files is contained in the previous tables.)

Column	Description
Name	This field is required for all devices as noted above.
ID	Input from FMS: For all Nodes, this field contains the Node ID. This column is required to be present and have a value in order to change existing FMS Node Name values. If present, this column is required to be blank (no value) in order to create a new FMS Node upon import.
FmsExportStatus	The value for this field is generated at export from FMS to the .csv file. Results displayed include the following. OK — Export was successful. Error: X — Export failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the export again. See Exporting FMS Devices to CSV Files for more information.
FmsImportStatus	This field is required for all devices as noted above in Required Columns for All Device Types.
GmrExportStatus	Input from GMR, when the export is from a GMR service. The value for this field is generated at export to the .csv file. Results displayed include the following. OK — Export was successful. Error: X — Export failed due to an error, where X represents the field and the reason for the error. See Exporting GMR Devices to CSV Files for more information.
BeginActiveUtc	User input: For all Nodes, enter the UTC time for the Node to begin being active. Note: Leaving this field blank will default to Indefinite (no begin DateTime).
EndActiveUtc	User input: For all Nodes, enter the UTC time for the Node to stop being active. Note: Leaving this field blank will default to Indefinite (no end DateTime).
NodeType	This field is required for all devices as noted above.
Description	Input from GMR: The device description.
ReportingSiteService	User input: Enter the Site.Service of the service reporting data for the device. For an Accessory Node (a non-meter-specific Node primarily used for scheduling jobs in conjunction with CygNet Dispatch), enter the Site.Service associated with the accessory.
ReportingFacilityId	User input: Enter the FacilityId of the facility reporting data for the device. For an Accessory Node (a non-meter-specific Node primarily used for scheduling jobs in conjunction with CygNet Dispatch), enter the FacilityId of the facility for the specified Site/Service associated with the accessory.
SortPriority	User input: The sort priority of the device. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list. The default value is 0 when exporting from GMR.
SecurityApplication	Input from GMR: The name of the CygNet security application against which GMR security events for the device are authorized. This value is generally GMR, unless the system was customized during setup.
PollingSiteService	Input from GMR: The GMR Site.Service polling for the device.
PollingFacilityId	Input from GMR: The name of the polling facility for the device in the CygNet SCADA system.
DaysOfData	Input from GMR: The number of days source data is retained on the flow computer.
InstallDateTime	This field is required for all devices as noted above.
JobScheduleStartDate	User input: Applicable if using CygNet Dispatch. An optional field that defines the first possible date, in Device time (D), that can be used for scheduling job occurrences associated with the Node, when automatically scheduling jobs via the Schedule Jobs command. If no date is provided, default value used is the device InstallDateTime.
PMRecordSpan	This field is required for devices for which HasPMHistory = Y.
PQRecordSpan	This field is required for devices for which HasPQHistory = Y.
CollectionMethod	User input: For all Nodes (except as noted below), enter the collection method of the device. Options are as follows. 0 or FMS Polling Engine — Polling Engine facilities containing the FMS Configuration data group 1 or Device Import — Device Import 2 or Other — Other 3 or FMS Legacy Polling Engine — Polling Engine facilities containing the FMS Legacy Configuration data group 4 or Associated Site/Service — provided to allow making a facility association for an Accessory Node (a non-meter-specific Node available primarily for scheduling jobs in conjunction with CygNet Dispatch). See Accessory Node and CygNet Dispatch for more information. Note: If GMR successfully exported PollingSiteService and PollingFacilityId, this field will already be populated with the value 3. If so, the HasPMHistory property must be set to Y. Otherwise, enter the collection method as outlined above.
StationContribution	User input: Enter the system contribution value for the device. Options are as follows. 0 or [+] — Receipt (+) 1 or [-] — Delivery (-)
StationType	User input: For a station meter (a Gas Meter Node set to also function as a station), enter the station type value for the meter. Options are as follows. 0 or Custody — Custody 1 or Check — Check 2 or Interconnect — Interconnect 3 or Line Pack — Line Pack 4 or Gas Loss — Gas Loss 5 or Other — Other
LinkedStationNodeId	User input: For a station meter (a Gas Meter Node set to also function as a station), enter the Node ID, in numerical form, of a station to which to link for validation purposes.
ContractHour	Input from GMR: The offset (from midnight) for the meter contract hour. This column indicates the contract hour configured for the device, if present.
TimezoneKey	This field is required for all devices as noted above.
TimezoneDst	User input: For all Nodes, enter a value to indicate whether or not time Daylight Saving Time is enabled for the device. Options are as follows. Y = Daylight Saving Time enabled N = Daylight Saving Time not enabled
IsActive	This column indicates whether or not the device status is active. Options are as follows. Y = Active N = Not active The default value is Y when exporting from GMR.
HasConfig	This column indicates whether or not the device has configuration data. Options are as follows. Y = Has configuration data N = Does not have configuration data The default value is Y when exporting from GMR.
HasPMHistory	This field is required for gas meters and liquid devices as noted above. This field is optional for chromatographs (set to N, if used; if set to Y for a liquid device Node, the import will fail).
HasPQHistory	This field is required for chromatographs and gas meters as noted above. This field is optional for liquid devices (set to N, if used; if set to Y for a liquid device Node, the import will fail).
HasProduct	This field is required for liquid devices as noted above. This column is optional for chromatographs and gas meters (set the value to N, if used; if set to Y for a gas device Node, the import will fail). The default value is N when exporting from GMR.
HasBatchHistory	This field is required for liquid devices as noted above. This column is optional for chromatographs and gas meters (set the value to N, if used; if set to Y for a gas device Node, the import will fail).
HasTicketHistory	This field is required for liquid devices as noted above. This field is optional for chromatographs and gas meters (set the value to N, if used; if set to Y for a gas device Node, the import will fail).
HasEvents	This column indicates whether or not the device has event data. Options are as follows. Y = Has events data N = Does not have events data The default value is Y when exporting from GMR.
HasAlarms	This column indicates whether or not the device has alarm data. Options are as follows. Y = Has alarms data N = Does not have alarms data The default value is Y when exporting from GMR.
UseAltGQ/GASource	This column indicates whether the device will use gas quality/analysis data from a specified source Node, instead of using its own GQ history data or the GQ configuration of the corresponding EFM device. Options are as follows. Y = Use a specified alternate source Node's gas quality/analysis data - must also include a column and valid value for AltGQ/GASourceNode N = Use this Node's (live) gas quality history if available (HasPQHistory = Y). If unavailable, use the (imported) gas analysis values when present, otherwise use the (static) gas quality values configured in the device properties The default value is N when exporting from GMR.
AltGQ/GASourceNode	When UseAltGQ/GASource = Y, this column must be present, and lists the alternate device Node to use as the source for gas quality/analysis data for the selected Node, instead of using its own GQ history data or the GQ values configured in the corresponding EFM device. Note: If importing files into CygNet Measurement v8.2.0 from a prior version, and if the value of UseExternalGQ = Y, this column is also required to be present and to have a valid Node value in the CSV export file. Insert the column and value(s) before performing the file migration.
GmrUnitSet	This column indicates the (optional override) unit set for the system to apply to data exported from GMR. Note: GmrUnitSet is optional. It provides the ability to override units in cases where GMR data coming into FMS may contain values in units other than the expected GMR units. In such cases, use this parameter to define the unit set to use instead, and the FMS system will apply the specified unit set to the incoming GMR data. See GMR Data Items Units for more information.
[FrozenConfig]	Note: Frozen configuration items cannot be configured through this process; they must be configured in the device properties in FMS.

GMR Data Items Units