Elasticsearch Supported Search Options, Filters, Facets and Sorting

Owned by Magda Zacharska
Last updated: Mar 10, 2022 by Charlotte Whitt
3 min read

The list below covers backend functionality that was delivered in scope of Iris as a part of POC and Juniper/Kiwi releases based on the feedback provided by Inventory Search Improvements Working Group.  For implementation details, including examples and supported operators please refer to https://github.com/folio-org/mod-search, especially the Supported search types section.

Search Options and Filters

Instance segment

Search And Filter Options  - backend

(Kiwi release)

MSEARCH

Magda will update

Available in Inventory UI (Kiwi)

Charlotte will update

UIIN

Charlotte will update

KeywordMSEARCH-17; UISEES-9; MSEARCH-31YesUIIN-572; UIIN-998; UIIN-1244; 

UIIN-1942

 
UUID
YesUIIN-838
HRID
YesUIIN-899 
SourceUISEES-16

Yes

UIIN-1132
Title  (includes search by title, alternative title, index title and series)
Yes as search option Title (all)MODINVSTOR-627
Alternative title (separate search option)
Yes as search option Title (all) but not as a separate search optionMODINVSTOR-627
Uniform title (separate search option)MSEARCH-148Yes as search option Title (all)but not as a separate search option
Series (separate search option)MSEARCH-150Yes as search option Title (all)but not as a separate search optionMODINVSTOR-627
Identifiers (all) by value
Yes

UIIN-56; UIIN-999      


Identifier by type
Yes as search option Identifier (all)TBD (MM-SIG)
ISSN
YesUIIN-1234, MODINVSTOR-475
ISBN
YesUIIN-647
Contributors
Yes

UIIN-56

Primary contributor
NoTBD (MM-SIG)
Subject
Yes

UIIN-56

Resource type
YesUIIN-32
Instance format
YesUIIN-820
Instance status
NoUIIN-1207; MODINVSTOR-545?
Languages
YesUIIN-32
Created dateMSEARCH-30YesUIIN-788
Updated dateMSEARCH-30YesUIIN-790 
Mode of issuance
YesUIIN-823
Nature of content
YesUIIN-824
Tags
YesUIIN-763
Classification Number
No
Electronic access (all fields)MSEARCH-22No
Electronic access - URIMSEARCH-22No
Electronic access - Linked TextMSEARCH-22No
Electronic access - Public NoteMSEARCH-22No
Suppress from discovery
Yes UIIN-967
Staff suppress
Yes UIIN-968
Public notes

MSEARCH-21

No
Notes - allMSEARCH-116NoUIIN-942 
All
Yes (Morning glory)UIIN-1645
Query search
YesUIIN-724

Holdings segment

Search and Filter Options - backend

(Kiwi release)

MSEARCH

Magda will update

Available in Inventory UI (Kiwi)

Charlotte will update

UIIN

Charlotte will update

Identifiers (all) (includes HRIDs and Former Ids)

MSEARCH-26 - HRID

MSEARCH-152 - Identifiers (all)

No
UUIDMSEARCH-184NoUIIN-911 
Permanent location
Yes UIIN-679
Suppress from discovery

Yes

UIIN-766;  UIIN-969 
HRID
YesUIIN-900
Copy number

UIIN-778
Tags
YesUIIN-764
Call number, eye readable
YesUIIN-1040
Call number, normalizedMSEARCH-169-UIIN-721 ;UIIN-1918  
Holdings type
NoUIIN-1347
Electronic access (all fields)MSEARCH-109No
Electronic access - URIMSEARCH-109No
Electronic access - Linked TextMSEARCH-109No
Electronic access - Public NoteMSEARCH-109No
Notes (all)MSEARCH-117NoUIIN-943 
Public notes
No
Identifiers (includes HRID and former Id)
(must investigate)Holdings Accession number: UIIN-775
SourceUISEES-72Yes (Lotus)UIIN-1810 
Created date
Yes (Lotus)UIIN-789 
Updated date
Yes (Lotus)UIIN-791 
All
Yes (Morning glory)UIIN-1645
Query search
YesUIIN-868

Item segment

Search and Filter Options - backend 

(Kiwi release)

MSEARCH

Magda will update

Available in Inventory UI (Kiwi)

Charlotte will update

UIIN and MODINVSTOR

Charlotte will update

Identifiers (all) (includes searches by HRID, Former Id and Accession NumberMSEARCH-153; MSEARCH-272NoWrite up UIIN jira
UUID
NoUIIN-912
HRID
YesUIIN-901 
Barcode
YesUIIN-143 
Copy number
-UIIN-779
Effective location
Yes

MODINVSTOR-348; UIIN-199

Item status
YesUIIN-771
Material type
YesUIIN-777 
Suppress from discovery
YesUIIN-970
Tags
YesUIIN-765
Call number, eye readable
Yes UIIN-1041
Normalized call number

MSEARCH-169

-UIIN-722; UIIN-1919
Call number type, item
-UIIN-1027 (relevant for browse)
Electronic access (all fields)MSEARCH-110No
Electronic access - URIMSEARCH-110No
Electronic access - Linked TextMSEARCH-110No
Electronic access - Public NoteMSEARCH-110No
Notes (all)MSEARCH-117NoUIIN-944; UIIN-945
Public notes
No
Circulation notes

MSEARCH-158

NoUIIN-945
Identifiers (includes HRID, former Id, accession number)
Must investigate(UIIN-776)
Created date
Yes (Lotus)UIIN-785
Updated date
Yes (Lotus)UIIN-786
All
Yes (Morning glory)UIIN-1645
Query search
YesUIIN-869

Search All 

Search by all record types and all properties has to be enabled on the tenant level.  Enabling the option requires re-indexing.  Supported search options:

  • Search by all records type and properties
  • Search by instance properties
  • Search by holdings properties
  • Search by items properties

Those options are currently not available in the UI

Facets

Instance

Facet 

MSEARCH

Magda will update

Available in UI (Lotus)

Update by Charlotte

UIIN

Charlotte will update

Source
YesUIIN-1132
Resource type
YesUIIN-193 
Instance format
YesUIIN-820
Mode of Issuance
YesUIIN-823
Nature of Content
YesUIIN-824
LanguageUISEES-14YesUIIN-32
Instance status
-UIIN-1207; MODINVSTOR-545?
Staff suppress
YesUIIN-967
Suppress from discovery
YesUIIN-968
Statistical codes
YesUIIN-792 
Tags
YesUIIN-763

Holdings 

Facet 

MSEARCH

Magda will update

Available in UI (Lotus)

Update by Charlotte

UIIN

Charlotte will update

Permanent location
YesUIIN-679
Suppress from discovery
YesUIIN-766;  UIIN-969 
Statistical codes
YesUIIN-793 
SourceUISEES-72Yes (Lotus)UIIN-1810 
Tags
YesUIIN-764

Items

Facet 

MSEARCH

Magda will update

Available in UI (Lotus)

Update by Charlotte

UIIN

Charlotte will update

Item status
YesUIIN-771
Effective location
YesMODINVSTOR-348; UIIN-199
Material type
YesUIIN-777
Suppress from discovery
YesUIIN-970
Statistical codes
YesUIIN-794
Tags
YesUIIN-765

Sorting

Currently supported sort options:

  • Relevance  - based on TF-IDF (POC default sort)
  • Title - based on MSEARC-136 Index title (Inventory Kiwi default sort) 
  • Contributors
  • Item status (not supported in UI)

Sorting by publisher has not been implemented yet.


Boolean operators

Backend supports Boolean operators starting with the Juniper release.   This option is currently available in the UI only through Query search.