QueryParsing - AFS

AFS Configuration Options

Product
AFS
AFS_Version
7.10
Category
Reference Guide

Prefix: QEng/SearchFrontEnd/QueryParsing

Query Parsing options

The following table lists and describes the QueryParsing configuration options.

Option

Type (default)

Description

Role

Editable in Back Office

discardOnError

bool (true)

If true then a parse error discards the whole query. Otherwise the query is performed with the correct items - caution this might be a security hole!

advanced_developer

Yes

removeCharacters

string

List of characters to be removed from query. Leave empty to disable

advanced_developer

Yes

expressions

string_list

Quote all expressions of this list in query

developer

Yes

caseSensitiveExpressions

bool (false)

If set to true then case will be strictly checked when detecting expressions

linguist

Yes

emptyWords

string_list

List of empty words. Default value when query is not localized or when no localized keyword can be used. This parameter is deprecated in favor of the QueryParsing/localizedEmptyWords parameter.

developer

Yes

localizedEmptyWords

localized_string_map

List of localized empty words. Key is normalized localization (ex: fr_FR, en_US ...) and value is keyword. This parameter is deprecated in favor of the QueryParsing/localizedEmptyWords parameter.

developer

Yes

caseSensitiveEmptyWords

bool (false)

If set to true then case will be preserved and used while removing empty words

linguist

Yes

defaultLang

string ("en")

Default language for the query if no afs:lang parameter is set. Default is en for English

enduser

Yes

defaultRegion

string

Default region for the query if no afs:lang parameter is set. Empty (default) means no specific region

enduser

Yes

defaultParameter

string_map

List of default parameters to use. Key is parameter name, value is parameter value. For each query, if a parameter from this list is not set then the corresponding default value will be used

developer

Yes

defaultSort

string

If not empty, value to use for afs:sort if it is not explicitely in the query. In this case, defaultSort will override any entry in defaultParameter with afs:sort key

enduser

Yes

defaultFacetOrder

string

If not empty, value to use for afs:facetOrder if it is not explicitely in the query. In this case, defaultFacetOrder will override any entry in defaultParameter with afs:facetOrder key

enduser

Yes

storedQuery

string_map

Key is the stored query name, value can be a simple rewrite_rule or it can take parameters to use in a rewrite_rule. In this case, the syntax is (param1,...paramN)rewrite_rule with N <= 9. For instance, for the key mystored and the value (a,b)afs:filter=price>$a and price<$b, afs:storedQuery=mystored(1,10) is equivalent to afs:filter=price>1 and price<10

developer

Yes

rewriteArg

string_map

Rewrite one query argument. Key is argument name and value (ex: afs:query=foo), value is replacement value (ex: afs:storedQuery=bar())

developer

Yes

addArg

string_map

Add one query argument if another is set. Key is argument name and value (ex: afs:lang=FR), value is additional value (ex: afs:log=Europe)

developer

Yes

rewriteRules

string

List of rewriting rules. A rule is of type (precondition)* [matching condition] (actions).

developer

Yes