Indexing the Data Capture documents - SmartPlant Foundation - IM Update 48 - 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)

Server configuration

Full Text Retrieval (FTR) settings are configured in the Desktop Client. The FTR Server Configuration object is used to configure various registry keys and environment variables used by FTR with the associated site.

  1. Click Administration > FTR > Server Configuration. The FTR Server Configuration object appears in the list view.

  2. Right-click the object, and click Update.

  3. Modify the values in this dialog box as necessary. Refer to the following sections for more information on the settings managed with this dialog box.

FTR Server Options details

Regular Indexing turn ON/OFF - Select this option to submit FTR configured objects marked for indexing for regular indexing. If this option is disabled, objects are not submitted for regular indexing. Selecting this option creates the FTR Regular Indexing task, while disabling this option deletes the FTR Regular Indexing task from the system. By default, this option is disabled.

If FTR indexing is not required for a SmartPlant Foundation project implementation, the administrator must disable the FTR scheduler.

FTR Configuration details

Collection Name - Specifies the name of the FTR Collection into which objects are indexed and searched.

Indexing Type - Determines the timing of the indexing operation, either Immediate or Periodic. If set to Immediate, indexing occurs immediately after a row in an FTR collection is added, updated, or deleted, and it is immediately available for FTR searches. If set to Periodic, the collection is indexed only when the FTR Interface indexing server indexes the collection.

AND Token - Symbol used for searching by FTR for AND operations.

OR Token - Symbol used for searching by FTR for OR operations.

NOT Token - Symbol used for searching by FTR for NOT operations.

Locale List - Lists available locales for the system.

Language

Locale list

Chinese

cn_cn

English

en_us

Japanese

jp_jp

Korean

ko_ko

Character Code - Maps a locale name to a character set name.

Language

Character code

Chinese

GB2312

English

ASCII

Japanese

EUC_JP

Korean

KSC_5601_1992

Term Generator - Determines the type of linguistic processing performed on search terms in the CONTAINS or LIKE predicates of SELECT statements. An empty string disables searching for inflected forms. A value of "DEFAULT" enables morphological searching.

Default Locale - Specifies the default locale used when a document is created or searched in the system.

Language

Default locale

Chinese

cn_cn

English

en_us

Japanese

jp_jp

Korean

ko_ko

Attribute Locale - Specifies the locale used when attributes are created or searched in the system.

Language

Attribute locale

Chinese

cn_cn

English

en_us

Japanese

jp_jp

Korean

ko_ko

Relevance Method - Indicates the relevance method used when sorting results.

Rewind Index Log - Indicates if the index log should be cleared before the index is refreshed.

Search Server Driver - Sets the ODBC driver for indexing and searching.

FTR Server details

Main Server Host - Specifies the name of the server on which the FTR service is running. This value is typically the name of the machine where SmartPlant Foundation (FTR Service) and FTR RT are installed. Object metadata is indexed on this server. This host is designated as the main FTR server host and can be the same machine as the SmartPlant Foundation application server or a different machine on which FTR is installed.

Server Virtual Directory - Specifies the name of the virtual directory (as configured in IIS) that the SmartPlant Foundation server will use for FTR operations.

Additional FTR server hosts - Specifies all the hosts where FTR web service is configured and where FTR collection needs to be searched during FTR search. Content Indexing of files is performed on the machines where the files are stored in vaults. Every file server should have FTR installed to index the file content. All the file server hosts on which file contents are being indexed should be selected to ensure that FTR search can process all the indexed collections.

FTR Stop Properties details

Stop Properties - Sets all properties that are not to be indexed. Stop properties must be separated by a comma.

FTR Stop properties are the properties which will not get indexed even though they are configured for Indexing. For e.g.., the property “OBID”. I can configure this property for Indexing and if I include this in the Stop Properties list (comma separated one), this will not get indexed. Also properties like creation dates, unique Id, etc.., all come under this category. This concept is mainly for the flexibility of the end users and they can stop a property being indexed without doing schema changes

Configure indexing

  1. Click Administration > FTR > Indexing Configuration.

    The following dialog box allows you to configure the indexing of class definition objects. You can add or remove class definition objects from indexing.

  2. In the left pane, all class definitions that realize the interface definition ISPFFTRItem are listed. A class definition is enabled for FTR indexing only when selected, which in turn sets the SPFFTREnabled property on ISPFFTRItem to True.

    In the right pane, select the property definitions to be indexed. When the selection is complete, the property definition SPFFTRIndicator is set to True.

    The Enable FTR Indexing and Disable FTR Indexing commands are available on the shortcut menu of the property definition items.

  3. Click OK.