Search Indexes: General Information
Within MYOB Acumatica, users can perform searches in Help topics, wikis, and various entities, such as vendors, customers, invoices, and contracts. To make the process quick and accurate, MYOB Acumatica uses semantic search and search indexes.
Learning Objectives
In this chapter, you will learn how to build search indexes.
Applicable Scenarios
You need to rebuild the search indexes in the following cases:
- You have received complaints from the users of the system on the quality of search results. You rebuild the search indexes as the first step of the process of investigating the reported issue.
- You have upgraded your MYOB Acumatica system from a version that did not include the search indexes.
Semantic Search in MYOB Acumatica
MYOB Acumatica uses semantic search through SQL databases, which gives the system the ability to identify the key phrases in text or documents, discover similar or related documents, and provide information to explain how documents are similar or related.
To employ semantic search in your MYOB Acumatica instance, make sure that semantic search functionality is enabled, which depends on your SQL server as follows:
- In Microsoft SQL Server, the semantic search functionality is disabled by default. Enable the functionality, as described in Enabling Semantic Search for Microsoft SQL Server in MYOB Acumatica Installation Guide.
- In MySQL Server, the semantic search functionality is enabled by default.
Search Indexes
The search indexes are used to accelerate searching in MYOB Acumatica. When users perform day-to-day operations, such as adding new documents or updating customer accounts, new information is added to the appropriate search indexes automatically.
The list of indexed entities, excluding the wikis, is available on the Rebuild Full-Text Entity Index (SM209500) form. By using this form, you can rebuild selected search indexes or all of them at once.
The indexing of the data may take some time. In the Processing dialog box, the green check mark appears for the indexes after their successful creation. The red check mark appears for the indexes that could not be built.
Recreation of Search Indexes
If the system has failed to rebuild some search indexes, you can recreate all the indexes. On the More menu of the Rebuild Full-Text Entity Index (SM209500) form, you click Clear All Indexes to remove all the indexes. Then on the form toolbar, you click Process All to build all the indexes anew.
Wiki Search Indexes
The built-in Help wikis are indexed automatically. The wikis created in your system are not indexed automatically; you need to build indexes for such wikis manually. On the More menu of the Rebuild Full-Text Entity Index (SM209500) form, you click Index Custom Articles to initiate indexing of your custom articles. Wiki search indexes are not displayed on the Rebuild Full-Text Entity Index form.
Known Limitations to Search Queries
The system performs a full-text search for the queries that contain words whose length is two or more characters.
A semantic search does not find related entities if the search query includes word breakers, such as AND or FOR.
For example, suppose that you want to find related entities by using a description as a search query. If the description includes at least one word breaker, the search returns no results.
Restart of the Full-Text Engine
The full-text search functionality could unexpectedly stop working after an upgrade, snapshot restoration, or unsuccessful attempt to copy a company because the full-text search feature became disabled on a database server.
The system detects that the Full-Text Search feature is disabled on the server and shows a warning message to a user after a global search attempt. You can restart the engine by clicking Restart Full-Text Search on the More menu of the Rebuild Full-Text Entity Index (SM209500) form.
Configuration of a Search Condition
You can control which condition the system uses by default for the searches performed with the search box in tables. You select a condition in the Search Condition box on the Site Preferences (SM200505) form. The following options are available:
- Contains (default): The system converts the Contains condition to the
LIKE '%X%'
inquiry in MS SQL; the search may take some time and cause performance issues. This option is offered to preserve backward compatibility. - Starts With: The Starts With condition (
LIKE 'X%'
in MS SQL) works more quickly when a user is searching for a record in a table.
If the Starts With option is selected, the system uses this condition by default for these searches. If a search returns no results, the system notifies the user and provides a link that the user can click to perform the search with the Contains condition instead; see the following screenshot.