systemIndex-LocalSystemIndexer

This component is used to enable and configure indexing of the Supervisor station into its own SystemDb. It is optional, only added to the station if you intend to index the Supervisor station. It is included with the SystemIndexService in the niagaraSystemIndex palette’s Typical configuration folder, and is enabled by default. If using Unconfigured components, this can be optionally installed directly under the SystemIndexService on the Supervisor.

Figure 4. Local System Indexer (unconfigured) properties

NOTE: The LocalSystemIndexer component is valid only on a Supervisor station running the SystemDbService. Attempting to enable this component on a remote controller station causes it to go into fault. This is because it will detect that no SystemDbService is installed and running there.

This component is found in the systemIndex and niagaraSystemIndex palettes.

Properties

In addition to standard properties (e.g. Status, Enabled, Fault Cause, Alarm Source Info, and etc.), this component provides the following configuration properties.

Property	Value	Description
State	read-only	A frozen property on a component, indicates the current state of operations. `Idle` (default) `Pending` `In Progress`
Last Attempt	read-only (defaults to null)	Reports the date and time of the last attempted execution.
Last Success	read-only	Reports the last time the station successfully performed this function.
Last Failure	read-only	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.
Alarm Source Info	additional properties	Contains a set of properties for configuring and routing alarms when this component is the alarm source. For property descriptions, refer to the Niagara Alarms Guide
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.

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