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 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.

Type	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 date/timestamp of the last successful index.
Last Failure	read-only, null (default)	Reports date/timestamp of the last failed index. See `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)	This read-only OrdList is a frozen property on several indexing components (LocalSystemIndexer, NiagaraNetworkSystemIndexSource, NiagaraSystemIndexExport, and NiagaraSystemIndexImport) that provides preconfigured default query ORDs. For more details, see 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	This is an admin-writable OrdList, a frozen property which allows you to specify additional query ORDs that will be merged with the `Default Index Queries` (unless `Use Default Index Querie`s is set to “false”). This field 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.
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

Type	Value	Description
Trigger Mode	interval, daily (default), manual	Determines when a TimeTrigger fires its trigger. When this trigger fires, it causes a system indexer (either the `LocalSystemIndexer` or `GlobalNiagaraNetworkIndexer`) to execute its index operation. Provides the standard trigger mode options, with a default setting of `Daily` at 2:00 AM, all days of the week. Other selections include `Manual` or `Interval`. For Daily or Interval modes, you can choose the desired execution parameters (Time of Date, Randomization, Days of Week) for the specific mode. Interval fires a trigger each time the specified interval has elapsed. Intended for use when firing the trigger several times per day (e.g. every 5 minutes). Daily allows the trigger to be fired at a specific time on selected days of the week. Also, provides randomization interval so that the trigger is not fired at exactly the same time every day, useful when handling large volumes of data. Manual requires human interaction to fire a trigger. NOTE: Indexing a database is a memory- and CPU-intensive operation that affects the availability of your SystemDb and remote stations. When configuring a re-index time, be sure it does not occur too often so your SystemDb and remote stations can maintain better availability throughout the day. If your SystemDb is indexed too often, query performance will degrade.
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