The global search allows users to search for information by words, parts of words, and phrases.
Before sending a query to the database, the search engine gets available Search Groups along with the portal URL if it is specified. Within each group, when the search query is performed through the Search Table included, they are checked against the ACL Rules, and then through the Search Indices. Thus, the query is processed, and the results are displayed only for the fields available to a particular user.
Role required: admin. |
To configure global search in the agent interface, complete the steps below:
Configure search indices.
To configure global search on the self-service portal, complete the same steps, but select the required portal in the Portal field of the Text search group form.
If there are no active records in the Text Search Group (ts_group) or Text Search Table (ts_table) tables, the search is not performed. |
The search groups are intended to categorize tables in which the search is performed.
To create a search group, complete the steps below:
Text search group form fields
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify the name of the group displayed in the search results panel. |
Portal | N | Select a portal to make the search group available to its users. The search group will only be available on the selected Portal. To make the search group available in the agent interface, leave this field empty. |
Order | N | Enter an integer to set the relative position of the group in the search results panel. Groups are displayed in ascending order. |
Description | N | Add a description of the search group. |
Active | N | Select this checkbox to make the group available and visible to users in the search results panel. |
Opened by default | N | Select this checkbox to make the group expanded by default in the search results panel. |
Search tables specify data sources for text search indexing. Within the groups, these tables also collect search results, determining their categories.
To create a search table, complete the steps below:
Text search table form
Field | Mandatory | Description | |
---|---|---|---|
Name | Y | Enter the name of the table displayed in the search results panel. | |
Table | Y | Select the source table that contains data indexed for search.
| |
Search group | Y | Select a search group in which the table search results will be displayed. | |
Displayed fields | N | Select the table fields to display in the search results if the values in those fields match the search query.
| |
Subinfo fields | N | Select the table fields that are always displayed in the search results. | |
Filter | N | Use the condition builder to filter and sort the search results. | |
Order | N | Enter an integer to set the relative position of the table within its search group. The tables are displayed in ascending order. | |
Active | N | Select this checkbox to activate the search table and make it visible to the users in the search results. |
The following search groups and tables are configured out-of-the-box:
|
|
The Search Indices (sys_search_index) table contains text values of the indexed columns. These values are used for the global search. The records in this table are automatically created when a new record is created in a table containing an indexed column. Empty fields are ignored.
You cannot create, edit, or delete records in the Search Indices (sys_search_index) table. Only users with the admin role can read them. |
To index a column, complete the steps below:
On the record form, select the Full Text Search checkbox.
If the column is of the Reference type, ensure that the Display by ref checkbox is selected. If not, select it. Otherwise, the column values will not be indexed. |
As a result:
Search Index form fields
Field | Description |
---|---|
Record | The ID of the record that contains the indexed field. |
Table | Reference to the table that contains the indexed column. |
Column | Reference to the indexed column of the Table. |
Text | The text value of the indexed field. It is automatically updated if the value of the indexed field changes. |