You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Role required: admin.

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 for the self-service portal users with the Search Groups settings.

If there are no 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 the steps below:

  1. Navigate to System Settings → 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 the group for the search results panel.
PortalN

Select a portal to make the search group available to its users. If this field is empty, the search group is available only in the agent interface.

OrderN

Enter an integer to set the relative position of the group in the search results panel. Groups are displayed in ascending order.

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

Select this checkbox to make the group expanded by default in the search results panel.

Default group configuration

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

Table categorization in the agent interface
= Tasks:
Change Request
Change Task
Incident
Incident Task
User Query
Service Request
Requests Task

= People & Companies:
Employee
Company

= CMDB:
Configuration item

= Configuration:
Business Rule
Client Script
UI Action
ACL
Script Include
Notification Rule
Dynamic Filter Option
Scripted Related List
Widget
System Property

= Knowledge Base:
Articles

The search requests are processed against these tables, and the results may look as shown on the screenshot below.

Table categorization on the portal
= Tasks:
ITSM Tasks

= Knowledge Base:
Article

Create a text search table

Search tables define data sources for text search indexing. Within groups, these tables also collect the search results, determining 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.


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 (sys_search_index) table.

To create a search table, complete 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 the table displayed in the search results.
TableY

Select a source table of data indexed for search.

The text search tables only include the data in the source table but not 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 will be displayed in the search results panel.

Displayed fieldsN

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

If this field is empty, all fields with the Full Text Search attribute enabled that match the search query will be shown in the search results.

Subinfo fieldsNSelect the table fields that will always be displayed in search results.
FilterNUse the condition builder to limit and sort the search results.
OrderN

Enter an integer to set the relative position of the table in the search group. The tables are displayed in ascending order.

ActiveN

Select this checkbox to make the search table available and visible for the users in the search results.

Configure search indices

The Search Indices (sys_search_index) table contains values of the indexed columns 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 Indices (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 necessary Column record of your search table. Use filter options or the condition builder to find the record.

  3. On the record form, select the Full Text Search checkbox.

    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.



  4. Click Save or Save and Exit to apply the changes. The system automatically adds the field values of this table column to Search Indices when creating new table records.


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:

  1. Navigate to System Definition → All Columns.
  2. Open the necessary reference column whose values you need to use as search indices.
  3. On the record form, select the Display by Ref checkbox.
  4. Click Save or Save and Exit to apply the changes.

Search Index form fields

FieldMandatoryDescription
RecordNThe ID of the record that contains the indexed field.
TableYReference to the table that contains the indexed column.
ColumnYReference to the indexed column of the Table.
TextYThe text value of the indexed field.

/

  • No labels

© 2019-2024, SimpleOne

https://simpleone.ru