Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Tip |
---|
Role required: admin. |
Panel | ||
---|---|---|
| ||
|
Note |
---|
If there is no record in the Text Search Group or Text Search Table tables, the search is not performed. |
Create a text search group
The search groups are intended to categorize tables in which the search is performed.
To create a search group, follow the steps below:
- Navigate to System Definition → Text Search Groups.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Search Group form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Name | Y | Enter the name of the group category for the search results. | ||
Portal | N | To make the search group available for the self-service portalusers, click the magnifier icon
| ||
Order | N | Enter an integer in the field to define the sequence in which the group of search results is displayed. Groups are displayed in ascending order. | ||
Description | N | Type brief or detailed information about the search group. | ||
Active | N | Select this checkbox to make the group available and visible for users. | ||
Opened by default | N | Select this checkbox to make the group unveiled, so that, the search result table are visible within the search navigator bar. |
Default group configuration
The out-of-the-box tables categorization is provided as listed below:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
= Tasks: Change Request Change Task Incident Incident Task User Query Service Request Requests Task = People & Companies: Employee Company = Configuration: Business Rule Client Script UI Action ACL Script Include Notification Rule Dynamic Filter Option Scripted Related List Widget System Property = Knowledge Base: Articles = CMDB: Configuration item |
That is, your search request is processed against these tables, and the result may look as shown on the screenshot in the table above.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
= Tasks: ITSM Tasks = Knowledge Base: Article |
Create a text search table
Search tables define data sources for text search indexing. Within groups, these tables also collect the search results, determining its categories.
The system property search_text_service.excluded_tables allows you to specify tables that will not appear as options when setting up the search tables.
Info |
---|
The search query passes the ACL check on the tables and indexed columns before it is sent it to the database and executed through the Search Indices table. |
To create a search table, follow the steps below:
- Navigate to System Definition → Text Search Tables.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Text Search Table form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Name | Y | Enter the name of the table displayed in the search results. | ||
Table | Y | Specify a source table of data indexed for search. Click the magnifier icon | ||
Search group | Y | Specify a group to the table in which the search results will be displayed. Click the magnifier icon | ||
Displayed fields | N | Choose the table fields to display in search results if the values in those fields matches the search queries.
| ||
Subinfo fields | N | Select the table fields that will always be displayed in search results. | ||
Filter | N | Use the condition builder to limit and sort the search results. | ||
Order | N | Enter the integer in the field to define the sequence in which the search result tables are displayed. The tables are displayed in the ascending order. | ||
Active | N | Select this checkbox to make the search table available and visible for users. |
Configure search indices
The Search Indices table contains every value of the columns indexed that are automatically added to the table after the search tables records creation. The search is performed through these search indices.
Note |
---|
Only users with the admin role can read the Search Index (sys_search_index) table records. |
To make a table column indexed, follow the steps below:
- Navigate to System Definition → All Columns.
- Open the necessary Column record of your search table. Use filter options or the condition builder to find the record.
On the record form, select the Full Text Search checkbox.
Note The Search Indexes only include those records that were created after enabling the Full Text Search option of the table column.
To index records that already existed before the Full Text Search attribute was enabled, use the SimpleSearch server API methods.
- Click Save or Save and Exit to apply the changes. Subsequently, the system will automatically add the field values of this table column to Search Indices when creating new table records.
Info | ||
---|---|---|
| ||
The reference columns are also indexed. The system adds to the Search Indices table the reference table column values that have the active Display by Ref attribute. To make a reference column indexed, follow the steps below:
|
Search Index form
Field | Mandatory | Description |
---|---|---|
Record | N | A field indexed. |
Table | Y | The name of a table that has the indexed column |
Column | Y | The name of an indexed column of the table specified in the Table field. |
Text | Y | A particular record field value. |
/
Table of Contents | ||||||
---|---|---|---|---|---|---|
|