FTR Server Configuration Properties - 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)

Main details

Name - Displays the name of the FTR server.

Description - Provides a description of the FTR server.

Container ID - Displays the container ID of the FTR server configuration object.

FTR Server Options details

Regular Indexing turn ON/OFF - A Regular Indexing task is created only if the Regular Indexing turn ON/OFF option is turned on. When the option is turned off, the Regular Indexing task is deleted.

Only one Regular Indexing task is maintained in the system when the Regular Indexing turn ON/OFF option is turned on. The Regular Indexing task is always in a ready state once the processing is done regardless of success or failure, so that next time the same Regular Indexing task is processed by the scheduler.

By default, FTR Indexing is turned off. If FTR Indexing is required for SmartPlant Foundation project implementation, you must turn on the Regular Indexing turn ON/OFF option.

Update object after indexing - When the Update object after indexing option is selected, the last updated date of the object is changed after indexing. When the option is off, the updated date for the object is not changed after indexing.

By default, the last updated date is changed after indexing. You can clear the Update object after indexing check box so that the last updated date is not changed after indexing.

FTR Configuration details

Collection Name - Specifies the name of the data database used by FTR (the name of data database associated with the site). This can be any name. FTR creates a set of files with different extension to manage the indexed data (metadata and content).

Indexing Type - Determines the timing of the indexing operation.

  • A collection with IMMEDIATE index is indexed immediately when data is changed; the updated data is immediately available for FTR searches.

  • A collection with PERIODIC indexing is indexed only when FTR indexes the collection.

By default, all FTR collections are created using IMMEDIATE indexing.

AND Token - Specifies the symbol for Boolean operator AND.

OR Token - Specifies the symbol for Boolean operator OR.

NOT Token - Specifies the symbol for Boolean operator NOT.

Locale List - Specifies a list of available locales for the system. The settings for the following languages are:

Language

Locale list

Chinese

cn_cn

English

en_us

Japanese

ip_jp

Korean

ko_ko

Character Code - Maps a locale name to a character set name. Check the SQLRef.pdf document located at C:\Program Files (x86)\Intergraph\FTR\documentation for character code settings for the locale language. For example:

Language

Character code

English

ASCII

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

Default Locale - Specifies the default locale used when a document is created or searched in the system. The settings for the following languages are:

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. The settings for the following languages are:

Language

Attribute locale

Chinese

cn_cn

English

en_us

Japanese

jp_jp

Korean

ko_ko

Relevance Method - Specifies the value used to indicate the relevance method used when sorting results. The following values are supported:

Value

Name

Description

2:1

Hits Count

Counts the total number of occurrences of the individual words (not phrases) matched regardless of the term frequency within the table.

This is the default value.

2:2

Terms Count

Counts the number of search terms matched. The frequency of the occurrence of the terms is not considered.

2:3

Terms Ordered

Uses a mathematical formula that computes the relevance statistically. It combines the characteristics of algorithms 1 and 2 and considers not only the number of occurrences of each search term, but also a statistical measurement of how common the term is over all the rows in the table (document frequency).

2:4

Critical Terms Ordered

Uses a mathematical formula that computes the relevance statistically and accentuates the effect of the inverse document frequency. It squares the search term importance before multiplying it with the number of occurrences of the search term.

The Relevance Method setting is for future use.

Rewind Index Log - Controls whether to clear the index log before the index is refreshed.

Search Server Driver - Sets the ODBC driver for searches.

Delay Indexing by Seconds - Specifies the time lag in seconds between the creation of objects and indexing of objects by the scheduler task. This value is set to 0 by default.

You can change the Delay Indexing by Seconds value to match your own requirements. For example, if you set the Delay Indexing by Seconds value to 7200 seconds (2 hours) and the scheduler task for indexing of objects is scheduled to start at 6 P.M., then the objects created or updated until 4PM are queried for indexing. Objects created or updated after 4 P.M. are not indexed by this scheduler task because they have been delayed for indexing by 2 hours.

FTR Server details

Main Server Host - Specifies the name of the server on which the FTR service is running. This is typically the name of the machine where SmartPlant Foundation and FTR are installed.

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

Additional FTR server hosts - Displays all the hosts in the SmartPlant Foundation database. You can select additional hosts you want to search. This configuration option applies to content searches only. When an FTR Content Search is started, the software searches on all selected FTR servers. All metadata is stored on the main FTR server.

FTR Stop Properties details

Stop Properties - Specifies object properties that are ignored in indexing. Stop properties must be separated by a comma.

Collapse sections automatically - Controls the expand/collapse behavior of the configuration details sections.

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.