The Full-Text Search Configuration page allows you to configure the index and review statistics about your index.
Index Configuration
This section provides information on the information that has been indexed by the system, plus identifies the limits that have been set for the indexer by the LabKey team. These limits enhance performance. For example, you will see the "Maximum Size" of files that will be scanned by the indexer; the maximum size allows the system to avoid indexing exceptionally large files.
Search Statistics
Lists the average time in milliseconds for each phase of searching the index, from creating the query to processing hits.
To see the search audit log:
This displays the log of audited search events for your system. For example, you can see the terms entered by users in the search box. If someone has deleted your search index, this event will be displayed in the list, along with information on the user who ordered the delete.
By default, a site-wide search box is included on the top right side of every page of your LabKey Server site. You can add additional, scoped search boxes to individual projects or folders.
Add Search Web Part. To add a search box that searches only a particular container, enter > Page Admin Mode and add the Search web part to a project or folder. For an example of a search box applied to a particular container, use the search box to the right of this page you are reading. It will search only the current folder.
Administrators can specify whether a search box searches just the current container or the current container and its sub-containers by default.
Select Customize from the (triangle) menu in the Search web part. Check the box to "Search subfolders".
By default, the search index includes metadata for lists and external schemas (including table names, table descriptions, column names, column labels, and column descriptions).
You can control indexing of List metadata when creating or editing a list definition under Advanced List Settings > Search Indexing Options. Learn more here: Edit a List Design
You can turn off indexing of external schema metadata by unchecking the checkbox Index Schema Meta Data when creating or editing an external schema definition. Learn more here: External Schemas and Data Sources
You may want to exclude the contents of certain folders from searches. For example, you may not want archived folders or work in progress to appear in search results.
Searches that originate from that folder will still include its contents in the results, but searches from any other folder will not.
LabKey Server automatically indexes the file system directories associated with projects and folders. It will ignore the contents of directories named ".Trash", for example. To tell the server to not index the content of a directory, you can add a file named ".nocrawl". The content of the file does not matter, an empty text file is sufficient.
When the search index cannot be found or properly initialized, you may see an error similar to "ERROR LuceneSearchServiceImpl <DATE> Module Upgrade : Error: Unable to initialize search index. Search will be disabled and new documents will not be indexed for searching until this is corrected and the server is restarted." A path to the .tip file will be included in the error text.
Options for resolving this include:
If you experience Tomcat threads hanging during search operation, check to ensure that your search index is NOT on an NFS filesystem or on AWS EFS. These filesystems should never be used for a full-text search index.