Configure peek search request value - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

Hexagon University Icon eLearning is available for this topic. Check it out here: HxGN SDx® | Modify the Peek Search request value

As you enter characters in the Search bar, the system invokes a peek search request into the database after a set number of characters have been typed. The peek search displays the number and examples of objects returned that match the search characters. This helps search performance by allowing you to refine the criteria before you run the main search and return the objects in a results grid.

You can configure the number of characters you must be enter before a peek search is invoked This helps performance by reducing the number of peek search requests for objects with long prefixes. The default peek search value is set at 3. The minimum value that can be set is 3 and the maximum is 9.

For example, if the character limit is set to three, and you have to type in six characters to match your document type, increasing the peek search request value to six avoids unnecessary peek search requests being sent each time to the database after you type three, four, and five characters for that object type.

You can change the peek search request value for an API Entry Point as follows:

  1. Search for the API Entry Point you want to edit, and select Actions > Update.

  2. Enter the number of characters for the peek search in the Number of characters for peek search request box.

  • The minimum number of characters that can be set for a peek search is 3 (the default). The maximum number is 9.

  • The peek search request value set for the number of characters is specific to each object API Entry Point.

  • Increasing the peek search limit for one API Entry Point does not affect any other API Entry Points.

  • The peek search value only applies to the main Search bar and Relationship Builder search bar.

  • The Search is disabled until the set number of peek characters has been typed.

  • You can set a global system wide peek search setting using the SDx Web Client peek search characters count (3-9) setting in the Server Manager Web Client Site Settings node. The default value is set to 3. However, the peek search request value set in an object API Entry point always takes precedence over the global system wide setting.

    You can also set the global system wide peek search setting using the APPLICATION_PEEKSEARCH_CHARACTERS_COUNT parameter in the Web Client settings.json file.