Logo

    Home

    Documentation

    Use Cases

    Training

    Applications

    Release Notes

    ElasticSearch

    ElasticSearch

    icon
    ElasticSearch REST API adapter on the BusinessEntity object level is supported from the 21.22 release of the SWAT framework
    • Description
    • How to use it
    • BusinessEntity
    • DynSelect

    Description

    ElasticSearch is an open-source, distributed search and analytics engine built on Apache Lucene. Designed for scalability, it offers real-time full-text search, JSON-based API interaction, and supports complex data analysis and aggregation. As a document-oriented system, Elasticsearch is a key component in applications requiring efficient search capabilities and is integral to the Elastic Stack for log and data analysis.

    ElasticSearch can be used in Build.One with a BusinessEntity or with a Select (DynSelect)Select (DynSelect)

    How to use it

    To configure a BusinessEntity or DynSelect control to use the ElasticSearch API please use the following repository attribute settings

    BusinessEntity

    Attribute
    Value
    SUBTYPE
    ElasticSearchCollection
    resourceName
    The elastic search index.
    entityName
    The ElasticSearch type, optional attribute.

    DynSelect

    Attribute
    Value
    SUBTYPE
    ElasticSearchCollection
    entityName
    The elastic search index.
    entityTable
    The ElasticSearch type, optional attribute.

    It is also required to create a proxy for the given index. The setting for the base API endpoint can be configured using the .restapplicationsettings

    icon
    For the autocomplete search of the Dynselect object, the fuzzy query is applied, which returns documents that contain terms similar to the search term.
    icon
    By default the base API endpoint is /web, and can be configured as application setting, the key elasticSearchBaseURL.

    Back to DocumentationDocumentation

    Back to Home Page

    Logo