Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
Start and Stop the Solr Search Engine
You can start and stop the Solr Search Engine by using the command line scripts or through a Windows Service.
Security best practices
Since the Search Engine uses Tomcat as the web server, be sure to follow the following best practices (see also the Apache documentation for information on Tomcat security best practices).
- On Windows operating systems, you need to create a user account that has been granted the Log on as a service right and has Full Control permissions to the search engine installation directory. Further, make sure the KM Search Engine - Master or KM Search Engine - Slave service is set to run as this user.
- On Unix systems, follow these steps:
- Install the Search Engine as root.
- Create a user to run the Search Engine. Suppose the user is SearchEngineUser.
Run the following command to change the owner of the Search Engine installation directory:
sudo chown -R SearchEngineUser Search_Engine_install_directory
Run the following command to start the Search Engine:
sudo -u SearchEngineUser Search_Engine_install_directory/startup.sh
Start and stop the Search Engine using scripts
Run the following executable scripts in the Solr Search Engine installation folder to start and stop the Search Engine.
| Name | Purpose |
|---|---|
| startup.cmd |
Starts the master Solr Search Engine server on a Windows system. Starts the KMCrawler that has been installed separately. |
| startup.cmd slave | Starts the slave Solr Search Engine server on a Windows system. |
| startup.sh | Starts the master Solr Search Engine server on a UNIX system. |
| startup.sh slave | Starts the slave Solr Search Engine server on a UNIX system. |
| Name | Purpose |
|---|---|
| shutdown.cmd |
|
| shutdown.cmd slave | Shuts down the slave Solr Search Engine server on a Windows system. |
| shutdown.sh |
|
| shutdown.sh slave | Shuts down the slave Solr Search Engine server on a UNIX system. |
Start and stop the Search Engine as a Windows service
You can register and install the Search Engine as a Windows service, and then start and stop the Solr Search Engine as a Windows service.
Register and install the Search engine as a Windows service
Run the following scripts to register the Solr Search Engine as a Windows service. Once the Solr Search Engine is registered as a Windows service, then you can use startup and shutdown scripts through the Windows service. The name of the Windows service in the Windows console is: KM Search Engine.
The following table lists the registration scripts for Windows systems.
| Name | Purpose |
|---|---|
| installasservice.cmd install master |
Installs the master Solr Search Engine server as a Windows Service.
|
| Installasservice.cmd install slave <identifier> | Installs the slave server as a Windows Service. |
| installasservice.cmd install |
Installs the KMCrawler as a Windows Service when the KMCrawler has been installed separately.
|
| installasservice.cmd remove master | Removes the master Windows Service. |
| installasservice.cmd remove slave <identifier> | Removes the slave Windows Service. |
| installasservice.cmd remove | Removes the KMCrawler Windows Service. |
Start and stop the Solr Search Engine as a Windows Service
- From the Windows Start menu, select Control Panel > Administrative Tools > Services.
- Select the service that you want to start, for example: KM Search Engine - Master, KM Search Engine - Slave <identifier>, or KM Search Engine - Crawler.
- To start the service, right-click the service and select Start.
- To stop the service, right-click the service and select Stop.
Once you have installed and started your search engine instances, you are ready to configure them and verify their connectivity in Knowledge Management. For more information, see Configuring Search Servers.
Related topics
