Product Selector

Fusion 5.9
    Fusion 5.9

    Apply RulesQuery pipeline stage configuration specifications

    Table of Contents

    This stage looks up rules that have been deployed to the COLLECTION_NAME_query_rewrite collection and matches them against the query. Matching rules that perform query rewriting are applied at this stage, while matching rules that perform response rewriting are applied by the Modify Response with Rules stage later in the pipeline.

    To trigger a rule that contains a tag, specify the tagname in the request URL of the user search app. See Easily define triggers in tags for more information.

    See Rules for additional details about how to configure this set of features.

    This stage supports asynchronous processing.

    Although this stage is available without a Managed Fusion license, it is only effective after creating rules in Managed Fusion.

    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.

    Look up and apply rules to the 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.

    asyncConfig - Asynchronous Execution Config

    enabled - boolean

    Run the expensive data loading or processing part of this stage in a separate thread allowing the pipeline to continue executing. The results of this asynchronous execution can be merged into the pipeline request using a downstream "Merge Async Results" stage.

    Default: false

    asyncId - string

    A unique value to use as reference in downstream "Merge Async Results" stages.

    collection - string

    The collection to read rules from. Leave blank to use the default rules collection for the current application. Supports template expressions.

    handler - stringrequired

    Default: select

    method - stringrequired

    Default: POST

    Allowed values: GETPOST

    ruleLimit - string

    Max number of business rules to be triggered by the same query. The default rules matching limit is 100. This config overwrites "rows" param set in "Query Parameters" section

    Default: 100

    params - array[object]

    Additional query parameters to use when querying the rules collection. NOTE: "rows" parameter set here will be overwritten by the config in "Rule Triggering Limit" section

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

    subqueryRewritePipelineId - string

    Option to call a Fusion query pipeline to modify rule-retrieving subquery. Supports template expressions.

    hierarchicalFilter - array[object]

    Deprecated. Set hierarchical Fields in Predictive Merchandiser.

    object attributes:{field required : {
     display name: Field Name
     type: string
    }    delimiter required : {
     display name: Field Delimiter
     type: string
    }    }

    headers - array[object]

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

    useOriginalQueryIfNoRulesMatch - boolean

    If checked, then this stage will try to match rules using the original query (un-tagged) sent into the tagger stage if available.

    Default: true

    matchPartialFilterQueries - boolean

    If checked, then this stage will trigger filter rules as long as there is one filter query in the query parameter that matches the filter specified in the rule.

    Default: true

    maxWaitMs - integer

    Max time to wait for call to remote tagger collection to return; set to -1 to disable.

    Default: 500