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.
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. |
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 |
|
Smart search
This hot topic 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/smartsearch
An example of the request body:
{ SmartAnalytics:{ in:'{keyword: "test", start:1, pagesize:2}', } }
Response example:
Note You can ignore the messages in the response as these messages are printed by the Restful framework.
{ "Messages": [ "Invalid syntax for query. Failed parsing", "in=\"1\"", "Invalid syntax for query. Failed parsing", "in=\"1\"" ], "ReturnCode": -1, "SmartAnalytics": { "in": "{keyword: \"test\", start:1, pagesize:2}", "out": "<autnresponse xmlns:autn=\"http://schemas.autonomy.com/aci/\"><action>QUERY</action><response>SUCCESS</response><responsedata>\n<autn:numhits>2</autn:numhits><autn:totalhits>18</autn:totalhits><autn:totaldbdocs>346</autn:totaldbdocs><autn:totaldbsecs>346</autn:totaldbsecs><autn:hit><autn:reference>scactivelink%3A%2F%2Fkmdocument%3Aid%3D%26quot%3BKM0580%26quot%3B%26nbsp%3Band%26nbsp%3Bkbname%3D%26quot%3BKnowledge_Library%26quot%3B</autn:reference><autn:id>1588</autn:id><autn:section>0</autn:section><autn:weight>57.09</autn:weight><autn:links>TEST</autn:links><autn:database>Knowledge_Library</autn:database><autn:title>test error message by Jora(Title)</autn:title><autn:summary><_em_>test</_em_> error message by Jora(Title). 2015/06/22 14:07:46. falcon. external. errormsg. <_em_>test</_em_> error message by Jora(Error Message). <_em_>test</_em_> error message by Jora(cause). <_em_>test</_em_> error message by Jora(Wordaround/Fix).</autn:summary><autn:content><DOCUMENT><KMSEARCHCATEGORY>KM01CAT:KM03CAT:KM05CAT</KMSEARCHCATEGORY><KMSTATUS>external</KMSTATUS><DOCTYPE>errormsg</DOCTYPE><ID>KM0580</ID><SYSMODTIME_DATE>2015/06/22 14:47:00</SYSMODTIME_DATE><CATEGORY>Service Manager>Knowledge Management>Document Maintenance and Lifecycle;</CATEGORY><DRETITLE>test error message by Jora(Title)</DRETITLE></DOCUMENT></autn:content></autn:hit><autn:hit><autn:reference>scactivelink%3A%2F%2Fkmdocument%3Aid%3D%26quot%3BKM0580%26quot%3B%26nbsp%3Band%26nbsp%3Bkbname%3D%26quot%3BKnowledge_Library%26quot%3B</autn:reference><autn:id>1588</autn:id><autn:section>0</autn:section><autn:weight>57.09</autn:weight><autn:links>TEST</autn:links><autn:database>Knowledge_Library</autn:database><autn:title>test error message by Jora(Title)</autn:title><autn:summary><_em_>test</_em_> error message by Jora(Title). 2015/06/22 14:07:46. falcon. external. errormsg. <_em_>test</_em_> error message by Jora(Error Message). <_em_>test</_em_> error message by Jora(cause). <_em_>test</_em_> error message by Jora(Wordaround/Fix).</autn:summary><autn:content><DOCUMENT><KMSEARCHCATEGORY>KM01CAT:KM03CAT:KM05CAT</KMSEARCHCATEGORY><KMSTATUS>external</KMSTATUS><DOCTYPE>errormsg</DOCTYPE><ID>KM0580</ID><SYSMODTIME_DATE>2015/06/22 14:47:00</SYSMODTIME_DATE><CATEGORY>Service Manager>Knowledge Management>Document Maintenance and Lifecycle;</CATEGORY><DRETITLE>test error message by Jora(Title)</DRETITLE></DOCUMENT></autn:content></autn:hit><autn:engines><autn:used>0</autn:used><autn:unused>1</autn:unused></autn:engines><autn:warning>Engine 0: Engine 0: At least one of the fields in a parameter (probably 'printfields') does not exist</autn:warning><autn:warning>Engine 0: Engine 0: One of the fields used in the field text does not exist</autn:warning><autn:warning>Engine 0: Engine 0: The languagetype of the text could not be determined. The default languagetype was used.</autn:warning><autn:warning>Engine 0: Engine 1: At least one of the fields in a parameter (probably 'printfields') does not exist</autn:warning><autn:warning>Engine 0: Engine 1: One of the fields used in the field text does not exist</autn:warning><autn:warning>Engine 0: Engine 1: The languagetype of the text could not be determined. The default languagetype was used.</autn:warning></responsedata></autnresponse>" } }