Data element
Description
Settings url in the UI (relative to base url for instance)
API endpoint for post
Schema
Prerequisites
...
Scope
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, as TAMU did not migrate all possible record types from its previous system.
Data records – Prerequisite reference data/data records, other instructions
Data record | Application | Prerequisite reference data or other data records (settings/... entries are relative to FOLIO baseurl) | Schema or other documentation | Notes |
|---|
| instances | inventory | - 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.json | Institutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor. |
| holdings | inventory | - 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
| |
configurationconfig.html#configurations_entriesaddresstypes | used in user records to identify type of address. Local tenant may wish to delete default address types provided with FOLIO. | settings/users/addresstypes | addresstypes | addressTypeshtml#addresstypescall-number-types | used in inventory holdings records to identify type of call number. As of Q4 2019, the default reference data does not include a call-number-type for 'blank' as defined by MARC 852 indicator 1. Local tenants may need to add the 'blank' value for migration purposes. | settings/inventory/callNumberTypes | call-number-types |
|
| 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- |
inventorycallnumber-typehtml#callnumbertypes_postcategories (organizations) | used in organization records to identify classes of data, such as addresses, emails, urls, etc. Local tenant may wish to delete default categories provided with FOLIO, using the Settings/organizations/category page in the UI. | settings/organizations/category | organizations-storage/categories | used in inventory holdings & item records to identify 2nd level in location hierarchy.campuses | - urls in the organizations record must begin with 'http://' or 'https://', otherwise the record will be rejected as invalid.
|
| purchase orders | orders | - 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
|
/campuses- 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- |
inventory-storagelocationunithtml#locationunitscampusesinstitutions | circulation-rules | used in circulation to determine combination of loan policy and notice policies that apply to a given circulation situation. | settings/circulation/rules | circulation-rules-storage |
|
| pieces | receiving | | 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. |
Reference data (elements are grouped by the url in the settings app and then listed alphabetically)
circulationruleshtmlloan policies
request policies
notices policies
overdue fine policies
lost item fee policies | groups | used in user records to identify patron groups. As of Q4 2019, the system loads reference data for groups, so local tenants will probably want to delete those groups before creating their own. | settings/users/groups | groupsusersgroups.html#groupsholdings-typesholdings-types | used in inventory holdings records to identify type of holdings record. If the local tenant wishes to base their holdings-types codes on USMARC holdings records leader/06, then they will have to create an additional holding type for 'unknown'. | settings/inventory/holdingsTypes | inventoryholdingstype.html#holdings_types_postholdings-note-types | used in inventory holdings records to identify types of note included in the record. Can be used, for instance, to define a type of note that contains "Latest volume or edition in alternate location". | settings/inventory/holdingsNoteTypes | holdings-note-typesinventory-storageholdingsnote-typehtml#holdingsnotetypes_postidentifier-types | used in inventory instance records to define type of identifier. Local tenant may wish to define specific identifier type for USMARC field 001 to uniquely identify previous system record key| put | Rules can be created through the Settings/Circulation/Circulation rules UI or by "putting" a text file to the endpoint. Local tenants with complex circulation rules may find it more convenient to update rules via the text file, although that method requires substituting uuids for text labels. When PUTting the text file to the /circulation/rules endpoint, do not include the uuid in the file. |
| settings/inventory/ |
identifierTypesidentifier-typesidentifierhtml#identifierinstance-| As of Honeysuckle release, the default reference data does not include a call-number-type for 'blank' as defined by MARC 852 indicator 1. Local tenants may need to add the 'blank' value for migration purposes. |
| settings/inventory/formats | used in inventory instance records to identify record format. Identified in the inventory instance record UI and Settings/Inventory UI as "formats". If instance record is created via Data Import of a MARC record, format is assigned by mapping the MARC field 338 subfield $b. Default list provided in FOLIO based on RDA carrier type codes and names |
. Local tenant may wish to add instructions to default mapping rules to create instanceFormatIds in instance records where MARC source records lack 338 fields, basing the codes on field 007 values. /formatsinstance-formatsinstance-format.htmlinstance-types | holdings-note-type.html#holdings_note_types_post | Can be used, for instance, to define a type of note that contains "Latest volume or edition in alternate location". |
| settings/inventory/identifierTypes | used in inventory instance records to define type of identifier. |
| https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/identifier-type.html#identifier_types_post | Local tenant may wish to define specific identifier type for USMARC field 001 to uniquely identify previous system record key. |
| settings/inventory/resourcetypes | used in inventory instance records to identify record type. Identified in the inventory instance record UI and Settings/Inventory UI as "resource type". If instance record is created via Data Import of a MARC record, instance-type is assigned by mapping the MARC field 336 subfield $b. Default list provided in FOLIO based on RDA content type codes and names. If the MARC record lacks field 336 subfield $b, the instance record is assigned a default instance-type of 'unspecified'. |
settings/inventory/resourcetypes | instance-types | instancehtml#instanceinstitutions | used in inventory holdings & item records to identify top level in location hierarchy. | settings/tenant-settings/location-institutions | location-units/institutionslocationunit.html#location_units_institutions_postlibraries 3rd | 2nd level in location hierarchy. | - settings/tenant-settings/location-
|
librarieslocation-units/librarieslibrariesinstitutions campuses | loan-policies | used in circulation module to define basic loan/renewal/recall configuration. If the local tenant wishes to migrate retrospective loans to FOLIO and link them to existing policies and rules, loan-policies must be created before migration. | settings/circulation/loan-policies | loan-policy-storage/loan-policiescirculationloan-policy-storage.html#loan_policy_storage_loan_policies_postloan-types and circulation rules to determine appropriate loan policy. Local tenant may wish to delete default loan types provided with FOLIO.settings/inventory/loantypes | loan-typesloan-type.html#loan_types| locationunit.html#location_units_libraries_post |
|
| settings/tenant-settings/location-locations | used to identify shelf locations in inventory holdings & item records. | - settings/tenant-settings/location-institutions
- settings/tenant-settings/location-campuses
- settings/tenant-settings/location-
|
locationslocationsservice-pointsinstitutions campuses libraries service points | | Location codes and location names must be unique within a tenant. For example, if the "main" library and "science" 2 each has a reference section, those locations cannot use the location code 'ref' even though the upper levels of the hierarchy identify the location uniquely. One would have to be 'mainref' and the other 'sciref'. |
| settings/tenant-settings/servicePoints | used primarily in circulation apps to identify points where circulation actions take place. Local tenant may wish to delete default service points provided with FOLIO. As of Q4 2019, the local tenant will apparently have to do the delete using a curl command or other script that deletes from the API endpoint, as there doesn't appear to be a delete function for these in the Settings/Tenant/Service Points UI. Also, although the options to print slips at a specific Service Point appear to be selected by default, they do not become active unless Pickup location is set to 'Yes'. |
settings/tenant-settings/servicePoints | service-points | Data record | Application | Prerequisite reference data or other data records | API endpoint for post | Schema | Notes |
|---|
holdings | inventory | full location hierarchy (institutions/campuses/libraries/locations) and service points (required), call-number-types (required), holdings-types (required), holdings-type-notes (optional). | holdings-storage/holdings Data records – Prerequisite reference data/data records, other instructions
inventory-storageholdings-storage.html#holdings_storage_holdingsinstance-storage/instances| instances | inventory | instance-types (required if loading through Data Import), formats (optional) | | settings/users/feefinestable | defines manual (as opposed to automatic) charges that can be created in the system. Users can set default amount charged, default charge notice, and default action notice. | | https://s3.amazonaws.com/foliodocs/api/mod- |
inventory-storageinstance-storage.html#instance_storage_instancesitem-storage/itemsitems | inventory | full location hierarchy (institutions/campuses/libraries/locations) and service points (required), loan-types (required), material-types (required), statistical-code-types (optional), statistical-codes (optional) | inventory-storageitem-storage.html#item_storage_items_postorganizations | organizations | categories (optional), contacts (optional) | organizations-storage/categories | https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/category.html#organizations_storage_categories_post | proxies | users | users (required) | proxiesfor | https://s3.amazonaws.com/foliodocs/api/mod-users/p/proxiesFor.html#proxiesfor_post | purchase orders | orders | full location hierarchy (institutions/campuses/libraries/locations) and service points (required), instances , organizations (vendors), addresses | orders/composite-ordersordersorder.html#orders_composite_orders tenant may wish to use the user schema and endpoints instead.users | users | groups (required), addresstypes (required) | user-import | https://github.com/folio-org/mod-user-import/blob/master/ramls/schemas/userdataimport.json | as of 202001, latest commit to this repository was made in 201801. The schema is out of date with the user schema, so the local | Fee/fine "manual charges", "payment methods", and "transfer accounts" are differentiated by fee/fine owner |