Configuring Import: Gas Analysis CSV Commands

Use the Import File: Gas Analysis CSV command to import comma-separated values (.csv) files containing gas analysis data into FMS. Results of the import can be viewed via the Configuration control. See Using the Configuration Control for more information.

The imported gas analysis data is applied to update the device Node record for a specified date/time. Prior to executing the import, you also have the option to configure the .csv file to prepare it for successful importation into your CygNet Measurement system, and customize it using an .idf file.

In addition, you can optionally define details about how the items in your gas analysis .csv file are imported relative to FMS, and how they will appear in the file. To do this, column and data source settings can be customized using an import definition file (.idf). See Using an Import Definition File for more information about this option.

See FMS Commands and Import: Gas Analysis CSV for more information about this command.

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

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

See CxFms for more information about scripting commands.

Command Definition Properties

The following command definition properties apply to Gas Analysis CSV File Import commands.

Property	Description
Command type	For system commands, this property will be read-only and will display the selected command type. See FMS Commands for more information about command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and status Default value is Low level logging when scheduling a command in the MSS. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.

Property

Description

Command type

For system commands, this property will be read-only and will display the selected command type.

See FMS Commands for more information about command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

Low level
Medium level
High level
User initiated transaction
Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

Low — displays errors
Medium — displays errors and warnings
High — displays errors, warnings, and status

Default value is Low level logging when scheduling a command in the MSS.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.

Command Parameters

The following command parameters apply to Import: Gas Analysis CSV commands, when creating or editing commands in FMS. See Gas Analysis Import CSV Files for more information about setting up your gas analysis .csv file for import.

Parameter	Value
Import file directory	Enter the directory location from which to import the file. Type in the value or click ... to access the Browse for Folder dialog box, and browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS. This parameter is required.
Import file mask	If specified, only files meeting the file mask will be considered for import. Type the file mask name. Default file mask value is "*" (multiple character wildcard). This parameter is optional.
Processed files retention (days)	If specified, the files that have been processed will be deleted after the specified number of days. If not specified, processed files will never be deleted. Type the number of days. This parameter is optional.
Unit set	If specified, select a unit set in which to view the data. Options appear in the drop-down menu, which is populated by the unit sets defined in the service. See Configuring Unit Set Definitions for more information. This parameter is optional. Notes: If you do not specify the unit set with this parameter, units for each included value must be specified using an .idf file. If you specify the unit set with this parameter AND in the .idf file, the value specified in the .idf file prevails, and overrides this setting. In this way, you may override individual unit values by setting them in the .idf file.
Recalculate affected history records	Select whether or not to recalculate history records affected by the gas analysis value change. Options are as follows. Yes No Energy only If set to Yes, the system will automatically recalculate energy, volume and/or mass values, for any historical records affected by the gas analysis change. If set to No, the system will not recalculate any historical records, but gas analysis value changes will be saved. If set to Energy only, the system will automatically recalculate energy values only, for any historical records affected by the gas analysis change, while preserving previous history edits. If no historical records are affected, this parameter will be ignored. This parameter is required.
Add devices to group	If specified, all devices with imported data will be added to the group. Type the name of the group to which the imported devices will be added. Associated devices that are configured to use the same gas quality/analysis source Node will also be added to the group when gas analysis data is present for the source Node. Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less). Example In the case of a gas quality import, you could execute a Send Gas Quality command to send GQ data from all imported files to the devices. This parameter is optional.
Clear existing group entries	If specified, options are Yes or No. If set to Yes, and a value has been specified for Add devices to group, any existing entries will be removed from the specified group before executing the command. If set to No, the existing group entries will be retained when executing the command. Note: Nodes cleared from this group are cleared for the entire span of the Node or group. This parameter is optional.
Import time format	Select what time format to use for the imported data. Options are Device or Contract time. Device time is based on the time in the raw device data records. Contract time is based on the contract hour value configured in the Node properties. Note: The effective date/time from the .csv file is applied to the record, using the time format selected. Use the optional effective date/time override parameter to change the effective date/time used for the record. This parameter is required.
Effective date/time override	If specified, the date entered overrides the effective date/time from the .csv file, to become the new effective date/time for the gas analysis file import. Click ... to Select Date and Time. See Selecting Date and Time for more information. Note: The selected time format still applies. Use the import time format parameter to change between Device/Contract time formats. This parameter is optional.
Comments	If specified, the comments will be part of the audit record for the file import. Type comments regarding the import. This parameter is optional.

