niagaraDriver-NiagaraHistoryImport

This component configures import properties for a remote history, including collection (pull) times, current status, local history Id, and config overrides. History imports reside under the Histories extension of the NiagaraStation in the NiagaraNetwork.

Figure 1. Niagara History Import properties


To view these properties, expand Config > Drivers > NiagaraNetwork > NiagaraStation, right-click Histories and click Views > AX Property Sheet.

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

PropertyValueDescription
Stateread-only
Reports the current state of the data transfer as: Idle, Pending or In Progress.
Execution Timeadditional properties (Trigger Mode defaults to Daily)
Configures a time trigger that controls when to perform the function.

Trigger properties are documented in the Getting Started with Niagara guide.

Last Attemptread-only
Reports the date and time of the last attempted execution.
Last Successread-only
Reports the date and time of the last successful execution.
Last Failureread-only
Reports the date and time of the last execution failure.
On Demand Poll Enabledtrue (default) or false
Enables and disables 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 Frequencydrop-down list
References the On Demand Poll Scheduler rates under the NiagaraNetwork’s History Policies container slot.
Config Overrides, capacitydrop-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, fullpolicydrop-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.

Action

Figure 2. NiagaraHistoryImport actions menu


This component has one action, Executes, which imports of all the selected histories.