System query parameter

Managed by | Updated .


The system query parameter is search query input field that can be used to supply search terms and constraints to a search query that are treated as hidden parameters.

The system query accepts a query specified using Funnelback's query language operators (the same as in a standard query field) but with the following differences:

  • The system query field is not modified by transformation features such as synonyms and query blending. (Note: stemming is applied to the system query)
  • Values within the system query field are not displayed in the cleaned query (so don't display on the search interface)
  • Values within the system query field are not displayed in the search analytics

System query parameters should be used for any system generated queries such as cases where Funnelback's search index is used like a database. This keeps that analytics clean (so it only reports on the queries that the user types) and also avoids synonym/query blending transformations that don't make sense for a system query.

System query parameters

The system query parameter is accessed via the s and smeta_X_* parameters.

The following table illustrates standard query parameters and their system query equivalents

Standard query parameterSystem query parameterExample (CGI parameter)

Setting the system query parameter using a hook script

The system query parameter can be supplied as a CGI parameters (&s=, &smeta_X=) but can also be injected into the data model from a hook script but must be done so by adding to rawInputParameters

transaction.question.rawInputParameters["s"] = ["VALUE"]
Was this artcle helpful?