XML Hit List Component (XHitList)

XHitList is an XML version of the HitList component. However, the parameters of the two components are completely separate so that setting the q parameter of one, for example, does not affect the q parameter of the other.

URL Parameters

Name	Value	Description
xhitlist_d	domain string	domain string
xhitlist_q	string	Query
xhitlist_hc	string	Hit context (always use the [XML] prefix).
xhitlist_mh	number	Maximum number of hits to return
xhitlist_mt	number	Maximum time allowed before timeout.
xhitlist_ncd	domain string	Not like these (negative concept) domain. If present on the URL, a "More Like This" query is performed, and the q parameter is ignored.
xhitlist_opt	string	User-defined query syntax options string. Passed to the query component DLL that implements the query syntax. Retrieved with query-syntax-options.
xhitlist_pcd	domain string	More like these (positive concept) domain. If present on the URL, a "More Like This" query is performed, and the q parameter is ignored.
xhitlist_s	sort string	Sort order
xhitlist_x	simple \| advanced	Query syntax

List Metadata

This metadata is available from the Xhitlist component in addition to the common metadata listed above.

Name	Description
concept-query	Set to 'yes' if the query was the result of a concept search (find similar/not similar), by using the pcd or ncd parameters, or using the server syntax scalar query operator.
domain	Domain the search is limited to. Returned only if the domain has been explicitly set.
escaped-query	Query with single and double quotes escaped appropriately for use in a JavaScript statement. For example, [field 'DC:Title'] becomes [field \'DC:Title\'].
hit-context-param	Hit context parameter (as opposed to the actual hit-context that comes back for each hit).
hit-count	Total number of hits
max-hits	Maximum number of hits
max-relevance-weight	The highest relevance weight resulting from the search. This value can be used to normalize all of the relevance weights.
max-time	Maximum time allowed before time out
query	Original query
query-language	Language of the query
query-syntax	Syntax of the original query
query-syntax-options	Options string associated with the query syntax (returned only when you pass options in through the xhitlist_opt parameter.
query-timed-out	Returned if the query could not be completed within the maximum allotted time.
sort	Sort order
translated-query	Query in server syntax

Properties

These properties are available for inclusion in the select string (xhitlist_sel) parameter. As the common properties, these properties give values for the "item" elements, which are hit documents.

Name	Description
relevance-weight	Document's relevancy rank; a number between 0 and 1000. You can specify relevance-weight for any query using the Rank syntax in the query. By default, queries submitted to the "simple" query component use relevance weight. If you specify relevance-weight for queries submitted to the "advanced" query component, the rank entries display 0.

Replacement Variables

Name Description

XHITLIST:QUERY Returns the value of query (xhitlist_q).

XHITLIST:SYNTAX Returns the value of query syntax (xhitlist_x).

XHITLIST:HITCOUNT Returns the number of hit documents.

XHITLIST:TRANSLATED_QUERY Returns the query string translated to server syntax.

Name	Description
XHITLIST:QUERY	Returns the value of query (xhitlist_q).
XHITLIST:SYNTAX	Returns the value of query syntax (xhitlist_x).
XHITLIST:HITCOUNT	Returns the number of hit documents.
XHITLIST:TRANSLATED_QUERY	Returns the query string translated to server syntax.