Search Engine Configuration Utility
The Search Engine Configuration Utility must be run on the same computer on which the Laserfiche Full-Text Indexing and Search Service was installed.
To use the Laserfiche Search Engine Configuration Utility
- In Windows, navigate to the Laserfiche Full-Text Indexing and Search Service installation folder. By default, this folder is C:\Program Files\Laserfiche\LFFTS.
- Double-click the lfftscfg.exe file. This will launch the Search Engine Configuration Utility.
- Type one of the listed commands and press ENTER. (Refer to the commands, listed below, for available commands.)
The following table contains the commands available in the Search Engine Configuration Utility.
| Argument | Description |
| mem port limit | Sets a memory usage limit for the search engine. Limit is the maximum size, in bytes, of the computer's memory that can be used by the Laserfiche Search Engine. If the port is not specified, 5053 will be used. See "Setting a Memory Usage Limit," below, for more information. |
| showmem port | Displays the current memory usage for the search index files. If the port is not specified, 5053 will be used. |
| showfrag port | Displays the current fragmentation percentages of the search index files. If the port is not specified, 5053 will be used. |
| optimize port | Performs optimization on the search catalog to defragment the search index files. If the port is not specified, 5053 will be used. |
| threads port | Shows the current status of the search engine threads. If the port is not specified, 5053 will be used. |
| list port | Shows the list of all catalogs attached to the search engine. If the port is not specified, 5053 will be used. |
| detach port catalog | Detaches the catalog from the repository. In most cases, the catalog name will match the name of the repository to which it is attached. If the port is not specified, 5053 will be used. |
| delete port catalog | Permanently deletes the catalog from the repository. In most cases, the catalog name will match the name of the repository to which it is attached. If the port is not specified, 5053 will be used. |
| setthesaurus port catalog thesauruspath | Sets the thesaurus for the repository to the thesaurus XML file specified in the thesauruspath attribute. See Customizing the Search Thesaurus XML for more information. In most cases, the catalog name will match the name of the repository to which it is attached. If the port is not specified, 5053 will be used. |
| getthesaurus port catalog | Retrieves the thesaurus for the repository. In most cases, the catalog name will match the name of the repository to which it is attached. If the port is not specified, 5053 will be used. |
| quit | Exits the utility. |
| help | Displays the help for the utility. |
Note: The --secure switch can be used to specify whether the search engine should use a secure (HTTPS) connection instead of an unsecure (HTTP) connection to communicate. Valid values are yes (to use HTTPS) and no (to use HTTP). If the switch is not used, the default is no. This switch can be used with any of the above commands, except "quit" and "help." For example, detach 5053 MyRepository --secure yes would detach the catalog "MyRepository" communicating over port 5053, using HTTPS. The Search Engine must be configured to accept secure connections if you want to use this switch.
Setting a Memory Usage Limit
You can use the Search Engine Configuration Utility to cap memory usage, restricting the amount of memory the Laserfiche Full-Text Indexing and Search engine can use on the computer on which it is installed.
By default, the memory cap will be set to 0, which has the following effects:
- If the Search service detects that the Laserfiche Server service is installed when it starts up, one quarter of the computer's memory (up to 3GB) will be reserved for the Server, and the Search Engine will be able to use the remainder.
- If the Search service does not detect that the Laserfiche Server service is installed when it starts up, the Search Engine will be able to use all memory on the computer.
We recommend using these default settings if the Laserfiche Search service has a dedicated computer, or if it is sharing the same computer with the Laserfiche Server but will always start after the Laserfiche Server.
If the Laserfiche Search service will start before the Laserfiche Server, we recommend capping the Search service's memory to half the available memory of the computer, to ensure that the Server will have sufficient memory to run.
If the machine is not dedicated to the Laserfiche Full-Text Indexing and Search Service, you may need to cap memory if you encounter performance issues with your other applications, or if recommended by Support.