Configuring Import: Gas Quality CSV Commands

Use the Import File: Gas Quality CSV command to import comma-separated values (.csv) files containing gas quality data, and send that information directly to the device.

You can also optionally decide to import the gas quality data into your CygNet Measurement system.

To import the data into FMS as well, configure and edit the gas quality .csv file to prepare it for successful importation, and do one of the following to request current configuration data from the device.

Automatically poll the device for configuration data - Prior to execution of the Import Gas Quality CSV command, set the Request config after successful send parameter to Yes to automatically poll the device for configuration data (including the data sent via the .csv import) after the file import command succeeds.
Manually request configuration data from the device - After successful completion of the Import Gas Quality CSV command, execute a Request Current Configuration command to request configuration data from the device (including the data sent via the .csv import).

In addition, you can optionally define details about how items in your gas quality .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) to map values. See Using an Import Definition File for more information about this option.

See FMS Commands and Import: Gas Quality 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 Quality 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 Quality CSV commands, when creating or editing commands in FMS. See Gas Quality Import CSV Files for more information about setting up your .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 used, only files meeting the file mask entered 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 used, 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 used, 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.
Status point UDC	If used, the UDC of the status point that monitors the status of the command. (The command will run whether or not it is monitored by a status point.) Type the status point UDC into the text box. The UDC will be combined with the field device Facility ID. This parameter is optional.
Request config after successful send	Select whether or not to automatically request configuration for the device once the imported data has been successfully sent. Options are Yes or No. Select Yes if you also want to automatically import the configuration data contained in the .csv file into FMS. Select No if you do not want to import the configuration data contained in the .csv file into FMS, or if you want to do so manually. This parameter is required.
Max runtime (minutes)	Enter the maximum time (in minutes) to allow the command to run before the import will time out. Note: Entering a value of 0 causes the command to run indefinitely. This parameter is required.
Communication attempt count	Enter the number of times to attempt the import before it will fail. This parameter is optional. Notes: If you specify 0 for this value, the import will be attempted until it succeeds. If you do not specify a number, the default value is 1.
Add devices to group	If used, type the name of the group to which devices will be added. All devices with data in the imported .csv file will be added to the specified group, resulting in a group containing Nodes that have imported data. You can then issue commands against the group. Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less). This parameter is optional.
Clear existing group entries	If used, 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.

Gas Quality Import CSV Files

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

The 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 Quality import .csv file for import.

To Configure and Edit a Gas Quality Import CSV File

Once generated, you can edit the Gas Quality import .csv file as follows, prior to importing it and sending the data to the device.

Open a .csv file for your Gas Quality import.
Ensure that required (as noted) columns are present in your file. If necessary, insert required columns using your .csv editor. All required Gas Quality import .csv columns are noted in the table below.
Insert additional columns into your file, as desired. All available Gas Quality import .csv columns are described or referenced in the tables below.
Optionally edit any Gas Quality items desired (e.g. description, etc.) at this time, in preparation for importing the file into FMS.
Save and Close the .csv file when you are done.

Gas Quality Import CSV Columns

Required Gas Quality Import CSV Columns

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

Column	Description
Device	The device name. Note: This column is required.
eFMS_CFG_ *	At least one Gas Quality data item is required. See Note below this table. See FMS Send Gas Quality Items for a complete list of supported 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.

Column

Description

Device

The device name.

Note: This column is required.

eFMS_CFG_ *

At least one Gas Quality data item is required. See Note below this table.

See FMS Send Gas Quality Items for a complete list of supported 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 quality 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.

Additional Gas Quality Import CSV Columns

Additional column headers can be included in the Gas Quality import .csv file. Columns can be included for any supported FMS 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. It is provided only for reference, as your columns will be specific to your requirements. See FMS Send Gas Quality Items for a complete list of FMS gas quality items supported by CygNet Measurement.

FMS Gas Quality Item String	Description
Gas Quality Items
eFMS_CFG_METHANE	Methane (C1)
eFMS_CFG_ETHANE	Ethane (C2)
eFMS_CFG_PROPANE	Propane (C3)
eFMS_CFG_ISOBUTANE	Isobutane (isoC4)
eFMS_CFG_N_BUTANE	n-Butane (C4)
eFMS_CFG_ISOPENTANE	Isopentane (isoC5)
eFMS_CFG_N_PENTANE	n-Pentane (C5)
eFMS_CFG_NEO_PENTANE	Neopentane (neoC5)
eFMS_CFG_N_HEXANE	n-Hexane (C6)
eFMS_CFG_N_HEPTANE	n-Heptane (C7)
eFMS_CFG_N_OCTANE	n-Octane (C8)
eFMS_CFG_N_NONANE	n-Nonane (C9)
eFMS_CFG_N_DECANE	n-Decane (C10)
eFMS_CFG_NITROGEN	Nitrogen (N2)
eFMS_CFG_CARBON_DIOXIDE	Carbon dioxide (CO2)
eFMS_CFG_WATER	Water (H2O)
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_HEATING_VALUE_VOLUME	Heating Value Volume
eFMS_CFG_RELATIVE_DENSITY	Relative density
eFMS_CFG_VISCOSITY	Viscosity

CSV Columns Generated at Import

Several .csv columns are generated during the file import, and are used for tracking and error identification purposes.

Warning: Do not edit values in these columns. Doing so could jeopardize your ability to successfully complete the import.

The following table lists the columns that are generated upon import of the gas quality import .csv file.

Column	Description
Operations	The description of the last operation performed for the Node; used for tracking status. The value for this field is generated at import into FMS. DO NOT EDIT THIS VALUE.
Tx Id	The transaction ID; used for tracking status. The value for this field is generated at import into FMS. DO NOT EDIT THIS VALUE.
Attempts	The number of times the import will be attempted before it fails. Note: A value of 0 in this column means the import will be attempted until it succeeds. The value for this field is generated at import into FMS. DO NOT EDIT THIS VALUE.
Status	Results displayed include the following. OK — Import was successful. Error: X — Import failed due to an error of type X. See Importing Group CSV Files into FMS for more information. The value for this field is generated at import into FMS. DO NOT EDIT THIS VALUE.
Error Text	The explanatory text for a transaction error identified in the Status column. This information lets you reconfigure or edit the identified error before attempting the import again. The value for this field is generated at import into FMS. DO NOT EDIT THIS VALUE.