Login
Home Knowledge Base Documentation CMS 10 InSite Search Creating DEX Search Components Search Navigation

Search Navigation

On This Page

This DEX component returns results from the index, based on category (taxonomy) or type (schema). It requires an ancestor xID to limit the search results. To do this, the component reads the references.xml file to determine the site's structure. Search Navigation uses the main index as defined in Search.config, so it does not create a new index.

Search Navigation is used for "termless" searches. If your search involves term queries, then use Ingeniux Search. If you need to search for a term, you can use Search Navigation and Ingeniux Search within the same page then cross-reference your filtered set. For instance, you may want to limit the result set with a "termless" search, using Search Navigation, then query the result set with a term, using Ingeniux Search.

The Search Navigation component must be configured with at least one of the following:

  • Search Site
  • Category
  • Type

Schema Elements

Each type of search schema has a local and remote version. The following table includes element descriptions for both the local and remote schemas. The table's description indicates if the element is exclusive to either the local or remote version.

Note: If a text field requires multiple values, comma delimit the items.

Schema Element Description
Expand Global Variables Boolean.
Search Scope Definition Group Element
Site Name Sets the Site profile name in Search.config. If you define multiple search profiles in Search.config and set the Site Name value explicitly, then this DEX Search Component only executes searches against the defined profile.
Search Sources Sets the source name that are included within the profile.
Category IDs Insert numeric category IDs that you want to be included in the search (e.g., 45,95).
Types Insert the schema types that you want to be included in the search (e.g., detail,home).
Locales Insert the locales that you want to be included in the search. The values are locale IDs (e.g., en-us, pt-br), as they exist in the Worldview configuration for defined locales in the CMS. If defined on the component, this parameter is treated as another dimension filter, if there are multiple lingual roots within a defined ancestor root xID.
Group By Structure Boolean. This feature affects lists and groups within pages and components. It structures grouped content, whose tags had been displayed in the returned result as "flattened out" concatenations (e.g., RelatedPhotos__Related_1 tag). Note: The indexer adds two underscores ("__") between each element node to create the new index field name. If true, the resulting XML displays as properly nested markup. For backwards compatibility, this feature is disabled.
Filtering Group Element
   Allowed Ancestors Allows you to limit search to a branch within the Site Tree.
   Exclusion Roots xID and its children will not be included in search results. This parameter may be particularly used to exclude sibling locale sites so that search results only include a particular language/locale. This value can be multiple xIDs.
   Fields to return By default, all fields in the index are returned. You can identify specific fields to be returned by listing them (e.g., Title,BodyCopy).
Facet Logics Group Element
   Category Facet internal logic

Allows you to define the relationship among categories.

Options:

  • SHOULD: Any category can match search criteria. (This is equivalent to the or operator.)
  • MUST: All categories must match search criteria. (This is equivalent to the and operator.)
  • MUST_NOT: No category can match. MUST_NOT is exclusionary. That is, the selected categories must not have an association with the returned page; however, the page must have other associations to be returned (e.g., The page meets Type or Locales criteria before it is excluded by MUST_NOT.)
   Cross Facets logic

In this context, the facets are Category IDs, Types, and Locales.

Options:

  • SHOULD: Any matching facet that meets the search criteria returns to hit in search results.
  • MUST: (Default) Search criteria must meet all three facets to return a hit in search results.
Include Categorization Stats Boolean. If true, search results include number of associations for each category.
Include Types Stats Boolean. If true, search results include number of hits per page type.
Advanced Group Element.
   Page Size Integer. Defines the number of returned hits within the search page.
   Field to Sort You can define the field to sort the returned results.
   Sort ascendingly The result set is sorted in ascending order.
   Additional Facets for Stats When you insert an element name in this field, the query returns the number of times that the string value of the element matches. This feature could be used to find duplicate field values.
   Number of top facet terms to return Integer. Sets the of top facets returned within the search page. The default value is 50 items.