Versions Compared

Key

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

...

Data record

Application

Prerequisite reference data or other data records (settings/... entries are relative to FOLIO baseurl)

Schema or other documentation

Notes

instancesinventory
  • Reference data
    • MARC bib-to-Instance map (optional; if desired to change default marc-to-instance mapping for all MARC records)
    • FOLIO baseurl/settings/inventory instances section (optional)
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)
https://github.com/folio-org/mod-source-record-manager/blob/master/mod-source-record-manager-server/src/main/resources/rules/rules.jsonInstitutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor.
holdingsinventory
  • Reference data:
    • full location hierarchy (institutions/campuses/libraries/locations) (required)
    • service points settings/tenant-settings/location-institutions (required)
    • settings/tenant-settings/location-campuses (required)
    • settings/tenant-settings/location-libraries (required)
    • settings/tenant-settings/servicePoints (required)
    • FOLIO baseurl/settings/inventory Holdings section (optional)
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)
  • Data records
    • instances (required)
Institutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor.
itemsinventory
  • Reference data
    • full location hierarchy (institutions/campuses/libraries/locations) (required)
    • service points (required),
    • loan-types settings/tenant-settings/location-institutions (required)
    • settings/tenant-settings/location-campuses (required)
    • settings/tenant-settings/location-libraries (required)
    • settings/tenant-settings/servicePoints (required)
    • settings/inventory/loantypes (required),
    • material-types settings/inventory/materialtypes (required),
    • FOLIO baseurl/settings/inventory Items section (optional)
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)
  • Data records: instances, holdings (both required)
Schema: https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/item-storage.html#item_storage_items_postInstitutions may wish to identify records with statistical codes for a variety of reasons. Example: recording multiple item statuses from a previous system
usersusers
  • Reference data:
    • groups settings/users/groups (required)
    • addresstypes settings/users/addresstypes (required)
Schema: https://github.com/folio-org/mod-user-import/blob/master/ramls/schemas/userdataimport.json


proxiesusers
  • Data records: users (required)
Schema: https://s3.amazonaws.com/foliodocs/api/mod-users/p/proxiesFor.html#proxiesfor_post
loans
  • Reference data:
    • settings/tenant-settings/servicePoints
    • settings/calendar
    • settings/circulation/loan policies
    • settings/circulation/request policies
    • settings/circulation/notices policies
    • settings/circulation/overdue fine policies
    • settings/circulation/lost item fee policies
    • settings/circulation/patron-notices
    • settings/circulation/rules
  • Data records:
    • users (required)
    • instance, holdings, items and their prerequisites (required)

For migration purposes, calendar begin and end dates must include the earliest loan to be migrated and the latest possible due date based on loan policy.
contacts (organizations)organizations
  • Reference data: categories
    • settings/organizations/category (optional)
Schema: https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/contact.html#organizations_storage_contacts_post
  • urls in the contact record must begin with 'http://' or 'https://', otherwise the record will be rejected as invalid.
organizationsorganizations
  • Reference data:
    • categories settings/organizations/category (optional),
  • Data records: contacts (optional)
Schema: https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/category.html#organizations_storage_categories_post
  • urls in the organizations record must begin with 'http://' or 'https://', otherwise the record will be rejected as invalid.
purchase ordersorders
  • Reference data:
  • full location hierarchy (institutions/campuses/libraries/locations)
  • service points (required), addresses 
    • settings/tenant-settings/location-institutions (required)
    • settings/tenant-settings/location-campuses (required)
    • settings/tenant-settings/location-libraries (required)
    • settings/tenant-settings/servicePoints (required)
  • Data records:
    • instances (optional)
    • organizations (vendors) (required)
    • finance structure (Ledgers, FY, Funds, Budgets required, Fund groups and expense classes optional)
    • acquisitions units required settings/acquisition-units required if orders/financials must be separated/permissioned differently for different users within the same tenant
Schema: https://s3.amazonaws.com/foliodocs/api/mod-orders/p/order.html#orders_composite_orders_post

...