IHS server settings

#IHS Cache

Information and details on the function of the IHS server can be found under Determining receivers in MS/OS-IHS.

The IHS server enables a quick search for persons / logistics units and cost units based on search terms (tokens).

ATTENTION:

The blacklist and all other settings apply system-wide for all computers!
The blacklist and all other settings are NOT saved automatically when the tab is exited!
They must be saved explicitly via the Save button.

Settings tab

101: Additional separators for search terms
Default: <empty>
Enter additional characters here for separating text into individual keywords, e.g. "-" (hyphen/minus). Spaces, tabs and line breaks (CR) are predefined as standard separators.
102: Special additional separators for personal names (double names)
Default: "-"
In addition to the separators entered in the "Additional separators for search terms" setting, personal names are also split using the separators entered here.
This setting is used to find people with double names (e.g. "Meier-Müller") with only one of the two words. These separators are only used for personal names, not for other attributes. This means that names of logistics units, for example, are not separated.
103: Character for concatenation of search terms
Default: "+"
Define a character here for concatenating several individual search terms. For example, the search term "Von+Arx" is used to search for the keyword "Von Arx" as a whole.
104: Character for exact match of a search term
Default: "/"
Defines a special character that can be used at the end of a search token. This ensures that a token must match the keywordexactly. For example, the token "Meier/" will not find the keyword "Meierhans".
105: Wildcard (joker character)
Default: "*"
Defines the special character that is used for the search with wildcard(s). Must contain no or exactly one character.
If no character is defined (empty), a "normal" search is performed even if the wildcard character is entered.
201: Display search results as
Default: Separate lists
- Complete list
  For each entity type (person, logistics unit, cost unit), all hits that reach at least the value set under "Minimal full score [%]" for the highest full score per entity type are displayed.
  The overall hit list is sorted by full score regardless of the entity type.
- Separate lists (default)
  In principle, the overall result consists of 1/3 persons, 1/3 logistics units and 1/3 cost units. However, only those hits are included per entity type that reach at least the value of the highest full score per entity type set under "Minimal full score [%]". If this does not achieve an even distribution, the results list is filled with further results from the other entity types.
  The overall hit list is sorted by full score regardless of the entity type.
202: Sorting of results with identical full score
Default: Person name/first name
Defines the order/sorting for the display/output of equivalent search results (identical full score)
- None
  Equivalent search results are not sorted
- Person number
  Equivalent search results are sorted alphabetically in ascending order by person number
- Person name/first name (default)
  Equivalent search results are sorted alphabetically in ascending order by surname and first name
- Logistics unit
  Equivalent search results are sorted alphabetically in ascending order according to the name of the logistics unit
301: Minimum score for hits (relative to the highest weighting) [%]
Default: 50%
For each entity found (person, logistics unit, cost unit), the sum of the scores of the individual hits must exceed this threshold in order to be included in the hit list.
This value is relative to the highest defined weighting. Example: With a setting of 50 and a highest weighting of 50, the sum of the scores must be >= 25.
302: Minimum full score [%]
Default: 70%
Defines the minimum value in percent that a search result must achieve relative to the highest full score in order to be displayed in the results list.
The setting is applied per entity type (person, logistics unit, cost unit). See also setting "Display search results as:".
The higher this value is, the fewer search results are displayed.
303: Devaluation factor for indirect hits [%] (0 = full weighting/no devaluation)
Default = 0%, permitted range = 0..100.
Indirect hits are devalued with this factor.
Double indirect hits are devalued quadratically.
Indirect hits are hits that do not apply directly to the entity found, but indirectly (e.g. if a person is found via the name of the assigned logistics unit or cost center).
304: Devaluation factor for persons on incorrect address line [%] (100 = complete devaluation)
Default = 100%, permitted range = 0..100.
Only used in OCR mode. Found person keywords that are not contained in the detected person lines are devalued with this factor.
305: Use address keywords of logistics units for indirect hits
Default: No (switched off)
Defines whether logistics units found via address keywords are also used for indirect hits.
Indirect hits are hits that do not apply directly to the entity found, but indirectly (person or customer/cost center via assigned logistics unit).
401: Timeout for search [ms] (0 = no timeout)
Default: 0
Defines the maximum time a search in the IHS server may take [ms]. If no hits are found within the specified time, the search result is empty.

501: Exponent for full score calculation [0..1]
Default: 0.1
Defines the exponent used for the full score calculation, value range [0.0 ... 1.0].
The setting cannot be edited by default, please contact CodX Support.

If the sum of the individual scores is identical, the setting causes a higher weighting of a few long search tokens.
With exponent = 0, only the sum of the individual scores is taken into account.

Formulas for calculation:
a) Quality factor = (sum of length of search tokens / number of keywords) ^ exponent
b) Full score = sum of individual scores * quality factor
Examples:

Total individual score	Number of keywords	Total length of search token	Exponent	Quality factor	Full score
100	1	5	0.1	1.17	117.46
100	1	10	0.1	1.26	125.89
100	1	20	0.1	1.35	134.93
100	2	5	0.1	1.10	109.60
100	2	10	0.1	1.17	117.46
100	2	20	0.1	1.26	125.89
100	3	5	0.1	1.05	105.24
100	3	10	0.1	1.13	112.79
100	3	20	0.1	1.21	120.89

Displays the list of all defined blackwords. Blackwords are filtered out of the search terms (tokens) entered and are not used for the search in the IHS cache. Enter terms here that do not contribute to the correct identification of persons / logistics units / cost units, e.g. company names, salutations, place names, etc. The individual blackwords can be edited directly in the list.

Threshold value [%] column:
The column defines the threshold value (as a percentage) for recognizing a search term (token) as a blackword. If, when comparing a token with the blackword, they match at least this value, the token is identified as a blackword. Permitted values are in the range 50% to 100%. A value of 100% means that the token and blackword must match exactly.

Add
Adds an empty line to the end of the list.
Delete
Deletes a blackword from the list. To do this, select a line with a mouse click (highlighted in blue).

Displays the dialog for defining the keyword weighting. The weighting is defined per keyword group.
Keywords found are multiplied by the weighting defined here to calculate the overall score. A weighting of 0 means that a keyword is not used.

Minimum keyword length tab

Displays the dialog for defining the minimum keyword length. The minimum required length of keywords is defined per keyword group. Only keywords that have at least the length defined here are included in the IHS cache.

Displays the dialog for defining the error tolerance.
The error tolerance defines a tolerance value (in percent) per keyword group.
The higher this value is, the more errors a search token may have when compared with the keywords in order to be considered a hit (similarity search). Reduce this value if too many "false" hits are displayed in the search result.
Valid values: 0..90 [%], default value: 50 [%].

Save button

Saves the current settings. ATTENTION: The settings areNOT automatically saved when you exit the tab!