Magnify Search > Auto Complete > Configuring Auto Complete

Configuring Auto Complete

Topics:

To use Auto Complete with Magnify Search, you must first generate a suggestion index for each index you will be searching against. These suggestion indices must be stored in the same location where your standard indices are located and have a suffix of _IBI_SUGGEST_CONTENT. In the following example, the cars index is located in C:\ibi\WebFOCUS82\magnify\lucene4_index along with a new corresponding suggestion index called cars_IBI_SUGGEST_CONTENT.

Once you create the suggestion index, users can see the suggested terms as they type in the Magnify Search query field, as shown in the following image.

Auto Complete will also suggest any URLs or file paths saved in your suggestion index, as shown in the following image.

File path search suggestions

Generating Suggestion Indices

Topics:

You can generate a suggestion index for Auto Complete in two different ways:

  1. During the regular feed process.
  2. Using a batch/script program.

Generating a Suggestion Index During the Regular Feed Process

You can generate a suggestion index during your regular feed process by enabling the Enable Suggest Index Creation parameter (IBI_MAGNIFY_ENABLE_SUGGEST_INDEX_CREATION) in the Magnify settings page of the WebFOCUS Administration Console.

  1. Navigate to the WebFOCUS Administration Console, as shown in the following image.
  2. From the Configuration tab under Application Settings, click Magnify, as shown in the following image.
  3. Click the check box that corresponds to the Enable Suggest Index Creation parameter.

    By default, this parameter is not enabled.

  4. Click Save.

Generating a Suggestion Index Using a Batch/Script Program

If you have already created regular indices (for example, in a prior release), then you can use the batch file (generateAutocomplete.bat) for Windows platforms or script file (generateAutocomplete.sh) for Unix/Linux platforms to generate suggestion indices on existing indices.

These batch/script programs are located in the drive:\ibi\WebFOCUSxx\utilities\magnify folder of your WebFOCUS installation, as shown in the following image.

Note: Any existing index must be upgraded to the Lucene 4.9 level before running the batch/script program to generate the suggestion index for Auto Complete.

This batch/script program reads the available indices in the Magnify Search index folder and generates suggestion indices for each index. It generates a log file in the regular drive:\ibi\WebFOCUSxx\logs folder, named Generate_AutoComplete_Index.log, which can be used to review what was done and to see any errors that may have occurred. The batch/script program defaults to the drive:\ibi\WebFOCUSxx\magnify\lucene4_index folder to locate indices, but does allow you to override this default path when run interactively.

If you are using the batch/script program and the index location specified does not have any indices, then the following message is displayed: 

*** No Lucene Indices to generate autocomplete indices for in path %indexloc% !!!

Usage Considerations

Topics:

This section describes several usage considerations for Auto Complete with Magnify Search.

Disabling Auto Complete

At this time, Magnify Search does not provide an individualized search experience, so either all users of Magnify Search use the Auto Complete feature or they do not use it. However, a WebFOCUS administrator can disable the Auto Complete feature by:

  1. Disabling the Enable Suggest Index Creation parameter (IBI_MAGNIFY_ENABLE_SUGGEST_INDEX_CREATION) in the Magnify settings page of the WebFOCUS Administration Console.
  2. Deleting all suggestion indices or moving them to another location (outside the Magnify Search index path).

If the WebFOCUS administrator decides to enable Auto Complete at some point, they can regenerate the suggestion indices or move the suggestion indices back to the Magnify Search index path.

Suggestion Limits

The Auto Complete drop-down list of suggestions (terms) is limited to a maximum of 10 entries, provided there are at least 10 entries to display. If the search term you begin to type displays less than 10 entries, then the drop-down list will only show that number of entries.

WebFOCUS

Feedback