Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

panelTo index table columns, follow
Tip

Role required: admin.

title

To configure global search in the agent interface, complete the steps below:

  1. Create a
Search Group
  1. search group.
  2. Create
a Search Table
  1. search table.
Configure Search Indices
  1. Configure search indices.

InfoYou can also configure the portal search to

To configure global search on the self-service

portal users with the Search Groups settings

portal, complete the same steps, but select the required portal in the Portal field of the Text search group form.

Note

If there

is

are no

record

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:

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

Search Group form Text search group form fields

FieldMandatoryDescription
NameY
Enter
Specify the name of the group
category for
displayed in the search results panel.
PortalN
To

Select a portal to make the search group available

for the self-service portalusers, click the magnifier icon Image Removed and select the necessary portal from the list. Info

to its users. The search group

is

will only

available for end-users or SimpleOne agents.

be available on the selected Portal. To make the search

group agents-only

group available in the agent interface, leave this field empty.

OrderN

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.

DescriptionN
Type brief or detailed information about
Add a description of the search group.
ActiveNSelect this checkbox to make the group available and visible
for
to users in the search results panel.
Opened by defaultN

Select this checkbox to make the group

unveiled, so that, the search result table are visible within the search navigator bar.

Image Removed

Default group configuration

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

Code Block
languagetext
themeEclipse
titleTable 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
languagetext
themeEclipse
titleTable categorization on the portal
= Tasks: ITSM Tasks = Knowledge Base: Article

expanded by default in the search results panel.

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. 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 complete the steps below:

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

Text Search Table search table form fields

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

Select the source table

of

that contains data indexed for search.

Click the magnifier icon Image Removed and select a table.

Note

A text search table only includes the data from the source table, without its child tables. You need to create a separate text search table for each of them.


Search groupY

Select a search group in which the table

Search GroupYSpecify a group to the table in which the

search results will be displayed.

Click the magnifier icon Image Removed and select a search group
Displayed fieldsN

Select the table fields to display in the search results if the values in those fields match the search query.

Info

If this field is empty, all fields that match the search query and have the Full Text Search attribute enabled are displayed in the search results.


Subinfo fieldsNSelect the table fields that are always displayed in the search results.
FilterNUse the condition builder to filter and sort the search results.
OrderN

Enter

the

an integer

in the field

to

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

ascending order.

ActiveN

Select this checkbox to

make

activate the search table

available

and make it visible

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
titleAgent interface search groups
  • Tasks:
    • Change Requests
    • Change Tasks
    • Incidents
    • Incident Tasks
    • User Queries
    • Service Requests
    • Requests Tasks
    • Problems
    • Problem Tasks
  • People & Companies:
    • Employees
    • Companies
  • CMDB:
    • Configuration items
  • Configuration:
    • Business Rules
    • Client Scripts
    • UI Actions
    • ACL
    • Includes Scripts
    • Notification Rules
    • Dynamic Filters
    • Scripted Related Lists
    • Widgets
    • Property
  • Knowledge Base:
    • Articles


Expand
titleSelf-service portal search group
  • Self-Service Portal:
    • Tasks
    • Knowledge Base

Configure search indices


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:

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 record of the reference table column which values you need to use as search indices.
  • On the record form, select the Display by Ref checkbox
    1. Navigate to System Definition → Settings → All Columns.
    2. 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.
    3. 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.

      Image Removed
    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.
    Info
    titleReference column indexing
    1. 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.


    2. Click Save or Save and
    Exit
    1. exit to apply the changes
    .
    1. .

    As a result:

    • All existing records are indexed.
    • All new records will be indexed when they are created.

    Search Index form fieldsSearch Index form

    Field
    Mandatory
    Description
    Record
    NA field indexed
    The ID of the record that contains the indexed field.
    Table
    YThe name of a table that has the indexed columnColumnYThe name of an indexed column of the table specified in the Table field.TextYA particular record field value.
    /
    Reference to the table that contains the indexed column.
    ColumnReference to the indexed column of the Table.
    TextThe text value of the indexed field. It is automatically updated if the value of the indexed field changes.



    Table of Contents
    absoluteUrltrue
    classfixedPosition
    printablefalse

    Panel
  • Search Configuration
  • Search Text Service Properties
  • ACL