The Configuration domain

Profile

The profile, or role that will be allowed to access global search functionality. Set the search scope for this profile using the Context field.

Context

The context defines which table(s) will be included when the chosen profile performs a global search.

Code

A unique identifier for the context. No whitespaces are allowed.

Custom title

Use this field to customize the context's title that will be displayed in the global search screen. If no custom title is defined, or several contexts are defined for a single profile, the title defaults to Search.

Data model

The data model on which the EBX Information Search Add-on options on this page apply. These settings apply to all tables based on this data model for which you enable search.

Sensitivity default value (%)

Fuzzy search gives a percentage level of the similarity between information and the search criterion. For example, the criterion Jone is considered 73% similar to John. The level from which the information will be considered a relevant search result must be configured carefully. If the sensitivity level is set too high, then some results could be missed. Conversely, if this level is too low then unwanted information could be retrieved.

This means that the sensitivity value must be tested to check that the results are relevant. You may need to adjust the default sensitivity level-on a case by case basis-depending on the nature of the information on which the search is applied (string, digit, short text, long description, languages, etc.) and the algorithms that are used for the fuzzy search (phonetics, distance).

By default the value of the sensitivity is set to 70%.

Data model

A reference to the data model configured in the Model table.

Table

A table in the data model. Once a table is configured it benefits from the EBX Information Search Add-on no matter its location in the datasets.

Results sorted by

Defines how the results are displayed:

• Scoring order: The result are displayed in order of descending score.

• Field order: The results are displayed in order of field configuration.

• Default value: Scoring order

Result line template

Defines how each result will be displayed. Up to five lines can be configured. At least one result line template must be configured.

Table

A table configured for EBX Information Search Add-on.

Field

A field in the configured table on which EBX Information Search Add-on executes.

Primary search algorithm

The primary algorithm used to execute a fuzzy search. Different algorithms are available to either enforce a phonetics search or a distance search. See the following recommendations:

• For name and first name: "Jarowinkler".

• For products titles, films names, etc.: "FuzzyFulText" with suitable configuration for the Similarity and Prefix length properties to get the best expected results.

• For postal code or similar conventions: "Levenshtein".

• For number: Search Number

• For date: Search Date

Secondary search algorithm

This algorithm executes after the primary algorithm and you can use it to manage records considered a false negative result by the primary algorithm. This works to ensure that no possible record has been missed.

Best word

A Best word search scores results based solely on how close a word matches the search criteria. It assigns each word a score and returns the word with the best score. This type of search works well when searching fields such as descriptions that contain many words. You can use this option with distance and phonetic algorithms. This option does not work for Search Number, Search Date algorithms.

For example, using the search criteria "lice" on a table's Name field could return a result of "Alice". The basic fuzzy search gives this field a high score because of the similarity between the search criteria and the information contained in the field. If the same search criteria is applied instead to search a descriptive field containing the text "A cartoon character named Alice", the search score would greatly decrease. This is because the percentage of similarity-or score-is computed using all of the words in the text.

If set to Yes: The search bases a word's score solely on matching against the criteria. Users can also enclose multiple search terms in double-quotes to force a search on the entire phrase.

If set to No or Undefined: The search bases a word's score on the percentage of similarity between the criteria and the data being searched.

Default value: No

Java class value filter

This property accepts a Java class to define values you want to exclude from a search operation. You can use the add-on's predefined class (com.orchestranetworks.addon.tese.SearchValueFilter), or create your own custom class. The predefined class gets values to filter from the Filtered value group table.

If you decide to create a custom class, include in the class the values to filter and be sure the class implements the SearchTextNormalize interface. The value filter depends on the record's fields.

Filtered value group

This property allows you to choose a group that contains values to exclude from the search. If you haven't created a group yet, use the Filtered value and Filtered value group to do so.

Note that this property only displays when you use the predefined com.orchestranetworks.addon.tese.SearchValueFilter class in the Java class value filter property.

Synonyms processing mode

Defines the processing mode for synonyms, you can select from the following options:

• Use synonyms for the entire value of the attribute: Apply synonyms on the entire value of the attribute.

• Use synonyms for every words of the attribute: Apply synonyms on every words of the attribute.

Check synonyms in all groups

If Yes: In addition to the configured group, all the groups with a parent relationship are used to look for the synonyms.

If No or Undefined: Records in different child groups cannot be matched with each other.

Default value: No

Value

A value to ignore when performing a search.

Group

The Filtered value group this value is assigned to.

Group

Name of the Filtered value group.

Code

A unique name without white spaces.

Label

Any naming convention without white spaces can be used to define this property.

Supported algorithm

The chosen algorithm from which you can customize its input parameters to create a new algorithm used to search.

Input parameters

A list of customized parameters. The available parameters depend on the corresponding Supported algorithm.

Code

Any naming convention except the prefix [ON] that is reserved for the synonyms provided by the add-on can be used.

Name

The name of the synonym.

Code

Any naming convention except the prefix [ON] that is reserved for the synonyms provided by the add-on can be used.

Name

The name of the synonym group. The Synonym by group data hierarchy view on the Synonym table is used to attach the synonyms to a group.

Parent group

Groups of synonyms can be arranged through a relationship hierarchy. When you use a synonym group to search a field, you can specify that the add-on looks for synonyms through these relationships.

Synonym group

A record of the Synonym group table.

Synonym

A record of the Synonym table.