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.
Tip |
---|
Role required: admin. |
Panel |
---|
title |
To
index table columns, follow configure global search in the agent interface, complete the steps below:
- Create a
Search Group- search group.
- Create
a Search Table- a search table.
Configure Search IndicesConfigure search indices.
Info |
You can also configure the portal search for To configure global search on the self-service portal
users with the Search Groups settings, complete the same steps, but select the required portal in the Portal field of the Text search group form.
Note |
---|
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. |
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 complete the steps below:
- Navigate to System Definition Settings → Text Search Groups.
- Click New and fill in the fields.
- Click Save or Save and Exitexit to apply the changes.
Search Group form Text search group form fields
Field | Mandatory | Description |
---|
Name | Y |
Enter Specify the name of the group |
category for displayed in the search results panel. |
Portal | N | Select a portal to make the search group available to its users |
. If this field is empty, . The search group will only be available on the selected Portal. To make the search group |
is only in the agent interface, leave this field empty. |
Order | N | Enter an integer |
in the field to define the sequence in which the group of search results is displayed.to set the relative position of the group in the search results panel. Groups are displayed in ascending order. |
Description | N |
Type brief or detailed information about Add a description of the search group. |
Active | N | Select this checkbox to make the group available and visible |
for 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 |
bar.
Image Removed
Default group configuration
The out-of-the-box tables categorization is provided as listed below:
Code Block |
---|
language | text |
---|
theme | Eclipse |
---|
title | Table categorization in the agent interface |
---|
|
= 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 |
---|
language | text |
---|
theme | Eclipse |
---|
title | Table categorization on the portal |
---|
|
= Tasks:
ITSM Tasks
= Knowledge Base:
Article |
Create a text search table
Search tables define specify data sources for text search indexing. Within the groups, these tables also collect the search results, determining its their categories.Use the system property search_text_service.excluded_tables 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, complete the steps below:
- Navigate to System Definition Settings → Text Search Tables.
- Click New and fill in the fields.
- Click Save or Save and Exitexit to apply the changes.
Text Search Table search table form fields
Field | Mandatory | Description |
---|
Name | Y | Enter the name of the table displayed in the search results panel. |
Table | Y |
Specify a of that contains data indexed for search. |
Click the magnifier icon
Image Removed and select a table.The tables include in but not , without its child tables. You need to create a separate text search table for each of them. |
|
Search group | Y |
Specify to the table in which the table search results will be displayed |
.Click the magnifier icon
Image Removed and select a search groupChoose Select the table fields to display in the search results if the values in those fields |
matches queries you do not specify any fields, fields with the active this field is empty, all fields that match the search query and have the Full Text Search attribute |
|
and that contain the search query will be shown in search results by defaultenabled are displayed in the search results. |
|
Subinfo fields | N | Select the table fields that |
will be displayed in the search results. |
Filter | N | Use the condition builder to |
limit filter and sort the search results. |
Order | N | Enter |
the in the field define the sequence in which the search result tables are displayed.set the relative position of the table within its search group. The tables are displayed in |
the make activate the search table |
available for users.to the users in the search results. |
Default search groups and tables
The following search groups and tables are configured out-of-the-box:
Expand |
---|
title | Agent interface search groups |
---|
|
- Tasks:
- Change Requests
- Change Tasks
- Incidents
- Incident Tasks
- User Queries
- Service Requests
- Requests Tasks
- Problems
- Problem Tasks
- People & Companies:
- CMDB:
- Configuration:
- Business Rules
- Client Scripts
- UI Actions
- ACL
- Includes Scripts
- Notification Rules
- Dynamic Filters
- Scripted Related Lists
- Widgets
- Property
- Knowledge Base:
|
Expand |
---|
title | Self-service portal search group |
---|
|
|
The Search Indices (sys_search_index) table contains every value text values of the indexed columns indexed that are automatically added to the table after the search tables records creation. The search is performed through these search indices.. 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.
Note |
---|
You cannot create, edit, or delete records in the Search Indices |
Note |
---|
Only users with the admin role can read the Search Index (sys_search_index) table records. Only users with the admin role can read them. |
To make index a table column indexed, follow complete the steps below:
- Navigate to System Definition → Settings → All Columns.
- Open the necessary Column record of your search table. Use filter options or the condition builder to find the recordFind the required column in the list and open it.
On the record form, select the Full Text Search checkbox.
Note |
---|
The Search Indexes only include records created after enabling the Full Text Search option of the table column. To index records created before the Full Text Search attribute was enabled, use the SimpleSearch server API methods.
|
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. |
Image Removed
Click Save or Save and Exitexit to apply the changes. The system automatically adds the field values of this table column to Search Indices when creating new table records.
Info |
---|
title | Reference column indexing |
---|
|
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: - Navigate to System Definition → All Columns.
- Open the necessary reference column whose values you need to use as search indices.
- On the record form, select the Display by Ref checkbox.
- Click Save or Save and Exit to apply the changes.
|
Search Index form
Field | Mandatory | Description |
---|
Record | N | An ID of the field indexed. |
Table | Y | The name of a table that has the indexed column. |
Column | Y | A name of an indexed column of the table specified in the Table field. |
Text | Y | A particular record field value. |
/
As a result:
- All existing records are indexed.
- All new records will be indexed when they are created.
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. |