Role required: admin.


Search configuration guide


If the Text Search Group or the Text Search Table is not specified, the search is not performed.


To index table columns, follow the steps below:

  1. Create a Search Group.
  2. Create a Search Table.

  3. Configure Search Indices.

You can also configure the portal search to the self-service portal users with the Search Groups settings.


Create a text 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:

  1. Navigate to System Definition → Text Search Groups.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply the changes.

Search Group form fields

FieldMandatoryDescription
NameYEnter the name of a group category for the search results.
PortalN

To make the search group available for the self-service portal users, click the magnifier icon  and select the desired portal from the list.

The search group is only available for end-users or SimpleOne agents.

To make the search group agents-only, leave this field empty.


OrderN

Enter the integer number in the field to define the sequence in which the search result group is displayed.

The groups are displayed in ascending order.

DescriptionNA brief or detailed information about the search group.
ActiveNSet this checkbox active to make the group available and visible for users.
Opened by defaultN

Set this checkbox active to make the group unveiled, so that, the search results are visible within the search navigator bar.


Default group configuration

The out-of-the-box tables categorization is provided as listed below:

= 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 search request is processed against these tables, and the result may look as shown on the screenshot in the table above.

= Task
= Knowledge Base

Create a text search table

Search tables specify data sources for text search indexing. Within the groups, these tables also collect the search results, determining its categories. 

The system property search_text_service.excluded_tables allows you to specify tables not appeared as options when setting up the Search tables.

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:

  1. Navigate to System Definition → Text Search Tables.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply the changes.

Text Search Table form fields

FieldMandatoryDescription
NameYEnter the name of a table displayed in search results.
TableY

Specify a source table of data indexed for search. Click the magnifier icon  and select a table.

Search GroupY

Assign a group to the table for displaying the search results.

Click the magnifier icon  and select a search group.

OrderN

Enter the integer number in the field to define the sequence in which the search result tables are displayed.

The tables are displayed in the ascending order.

ActiveN

Set this checkbox active 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.

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:

  1. Navigate to System Definition → All Columns.
  2. Open the desired Column record of your search table. Use filter options or Condition Builder if you need to find it.

  3. On the record form, set the Full Text Search checkbox to the active state.

    The Search Indexes include only those records that were created after enabling the Full Text Search option of the table column.



  4. 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.


The 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 reference column indexed, follow the steps below:

  1. Use the instruction above to index the desired column of the search table.
  2. Navigate to System Definition → All Columns and open the record of the reference table column which values you want to use as search indices.
  3. On the record form, check the Display by Ref box.
  4. Click Save or Save and Exit to apply the changes.

To create a search index, follow the steps below:

  1. Navigate to System Definition → Search Indices.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply the changes.

Search Index form

FieldMandatoryDescription
RecordNA record containing the field indexed.
TableYA reference field containing the name of a table from sys_db_table the indexed column belongs to. 
ColumnYA reference field containing the name of an indexed column of the table specified in the Table field.
TextYA particular record field value.

/


Related articles