This section describes the high-level design of Full-Text Retrieval (FTR) in terms of the data flow, software structure, and the interfaces between structure components.
The FTR service provides three major functionalities:
-
Data storage, through a process known as FTR Indexing. FTR supports indexing of object metadata and file content, if the class definition realizes the interface definition ISPFFTRItem
-
Data retrieval, through the process of FTR Searching. After objects have been indexed in a collection, users can search on the indexed data to retrieve objects matching the search criteria.
-
FTR Configuration GUI that enables users to select class definitions and property definitions to be indexed.
As shown in the following diagram, three basic features are implemented for FTR Interface support in SmartPlant Foundation: FTR Configuration, FTR Indexing, and FTR Search.
All the components/dependencies are not shown on this diagram. This graphic is presented
to give a high-level overview of how the FTR functionality works.