driver-DelimitedFileImport

This component is a history file import descriptor used to create a history based upon data in a (local) delimited text file, such as a comma-separated-values (CSV) or tab-delimited values file (you can configure the delimiter to use). To view Import descriptors expand FileNetwork > FileDevice > HistoryNetworkExt (Histories extension).

This import descriptor is similar to the Excel CSV file import descriptor, with the exceptions that the delimited file import descriptor uses a dumb-string tokenizer to parse each line of the specified file and separates table columns based solely on the specified delimiter. You should import only non-complex CSV file or non-CSV delimited file (such as tab-delimited, for example) with the delimited file import descriptor. For any CSV file created by Microsoft Excel, use the Excel CSV file import descriptor instead.

Figure 36. Delimited File Import properties

To create this component, expand Config > Drivers > NiagaraNetwork, right-click Histories, click Views > Delimited File Import Manager, click New, select DelimitedFileImport, click OK, configure the import descriptor and click OK.

To access these properties after creating an import descriptor, expand Config > Drivers > NiagaraNetwork > Histories and double-click DelimitedFileImport

In addition to the standard properties (Status, Enabled and Fault Cause), these properties are unique to this component.

Property	Value	Description
State	read-only	A frozen property on a component, indicates the current state of operations. `Idle` (default) `Pending` `In Progress`
Execution Time	additional properties	Configures a time trigger that controls when to perform the function. Trigger properties are documented in the Getting Started with Niagara guide.
Last Attempt	read-only	Reports the date and time of the last attempted execution.
Last Success	read-only	Reports the timestamp of the last successful history export.
Last Failure	read-only	Reports the last time the system failed to perform this function. Refer to `Fault Cause` for details.
History Id	text (defaults to:/stationname/historyname, where stationname is the name of the Supervisor station and historyname is a discovered name)	Specifies the history station and name. If the Discovered pane displays the station name as the caret symbol (^), the history name reflects the source history name. Leave both properties at their default values or edit the second (<historyName>) property only.
On Demand Poll Enabled	`true` (default) or `false`	Determines user control over polling. `true` enables a system user to use the Live Updates (play) button in History views to poll for live data for the associated imported history(ies). `false` renders this button unavailable in history views for the associated imported history(ies).
On Demand Poll Frequency	drop-down list	References the On Demand Poll Scheduler rates under the NiagaraNetwork’s History Policies container slot. Configures how often this type of poll occurs.
Config Overrides, capacity	drop-down list (defaults to `Unlimited`)	Defines the maximum number of history records allowed in the associated table. `Unlimited` enforces no limitation on the number of records. `Record Count` opens an additional property for defining the table limit.
Config Overrides, fullPolicy	drop-down list (defaults to `Roll`)	Defines what happens if `Capacity` is set to `Record Count` and the specified record count is reached. `Roll` overwrites the oldest records with the newest ones. This ensures that the latest data are recorded. `Stop` terminates recording when the number of stored records reaches the specified capacity. Full policy has no effect if `Capacity` is `Unlimited`.
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. `True` imports the entire history on each import. `False` 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 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.

driver-DelimitedFileImport

Figure 36. Delimited File Import properties

Related Links