niagaraSystemIndex-NiagaraNetworkSystemIndexSource

When installed and enabled under the SystemIndexService, it enables the NiagaraSystemIndexDeviceExt “mixin” on all NiagaraStations in the NiagaraNetwork. This causes a new SystemIndexer component property to be added dynamically under any NigaraStation or NiagaraEdgeStation in the Supervisor’s NiagaraNetwork.

This component is found in the niagaraSystemIndex palette.

Global Niagara Network Indexer

A frozen property on the NiagaraNetworkSystemIndexSource, which allows for specifying a global index query to periodically run against all active NiagaraStations in the NiagaraNetwork (and optionally their reachable stations), pulling entity data into the Supervisor’s SystemDb.

The global indexing process skips any NiagaraStation that is specifically disabled from global indexing, or that already has an active NiagaraSystemIndexImport in the Supervisor or a corresponding NiagaraSystemIndexExport that is pushing the data from the station. Since there can be only one master index source per NiagaraStation, the order of precedence is as follows.

An active NiagaraSystemIndexExport on the remote station
An active NiagaraSystemIndexImport on the Supervisor
The global NiagaraNetworkSystemIndexer

Figure 6. GlobalNiagaraNetworkIndexer property

Properties

In addition to standard properties (for example, Status, Enabled, Fault Cause, State, Alarm Source Info), the following configuration properties are available.

Property	Value	Description
Last Attempt	read-only, null (default)	Reports the date and time of the last attempted execution.
Last Success	read-only, null (default)	Reports the last time the station successfully performed this function.
Last Failure	read-only, null (default)	Reports the last time the system failed to perform this function. Refer to `Fault Cause` for details.
Execution Time	additional properties	See following sections.
Alarm on Failure	true (default), false	Enables/disables the generation of an alarm on indexing failure.
Default Index Queries	BQL queries (default)	Provides pre-configured default query ORDs. It is a read-only OrdList (frozen property) on several indexing components: LocalSystemIndexer, NiagaraNetworkSystemIndexSource, NiagaraSystemIndexExport, and NiagaraSystemIndexImport). For more details, refer the separate topic in this guide titled “Default Index Queries”.
Use Default Index Queries	`true` (Merge with Custom) (default), `false` (Custom Only)	If true, indexing uses the `Default Index Queries` and merges those with any Custom Index Queries that have been entered. If false, indexing uses only the `Custom Index Queries` that have been entered.
Custom Index Queries	empty (default), text	Provides an admin-writable OrdList, a frozen property with which to specify additional query ORDs that the framework merges with the `Default Index Queries` (unless `Use Default Index Querie`s is set to `false`). This property is empty unless you have entered custom queries. Click (+) to enter a new custom query.
Global Index Timeout	00002h 00m 00s (default)	Defines how long the system will wait for a global system index operation to complete. If a global index operation takes this long and is still in progress, it will timeout and assume a failure.
Include Reachable Stations	`false` (default), `true`	Defines whether to include reachable stations in the global system index operations. Reachable stations are those that are not direct NiagaraStations in the local Supervisor’s NiagaraNetwork, but those that are further downstream and accessible via Niagara virtuals routed through a subordinate NiagaraStation. Setting this property to `true` will cause reachable stations to be discovered (and persisted in the Supervisor). If left at `false`, reachable stations will not be discovered and included, and only direct NiagaraStations in the local Supervisor's NiagaraNetwork will be system-indexed.
Global Index Last Result	read-only	Provides a summary of the results of the last global system index operation. If any eligible NiagaraStations did not index, it is indicated here.

Execution Time properties

Property	Value	Description
Trigger Mode	interval, daily (default), manual	Determines when a TimeTrigger fires. `Daily` fires the trigger at a specific time on selected days of the week, and includes a randomized interval so that the trigger does not fire at exactly the same time every day. Randomized firing is useful when handling large volumes of data. `Interval` fires a trigger each time the specified interval elapses. You would use it to fire the trigger several times per day (for example, every 5 minutes). `Manual` requires a human to fire a trigger. When this trigger fires for a station database, a system indexer (`LocalSystemIndexer` or `GlobalNiagaraNetworkIndexer`) executes its index operation. CAUTION: Indexing a database is a memory- and CPU-intensive operation that affects the availability of your SystemDb and remote stations. Do not configure a re-index to occur too often so your SystemDb and remote stations can maintain availability throughout the day. If your SystemDb is indexed frequently, query performance degrades.
Last Trigger	read-only	Reports when (by displaying a timestamp) the last trigger fired.
Next Trigger	read-only	Reports when the trigger is scheduled to fire again.

Actions

Execute — Manually trigger the indexing operation
Retry failed indexes — Manually trigger a subsequent attempt on failed indexing operations