Versions Compared

Old Version 56

changes.mady.by.user Anna Kryzhanovskaya

Saved on

compared with

New Version 57

changes.mady.by.user Anna Kryzhanovskaya

Saved on

Key

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

Global Search allows searching 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 performs through the Search Table included, they are checked by the ACL Rules, and then through the Search Indices. Thus, the query processing and the result outputting is 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 Search Group.
  2. Create a Search Table.

  3. Configure Search Indices.

Info

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



Create a 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.
  3. Fill in the fields.
  4. Click Save or Save and Exit to apply changes.

The Search Group form

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

To make the search group available for self-service portal users, click the magnifier icon Image Modified in the field, 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 displayed.

The groups are displayed in the ascending order.

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

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

E.g., the Task search group below has the inactive Default opened checkbox Opened by dafault checkbox.

Image Modified


Create a 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 property search_text_service.excluded_tables allows to specify tables not appeared as options when setting up the Search tables.

Info

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 To create a search table, follow the steps below:

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

The Search Table form

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 Image Modified and select a table.

Search GroupY

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

Click the magnifier icon Image Modified and select a search group.

OrderN

Enter the integer number in the field to define the sequence in which the search results tables 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.

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.

    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

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


To create a search indice, follow the steps below:

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

The Search Indice 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
maxLevel3
classfixedPosition