Configuring Import: Configuration CSV Commands

Use the Import File: Configuration CSV command to import comma-separated values (.csv) files containing configuration data, for gas or liquid data types, into your CygNet Measurement system. The imported configuration data can be applied to the Node record for a specified date/time or for a date/time range. Prior to executing the import command, you can optionally configure and edit the corresponding configuration data .csv file, gas or liquid, to prepare it for successful importation into FMS, and customize it using an .idf file. The file to use for the import is defined by the value of the Import file directory parameter.

CygNet Measurement provides sample CSV files, for gas (SampleConfigGasImport.csv) or liquid (SampleConfigLiquidImport.csv) configuration data, that you can adjust and use to create CSV files for new imports. The sample .csv files are located in the CygNet\Services\FMS\ImportSamples folder on your host server.

In addition, you can optionally define details about how items in your configuration .csv file are imported into FMS, and how they will appear in the imported file. To do this, column and data source settings can be customized using an import definition file (.idf) if desired. Samples of these files, for gas (CxFmsImportCsvConfigGas.idf) or liquid (CxFmsImportCsvConfigLiquid.idf) configuration data, are also provided by CygNet Measurement. The sample .idf files are located in the CygNet\Services\FMS\ImportSamples folder on your host server. See Using an Import Definition File for more information about this option.

See FMS Commands and Import: Configuration 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.

Preparing the CSV Import File

Include the appropriate column(s) to apply imported configuration records to a specified date/time or to a date/time range, as follows.

To apply imported records for a specified date/time, use only the ConfigDateTime column.
To apply imported records for a date/time range, use both the ConfigDateTime and the EndDateTime columns.
Note: When a date/time range is defined, the import creates a new configuration record only when it finds that configuration data item values have changed.

Imported configuration data is applied in the following manner, depending on the date/time(s) defined in the .csv file and the records present in the device.

If a specific date/time is defined, the new configuration record is created at the specified date/time.
If a date/time range is defined, and no configuration records exist within the specified range, the new configuration record (equal to the most recent configuration record) is created at the beginning of the specified range.
If a date/time range is defined, and configuration records already exist within the specified range, all configuration records within the specified range will be updated.
If a date/time range is defined, and a configuration record exists that is more recent than the specified range, the new configuration record is created at the end of the specified range.

Customizing the CSV Import File

You can also use an import definition file (.idf) to define details about how the items in your configuration .csv file are imported into FMS and how they will appear in the file. To do this, customize the column and data source settings using an .idf. See Using an Import Definition File for more information.

Command Definition Properties

The following command definition properties apply to Configuration 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: Configuration CSV commands, when creating or editing commands in FMS. See Configuration Import CSV Files for more information about setting up your configuration .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 no unit set is specified with the command parameter, units must be specified using an .idf file for each included configuration item using units. If the unit set is specified with the command 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	For gas Nodes, select whether or not to recalculate history records affected by the configuration 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 configuration change. If set to No, the system will not recalculate any historical records, but configuration 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 configuration 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. 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.
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.

Configuration Import CSV Files

Note: Prior to importing a configuration .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 configuration import .csv file for import into FMS. Sample .csv files, for gas (SampleConfigGasImport.csv) or liquid (SampleConfigLiquidImport.csv) configuration data, are provided for your use in the CygNet\Services\FMS\ImportSamples folder on your host server.

To Configure and Edit a Configuration Import CSV File

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

Open a .csv file for your configuration import.
Edit default gas or liquid column entries, using your .csv editor. A sample of default configuration import .csv columns are described or referenced in the tables below.
Insert additional gas or liquid columns into your file, as desired. A sample of available configuration import .csv columns are described or referenced in the tables below.
Edit any configuration 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.
Optionally prepare an IDF to customize your import. See Using an Import Definition File for more information.

Configuration Import CSV Columns

Default Configuration Import CSV Columns - Gas Nodes

A default column set is included in the sample import file.

The following table lists a sample of the gas configuration item columns reflected in the .csv sample file by default, for which values may exist in the configuration import file. The list is provided for reference, prior to user-customization. Columns can be included for any supported FMS Configuration Data Items for which you have data in your system. See FMS Configuration Data Items for additional data item options.

