Search and filters
In inventory, we have implemented segmented control search where it's possible to toggle between searching on an Instance, Holdings or individual Item level. Search in the Instance segment supports search on bibliographic data. Search in the Holdings and Item segments are a combination of key data from the Instance record, combined with holdings and item specific data elements. The filters reflect each of the individual segments and include search on effective location.
This is work in development, but as of end of January the following search and filter options are present in FOLIO Snapshot:
Search and filter options can be combined.
When searching in a filter, the search typed will be highlighted. E.g.:
If more than 100 hits are retrieved, the first 100 will load, and then you will see a "Load more" button at the bottom of the page.
When clicked, it will display the next 100:
There is also a Query search function, which can search across records on all data elements. See below.
Search using Query language (Instance, Holdings, Item segment)
See list of property names in Query Search - Inventory Beta - Metadata Elements, or in the API Documentation in the /instance-storage/instances POST, /holdings-storage/holdings POST and /item-storage/items POST.
See list of defined supporting database indexes: db_scripts/schema.json – Skip to the
"tableName": "holdings_record" or
"tableName": "item" section and look into the
See misc. test of search performance in Bug fest Goldenrod (https://bugfest-goldenrod.folio.ebsco.com/) in Document Inventory Search Response time (Q3 Timebox)
Tips: When searching by an ID, in the Query search it's better to use "==" as it uses the B-tree index to search, whereas a CQL query using "=" will result in a full text search, which is not efficient for searching when there is already an index on the ID.
Examples on CQL syntax (WIP)
|Query search||Search result|
id == "f31a36de-fcf8-44f9-87ef-a55d06ad21ae"
|give me the instance record where UUID = f31a36de-fcf8-44f9-87ef-a55d06ad21ae|
|hrid == "in00000009"||give me the instance record where the HRID = in00000009 (this number will later be an 11 digit sequence)|
|source == "folio"||give me all instance records where metadata source = FOLIO|
|source == "marc"||give me all instance records where metadata source = MARC, which means that the instance record has an underlying MARC record in SRS|
|contributors =/@name "frank"||give me all instance records where contributor = Frank|
identifiers =/@value/@identifierTypeId="01ca9cda-7027-4d64-abed-9e3c4943daf2" "806014467"
|give me all instance records where OCLC number = (OCoLC)806014467 - result in BugFest Goldenrod environment|
|identifiers =/@value/@identifierTypeId="01ca9cda-7027-4d64-abed-9e3c4943daf2" ("806014467" OR "560591246")||give me the two instance records with OCLC number = (OCoLC)806014467, (OCoLC)560591246 by using the OR boolean operator - result in BugFest Goldenrod environment|
series = "cooperative information systems"
|give me all instance records where the serie title = Cooperative information systems|
|publication = "MIT Press"||give me all instance records where the publisher = MIT Press|
|publication = "c2004"||give me all instance records where the publication year = c2004|
|physicalDescriptions = "bände"||give me all instance records where the physical description = bände|
|subjects = "history"||give me all instance records where the subject heading = history|
|instanceFormatIds == "f5e8210f-7640-459b-a71f-552567f92369"||give me all instance records where format term = online resource|
keyword all oclc
|give me all instance records where oclc is mentioned in title, contributor, or identifier|
holdingsRecords.fullCallNumber == "TK5105.88815 . A58 2004 FT MEADE" OR holdingsRecords.callNumberAndSuffix == "TK5105.88815 . A58 2004 FT MEADE"
|give me all holdings records where the call number = TK5105.88815 . A58 2004 FT MEADE|
|holdingsRecords.copyNumber = "C.2"||give me all holdings records where the copy number = C.2|
|holdingsRecords.holdingsStatements = "v.70-84"||give me all holdings records where the holdings statement = v.70-84 (1984-1998)|
|holdingsRecords.notes = "CharlotteTest"||give me all holdings records where the holdings notes = CharlotteTest|
|holdingsRecords.metadata.createdDate = 2020-07-13||give me all holdings records created on 2020-07-13|
|holdingsRecords.metadata.updatedDate = 2020-07-13||give me all holdings records updated on 2020-07-13|
|item.enumeration = "v.71"||give me all item records where the enumeration = v.71|
|item.accessionNumber == 2424242424||give me all item records with accession number 2424242424|
|item.electronicAccess = "table"||give me all item records where there in the electronic access elements is matching value = table|
|item.notes = "note"||give me all item records where the item note = note|
|item.circulationNotes = missing pages*||give me all item records with check out/check in note about having missing pages|
|item.permanentLoanTypeId == "2b94c631-fca9-4892-a730-03ee529ffe27"||give me all item records where the permanent item loan type is Can circulate|
|item.metadata.createdDate = 2020-07-13||give me all item records created on 2020-07-13|
|item.metadata.updatedDate = 2020-07-13||give me all item records updated on 2020-07-13|
Boolean search within records and across instance/holdings/item:
|Query search||Search result|
|publication = "MIT Press" and publication = "c2004"||give me all instance records where publisher = MIT Press AND publication year is c2004|
|publication = "MIT Press" and holdingsRecords.callNumber = "TK5105.88815 . A58 2004 FT MEADE"||give me all instance records where publisher = MIT Press AND the associated holdings records has holdings level call number = TK5105.88815 . A58 2004 FT MEADE|
subjects = "history" or identifiers = "OCoLC" not publication = "2017"
|give me all instance records where publisher = MIT Press AND the resource identifier is starting with OCoLC and does NOT has publication year = 2017|
|languages="eng" AND item.itemLevelCallNumber="TK5105*"|
give me all instance records where language = English AND the associated item records has item level call number starts with TK5105. The query includes wildcard search with an asterix
|identifiers =/@value/@identifierTypeId == "216b156b-215e-4839-a53e-ade35cb5702a" "10419/192087"||give me all instance records where resource identifier type = handle AND resource identifier = 10419/192087|
source = "*" not source = "folio"
id=* not source = "folio"
cql.allRecords = "1" not source = "folio"
|give me all instance records where metadata source is NOT Folio (but: MARC, and other source formats)|
|item.status="available" AND statusId = "26f5208e-110a-4394-be29-1569a8c84a65"||give me all records where item status = available AND instance status term = Uncataloged|
Search queries that currently do not seem to work
|Query search||Expected search result||Actual search result||Tested by / on environment||Comments|
|discoverySuppress="false" AND holdingsRecords.discoverySuppress="false" AND item.discoverySuppress="false" AND item.barcode="null"|
Instance, Holdings, Item are not suppressed (for discovery?) AND item barcode = blank
example from 2020-01-30 Metadata Management Meeting notes
The instance record JSON includes a boolean "discoverySuppress" which is set to false in my instance example record.
Holding and item records don't have this elements in their response. Use Chrome's dev tools to verify.
I'm not sure how to search for NULL values. If an item has no barcode assigned, the element is not included in the JSON response either.
For some CQL queries you need the UUID of the value, because you cannot search for the actual term. To do this, you can use the developer tools that are built into your browser. In Chrome, press F12 to open the developer tools and switch to the "network" tab. Clear out any previous data by pressing "clear" and refresh the Folio page. Please note, that you'll first have to open a detail instance record in the third pane. After the page has loaded, you should look in the network data for the record UUID. Select it to see the record data in JSON format.
|Instance status types|
Not yet assigned