Import Gas Analysis CSV Commands

Import: Gas Analysis CSV

Import: Gas Analysis CSV (IFGACSV via script) is a system-level command that triggers the service to import gas analysis .csv files into FMS according to the defined parameters. Results of the import can be viewed via the Configuration control, in the Gas analysis data view. See Using the Configuration Control and Gas Analysis View for more information.

In conjunction with the .csv file, an import definition file (.idf) can be used to customize the import. The .idf file defines details about how to import and format the data items in your .csv file. See Using an Import Definition File for more information about configuring this file.

This command does not automatically send any information to the associated gas device. To also send the gas quality data from the imported gas analysis to the device, initiate a Send Gas Quality to Device command in one of the following ways.

Select a record, and initiate the command from the Configuration control context menu - After successful completion of the Import Gas Analysis CSV command, view the records in the Configuration control, Gas analysis data view, and select a record to send to the device. Right-click on the record to access the context menu and select Send gas quality to device to send GQ data contained in the record (received via the gas analysis import) to the device.

Optionally edit the gas analysis record, and initiate the command from the record property sheet - After successful completion of the Import Gas Analysis CSV command, view the records in the Configuration control, Gas analysis data view, and select a record to send to the device. Right-click on the record to access the context menu and select Edit to access the record property sheet. After optionally editing the record, click Send to send the GQ data contained in the record (received via the gas analysis import) to the device.

Manually initiate the command for the Node - After successful completion of the Import Gas Analysis CSV command, execute a Send Gas Quality to Device command against the Node, to send GQ from the gas analysis record in the database to the device. See Executing CygNet Measurement Commands and Send Gas Quality for more information.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS 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 Import: Gas Analysis CSV commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available 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 via the MSS service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Property

Description

FMS service

Select a Site.Service for the command from the available FMS service list in the drop-down menu.

Command

Select the desired Command name from the drop-down menu.

See FMS Commands for more information about available 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 via the MSS service in CygNet Explorer.

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

Command Parameters

The following command parameters apply to Import: Gas Analysis CSV commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
ImpPath	Import file directory	File Directory	Double-click to access the Enter Report File Directory dialog box. Type the directory location from which to import the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS service. This parameter is required.
ImpMask	Import file mask	String	If used, double-click to access the Enter Import File Mask dialog box. Type an import file mask name into the text box. Default file mask value is "*" (multiple character wildcard). If specified, only files meeting the file mask will be considered for import. This parameter is optional.
ImpClrPrc	Processed files retention (days)	Integer	If used, double-click to access the Enter Processed Files Retention (Days) dialog box. Type the number of days to retain the processed files into the text box. 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. This parameter is optional.
RptUnitSet	Unit set	Dynamic String Enum	If used, double-click to access the Unit Set dialog box. 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.
CALCHIST	Recalculate affected history records	String Enum	Double-click to access the Recalculate Affected History Records dialog box. Select one of the following options. Yes (YES via script) No (NO via script) Energy only (ImpCalcEn via script) 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.
ImpGroup	Add devices to group	String	If used, double-click to access the Enter Add Devices to Group dialog box. Type the name of the group to which the imported devices will be added into the text box. If specified, all devices with imported data will be added to the group. 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). This parameter is optional.
ImpClrGrp	Clear existing group entries	String Enum	If used, double-click to access the Clear Existing Group Entries dialog box. Select one of the following options. Yes (YES via script) No (NO via script) If set to Yes, and a value has been specified for ImpGroup, 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.
DtTmFmt	Import time format	String Enum	Double-click to access the Import Time Format dialog box. Specify what time format to use for the imported data. Select one of the following options. Device (Device via script) Contract (Contract via script) If set to Device, the time listed is based on the raw device data record. If set to Contract, the time listed 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.
ImpEDOvrd	Effective date/time override	DateTime	If used, double-click to access the Select Date/Time dialog box. Enter a date to override the effective date/time from the .csv file, to become the new effective date/time for the gas analysis file import. 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.
ImpCmnts	Comments	String	If used, double-click to access the Enter Comments dialog box. Type comments to help identify the import circumstances into the text box. If specified, the comments will be part of the audit record for the file import. This parameter is optional.

Parameter

Description

Type

Usage Notes

ImpPath

Import file directory

File Directory

Double-click to access the Enter Report File Directory dialog box.

Type the directory location from which to import the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location.

Note: The directory specified is relative to the computer hosting the FMS service.

This parameter is required.

ImpMask

Import file mask

String

If used, double-click to access the Enter Import File Mask dialog box.

Type an import file mask name into the text box. Default file mask value is "*" (multiple character wildcard).

If specified, only files meeting the file mask will be considered for import.

This parameter is optional.

ImpClrPrc

Processed files retention (days)

Integer

If used, double-click to access the Enter Processed Files Retention (Days) dialog box.

Type the number of days to retain the processed files into the text box.

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.

This parameter is optional.

RptUnitSet

Unit set

Dynamic String Enum

If used, double-click to access the Unit Set dialog box.

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.

CALCHIST

Recalculate affected history records

String Enum

Double-click to access the Recalculate Affected History Records dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)
Energy only (ImpCalcEn via script)

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.

ImpGroup

Add devices to group

String

If used, double-click to access the Enter Add Devices to Group dialog box.

Type the name of the group to which the imported devices will be added into the text box.

If specified, all devices with imported data will be added to the group. 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).

This parameter is optional.

ImpClrGrp

Clear existing group entries

String Enum

If used, double-click to access the Clear Existing Group Entries dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

If set to Yes, and a value has been specified for ImpGroup, 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.

DtTmFmt

Import time format

String Enum

Double-click to access the Import Time Format dialog box.

Specify what time format to use for the imported data.

Select one of the following options.

Device (Device via script)
Contract (Contract via script)

If set to Device, the time listed is based on the raw device data record.

If set to Contract, the time listed 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.

ImpEDOvrd

Effective date/time override

DateTime

If used, double-click to access the Select Date/Time dialog box.

Enter a date to override the effective date/time from the .csv file, to become the new effective date/time for the gas analysis file import.

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.

ImpCmnts

Comments

String