Crawler Configuration (PI Web API Indexed Search)

Setup

The PI Web API Indexed Search Crawler requires read access to the PIUSER, PIDBSEC, PIMAPPING and PIPOINT tables. Access to these tables can be set in the Database Security plugin in PI SMT. Note that by default, the PIWorld identity has read access to PIUSER, PIPOINT and PIDBSEC. Therefore, explicit access is only required for PIMAPPING, unless you have disabled PIWorld. If PIWorld is disabled, you must grant explicit access to the PI Web API Indexed Search Crawler on each of the four tables mentioned above.

Create a new search source

Sets up a new PI Server or PI AF server as a source for the Indexed Search crawler to return results to future queries.

Body Parameter
JSON object with Name of the source, in the form of pi:piservername or af:\\afservername\afdatabasename as well as CrawlerHost, the hostname where the crawler service is running. Defaults to the same machine as the search service.

URL Parameters
If successful, the new search source object is returned. If unsuccessful, and exception is returned which contains details of the failure. A common exception is "AF source '\\server\database' not resolved to an AFDatabase" which can indicate the PI Web API service account doesn't have read access to that database.

UpdateSource

Edits an existing search source.

Body Parameter
The updated search source JSON object with Name of the source, in the form of pi:piservername or af:\\afservername\afdatabasename as well as CrawlerHost, the hostname where the crawler service is running. Defaults to the same machine as the search service.

URL Parameters
If successful, the updated search source object is returned. If unsuccessful, and exception is returned which contains details of the failure. A common exception is "AF source '\\server\database' not resolved to an AFDatabase" which can indicate the PI Web API service account doesn't have read access to that database.

localhost.osisoft.int
Enabling Operational Intelligence