Gas Analysis Import CSV Files

Note: Prior to importing a gas analysis .csv file, the following conditions must be met for each Node for which you are importing data.

The device Node must exist in your FMS system. See Using the Nodes Menu for more information about creating FMS Nodes.

Use the following procedure to prepare a gas analysis import .csv file for import into FMS.

To Configure and Edit a Gas Analysis Import CSV File

Once generated, you can edit the gas analysis import .csv file as follows, prior to importing it into FMS.

Open a .csv file for your gas analysis import.
Insert required (as noted) columns into your file, using your .csv editor. All required gas analysis import .csv columns are noted in the table below.
Insert additional columns into your file, as desired. All available gas analysis import .csv columns are described or referenced in the tables below.
Edit any gas analysis items desired (e.g. description, etc.) at this time, in preparation for importing the file to FMS.
Save and Close the .csv file when you are done.

Gas Analysis Import CSV Columns

Required Gas Analysis Import CSV Columns

The following table lists the columns for which values must exist in the gas analysis import .csv file (as noted in each description) in order for the FMS import to succeed.

Column	Description
Device	The device name
ConfigDateTime	The date/time for which to import and update the gas analysis record
eFMS_CFG_HEATING_VALUE_BASIS	Heating value basis Value options are as follows. 1 - Wet 2 - Dry 3 - As delivered
eFMS_CFG_BASE_PRESSURE	Base pressure Notes: If no value is present for this item, the configured value from the device will be used. Editing base condition values has data recalculation implications for physical properties (HVV, relative density, hydrocarbon liquid content). See CygNet Measurement Data Calculation for more information.
eFMS_CFG_BASE_TEMPERATURE	Base temperature Notes: If no value is present for this item, the configured value from the device will be used. Editing base condition values has data recalculation implications for physical properties (HVV, relative density, hydrocarbon liquid content). See CygNet Measurement Data Calculation for more information.
eFMS_CFG_*	At least one Gas Analysis configuration composition item is required. See Note below this table. See FMS Configuration Data Items for complete lists of all supported gas analysis and gas quality items.
[as specified in an .idf]	In the import definition file (.idf), additional columns may be identified as required="true" in order to perform the import. See Using an Import Definition File for more information.

Note: Although a minimum number of gas analysis items may be sufficient to read the import file, additional items may be required for the FMS Service to successfully process the imported data, since some processes are dependent on additional data items for associated data. For instance, proper HVV calculation requires a total composition of 1 (fraction) or 100 (%) as the sum of all mole percent data item values.

Additional Gas Analysis Import CSV Columns

Additional column headers can optionally be included in the gas analysis import .csv file. Columns can be included for any supported FMS gas analysis or gas quality items for which you have data in your system.

The following table lists options for column headers that may be contained in your .csv file.

Note: This list is provided only for reference, as your columns will be specific to your requirements. See FMS Configuration Data Items for complete lists of gas analysis and gas quality items which are supported in FMS and could also appear as column headers in your gas analysis import .csv file.

