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 |
|
Search
This search RESTful API is used to get the search results suggested by Smart Analytics.
Request:
POST http://<SM Server Address>:13080/SM/9/rest/SmartAnalytics/1/action/search
An example of the request body:
{
SmartAnalytics:{
query:'mobile',
start:1,
count:100,
filters:'{"Knowledge_Library":{"status":["external","internal"],"doctype":["howto"]},"Incident_Library":{}}',
max_characters:500,
startTag: '<_em_>',
endTag: '</_em_>'
}
}
Response example:
Note You can ignore the messages in the response as these messages are printed by the Restful framework.
{
"@count": 2,
"@start": "1",
"Messages": [],
"ResourceName": "SmartAnalytics",
"ReturnCode": 0,
"content": [
{"SmartAnalytics": {
"content": "ADJUST THE TIME AFTER WHICH <em>MOBILE<\/em> ENTERS THE SLEEP MODE. howto. How to adjust the time after which <em>mobile<\/em> enters the sleep mode in Android 4.2.2 Operating System.. To adjust the time after which <em>mobile<\/em>",
"id": "KM0122",
"title": "ADJUST THE TIME AFTER WHICH MOBILE ENTERS THE SLEEP MODE"
}},
{"SmartAnalytics": {
"content": "Email receiving error when using <em>mobile<\/em> phone as email client.. Email receiving error when using <em>mobile<\/em> phone as email client.. report error about 'connection fail' when attempt to connect to mail server..",
"id": "IM10012",
"title": "Email receiving error when using mobile phone as email client."
}}
]
}
