Prerequisites:
- You have connected locally to an existing
Supervisor station that is properly licensed and has the required software installed.
- The niagaraSystemIndex palette is open.
Perform the following steps:
- In the niagaraSystemIndex palette, expand
Typical configuration and drag the SystemDbService to the
Supervisor’s Services node, and in the pop-up window click OK.The SystemDbService is added to the station.
- Open the SystemDbService property sheet, and in the
System Database Type Selection property, select orientSystemDb from the drop-down list and click Save.You have chosen OrientSystemDb as the backend database.
- Expand , and set the
Enabled property to true to enable local system indexing.
NOTE: The SystemIndexService actually is a distinct and separate service. However, this service is dependent upon selections made
in the SystemDbService for its configuration. So the preconfigured SystemDbService component includes a SystemIndexService,
LocalSystemIndexer, as well as other components.
- To configure a time to periodically re-index the local
Supervisor station, under the LocalSystemIndexer expand
Execution Time. For example, you can set it to re-index every night at 2:00AM.
NOTE: Typically, entities (components, tags, and relations) are static in nature, so it is not necessary to constantly re-index.
However, it is a good practice to set up a schedule to re-index periodically.
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.
- To manually trigger a local index operation, right-click
Local System Indexer and select to launch the local system index operation.
NOTE: By default, the LocalSystemIndexer component is configured with a set of default query ORDs which (if not disabled) are used to index the local root component
and local (non-NiagaraDriver) networks, device folders, devices, point folders, points, and schedules, and populate your SystemDb.
This determines which local entities are indexed. Additionally, you can configure the component with custom query ORDs to
run in addition to (or in place of) the default set.
The system index operation populates the SystemDb with entities, tags and relations detected in the local station. At this
point you can run NEQL queries against the SystemDb, and the Search results show all of the indexed entities. For information
on how to run a scoped search against the SystemDb,