Versions Compared

Key

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

...

This is not intended to be a complete introduction to reference data. It is aimed at providing a list of reference data decisions that should be made prior to migration and documenting the order in which records should be migrated from legacy systems. Also, because this list is based on Texas A&M University's (TAMU) migration, it is not exhaustive, because as TAMU did not migrate all possible record types from its previous system.

...

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)
    • settings/inventory instances section (optional)
    • settings/inventory/ instances, 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:
    • 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 Holdings section (optional)
    • settings/inventory/ instances, 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
    • settings/inventory/loantypes (required),
    • settings/inventory/materialtypes (required),
    • settings/inventory Items section (optional)
    • settings/inventory/ instances, holdings, items section statistical code types, statistical codes (optional)
  • Data records:
    • instances (required)
    • holdings and their prerequisites (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:
    • settings/users/groups (required)
    • 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 and their prerequisites (required)
    • instances, 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.

Also for migration, institutions may choose to use storage endpoints or business logic endpoints to migrate loans. See Considerations for migrating loans for a comparison and contrast of these approaches and links to the relevant schema definitions.

requests (recall/hold/page)requests
  • Data records:
    • instances, holdings, items and their prerequisites (required)
    • users and their prerequisites (required)
    • loans and their prerequisites (required)

https://s3.amazonaws.com/foliodocs/api/mod-circulation/p/circulation.html#circulation_requests_post

https://s3.amazonaws.com/foliodocs/api/mod-circulation-storage/p/request-storage.html#request_storage_requests_post

Institutions have differed in their approach to migrating requests, some choosing to use business logic modules and others choosing storage modules. Both schema urls are listed for that reason.
fees and fines
  • Reference records:
    • settings/users/owners (optional)
    • settings/users/feefinestable (optional)
  • Data records:
    • users and their prerequisites (required)
    • instances, holdings, items and their prerequisites (required)

https://s3.amazonaws.com/foliodocs/api/mod-feesfines/p/accounts.html#accounts_post

https://s3.amazonaws.com/foliodocs/api/mod-feesfines/p/feefineactions.html#feefineactions_post

  • The settings/users/owners and settings/users/feefinestable must be set up if the institution chooses to migrate existing fees/fines as "not automatic" i.e. manual.
  • Institutions have taken different approaches to migrating fees and fines, some creating only account records and others creating account records plus feefineaction records


contacts (organizations)organizations
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:
    • 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: 
    • settings/tenant-settings/location-institutions (required)
    • settings/tenant-settings/location-campuses (required)
    • settings/tenant-settings/location-libraries (required)
    • settings/tenant-settings/servicePoints (required)
    • settings/acquisition-units required if orders/financials must be separated/permissioned differently for different users within the same tenant
  • Data records:
    • instances (optional)
    • organizations (vendors) (required)
    • finance structure (optional)
Schema: https://s3.amazonaws.com/foliodocs/api/mod-orders/p/order.html#orders_composite_orders_post
piecesreceiving
  • Data records
    • purchase orders
https://s3.amazonaws.com/foliodocs/api/mod-orders/p/pieces.html#orders_pieces_post

"Pieces" records may be created to contain loose issues that have been checked in but not yet bound and therefore lack an item record in inventory. The piece record requires a uuid link to the titleId that appears in the po line, but that uuid doesn't exist until the purchase order and its lines are POSTed to the /orders/composite-orders endpoint, so it's necessary to post the order po lines and get the title ids before creating the piece records.

As an alternative to creating piece records, some institutions have chosen to update the "receivingHistory" data element in the inventory holdings record to contain information about loose issues.

...