Import Events CSV Commands

Import: Events CSV

Import: Events CSV (IFEVTCSV via script) is a system-level command that triggers the service to import events .csv files according to the defined parameters.

Note: Events are only imported as raw data.

In conjunction with the .csv file, an import definition file (.idf) is 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.

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 Configuring File Import Commands: Events CSV and Running File Import Commands for more information about using this command via FMS Explorer.

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 Import: Events 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 in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer.

Command Parameters

The following command parameters apply to Import: Events 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 Import 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. 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 read the raw 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 the unit set is specified with the command parameter AND in the .csv file, the value specified in the .csv file prevails, and overrides the command setting. If no unit set is specified with the command parameter, units may be specified in the .csv file for included event items using units. If no unit set is specified with the command parameter, and no units are specified in the .csv file, the default unit set (as configured in your system) will be used.
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.