Customizing Suggest

Details for customizing the suggest service in NETVIBES OnePart are detailed below.

This task shows you how to:

Customize Search box suggest

The suggest service provides your users with auto-completion suggestions when they start typing in the Search box.

There are 2 customization scenarios for suggest:

  • modifying the existing OnePart suggest(s)

  • creating a new suggest in the UI, which involves several steps
OnePart provides a number of default suggest dictionaries based on index fields as follows. All dictionaries are scheduled to rebuild every 2 hours. See the Build Scheduling configuration available for each suggest dictionary.
Note: The suggest fields icsCategory and supplier are not used by OnePart, so it is useless to customize these fields. They are used in an internal product.

Context:

Suggest name Type Index field
file_name Index field suggest document_file_name
author Index field suggest document_author
part_number Index field suggest 3d_shape_part_number
revision Index field suggest 3d_shape_revision
definition Index field suggest 3d_shape_definition
nomenclature Index field suggest 3d_shape_nomenclature
material Index field suggest 3d_shape_material
sheet_name Index field suggest drawing_sheet_name
tags Index field suggest document_tags

Create the suggest dictionary

Create a suggest dictionary that is not handled by the defaults. Particularly for new index field properties that you have created in the data model.

Note: For complete details on suggest configuration, see the Exalead CloudView Configuration Guide.

  1. Go to Administration Console > Suggest.
  2. Click Add suggest and enter a name.
  3. Choose a suggest type.
  4. Configure suggest options.
  5. Compile the suggest dictionary (see below)
  6. Click Apply to save the changes.

Compile the suggest dictionary

Once created, you must build the suggest dictionary in the Administration Console. This provides your users with auto-completion suggestions when they start typing in the Search box.

Context:

For more details, see the Exalead CloudView Configuration Guide

  1. In the Administration Console, go to Search > Suggest.
  2. Click Build now for every new suggest dictionary.


    Note: For each suggest, you can also schedule the builds in the Build Scheduling configuration.

Customize Tag suggest

OnePart provides the CustomConfigs.xml file to customize the tag suggest. Be default, the users are free to enter any tag that they choose since the onlySuggestValues key is set to false. The tags entered by the users can be used to filter the search results as shown below. If you need to restrict the tag vocabulary that the users can enter then you can change the configuration.

Context:

To override the default behavior you must edit the xml configuration file and then manually apply the product configuration. 

...
<CustomConfig name="tagging">
<KeyValue value="false" key="onlySuggestValues">
</KeyValue>
<CustomConfig>
...

  1. Open the ONEPART_INSTALLDIR\datadir\config\CustomConfigs.xml
  2. Edit the value in the onlySuggestValues key tag: <KeyValue value="true" key="onlySuggestValues">
  3. Open the Administration Console.
  4. Go to Search > Suggest and delete the current "tags" suggest.


  5. Create a "tags" suggest dictionary in XML format.

    For details on “Search Suggest”, see the Exalead CloudView Configuration Guide.

  6. Run DATADIR\bin\buildgct.exe to rebuild the product configuration.

    Note: For more details on manually applying the configuration, see the Exalead CloudView Administration Guide

  7. On the Administration Console ’s home page, click Restart host.