To make a value search query, use a ValueSearchConfig type, specifying a SearchTerm element and, optionally, the attributes within which you would like to search.
ValueSearchConfig is a type of ContentElementConfig complex type element. ValueSearchConfig controls the behavior of a single value search query.
The SearchTerm element specifies search term(s) used by the Oracle Endeca Server for a search either against all value-searchable attributes, or those that you specify in RestrictToProperties. You can optionally limit the number of search matches returned for each attribute using MaxPerProperty.
Parameter | Description |
---|---|
HandlerFunction | Required attribute. Specifies the ValueSearchHandler handler function for ValueSearchConfig, which is a type of ContentElementConfig. |
HandlerNamespace | Required attribute. Specifies the namespace for the handler function. |
Id | Optional. An identifier for this query configuration. |
Mode | Optional. Specifies a search mode, such as Any, or AllPartial. If Mode is not used, the query defaults to using the All search mode. |
MaxPerProperty | Optional. Limits the number of matches returned per record attribute. If this attribute is omitted, all found matches for the record attribute are returned. |
RelevanceRankingStrategy | Optional. Specifies a relevance ranking strategy to use on the results. If you omit this attribute and do not specify a relevance ranking strategy, the Oracle Endeca Server uses the value for the strategy provided in the DIMSEARCH_CONFIG XML configuration document. Further, if the document does not specify a strategy, the Oracle Endeca Server ranks the results using the following three strategies in this order (to break ties): interp, exact, and static. |
RestrictToProperties | Optional. If not specified, the request searches within all attributes. If specified, the request searches within specified attributes. |
SearchTerm | Required. Contains the search term(s) (also known as keywords) the Oracle Endeca Server uses to conduct value search. |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.endeca.com/MDEX/conversation/1/0" xmlns:typ="http://www.endeca.com/MDEX/lql_parser/types"> <soapenv:Header/> <soapenv:Body> <ns:Request> <ns:State/> <ns:Operator/> <ns:ContentElementConfig Id="ValueSearchConfig" xsi:type="ns:ValueSearchConfig" HandlerNamespace="http://www.endeca.com/MDEX/conversation/1/0" HandlerFunction="ValueSearchHandler" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" MaxPerProperty="5" RelevanceRankingStrategy="static (nbins,descending)" Mode="Any"> <ns:SearchTerm>Wash</ns:SearchTerm> <ns:RestrictToProperties> <ns:Property>ModelName</ns:Property> </ns:RestrictToProperties> </ns:ContentElementConfig> <ns:PassThrough/> </ns:Request> </soapenv:Body> </soapenv:Envelope>