This commit is contained in:
2022-01-30 18:03:23 +00:00
parent d2078d2adc
commit 0ab6e83da9
5 changed files with 241 additions and 37 deletions

View File

@@ -19,6 +19,12 @@ When a business object is saved the AyaNova server indexes text and other unique
In order for a word to be indexed for searching it must be 2 to 255 characters long and not be a "Stop word".
All text in the business object is indexed including Addresses, phone numbers, email and web addresses, Tags, Wiki and custom fields. The _contents_ of file Attachments are _not_ indexed for searching and can not be searched for, however the name and notes are indexed for searching. (Attachments can also be viewed in a central list of all attachments in the [administration attachments](adm-attachments.md))
#### Numbers
In some cases numbers are indexed but only if they are unique and directly useful for finding an object, for example Work order serial numbers or Unit meter readings. Currency values are _never_ indexed as they are not typically useful for searching, change often and would take a significant amount of database space to index them all.
### Stop words
Stop words are words that are so common in each language that there is little point in indexing them for search purposes as they are not useful for uniquely identifying records. For example, in English some common stop words are `so` `to` `the` `be` `else` `did` `than` `that` `of` `only`.
@@ -27,28 +33,48 @@ AyaNova keeps a list of the most common stop words for each provided [Translatio
While we do not recommend it except in specific exceptional circumstances, it is possible to view the list of stop words and even add your own or remove any that need to be indexed for your business by examining and editing the "StopWords\*" keys in the translation form for the translations in use by your users.
### Searching
### Searching
#### Seach phrase
To search for a word or phrase enter terms into the `Search` text input control.
#### Seach terms
A search phrase can be
To search for a word or phrase enter one or more search terms into the `Search` text input control.
#### Case sensitivity
Search terms are one or more words separated by spaces. Each search term word must be 2 to 255 characters in length. Shorter or longer words will be ignored.
A search phrase can be entire words to match exactly or wildcard terms.
##### Wildcard terms
The `*` asterisk wildcard character can be used in a search term to search for words that begin with, end with or contain a portion of a word.
Begins with searches look like this `mon*` which would match "monday", "Montana", "mongoose" etc.
Ends with searches look like this `*ay` which would match with "sunday", "tray", "spray" etc.
Contains searches look like this `*oul*` which would match with "would", "boulder", "outlook", "soul" etc. (Note that contains can match starts and ends as well as contained within words)
You can use multiple wildcard terms and mix and match with non-wildcard terms so, for example this is a valid search phrase: `*att* rain blue *spa ors*`.
##### Inclusive "AND" results only
Imagine search terms have the word AND between them so searching for "flush drain deburr" is the equivalent of asking for records that contain _all_ the words "flush AND drain AND deburr" somewhere in them (they don't have to be in consecutive order or even in the same field of the business object to match).
Only results that contain _all_ the search terms entered will be matched and returned so if you search for "unit wire blue" a record that contains unit and wire but not blue will not be returned.
##### Case sensitivity
By default AyaNova search is case **in**-sensitive. Case insensitive searching is influenced by the [server locale settings](ops-server-locale.md)
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
##### All fields are combined
Explain search phrase entry, stopwords etc
When indexing and searching _all_ fields are searched at the same time so, for example you can enter the search phrase "Awesome possum" and it will match to a Customer with the Name "Amy's Awesome pets" and the Notes "mind the possum" even though the entire search phrase is not in the same field.
Searches are contains by default, case insensitive always.
Wildcards are supported for start and end of words but no point in doing both ends for contains as that is the default
multiple space seperated phrases are supported and are always inclusive (AND), i.e. "cotton fish" finds only records with both cotton and fish in them
#### Object filter
All text on object is search indexed including tags.
In cases where there is a identifying number on an object such as an ID or serial number that is also indexed for search, however currency amounts are not indexed
The `Object` select list can be used to only search for an exact type of object. When you come to the Search form via the Search menu option in a specific AyaNova object, the `Object` select list is automatically set to the type of object you came from.
To save bandwidth excerpts are not automatically retrieved but only on demand when user requests for a search result
You can change this to any type of object by selecting the `-` or no selection option.
There is no facility or setting to search case sensitive, it's just not an option with text indexing we have and differs from picklist which does have a server setting to control that.
### Results list
The search results list contains the records that were found to match the search phrase.
They are grouped by type of object and list the object name which is a hyperlink to open that object and an information (i) icon which when clicked on will retrieve a short excerpt including the best matching text of the record so you can see if it's the one you want without opening it.