API reference documentation for all modules located at: https://dev.folio.org/reference/api/Links to PO documentation for data elements
(need 'browse data element; cannot complete without it)
Voyager report example: https://docsdrive.google.com/spreadsheetsfile/d/1B924D2JaFUc6dqgItyKoOFdhn36lxwT6jaYmKpyk2Ws/edit#gid=1697459676
Voyager report example: Missing Items - OKU 10.10.18-10.23.18.pdf
*Report needed in order to withdraw missing items
*Inform replacement decisions
*need to know what is missing in order to replace, purchase items; ability to get circulation informatio
*Reports items that were discharged at a circulation desk other than their "home" circulation desk and haven't yet been discharged at home. Therefore the items might have been lost or misplaced on their way back to their home location1d_7VCaav5kE39Fnw3mudWQAfbi8rD3Io/view
*Number of print serials circulated or browsed by patrons.
*Reports needed by selectors for collection development/collection management decisions.
Report Description Detail
- This report is modeled on ID464 (REP-152), a monthly report listing all lost or/and missing items, and ID472 (REP-190), a daily missing-in-transit report UXPROD-2031, a cluster of resource access reports consisting of two reports: REP-135 (serials with usage by library) and REP-110 (reference library use).
Data fields
- Item status, status date, item notes and note type, item call number and ID, all item descriptors (call number, barcode, title, etc.), material type details, location fields, circ desk where discharged, home circ desk, date discharged
Report Criteria
- Within a specified date range, provides listing of items lost and/or missing by location, and of items lost in transit from one library location to another, along with details of the item (title, barcode, publisher, date when it entered the system, etc.), date it was discharged (if lost in transit) and item circulation stats (count of historical charges within a specified date range).
Filters
- Date range, status type (either lost or missing), missing in transit (if the loan has been discharged but the item has not been received at the home location within a specified period of time)Date range (as filter), BibID, HoldingsID, Title, Call Number, Library Location, Material type, issues available, volume count, 852z notes, Circulation counts *item holding location needed for circulation counts for particular library
Report Criteria
- Serials materials, with or without 852$z notes, with total circulation and browse counts at the end of the semester.
- Notes field describes if a serial is cancelled, available in print or electronic, when the subscription was cancelled etc. This is free form notes.
- Date range, material type (serials), circulation counts.
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query | |||||
|---|---|---|---|---|---|---|---|
| Table name: mod-inventory-storage/item-storage/items | |||||||
| Item ID (mod-inventory-storage/item-storage/items/ID) | The inventory ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-circulation-storage/loan-storage/loans | |||||
| Item holdings record ID (mod-inventory-storage/item-storage/items/holdingsRecordID) | The holdings record ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/holdings-storage/holdings | |||||
| Item Location (mod-inventory-storage/item-storage/items/permanentLocationID) | Item's permanent location ID | Needed to pull in 'name' element from mod-inventory-storage/locations, as searches for missing items are done by specific location, and all location fields need to be included | |||||
| Item Location mod-inventory-storage/item-storage/items/temporaryLocationID) | Item's temporary location ID | Needed to pull in 'name' element from mod-inventory-storage/locations, as searches for missing items are done by specific location, and all location fields need to be included | |||||
| Transit Destination Service Point ID (mod-inventory-storage/item-storage/items: inTransitDestinationServicePointID) | Service point ID where an item is intended to be transited to | Provides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/service-point/service-points | |||||
| Item Barcode (mod-inventory-storage/item-storage/items/barcode) | The barcode of the item | Needed for item search/replacement | |||||
Item Call Number (mod-inventory-storage/item-storage/items/itemLevelCallNumber) | The call number of the item | Needed for item search/replacement | |||||
Item Volume Number (mod-inventory-storage/item-storage/items/itemVolumeNumber) | Used for a multipart monograph | Needed for item search/replacement | |||||
Material Type ID (mod-inventory-storage/item-storage/items/materialTypeID) | ID of the material type | ||||||
| Item Needed for item search/replacement | |||||||
Item Status (mod-inventory-storage/item-storage/items/status:name) | The item's status (e.g. Available, Checked out, Lost/missing, etc.) | Where status.name="Lost" or "Missing" OR where status.name="In transit" | The date an item was flagged as "Lost" or "Missing" | For missing/lost items:This data element provides the main filter point for this report (where statusDate Between [start] And [end]). For items missing in transit: where today's date minus statusDate is greater than a specified period, e.g, 5 days | |||
items with serials material type | |||||||
| Item Enumeration (mod-inventory-storage/item-storage/items/enumeration) | Item enumerator (e.g., vol. 1, No. 2, etc.) | Needed for item search/replacementcirculation and browse count | |||||
| Item Chronology (mod-inventory-storage/item-storage/items/chronology) | Descriptive information for the dating scheme of a serial | Needed for item search/replacementcirculation and browse count | |||||
Item Copy Number (mod-inventory-storage/item-storage/items/copyNumbers) | Item copy number (e.g., copy 1, copy 2, etc.) | Needed for item search/replacement Item note (mod-inventory-storage/item-storage/items/notes: description) | Notes about the item | The item notes field may contain information that could be useful for an item search. All notes associated with an item should be included. | circulation and browse count | ||
| Table name: mod-inventory-storage/holdings-storage/holdings | |||||||
| Item holdings ID (mod-inventory-storage/holdings-storage/holdings/ID) | The holdings ID of the item | Provides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/item-storage/items. | |||||
| Item Location (mod-inventory-storage/holdings-storage/holdings/permanentLocationID) | Item's permanent holdings location ID | Needed to pull in 'name' element from mod-inventory-storage/locations, as searches for missing items are done by specific location, and all location fields need to be includedItem Location (mod-inventory-storage/holdings-storage/holdings/temporaryLocationID) | |||||
| Item 's temporary holdings location ID | Needed to pull in 'name' element from mod-inventory-storage/locations, as searches for missing items are done by specific location, and all location fields need to be included | Item Title (mod-inventory-storage/holdings-storage/holdings/shelvingTitle) | The title of the lost/missing item | Needed for item search/replacement | |||
| Instance ID (mod-inventory-storage/holdings-storage/holdings/InstanceID) | The instance ID of the item | Provides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/instance-storage/instances. | Table name: (mod-circulation-storage/loan-storage/loans | ||||
| Item checkout location (mod-circulation-storage/loan-storage/loans/itemEffectiveLocationAtCheckOut) | Location from where item was checked out | (not sure if this is needed for this report) | |||||
| loan ID (mod-circulation-storage/loan-storage/loans/id) | Loan ID | Needed to count the number of unique loans, to calculate historic charges | |||||
| loan renewal count (mod-circulation-storage/loan-storage/loans/renewal count) | Number of times an item loan has been renewed | Needed to add to the count of unique loan ids to calculate historic charges | |||||
| Item ID (mod-circulation-storage/loan-storage/loans/itemId) | The UUID of the item | Provides a join point between mod-circulation-storage/loan-storage/loans and mod-inventory-storage/item-storage/items | |||||
| Table name: mod-inventory-storage/instance-storage/instances | ID (mod-inventory-storage/instance-storage/instances/ID) | The instance ID of the item | Provides a join between (mod-inventory-storage/instance-storage/instances and Holding Notes (mod-inventory-storage/holdings-storage/holdings | ||||
Date of Publication (mod-inventory-storage/instance-storage/instances/publication:dateOfPublication) | Date (year YYYY) of publication, distribution, etc. | Needed for item search/replacement | |||||
| Item Record Date (mod-inventory-storage/instance-storage/instances/cataloguedDate) | Date item record was created (date the item first entered the system after being acquired) | Needed for item search/replacement/notes:HoldingNotesTypeID | notes on the holdings | to view 852 $z notes | |||
| Table name: mod-inventory-storage/material-types | |||||||
| (mod-inventory-storage/material-types/ID) | The material type ID of the item | Provides a join between mod-inventory-storage/material-types and mod-inventory-storage/item-storage/items | |||||
| Material Type Name (mod-inventory-storage/material-types/name) | Name of the material type (e.g., book, DVD, etc.) | Needed for item search/replacement | |||||
| Table name: mod-inventory-storage/locations | |||||||
| Location name (mod-inventory-storage/locations/name) | Name of location | For both reports, this provides a filter, as searches for missing items are done by specific location. | |||||
| Location ID (mod-inventory-storage/locations/ID) | ID of the location | Provides a join between mod-inventory-storage/locations and mod-inventory-storage/item-storage/items | |||||
| Table name: modloan-inventory-storage/service-point/service-points | Transit Destination Service Pointloans/loans | ||||||
| Loan ID (mod-inventorycirculation-storage/serviceloan-pointstorage/service-pointsloans:IDid) | ID of the (transit destination) service point | Provides a join between mod-inventory-storage/service-point/service-points and mod-inventory-storage/item-storage/items | |||||
| Transit Destination Service Point Name (mod-inventory-storage/service-point/service-points: name) | name of the (transit destination) service point | Needed for lost in transit report, in case the item was incorrectly routed |
Comments from Angela:
...
| UUID generated by a loan (identifies a specific circulation transaction) | This element will be counted to generate the number of transactions (COUNT(id)). Note: want to count Loan ID for checkouts only. | ||
| Loan Date (mod-circulation-storage/loan-storage/loans: |
...
| loanDate) | The date an item was loaned | This data element can be used to filter the report to a date range (where loanDate Between [start] And [end]). It is also used for the date aggregation (to weeks or days/hours). Will also need to (automatically) calculate day of week from this value. Note: this field is stored as a string but should follow a standardized datetime format (RFC3339 / ISO 8601 date and time). From Marc Johnson: "It should be relatively unlikely [to introduce an error]. Clients which interact with the storage module directly could. With the typical circulation flow it should not be possible" | ||
| Item ID (mod-circulation-storage/loan-storage/loans:itemId) | Unique ID of the item lent to the patron | Provides a join point between mod-circulation-storage/loan-storage/loans and mod-inventory-storage/item-storage/items. |
Notes:
/*Browse counts for this report are not available yet, will need to be added/
/*Report can be adapted for electronic materials as well by bringing in "form of item"?/