|
|
When creating a search index definition, data is converted into an indexed data structure made up of ‘documents’ and ‘fields’. This data structure resembles a database table, where the documents are the rows in the table, and the fields are the columns. The following image is a graphical representation of a simple 'staff member' search index definition:
Once created, a search index definition will be rebuilt periodically to ensure that it remains up to date. The frequency of the automatic rebuilds is determined by the value assigned to the 'Maximum Index Age' property in the On Key Config file. Search index definitions will be rebuilt automatically after this period, whether a rebuild is required or not.
In addition to this, the data contained in the search index definition will be updated each time the business object it is based on is updated.
How to ... Create a Search Index Definition
To create a new search index definition, you need to do the following:
Open the Search Index Definition browse screen.
Click the Insert New Record (
) button to open the Search Index Definition edit screen.
On the Header tab, provide a unique code, description, and select the sites that will have access to this search index definition.
On the Index Definition tab, select the table and fields that you want to include in the search index definition.
Click the Save (
) button to save the search index definition.
Click the Rebuild Index (
) button to build the new search index definition.
Note! Building the search index could take several minutes to complete, depending on the size of the selected database table.
View the Background Task Messages screen to ensure that no errors have occurred.
Note! The 'Total' and 'Number Done' fields in the Background Task Messages screen will not be updated to reflect the rebuild progress.
Note! Users need to log out of On Key, and then log back in for newly created search index definitions to be displayed in the Search screen.