Legacy Product

Fusion 5.10
    Fusion 5.10

    Parameterized Faceting Stage

    Table of Contents

    The Parameterized Faceting query pipeline stage determines the most frequent value for a given field, then uses that value to look up stored parameters and auto-select the most appropriate facet for a query.

    Configuration

    When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.

    Query Solr to determine the most frequent value for a given field (e.g. category) and then use that value to lookup stored parameters to auto-select the most appropriate facet for a query.

    skip - boolean

    Set to true to skip this stage.

    Default: false

    label - string

    A unique label for this stage.

    <= 255 characters

    condition - string

    Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.

    facetField - Facet Field

    field - string

    The field whose values you want to facet on.

    prefix - string

    Prefix of terms to facet on.

    sort - string

    Ordering of the faceting results.

    Allowed values: countindex

    limit - integer

    Maximum number of facets to return.

    offset - integer

    Offset into list of resulting facets.

    minCount - integer

    Lower threshold of term counts to be included.

    Default: 1

    missing - boolean

    Optionally include a 'missing' facet bucket for documents without the selected field.

    Default: false

    method - string

    Allowed values: enumfcfcs

    enumCacheMinDf - integer

    exclusiveMinimum: false

    threads - integer

    exclusiveMinimum: false

    fallbackValue - string

    Optional fallback value to use for the facet field if one cannot be determined by querying Solr.

    failQueryOnError - boolean

    Fail the query request if an error occurs when processing this stage.

    Default: false

    handler - stringrequired

    Solr query request handler to send the auto-facet query request to.

    Default: select

    method - stringrequired

    HTTP method used to send the auto-facet query request.

    Default: GET

    Allowed values: GETPOST

    params - array[object]

    object attributes:{key required : {
     display name: Parameter Name
     type: string
    }    value : {
     display name: Parameter Value
     type: string
    }    }

    headers - array[object]

    object attributes:{key required : {
     display name: Parameter Name
     type: string
    }    value : {
     display name: Parameter Value
     type: string
    }    }

    inherit - boolean

    Select box if a child category should inherit its parents' stored parameters.

    Default: false