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 |
|
Clean up search history
After a period of time, you may want to clean up the end user search history in IDOL and remove certain search terms. To do so, follow these steps:
-
Run the following command to export the search history data from IDOL:
java -jar lib/search.jar exportSearchHistory ./search.yml <path> <start> <max results>This command consists of the following parameters:
path: Path and name of the exported *.json file. This parameter is required.start: The first result to be exported from the entire list. The default value is 1. This parameter is optional.max results: The maximum number of results to export from the entire list. The default value is 1000000. This parameter is optional.
For example,
java -jar lib/search.jar exportSearchHistory ./search.yml ./test.json. -
Run the following command to remove certain search terms from the exported file:
java -jar lib/search.jar removeSearchHistory ./search.yml <search detail ids>In this command,
<search detail ids>refers to the search history text IDs to be removed. You can split multiple text IDs by commas. This parameter is required.For example,
java -jar lib/search.jar removeSearchHistory ./search.yml History_CONSUMER_lync,History_CONSUMER_managem.To remove all search terms and clear the search history, run the following command:
java -jar lib/search.jar idol ./search.yml cleardb SearchHistory -
Run the following command to import the updated search history data to IDOL again:
java -jar lib/search.jar importSearchHistory ./search.yml ./test.json
