Library Data Documentation
THIS DOCUMENTATION WAS INTENDED FOR THE STAR-BASED SCHEMA OF THE LDP, AND IS NOT CURRENTLY VALID.
NOTES:
- The correct term in FOLIO for each piece of data is 'attribute'.
- This documentation will contain attribute descriptions, including concepts defined in an unambiguous way. For example, what does the term 'effective location' mean? We need to decide on a single definition so we are all clear about what exactly it refers to (is it the location from where the item is currently being checked out?).
- After this documentation has been reviewed by the LDP Report Working Group (and others), the attribute descriptions will be imported into the database. The LDP schema will then also serve as the "data dictionary" for the LDP, as it will contain information about each attribute, such as type (numerical or character), relationships (including key attributes that connect tables/modules), and detailed descriptions of each attribute.
- Currently, the EXCEL file containing the documentation only includes those attributes which are already in the LDP schema, and will expand as more data are loaded into the LDP.
EXAMPLE FROM DATA DOCUMENTATION FILE:
Please review and add your notes to the data documentation EXCEL file, which is on the Reporting SIG's Google drive. The aim is to formulate clear, unambiguous and concise descriptions that can be used by all, including those who have no prior experience with library-related data.
Help is specially needed with attributes marked in red.
| Attribute | Description |
|---|---|
| item_key | Primary key linking item to other tables such as loans tables |
| item_id | FOLIO ID of the item |
| shelving title | Is this the same as item title in the API? |
| barcode | Links the item to its record in the catalog - does this mean it links to item_id? (is this the same for all libraries?) |
| item_level_call_number | How exactly is this different from call_number? Does it include extra information that is not part of the regular call number system ? |
| call_number | Unique 'address' of an item, showing where the item is located. Different systems of call numbers usually include date of publication, subject area code, author's last name, etc. Most commonly used ones in the U.S. are the Library of Congress and the Dewey Decimal systems. |
| status_name | The current status of the item, such as 'available', 'on hold', 'lost', 'missing', etc. (Is this the same as status_type in the API documentation? In that case, we need another attribute that records the date of each status_name change. If that is record_effective, then we need an attribute for the date the item entered the system.) |
| enumeration | "Data indicating the sequential numeric and/or alphabetic designation used by the publisher of the serial to identify the individual bibliographic or physical parts and to show the relationship of each part to the bibliographic unit as a whole."(Yale cataloging) Can include volume number, series number, etc. |
| copy_numbers | As there can be multiple copies of the exact same item, this gives the copy number (eg, 2nd of 5 copies) |
| material_type_name | The item's material type, such as paper book, ebook, map, laptop, etc. |
| record_effective | The date when the item was entered into the Library's catalog system |