Configure Full Text Retrieval (FTR) - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

FTR is a mechanism that allows SmartPlant Foundation object metadata and file content to be indexed for faster retrieval of information. It also allows content-based search in files. Full-Text Retrieval (FTR) indexes files for searching based on properties or document content (including text) in files when an object is created, updated, or deleted. The actual locations of the text occurrences within the files are also identified. The files can be text files, word processing files (such as Microsoft Word or WordPerfect), or CAD files (such as MicroStation, SmartSketch, or AutoCAD). However, only the text portions of the CAD files are indexed and available for searching.

The FTR Service provides three major functionalities:

  • Data storage through a process known as FTR Indexing. For SmartPlant Foundation, FTR supports the indexing of objects if the class definition has the ISPFFTRItem interface instantiated and the property that needs to be indexed has the FTRindicator property set to True.

  • Data retrieval through the process of FTR Searching. Once objects have been indexed in a collection, you can search on the indexed data to retrieve objects matching the search criteria.

  • Providing a GUI that displays the class definitions enabled for FTR and the property definitions that can be indexed. This feature applies to SmartPlant Foundation only.

These three basic features implemented for FTR Interface support in SmartPlant Foundation are FTR Configuration, FTR Indexing, and FTR Search.