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.

Type	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, null (default)	Reports date/timestamp of the last attempted index.
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.
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)	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.

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