Product Selector

Fusion 5.12
    Fusion 5.12

    JavaScriptQuery pipeline stage configuration specifications

    The JavaScript Query stage allows you to write custom processing logic using JavaScript to manipulate search requests and responses. The first time that the pipeline is run, Managed Fusion compiles the JavaScript program into Java bytecode using the JDK’s JavaScript engine.

    The JavaScript Query stage allows you to run JavaScript functions over search requests and responses by manipulating variables called "request" and "response" which are Request objects and Response objects, respectively.

    Users who can create or modify code obtain access to the broader Managed Fusion environment. This access can be used to create intentional or unintentional damage to Managed Fusion.

    The JavaScript engine used by Managed Fusion

    The JavaScript engine used by Managed Fusion is the Nashorn engine from Oracle. See The Nashorn Java API for details.

    The GraalVM engine from Oracle is also available. Select GraalVM from the JavaScript engine dropdown to use it. See GraalVM for details. GraalVM works in Nashorn compatibility mode and should not be used in production. Full backwards compatibility is not available.

    JavaScript Query Stage global variables

    JavaScript is a lightweight scripting language. The JavaScript in a JavaScript stage is standard ECMAScript. What a JavaScript program can do depends on the container in which it runs. For a JavaScript Query stage, the container is a Managed Fusion query pipeline. The following global pipeline variables are available:

    Name Type Description

    request

    Request for a Regular Query

    The request variable contains Solr query information and is referred to as a regular request. A regular query request does not include Search DSL (domain specific language) parameters.

    request

    DSL Request

    The request variable is also used when the query contains parameters for a Search DSL (domain specific language) request.

    See Domain Specific Language for more information.

    response

    Response for a Regular Query

    The response variable contains Solr response information, and is used to return information from a regular request. Because a regular request does not include Search DSL (domain specific language) parameters, the response will not return Search DSL results.

    response

    DSL Response

    The response variable is also used to return information from a Search DSL (domain specific language) request.

    See Domain Specific Language for more information.

    ctx

    Context

    A map that stores miscellaneous data created by each stage of the pipeline.

    Use the ctx variable instead of the deprecated _context global variable.

    The ctx variable is used to:

    • Pass data from one stage to another

    • Store data that needs to be passed from one custom stage to a later custom stage

    The data can differ between stages:

    • If the previous stage changes the data

    • Based on the configuration of each stage

    If the data is modified in one stage, it may cause a later stage to function irregularly.

    collection

    String

    The name of the Managed Fusion collection being indexed or queried.

    solrServer

    BufferingsolrServer

    The Solr server instance that manages the pipeline’s default Managed Fusion collection. All indexing and query requests are done by calls to methods on this object. See solrClient for details.

    solrServerFactory

    solrClusterComponent

    The SolrCluster server used for lookups by collection name which returns a Solr server instance for that collection, e.g.
    var productsSolr = solrServerFactory.getSolrServer("products");.

    QueryRequestAndResponse

    QueryRequestAndResponse

    Used to create query pipeline requests and responses.

    JSONResponse

    JSONResponse

    Returns list of info as a string.
    See Custom JavaScript Query Stage examples for more information.

    Syntax variants

    JavaScript stages can be written using legacy syntax or function syntax. The key difference between these syntax variants is how the "global variables" are used and interpreted. While using legacy syntax, these variables are used as global variables. With function syntax, however, these variables are passed as function parameters.

    Legacy syntax

    request.addParam("foo", "bar");

    Function syntax

    function(request,response) {
   request.addParam("foo", "bar");
}
    Function syntax is used for the examples in this document.

    Global variable logger

    The logs are output to the query service logs for custom query stages. Access the Log Viewer and filter on this service to view the information.

    JavaScript Query Stage global variables

    JavaScript is a lightweight scripting language. The JavaScript in a JavaScript stage is standard ECMAScript. What a JavaScript program can do depends on the container in which it runs. For a JavaScript Query stage, the container is a Managed Fusion query pipeline. The following global pipeline variables are available:

    Name Type Description

    request

    Request for a Regular Query

    The request variable contains Solr query information and is referred to as a regular request. A regular query request does not include Search DSL (domain specific language) parameters.

    request

    DSL Request

    The request variable is also used when the query contains parameters for a Search DSL (domain specific language) request.

    See Domain Specific Language for more information.

    response

    Response for a Regular Query

    The response variable contains Solr response information, and is used to return information from a regular request. Because a regular request does not include Search DSL (domain specific language) parameters, the response will not return Search DSL results.

    response

    DSL Response

    The response variable is also used to return information from a Search DSL (domain specific language) request.

    See Domain Specific Language for more information.

    ctx

    Context

    A map that stores miscellaneous data created by each stage of the pipeline.

    Use the ctx variable instead of the deprecated _context global variable.

    The ctx variable is used to:

    • Pass data from one stage to another

    • Store data that needs to be passed from one custom stage to a later custom stage

    The data can differ between stages:

    • If the previous stage changes the data

    • Based on the configuration of each stage

    If the data is modified in one stage, it may cause a later stage to function irregularly.

    collection

    String

    The name of the Managed Fusion collection being indexed or queried.

    solrServer

    BufferingsolrServer

    The Solr server instance that manages the pipeline’s default Managed Fusion collection. All indexing and query requests are done by calls to methods on this object. See solrClient for details.

    solrServerFactory

    solrClusterComponent

    The SolrCluster server used for lookups by collection name which returns a Solr server instance for that collection, e.g.
    var productsSolr = solrServerFactory.getSolrServer("products");.

    QueryRequestAndResponse

    QueryRequestAndResponse

    Used to create query pipeline requests and responses.

    JSONResponse

    JSONResponse

    Returns list of info as a string.
    See Custom JavaScript Query Stage examples for more information.

    Syntax variants

    JavaScript stages can be written using legacy syntax or function syntax. The key difference between these syntax variants is how the "global variables" are used and interpreted. While using legacy syntax, these variables are used as global variables. With function syntax, however, these variables are passed as function parameters.

    Legacy syntax

    request.addParam("foo", "bar");

    Function syntax

    function(request,response) {
   request.addParam("foo", "bar");
}
    Function syntax is used for the examples in this document.

    Global variable logger

    The logs are output to the query service logs for custom query stages. Access the Log Viewer and filter on this service to view the information.

    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.

    Manipulate the request using JavaScript. This stage allows to run arbitrary code on the server.

    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.

    script - stringrequired

    Enter your JavaScript code here. Your function does not need to return anything, all request and response modification is done in-place.

    Default: function (request, response, ctx) { // add your logic here }

    scriptEngine - string

    Choose the Javascript engine implementation to run the script (graalvm is an experimental option).

    Default: nashorn

    Allowed values: graalvmnashorn

    shareState - boolean

    Causes all instances of this stage to share global state. Enabling this will increase performance, but can lead to unexpected behavior if any variables are declared globally. This is safe to use if you declare all variables explicitly using 'var'.

    Default: true