driver-ExcelCsvFileImport

This component is a history file import descriptor used to create a history based upon data in any (local) comma-separated-values (CSV) text file created by Microsoft Excel. These history file import descriptors reside under the HistoryNetworkExt (Histories extension) of a FileDevice in a FileNetwork. You use the DelimitedFileImportManager view of the Histories extension to add history file import descriptors.

Note: This import descriptor is similar to the DelimitedFileImport descriptor, but assumes CSV data specifically created by Microsoft Excel (it lacks the Delimiter property). This allows complex CSV-delimited data to be successfully imported, using the special rules of Excel CSV generated files. For any other type of delimited data (for example, tab-delimited or pipe-delimited), use the DelimitedFileImport descriptor instead.

This import descriptor has properties common among all history import descriptors, such as Name, History Id, and so on. See History Import Manager. See the next section Properties of history file import descriptors for other configuration properties.

Properties of history file import descriptors

History file import descriptors (DelimitedFileImport, ExcelCsvFileImport) have the following set of configuration properties, which appear in the New and Edit dialogs for the descriptors:

Property	Value	Description
Value Facets	additional properties	Specifies the units with which to display values imported from the delimited file. On the import descriptor’s property sheet, this property is found under Config Overrides.
Time Zone	drop-down list	Specifies the time zone for the imported history. On the import descriptor’s property sheet, this is property is found under Config Overrides.
File	File Chooser	Identifies the local delimited file to import using standard ORD syntax and an absolute file ORD path. If the parent FileDevice has a non-null Base Ord property (specifying a directory), you can type in a file name or file path relative to that directory, using the following ORD syntax: file:fileName or filePath/toFileName.
Full Import On Execute	true or false (default)	Controls how much of history to refresh on each import. Enabled imports the entire history on each import. Disabled appends only new data to the history on each import.
Row Start	number (defaults to zero)	Specifies the line in the file from which to begin importing data. This value is zero-based, meaning that a value of 1 skips the first line (usually column headers) and begins importing with the second line.
Row End	number (defaults to the end of the file)	Specifies on which line in the file to stop importing data.
Delimiter	text character	Specifies the text character the file uses to separate columns.
Timestamp Column Index	number	Defines a left-to-right index (zero-based ) to identify the column in the file from which to import the timestamp. For example: if the timestamp is in the first column, this value is zero (0). If it is in the second column, this value is 1; and so on. This value is required.
Timestamp Format	drop-down list	Specifies a string to define how timestamps are formatted in the file. After selecting an option, you can further edit the string, if necessary. Editing may be necessary if you execute and the descriptor is in fault. This value is required.
Value Column Index	number	Defines a left-to-right index (zero based) to identify the column in the file from which to import the data value. For example, if the second column contains the data value, this value is 1; if the fifth column, this value is 4; and so on. This value is required.
Value Format	drop-down list (defaults to Numeric Type)	Specifies the data type of history record to create: Numeric Type identifies a numeric history. String Type identifies a string history. Boolean Type identifies a two-state history.
Status Column Index	number	Defines the left-to-right index (zero-based) to identify the column in the file used to import the status, if available. The imported status value must match the Niagara status bits implementation in encoded-integer format, which uses a decimal-equivalent value either singly or, in the case of non-zero values, in combinations: 0 - ok 1 - disabled 2 - fault 4 - down 8 - alarm 16 - stale 32 - overridden 64 - null 128 - unackedAlarm This value is optional.
Identifier Column Index	drop–down list (defaults to None)	Defines the left-to-right index (zero-based) to identify the column in the file used to filter rows for inclusion in combination with the Identifier Pattern property value). The default value provides no row filtering. This value is optional.
Identifier Pattern	*	Specifies the text string in the Identifier Column Index that the import searches for in all rows, where the import job imports any row with the matching text string. Wildcard characters (*) are supported. This value is optional.