Column	Description
Device	The device name This column is required.
ConfigDateTime	The date/time for which to import and update the configuration record Note: When EndDateTime is also defined, this value functions as the beginning date/time of a date range for which to update all records found. This column is required.
EndDateTime	The ending date/time of a date range. Any records that exist within the defined date range will be updated with the new configuration data. Note: When specified, this value functions in conjunction with ConfigDateTime to define a date range for which to update all records found.
eFMS_CFG_AGA3_EXPANDED_RANGE	AGA 3 Expanded Range Options are as follows. 0 - No 1 - Yes
eFMS_CFG_AGA8_EXPANDED_RANGE	AGA 8 Expanded Range Options are as follows. 0 - No 1 - Yes See AGA 8 Data Ranges for more information.
eFMS_CFG_CALC_METHOD_DISCHARGE_COEFFICIENT	Discharge Coefficient Calc Method Options are as follows. 1 - None
eFMS_CFG_CALC_METHOD_FPV	Compressibility Calc Method Options are as follows. 1 - AGA 8 Gross 1 2 - AGA 8 Gross 2 3 - AGA 8 Detail 4 - NX 19 GCN 5 - NX 19 Complete 6 - None 7 - GERG (not supported)
eFMS_CFG_CALC_METHOD_PRIMARY	The primary calculation method Options are as follows. 1 - AGA 3 1985 2 - AGA 3 1992 3 - AGA 7 5 - AGA 9 (not supported) 6 - AGA 11 7 - VCone 8 - AGA 5 (not supported) 9 - ISO 9951 (not supported) 10 - ISO 5167 (not supported) 11 - Wafer Cone 12 - AGA 3 2013 This column is required. Note: If you already have this configuration value imported, this field may not be required.
eFMS_CFG_METER_TYPE	The device type Options are as follows. 1 - Orifice 2 - Positive (not supported) 3 - Turbine 4 - Ultrasonic 5 - Liquids (not supported) 6 - Cone 7 - Coriolis This column is required. Note: If you already have this configuration value imported, this field may not be required.
eFMS_CFG_METER_TUBE_MATERIAL	Meter Tube Material Options are as follows. 1 - Stainless steel (unspecified type) 2 - Monel (valid for AGA 3 1985 or 1992 only) 3 - Carbon steel 4 - Unspecified 5 - Stainless steel 304 (valid for AGA 3 2013 only) 6 - Stainless steel 316 (valid for AGA 3 2013 only) 7 - Monel 400 (valid for AGA 3 2013 only) Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_PIPE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.
eFMS_CFG_ORIFICE_PLATE_MATERIAL*	Orifice Plate Material* Options are as follows. 1 - Stainless steel (unspecified type) 2 - Monel (valid for AGA 3 1985 or 1992 only) 3 - Carbon steel 4 - Unspecified 5 - Stainless steel 304 (valid for AGA 3 2013 only) 6 - Stainless steel 316 (valid for AGA 3 2013 only) 7 - Monel 400 (valid for AGA 3 2013 only) Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_ORIFICE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.
eFMS_CFG_CONE_MATERIAL	Cone Material Options are as follows. 1 - Stainless steel 2 - Monel 3 - Carbon steel 4 - Unspecified Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_CONE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.
eFMS_CFG_FLUID_TYPE	Fluid Type Options are as follows. 1 - Compressible 2 - Noncompressible
eFMS_CFG_USE_LIVE_TEMP	Use Live Temperature Options are as follows. 0 - No 1 - Yes
eFMS_CFG_DP_TAPS_TYPE*	DP Taps Type* Options are as follows. 1 - Flange 2 - Pipe
eFMS_CFG_SP_TAP_LOCATION	SP Tap Location Options are as follows. 1 - Upstream 2 - Downstream
eFMS_CFG_SP_SENSOR_TYPE	SP Sensor Type Options are as follows. 1 - Absolute 2 - Gauge
eFMS_CFG_INTEGRAL_VALUE_VARIABLES	Variables included in IV Options are as follows. 1 - (FTDP[inh2o]SP[psia]) 2 - (FTDP[inh2o]SP[psia])/T[R] 3 - (FTDP[inh2o]SP[psia])/Gr 4 - (FTDP[inh2o]SP[psia])/(T[R]Gr)) 5 - None 6 - (FTDP[mBar]SP[bar]) 7 - (FTDP[mBar]SP[bar])/T[K] 8 - (DP[inh2o]SP[psia]) 9 - (DP[inh2o]SP[psia])/T[R] 10 - (DP[inh2o]SP[psia])/Gr 11 - (DP[inh2o]SP[psia])/(T[R]Gr) 12 - (DP[mBar]SP[bar]) 13 - (DP[mBar]SP[bar])/T[K]
eFMS_CFG_CUSTOM1 - eFMS_CFG_CUSTOM10	Note: These values are applicable for gas (not liquid) device Nodes. 10 Custom configuration items are available for gas device Nodes, to be mapped to supported items as desired. See FMS Configuration Data Items for a complete list of all supported configuration items. See Configuring Custom Device Data for more information about the configuration process.
[as specified in an .idf]	In the import definition file (.idf), columns may be identified as required="true" or required="false" in order to perform the import. See Using an Import Definition File for more information.

