A basic record search requires an Operator with a SearchOperator type.
<Operator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SearchOperator" Within="false"> <SearchFilter Mode="AllPartial" RelevanceRankingStrategy="numfields" Key="PROD_CATEGORY" EnableSnippeting="false" Language="en"> electronics </SearchFilter> </Operator>
The text content of the SearchFilter type contains the search term(s). In the example, a record search is being made for the "electronics" keyword in the PROD_CATEGORY standard attribute.
Search attribute | Description |
---|---|
Within | Optional. If set to false on the SearchOperator element, then the visible parts of the filter state are cleared first. The default value is false. |
Key | Required to be specified for the SearchFilter. Specifies which standard or managed attribute will be evaluated when searching. You specify an attribute as a value for this parameter. You can also specify a search interface as a value. |
EnableSnippeting | Optional. If set to true on the SearchFilter element, enables snippeting. If set to false, disables snippeting. For details on snippeting, see Using Snippeting in Record Searches. |
SnippetLength | Optional. Specifies the length of the snippet. |
Mode | Optional. Specifies a match mode, which are described in List of valid search modes. Note that Boolean match mode cannot be used. |
RelevanceRankingStrategy | Optional. Specifies a relevance ranking strategy. For details on relevance ranking, see Relevance Ranking. |
Language | Optional. Specifies a language ID for the search. Valid language IDs are listed in the topic Supported languages. |