driver-ExcelCsvFileImport

 ExcelCsvFileImport is a history file import descriptor used to create a Niagara 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.

NoteThis 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:

  • Value Facets

    Lets you specify the units with which to display values imported from the delimited file. On the import descriptor’s property sheet, this is property is found under “Config Overrides”.

  • Time Zone

    Lets you specify the time zone for the imported history. On the import descriptor’s property sheet, this is property is found under “Config Overrides”.

  • File

    (Important) Identifies the local delimited file to import, using standard “ord” file syntax. Typically, you simply click the folder icon to open the File Chooser, and navigate as needed to click-select an absolute file ord path to the file.

    Of, 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

    Default is disabled. If set to enabled, the entire history is re-filled afresh upon each import. If left at default, only new data is appended to the history upon every import.

  • Row Start

    Along with Row End, lets you specify the start and end rows (lines) in the file to use for importing. Note that both properties are zero-based, meaning that a Row Start of 1 means that it skips the first line (usually column headers), and begins importing on the second line.

  • Row End

    See Row Start, above. Row End is optional, and defaults to go to the end of the file (none).

  • Delimiter

    (appears only if a DelimitedFileImport descriptor) Specifies the text character used in the file to separate columns. For any ExcelCsvFileImport descriptor, a comma (“,”) is used by default.

  • Timestamp Column Index

    (Required, zero-based) Left-to-right index of the column in the file used to import the timestamp. For example: if first column, this value is “0”; if second column, this value is “1”; and so on.

  • Timestamp Format

    (Required) String that specifies how timestamps are formatted in the file. A drop-down control lets you select among several common formats—after selection, you can further edit if necessary (may be necessary if you execute, and the descriptor is in fault). For timestamp format details and examples, see http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html

  • Value Column Index

    (Required, zero-based) Left-to-right index of the column in the file used to import the value. For example: if the second column, this value is “1”; if the fifth column, this value is “4”; and so on.

  • Value Format

    Specifies the value type, meaning the type of history record to create, as one of the following:

    • Numeric Type — (default) for a numeric type history.

    • String Type — for a string type history.

    • Boolean Type — for a boolean (two-state) type history.

  • Status Column Index

    (Usage optional). The left-to-right index (zero-based) of the column in the file used to import the status, if available. Note that the imported status value must match the Niagara “status bits” implementation in encoded-integer format, using the following decimal equivalent values (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

  • Identifier Column Index

    (Usage optional). The left-to-right index (zero-based) of the column in the file used to filter rows for inclusion, in combination with the Identifier Pattern property value (below). Default value is None (no row filtering).

  • Identifier Pattern

    (Usage optional). Specifies the text string in the Identifier Column (above) that is searched for in all rows, where any row with the matching text string is imported. Note that wildcard (“*”) characters are supported. Default if value is * (everything matched).