# iNav


# Description

INav is a feature of 1search that will take a given set of search results, and return all the possible indexes, aspects, and their respective facets through which the given results can be further filtered or sorted. This allows you to provide users of your 1search implementation with detailed, guided navigation. For example, iNav could be used to create the faceted search style with a specific sidebar configured using the configuration in the Client Portal. The Navigations configuration is responsible for setting up how your iNav will be generated, and what items will be shown inside it and the order they are shown in. In the Navigations config, you can configure which items you wish to provide options for with the guided navigation. Items configured within the Navigations config will appear in an iNav request as an option to further filter results.

The way your iNav will be generated can be viewed on the Diagnostics Page

For more information about the iNav request type, click here


The items within the Navigations configuration are used to configure what items are shown/generated inside iNav and can be used to simulate guided navigation. The types of items that can be placed in the Navigations config file are:

  • Aspects
  • Ranges
  • Keyword
  • POI

Each of the tags can have a FacetComparer, which will determine the order in which they are shown in the generated iNav. For a list of available string comparers and their uses, see String Comparers

<Navigation Name="BooksBooks">
    //All Other items go in here
</Navigation>

The Navigation tag shown above is used to contain the configuration for one of your iNav templates, items contained within the navigation tag represent how your iNav will be generated when running an iNav request with the parameter of the Name contained within that Navigation tag. It will automatically default to the first defined Navigation.

# Aspect

<Aspect Name="Genre" FacetComparer="OrdinalIgnoreCase">
    <Aspect Name="Series" FacetComparer="OrdinalIgnoreCase"/>
</Aspect>

The aspects within the aspects are sub aspects, and are used in relation to the parents when using guided navigation and will show up when selecting items from the parent aspect

# Range

<Range Name="Price" FacetComparer="OrdinalIgnoreCase">
    <Histogram Name="Dynamic Bin Histogram" />
    <Histogram Name="Static Bin Histogram" />
</Range>

Ranges can be configured with the Range tag, this is an XML element, and will cause a price range node to be generated in iNav.

Histograms can be included in range node and histogram results will be returned within the range node. For more information about histogram indexes, see Histograms.

# Keyword

<Keyword Name="BookDescAll" FacetComparer="OrdinalIgnoreCase"/>

Having the keyword tag allows the node's values configured within the index config to appear in iNav and allows it to become navigable.

# Point Of Interest (POI)

<Poi Name="SuburbPoi" FacetComparer="OrdinalIgnoreCase"/>

Similar to the above two, this is also here so that its values appear in iNav and can be navigated as a poi.


Here is where the names of the aspects and facets that will be displayed to the user are configured, when configuring these values be sure to have the aspect name listed first

# Example Syntax

"INavDisplayNames": {
    "Keys": [
        "en",
        "ch"
    ],
    Names: [
        [
            "Genre",
            "Genre",
            "类型"

In the Keys section of the above syntax, the language and order of languages in the Names lists is specified, note that the first item in the names lists is the item name itself that it was configured to in the Indexes Configuration.

# Full Example

<?xml version="1.0" encoding="utf-8" ?>
<Navigations>
    <Navigation Name="BooksBooks">
        <Aspect Name="Genre">
            <Aspect Name="Series"/>
        </Aspect>
        <Aspect Name="Microwaveable"/>
        <Range Name="Price"/>
    </Navigation>
</Navigations>