An administrator can configure the location of the full-text search index and related settings. Start and pause the crawler and even delete and reindex the entire system if necessary. The Audit Log captures both the searches performed by users and any activities like reindexing.
Full-Text Search Configuration
The Full-Text Search Configuration page allows you to configure the index and review statistics about your index.
- Go to (Admin) > Site > Admin Console.
- In the Management section, click Full-text search.
- Set Path. You can change the directory that stores the index (default: <tomcat>/temp/labkey_full_text_index) by entering a new path and clicking the Set Path button.
- Changing the location of the index requires re-indexing all data, which may affect performance.
- Resetting the path of the index is especially useful if you are running multiple LabKey deployments on the same Tomcat instance, because it allows each LabKey deployment to use a unique index.
- Be sure to place your labkey_full_text_search index on a drive with sufficient space.
- Start/Pause Crawler. The crawler, or document indexer, continually inventories your site when running. You might pause it to diagnose issues with memory or performance.
- Delete Index. You can delete the entire index for your server. Please do this with caution because rebuilding the index can be slow.
- Directory Type. This setting lets you can change the search indexing directory type. The setting marked "Default (MMapDirectory)" allows the underlying search library to choose the directory implementation (based on operating system and 32-bit vs. 64-bit). The other options override the default heuristic and hard-code a specific directory implementation. These are provided in case the "Default" setting causes problems on a specific deployment. Use the default type unless you see a problem with search. Contact LabKey for assistance if full-text indexing or searching seems to have difficulty with the default setting.
- Indexed File Size Limit: The default setting is 100 MB. Files larger than the limit set on this page will not be indexed. You can change this cap, but this is generally not recommended. Increasing it will result in additional memory usage; if you increase beyond 100MB, we recommend you also increase your heap size to be 4GB or larger. The size of xlsx files is limited to 1/5 the total file size limit set (i.e. defaults to 20MB).
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:
- Go to (Admin) > Site > Admin Console.
- In the Management section, click Audit Log.
- Choose the Search option in the pulldown menu.
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.
Setup Folder-Specific Search Boxes
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.
Set SubFolder Searching
Administrators can specify whether a search box searches just the current container or the current container and its sub-containers by default.
(triangle) menu in the Search web part. Check the box to "Search subfolders".
Searching List and External Schema Metadata
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 turn off indexing of List metadata by unchecking the checkbox Index list meta data
when creating or editing a list definition.
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. For details see External Schemas and Data Sources
Include/Exclude a Folder from Search
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.
To exclude the contents of a folder from searches:
- Navigate to the folder and select (Admin) > Folder > Management.
- Click the Search tab.
- Uncheck the checkbox Include this folder's contents in multi-folder search results.
- Click Save.
Searches that originate from that folder will still include its contents in the results, but searches from any other folder will not.
Exclude a File System Directory from Search
LabKey Server automatically indexes the file system directories associated with projects and folders. It will ignore the contents of directories named ".svn" and ".Trash". 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.