Skip to end of banner
Go to start of banner

Notes on Customizing Default MARC-Inventory Maps and Release Updates

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

The default mappings for MARC Bibliographic-to-Inventory Instance have been in place for some time. However, those default mappings usually will have at least one or two updates in each FOLIO release. Details of those updates are documented in the relevant Release Notes. 

Individual FOLIO libraries will often customize the default mappings. After a library upgrades to the next FOLIO release, staff are encouraged to review the existing customized map, plus any changes to the default map. During upgrade, the library's customized map is not changed by the system or any upgrade scripts.

For example:

  • Library A is on Juniper and has made some changes to the default MARC Bib-to-Inventory Instance map, e.g.
    • They created another Instance Identifier type and mapped the data from 902$a to that Identifier and Identifier type.
    • They mapped 595$a to an Instance note field with type General note.
  • The Kiwi release happens, and it includes some updates to the default mappings for some Instance Identifier types.
  • When Library A migrates to Kiwi, the updated default map DOES NOT affect the library's customized map.
  • If Library A wants to include the new default mappings in their custom mapping, they must
    • Review the default mapping updates that are documented in the Kiwi release notes
    • Manually update the library's customized map to add any of those new defaults they want to include
  • Updating the library's customized map does not automatically trigger a refresh of the library's Instances. For example, if the updated map has additional differentiation for the MARC 024 field, those changes do not automatically display in the Instance
  • After a map update, the library may want to refresh their Instances. Currently, there is not a formal script for refreshing Instances. For now, libraries may want to consider using a script written by Ian Walls, with a few caveats:
    • That code can be found at https://gist.github.com/sekjal/b1065f0483ee18c65b79d3d6560996ed. 
    • It's not exactly ready-to-roll right out of the box, unless you're using OpenFaaS, but the basic code or technique can be adapted. 
    • It's slow (one record at a time), but can safely be run during working hours if you keep the parallelism under 3

If a library wants to restore the default mappings at any time (and remove any customizations), they can use an endpoint that allows for that (hit PUT on /mapping-rules/{recordType}/restore) . Note that this action deletes any local customizations a Library may have added to the default map.


  • No labels