Column	Description
eFMS_CFG_HEATING_VALUE_VOLUME_WET	Heating Value Volume (HVV) - Wet
eFMS_CFG_HEATING_VALUE_VOLUME_DRY	Heating Value Volume (HVV) - Dry
eFMS_CFG_HEATING_VALUE_VOLUME_AS_DELIVERED	Heating Value Volume (HVV) - As delivered
eFMS_CFG_H2O_PER_VOLUME	H2O per volume
eFMS_CFG_H2S_PPM	H2S (PPM)
eFMS_CFG_TOTAL_H2S_PPM	Total H2S (PPM)
eFMS_CFG_COS_PPM	COS (PPM)
eFMS_CFG_MESH_PPM	MESH (PPM)
eFMS_CFG_ETSH_PPM	ETSH (PPM)
eFMS_CFG_DMS_PPM	DMS (PPM)
Gas Analysis - Composition
eFMS_CFG_METHANE	Methane
eFMS_CFG_ETHANE	Ethane
eFMS_CFG_PROPANE	Propane
eFMS_CFG_ISOBUTANE	Isobutane
eFMS_CFG_N_BUTANE	n-Butane
eFMS_CFG_ISOPENTANE	Isopentane
eFMS_CFG_N_PENTANE	n-Pentane
eFMS_CFG_NEO_PENTANE	Neopentane
eFMS_CFG_N_HEXANE	n-Hexane
eFMS_CFG_N_HEPTANE	n-Heptane
eFMS_CFG_N_OCTANE	n-Octane
eFMS_CFG_N_NONANE	n-Nonane
eFMS_CFG_N_DECANE	n-Decane
eFMS_CFG_WATER	Water
eFMS_CFG_HYDROGEN_SULFIDE	Hydrogen sulfide (H2S)
eFMS_CFG_HYDROGEN	Hydrogen (H2)
eFMS_CFG_CARBON_MONOXIDE	Carbon monoxide (CO)
eFMS_CFG_OXYGEN	Oxygen (O2)
eFMS_CFG_HELIUM	Helium (He)
eFMS_CFG_ARGON	Argon (Ar)
eFMS_CFG_NITROGEN	Nitrogen (N2)
eFMS_CFG_CARBON_DIOXIDE	Carbon dioxide (CO2)
Gas Analysis - Liquid Content
eFMS_CFG_ETHANE_LC	Ethane - liquid content
eFMS_CFG_PROPANE_LC	Propane - liquid content
eFMS_CFG_ISOBUTANE_LC	Isobutane - liquid content
eFMS_CFG_N_BUTANE_LC	Butane - liquid content
eFMS_CFG_ISOPENTANE_LC	Isopentane - liquid content
eFMS_CFG_N_PENTANE_LC	Pentane - liquid content
eFMS_CFG_N_HEXANE_LC	Hexane - liquid content
eFMS_CFG_N_HEPTANE_LC	Heptane - liquid content
eFMS_CFG_N_OCTANE_LC	Octane - liquid content
eFMS_CFG_N_NONANE_LC	Nonane - liquid content
eFMS_CFG_N_DECANE_LC	Decane - liquid content
Gas Quality
eFMS_CFG_COMPRESSIBILITY	Compressibility
eFMS_CFG_DEW_POINT	Dew Point
eFMS_CFG_HEATING_VALUE_VOLUME	Heating Value - Volume
eFMS_CFG_HEATING_VALUE_MASS	Heating Value - Mass
eFMS_CFG_RELATIVE_DENSITY	Relative Density
eFMS_CFG_VISCOSITY	Viscosity
eFMS_CFG_SAMPLE_DATE	Sample Date Can be mapped as a custom gas configuration item. See Configuring Custom Device Data for more information.
eFMS_CFG_SAMPLE_RATE	Sample Rate Can be mapped as a custom gas configuration item. See Configuring Custom Device Data for more information.
eFMS_CFG_SAMPLE_TYPE	Sample Type Can be mapped as a custom gas configuration item. See Configuring Custom Device Data for more information.
eFMS_CFG_SAMPLE_PRESSURE	Sample Pressure
eFMS_CFG_SAMPLE_TEMPERATURE	Sample Temperature
eFMS_CFG_SAMPLE_COUNT	Sample Count
eFMS_CFG_SAMPLE_TECHNICIAN	Sample Technician
eFMS_CFG_SAMPLE_COMMENTS	Sample Comments
eFMS_CFG_ANALYSIS_TECHNICIAN	Analysis Technician
eFMS_CFG_ANALYSIS_COMMENTS	Analysis Comments
eFMS_CFG_CUSTOM1	10 Custom string* items are available to be mapped to supported configuration items as desired.* See FMS Gas Configuration Items for a complete list of all supported gas analysis and gas quality configuration items. See Configuring Custom Device Data for more information about the mapping process.
eFMS_CFG_CUSTOM2
eFMS_CFG_CUSTOM3
eFMS_CFG_CUSTOM4
eFMS_CFG_CUSTOM5
eFMS_CFG_CUSTOM6
eFMS_CFG_CUSTOM7
eFMS_CFG_CUSTOM8
eFMS_CFG_CUSTOM9
eFMS_CFG_CUSTOM10
eFMS_CFG_CUSTOM_NUMBER1	5 Custom numerical* items are available to be mapped to supported gas analysis items as desired.* See FMS Gas Configuration Items for a complete list of all supported gas analysis configuration items. See Configuring Custom Device Data for more information about the mapping process.
eFMS_CFG_CUSTOM_NUMBER2
eFMS_CFG_CUSTOM_NUMBER3
eFMS_CFG_CUSTOM_NUMBER4
eFMS_CFG_CUSTOM_NUMBER5