Search Index Definition Edit Screen

The Search Index Definition edit screen lets you create a new search index definition, or modify an existing one. The screen consists of three tabs: Header, Index Definitions, Notes.

Header tab

The Header tab includes the following fields:

Header
Code Unique identifier for the search index definition. It is also the name that will be displayed in the list of available search index definitions in the Search screen.
Description Description of the search index definition and its purpose.
Site Indicates the sites that will have access to the search index definition.
Active Indicates whether the search index definition is active.
Status
Rebuild Required Indicates whether the search index definition needs to be rebuilt.
 
Note! You will need to rebuild the search index definition each time you make a change. To rebuild a search index definition, click the Rebuild Index () or Force Rebuild Index () button on the toolbar. Rebuilding a search index definition could take several minutes to complete, depending on the size of the database table.

 

Index Definitions tab

The Index Definitions tab consist of the following sections:

Edit Screen Table

The Name drop-down list lets you select the edit screen that you want to use to create the search index definition. Selecting an edit screen displays all of its fields in the Columns section.

Columns

The Columns section consists of two panes: Available fields (left) and Selected fields (right).

The Available fields pane lists all the fields in the table selected in the Edit Screen Table section. The fields are presented in a tree structure. To expand a parent node and view its nested fields, click the Expand () button next to its name. To add a field to the search index definition, select the check box next to its name.

The Selected fields pane lists all the fields that have been added to the search index definition. To view a selected field's location in the Available fields section, click the Locate () button next to its name. To change the order of the fields in the search index definition, click and the drag the Sort () button next to a field's name to move it to a different location. This is the order in which the information will be displayed when performing a search. You can also customise the search index definition field names. To do this, click the field in the Selected fields pane, and then type the new name. The following restrictions apply to search index definition field names:

  • They may contain alpha numeric characters (ie A-Z, a-z, and 0-9) only
  • They may not start with a numeric character (ie 0-9)
  • They may not include special characters (eg $, #, or @)

 

Notes

This Notes tab provides the standard notes functionality. It enables you to add custom notes to the search index definition. Notes are not searchable.