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.
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 |
|
| 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 |
| Institutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor. | |
| items | inventory |
| Schema: https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/item-storage.html#item_storage_items_post | Institutions may wish to identify records with statistical codes for a variety of reasons. Example: recording multiple item statuses from a previous system |
| users | users |
| Schema: https://github.com/folio-org/mod-user-import/blob/master/ramls/schemas/userdataimport.json | |
| proxies | users |
| Schema: https://s3.amazonaws.com/foliodocs/api/mod-users/p/proxiesFor.html#proxiesfor_post | |
| loans |
| 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 |
| https://s3.amazonaws.com/foliodocs/api/mod-circulation/p/circulation.html#circulation_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 |
| The settings/users/owners and settings/users/feefinestable must be set up if the institution chooses to migrate existing fees/fines as "not automatic". | ||
| contacts (organizations) | organizations | Schema: https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/contact.html#organizations_storage_contacts_post |
| |
| organizations | organizations |
| Schema: https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/category.html#organizations_storage_categories_post |
|
| purchase orders | orders |
| Schema: https://s3.amazonaws.com/foliodocs/api/mod-orders/p/order.html#orders_composite_orders_post |
Reference data
...
(elements are grouped by the url in the settings app and then listed alphabetically)
Data element (relative to base url for instance) | Description | Prerequisites | Schema | Notes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| settings/ | tenant-settings/addressesused in purchase orders for Bill to and Ship to addresses. | https://calendar | sets the normal opening and closing hours of a given service point as well as exceptions to normal hours. | settings/tenant-settings/servicePoints | https://s3.amazonaws.com/foliodocs/api/mod- | configurationcalendar/p/ | config.html#configurations_entriescalendar.html#calendar_periods__servicepointid__period_post | settings/users/addresstypes | used in user records to identify type of address. Local tenant may wish to delete default address types provided with FOLIO. | https://s3.amazonaws.com/foliodocs/api/mod-users/p/addressTypes.html#addresstypes_post | settings/calendar | sets the normal opening and closing hours of a given service point as well as exceptions to normal hours. | settings/tenant-settings/servicePointsAs of the Honeysuckle release, circulation staff have experienced problems editing calendars in the settings UI. Institutions may wish to fill out the hours in a json record and post the calendar to the appropriate endpoint. |
| settings/circulation/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. | https://s3.amazonaws.com/foliodocs/api/mod- | calendarcirculation-storage/p/ | calendar.html#calendar_periods__servicepointid__period_postAs of the Honeysuckle release, circulation staff have experienced problems editing calendars in the settings UI. Institutions may wish to fill out the hours in a json record and post the calendar to the appropriate endpoint. | settings/inventory/callNumberTypes | used in inventory holdings records to identify type of call number. 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. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/call-number-type.html#call_number_types_post | settings/organizations/category (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. | https://s3.amazonaws.comloan-policy-storage.html#loan_policy_storage_loan_policies_post | |||
| settings/circulation/rules | used in circulation to determine combination of policies that apply to a given circulation situation. |
| https://s3.amazonaws.com/foliodocs/api/mod- | organizations-storagecirculation/p/ | categorycirculation-rules. | html#organizationshtml#circulation_ | storagerules_ | categories_postsettings/tenant-settings/location-campuses | used in inventory holdings & item records to identify 2nd level in location hierarchy. |
| https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/locationunit.html#location_units_campuses_post | ||
| settings/circulation/rules | used in circulation to determine combination of policies that apply to a given circulation situation. |
| https://s3.amazonaws.com/foliodocs/api/mod-circulation/p/circulation-rules.html#circulation_rules_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/users/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 ownput | 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/callNumberTypes | used in inventory holdings records to identify type of call number. 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. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/call-number-type.html#call_number_types_post | |||||||||||
| 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. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/instance-format.html | Instructions on how to modify mapping rules are available at: How to work with mapping rules. | ||||||||||
| settings/inventory/holdingsTypes | 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'. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/holdings-type.html#holdings_types_post | |||||||||||
| settings/inventory/holdingsNoteTypes | 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". | https://s3.amazonaws.com/foliodocs/api/mod-inventory- usersgroups.html#groups | |||||||||||
| settings/inventory/holdingsTypesidentifierTypes | used in inventory holdings instance records to identify define 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'identifier. Local tenant may wish to define specific identifier type for USMARC field 001 to uniquely identify previous system record key. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/holdingsidentifier-type.html#holdingshtml#identifier_types_post | |||||||||||
| settings/inventory/ | holdingsNoteTypesresourcetypes | 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"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'. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/ | holdingsinstance- | note-type. | html#holdings_notehtml#instance_types_post | |||||||
| settings/inventory/ | identifierTypesloantypes | used in inventory instance records to define type of identifieritem records as one of several elements that determine appropriate loan policy. Local tenant may wish to define specific identifier type for USMARC field 001 to uniquely identify previous system record keydelete default loan types provided with FOLIO. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/ | identifierloan-type. | html#identifierhtml#loan_types_post | ||||||||
| settings/inventory/formatsmaterialtypes | required element used in inventory instance item 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. the item's type of material. Can be used as a defining data element in circulation-rules. Local tenant may wish to delete default material-types provided with FOLIO. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/instance-format.htmlInstructions on how to modify mapping rules are available at: How to work with mapping rules.material-type.html#material_types_post | |||||||||||
| settings/ | inventory/resourcetypesorganizations/category (organizations) | used in | inventory instanceorganization 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'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. | https://s3.amazonaws.com/foliodocs/api/mod- | inventoryorganizations-storage/p/ | instance-type.html#instance_typescategory.html#organizations_storage_categories_post | ||||||
| settings/tenant-settings/ | location-institutionsaddresses | used in | inventory holdings & item records to identify top level in location hierarchypurchase orders for Bill to and Ship to addresses. | https://s3.amazonaws.com/foliodocs/api/mod- | inventory-storageconfiguration/p/ | locationunitconfig. | html#locationhtml#configurations_ | units_institutionsentries_post | |||||
| settings/tenant-settings/location- | librariescampuses | used in inventory holdings & item records to identify | 3rd2nd level in location hierarchy. |
| institutionssettings/tenant-settings/campuses
| https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/locationunit.html#location_units_ | librariescampuses_post | ||||||
| settings/circulation/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 migrationtenant-settings/location-institutions | used in inventory holdings & item records to identify top level in location hierarchy. | https://s3.amazonaws.com/foliodocs/api/mod-circulationinventory-storage/p/loan-policy-storage.html#loan_policy_storage_loan_policieslocationunit.html#location_units_institutions_post | ||||||||||
| settings/ | inventory/loantypestenant-settings/location-libraries | used in inventory | item records as one of several elements that determine appropriate loan policy. Local tenant may wish to delete default loan types provided with FOLIO.holdings & item records to identify 3rd level in location hierarchy. |
| https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/ | loan-type.html#loan_typeslocationunit.html#location_units_libraries_post | |||||||
| settings/tenant-settings/location-locations | used to identify shelf locations in inventory holdings & item records. |
| https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/location.html#locations_post | ||||||||||
| settings/ | inventorytenant-settings/ | materialtypesservicePoints | required element used in item records to identify the item's type of material. Can be used as a defining data element in circulation-rules. Local tenant may wish to delete default material-types provided with FOLIOused 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'. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/ | materialservice- | typepoint. | html#materialhtml#service_ | typespoints_post | |||||
| settings/tenant-settingsusers/servicePointsaddresstypes | used | primarilyin | circulation appsuser records to identify | points where circulation actions take place.type of address. Local tenant may wish to delete default | service pointsaddress types 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'. | https://s3.amazonaws.com/foliodocs/api/mod-users/p/addressTypes.html#addresstypes_post | ||||||
| settings/users/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. | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storageusers/p/service-point.html#service_pointsgroups.html#groups_post | |||||||||||