Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

  • Description: The mod-search module for FOLIO provides search capabilities across multiple types of resources within the FOLIO Library Services Platform.

  • Key Features:

    • Supports searching for Instance and Authority records.

    • Integration with Elasticsearch/OpenSearch for advanced search capabilities.

    • Configurable indexing and search settings.

    • API endpoints for search functionalities.

    • Consortium support:

      • special endpoints to provide consolidated documents.

      • searching through consortium tenants.

Table of Contents

Table of Contents
excludeclass
maxLevel2
minLevel1maxLevel2
include
outlinefalse
indent
exclude
styledefault
typelist
printabletrue
class

Introduction

Background

The mod-search module is an integral part of the FOLIO Library Services Platform, designed to facilitate advanced search functionalities across various resource types. It leverages Elasticsearch/OpenSearch to provide efficient and scalable search solutions.

...

  • Enable robust and efficient search capabilities within the FOLIO platform.

  • Provide a flexible and configurable search solution that meets diverse library needs.

Features

  1. Instance Search

  2. Authority Search

  3. Call Numbers Browse

...

  • Search Requests: How to perform search requests using the API. TBD

  • Index Management: Instructions on managing indexes, including creation and deletion. TBD

Error Handling and Troubleshooting

TBD

Architecture and Design

System Architecture

The mod-search module is built on a microservices architecture and integrates with other FOLIO modules and Elasticsearch.

Diagrams: TBD

Module Design

  • Core Components: Indexing service, search service, and configuration service.

  • Technologies: Java, Spring Boot, Elasticsearch, PostgreSQL, Kafka.

...