Versions Compared

Old Version 64

changes.mady.by.user Dina Baksheeva

Saved on

compared with

New Version 65

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "DOC0000374" into parent

Global Search allows searching you to search 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 is performed through the Search Table included, they are checked by the <![CDATA[ACL Rules, and then through the Search Indices. Thus, 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
titleTo index table columns, follow the steps below:

To index table columns, follow the steps below:

  1. Create a <![CDATA[Search Group.
  2. Create a <![CDATA[Search Table.

  3. Configure Configure <![CDATA[Search Indices.

Info

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


Create a Search Group
Anchor
search group
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 changes.

Search Group form

FieldMandatoryDescription
NameYEnter the name of the grouping category for the search results.
PortalN

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

Info

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

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 results groups are displayed.

The groups are displayed in ascending order.

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

Set this checkbox active to disclose the group, so that the search results will be visible within the search navigator bar.


Default group configuration

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

Code Block
languagetext
themeEclipse
titleTable categorization in agent interface
<![CDATA[= 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

Your search request is processed against these tables, and the results may look as shown in the screenshot in the table above.

Code Block
languagetext
themeEclipse
titleTable categorization on portal
<![CDATA[= Task
= Knowledge Base

Create a Text Search Table
Anchor
search table
search table

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

The system property search_text_service.excluded_tables allows specifying you to specify tables that do not appear as options when setting up the Search tables.

Info

The search query passes the <![CDATA[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 changes.

Text Search Table form

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

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

Search GroupgroupY

Assign the group to the table that will be responsible for displaying the search results.

Click on the magnifier icon  and select a search group.

Displayed fieldsN

Choose the table fields to display in search results if the values in those fields matches the search queries.

Info

If you do not specify any fields, fields with the active Full Text Search attribute and that contain the search query will be shown in search results by default.


Subinfo fieldsNChoose the table fields that will always be displayed in search results.
FilterNUse the Condition Builder to limit and sort the search results.
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 ascending order.

ActiveN

Set this checkbox active to make the search table available and visible to users.

Configure Search Indices
Anchor
search indices
search indices

The Search Indices table contains every value of the columns indexed that are automatically added to the table after the search table record creation. The search is performed through these search indices.

Note

You cannot create, edit, or delete records in the Search Indices (sys_search_index) table. Only users with the admin role can read them.

To get the 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.

    Note

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

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

  1. Use the instructions 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 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 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.

/

Table of Contents
absoluteUrltrue
classfixedPosition
printablefalse


Panel