Global Search allows searching for information with words, parts of words, and even 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 performs is performed through the Search Table included, they are checked by the ACL Rules, and then through the Search Indices. ThusThus, the query processing and the result outputting are performed only by the fields available to a particular user.
| Note |
|---|
If the Text Search Group or the Text Search Table is not specified, the search does not apply. |
| Tip |
|---|
Role required: admin. |
Search configuration guide
| Panel | ||
|---|---|---|
| ||
To index table columns, follow the steps below:
|
Create a Search Group
The search groups are intended to categorize tables by 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 changes.
Search Group form
| Field | Mandatory | Description | ||
|---|---|---|---|---|
| Name | Y | Enter the name of a the grouping category for the search results. | ||
| Portal | N | To make the search group available for self-service portal users, click on the magnifier icon icon
| ||
| Order | N | Enter the integer number in the field to define the sequence in which the search results groups are displayed. The groups are displayed in ascending order. | ||
| Description | N | A brief Brief or detailed information about the search group. | ||
| Active | N | Set this checkbox active to make the group available and visible for to users. | ||
| Opened by default | N | Set this checkbox active to make disclose the group unveiled, so that , the search results are will be visible within the search navigator bar.
|
Default group configuration
The out-of-the-box tables table categorization is provided as listed below:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
= Tasks: Change Request Change Task Incidents Incident Task Inquiry Service Request Requests Task = People & Companies: Employee Company = Configuration: Business Rule Client Script UI Action ACL Includes Script Notification Rule Dynamic Filter Scripted Related List Widget Property = Knowledge Base: Articles = CMDB: Configuration item |
That is, your Your search request is processed against these tables, and the result results may look as shown on in the screenshot in the table above.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
= Task = Knowledge Base |
Create a Search Table
Search tables specify data sources for text search indexing. Within the groups, these tables also collect the search results, determining its their categories.
The system property search_text_service.excluded_tables allows to specify specifying tables that do not appeared appear as options when options when setting up the Search tables.
| Info |
|---|
The search query passes the ACL check on the tables and indexed columns before sending it to the database and performing 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 changes.
Search Table form
| Field | Mandatory | Description |
|---|---|---|
| Name | Y | Enter the name of a the table displayed in the search results. |
| Table | Y | Specify a the source table of data indexed for search. Click on the magnifier icon icon |
| Search Group | Y | Assign a the group to the table that will be responsible for displaying the search results. Click on the magnifier icon icon |
| Order | N | Enter the integer number in the field to define the sequence in which the search results result tables are displayed. The tables are displayed in the ascending order. |
| Active | N | Set this checkbox active to make the search table available and visible for to 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 table record creation. The The search is performed through these search indices.
| Note |
|---|
Only users with the admin role can read the Search Index You cannot create, edit, or delete records in the Search Indices (sys_search_index) table records. Only users with the admin role can read them. |
To make a get the table column indexed, follow the steps below:
- Navigate to System Definition → All Columns.
- Open the desired Column record of your search table. Use filter options or Condition Builder if you need to find it.
On the record form, set the Full Text Search checkbox to the active state.
Note The Search Indexes include only those records that were created after enabling the Full Text Search option of the table column.
- Click Save or Save and Exit to apply 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 Reference columns are also available for search indexing. The system adds to the Search Indices table the reference table column values that are marked with the Display by Ref flag. To make a get the reference column indexed, follow the steps below:
|
To create a search index, follow the steps below:
- Navigate to System Definition → Search Indices.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Search Index form
| Field | Mandatory | Description |
|---|---|---|
| Record | N | A record containing the field indexed. |
| Table | Y | A reference field containing the name of a table from sys_db_table the indexed column belongs to. |
| Column | Y | A reference field containing the name of an indexed column of the table specified in the Table field. |
| Text | Y | A particular record field value. |
/
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|