*Orifice

Additional Configuration Import CSV Columns - Gas Nodes

Additional column headers can be included in a configuration import .csv file, as appropriate for your usage. Columns can be included for any supported FMS Configuration data items for which you have data in your system. See FMS Configuration Data Items for a complete list of data items which could appear in your configuration import .csv file.

Default Configuration Import CSV Columns - Liquid Nodes

A default column set is included in the sample import file.

The following table lists a sample of the liquid configuration item columns reflected in the .csv sample file by default, for which values may exist in the configuration import file. The list is provided for reference, prior to user-customization. Columns can be included for any supported FMS Configuration Data Items for which you have data in your system. See FMS Configuration Data Items for additional data item options.

Column	Description
Device	The device name This column is required.
ConfigDateTime	The date/time for which to import and update the configuration record Note: When EndDateTime is also defined, this value functions as the beginning date/time of a date range for which to update all records found. This column is required.
eFMS_CFG_LIQUID_CALC_METHOD	The liquid calculation method Options are as follows: 1 - eFMS_CFG_LIQUID_CALC_METHOD_NONE - None 2 - eFMS_CFG_LIQUID_CALC_METHOD_API_12_2 - API 12.2 3 - eFMS_CFG_LIQUID_CALC_METHOD_API_14_7 - API 14.7 4 - eFMS_CFG_LIQUID_CALC_METHOD_DIRECT_MASS - Direct Mass 5 - eFMS_CFG_LIQUID_CALC_METHOD_API_14_3_MASS - API 14.3: Mass 6 - eFMS_CFG_LIQUID_CALC_METHOD_API_14_3_VOLUME - API 14.3: Volume 7 - eFMS_CFG_LIQUID_CALC_METHOD__PRIMARY_ISO_5167 - ISO 5167 This column is required. Note: If you already have this configuration value imported, this field may not be required.
eFMS_CFG_METER_TYPE	The device type Options are as follows. 1 - Orifice 2 - Positive 3 - Turbine 4 - Ultrasonic 5 - Liquids (not supported) 6 - Cone 7 - Coriolis This column is required. Note: If you already have this configuration value imported, this field may not be required.
eFMS_CFG_DP_TAPS_TYPE*	DP Taps Type* Options are as follows. 1 - Flange 2 - Pipe
eFMS_CFG_SP_TAP_LOCATION	SP Tap Location Options are as follows. 1 - Upstream 2 - Downstream
eFMS_CFG_SP_SENSOR_TYPE	SP Sensor Type Options are as follows. 1 - Absolute 2 - Gauge
eFMS_CFG_FLUID_TYPE	Fluid Type Options are as follows. 1 - Compressible 2 - Noncompressible
eFMS_CFG_USE_LIVE_TEMP	Use Live Temperature Options are as follows. 0 - No 1 - Yes
[Custom]	Note: Custom configuration items are not applicable for liquid device Nodes. See FMS Configuration Data Items for a complete list of all supported configuration items for liquid device Nodes.
[as specified in an .idf]	In the import definition file (.idf), columns may be identified as required="true" or required="false" in order to perform the import. See Using an Import Definition File for more information.

*Orifice

Additional Configuration Import CSV Columns - Liquid Nodes

Customizing the CSV Import File

In addition to editing the .csv file content, you can use an import definition file (.idf) to define details about how the items in your configuration .csv file are imported into FMS and how they will appear in the file. To do this, customize the column and data item settings (for example) using an .idf. See Using an Import Definition File for more information.