RA-ACRL Circulation
- Angela Zoss (Old)
About the ACRL Reports
API reference documentation for all modules located at: https://dev.folio.org/reference/api/
Example of this report coming from Voyager (not yet available)
Report Description Detail
These reports are modeled on ID111 (Association of College and Research Libraries Reporting) and ID104 (Association of Research Libraries statistics). These reports also utilize elements of the ID433 (Circulation Report) and ID226 (E-Resource Counts for ARL, ACRL, NCES). These reports are used for pulling data that are reported on an annual basis to organizations such as the Association of College & Research Libraries (ACRL), the Association of Research Libraries (ARL), and the National Center for Education Statistics (NCES).
The manner in which these reports are constructed can vary greatly from one library to the next. Therefore, a host of filter-point data elements must be included here in support of the widest variety of need within the FOLIO community.
Report Criteria
- A sum of total volumes
- A sum of total titles, broken down into the categories of "tangible" and "electronic."
- A sum of total expenditures, broken down into the categories of "one-time" and "ongoing."
Circulation
The ACRL statistical survey asks for an accounting of initial circulation transactions. "Initial circulation" includes charges only (no renewals). Depending on the situation, libraries may need to filter these transactions by location or the item-based material type. This query provides for such filtering.
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query |
|---|---|---|
| Loan ID (mod-circulation-storage/loan-storage:id) | UUID generated by a loan (identifies a specific circulation transaction) | Counting Loan IDs within a specified period is how initial circulation is tabulated for that period. |
| Loan Date (mod-circulation-storage/loan-storage/loans:loanDate) | The date an item was loaned | This data element provides the main filter point for this report (where loanDate Between [start] And [end]) |
| Item ID (mod-circulation-storage/loan-storage/loans:itemId) | UUID for a specific loaned item | Provides a join point between mod-circulation-storage and mod-inventory-storage. Connects with: mod-inventory-storage/item-storage/items:id This join makes additional filtering possible (e.g., by material type, location, etc.) |
| A library may count all loan IDs within a specific period to derive their initial circulation count. However, there may be instances where some filter mechanism must be used in order to select a subset of total initial circulation. In such cases, one may wish to filter out certain non-collection materials (e.g., markers, calculators, keys, etc.). There may also be a need for additional filtering by item location. Therefore, the following elements are being included in this report prototype to support this type of query refinement. | ||
Item ID (mod-inventory-storage/item-storage/items:id) * Notated as itemId in other branches of the module | UUID of the item record | Acts as the bridge between the circulation and collections modules. Provides a join point between mod-inventory-storage/item-storage/items and mod-circulation-storage/loan-storage/loans. Connects to: mod-circulation-storage/loan-storage/loans:itemId |
| Material Type ID (mod-inventory-storage/item-storage:materialTypeId) | UUID for a particular material type | Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/material-type - connects with: mod-inventory-storage/material-type:id |
Material Type Name (mod-inventory-storage/item-storage/material-types:name) | Label for the material type (e.g., "book") | Used to filter (if necessary) Provides a means to filter by material type. This element is pulled into the report using the materialTypeId found in mod-inventory-storage/item-storage. This element provides a human-readable material type that is easier to work than the materialTypeId, which takes the form of a long machine-readable UUID. |
Institution Location ID (mod-inventory-storage/location-units/institutions:id) * Notated as institutionId in other branches of the module | UUID for item location at the "institutions" level (i.e., highest location level). | Provides a join point between mod-inventory-storage/location-units/institutions and mod-inventory-storage/locations - connects with: mod-inventory-storage/locations:institutionId |
Campus Location ID (mod-inventory-storage/location-units/campuses:id) * Notated as campusId in other branches of the module | UUID for item location at the "campuses" level (i.e., second-highest location level). | Provides a join point between mod-inventory-storage/location-units/campuses and mod-inventory-storage/locations - connects with: mod-inventory-storage/locations:campusId |
Library Location ID (mod-inventory-storage/location-units/libraries:id) * Notated as libraryId in other branches of the module | UUID for item location at the "libraries" level (i.e., lowest location level). | Provides a join point between mod-inventory-storage/location-units/libraries and mod-inventory-storage/locations - connects with: mod-inventory-storage/locations:libraryId |
| Institution Location Name (mod-inventory-storage/location-units/institutions:name) | Name of item location at the "institutions" level (i.e., highest location level). | Used to filter (if necessary) Provides a means to filter by institutional location. This element provides a human-readable institutional location name that is easier to work than the institutionId, which takes the form of a long machine-readable UUID. |
| Campus Location Name (mod-inventory-storage/location-units/campuses:name) | Name of item location at the "campuses" level (i.e., second-highest location level). | Used to filter (if necessary) Provides a means to filter by campus location. This element provides a human-readable campus location name that is easier to work than the campusId, which takes the form of a long machine-readable UUID. |
| Library Location Name (mod-inventory-storage/location-units/libraries:name) | Name of item location at the "libraries" level (i.e., lowest location level). | Used to filter (if necessary) Provides a means to filter by library location. This element provides a human-readable library location name that is easier to work than the libraryId, which takes the form of a long machine-readable UUID. |
| Item Location (mod-inventory-storage/locations:name) | Location where the item is held. The name element can refer to the descriptive name of the item's location at any of the three location-unit levels currently defined within the system (i.e., institution, campus, library). | Used to filter (if necessary) Provides a means to filter by item location. The UUID provided by mod-inventory-storage/item-storage/items:permanentLocationId will determine what name is shown here. |
| Library Location Name (mod-inventory-storage/location-units/libraries:name) | Name of item location at the "libraries" level (i.e., lowest location level). | Used to filter (if necessary) Provides a means to filter by library location. This element provides a human-readable library location name that is easier to work than the libraryId, which takes the form of a long machine-readable UUID. |
Item Permanent Location ID (mod-inventory-storage/item-storage/items:permanentLocationId) | UUID for the item's permanent location. Note: The permanentLocationId is a UUID that can be used to designate a "permanent location" as defined within one of the system's three levels of locations (i.e., institution, campus, and library locations). *Needed to calculate Effective Location | Provides a join point between mod-inventory-storage/item-storage/items and mod-inventory-storage/locations. Connects with: mod-inventory-storage/locations:id At this time, the API documentation implies that an item location can be set to any location ID at any of the three location-unit levels (i.e., institution, campus, or library). |
| Item Temporary Location ID (mod-inventory-storage/item-storage/items:temporaryLocationId) | UUID for the item's temporary location. | Provides a join point between mod-inventory-storage/item-storage/items and mod-inventory-storage/locations. Connects with: mod-inventory-storage/locations:id |
| Item Location (mod-inventory-storage/locations:name) | Location where the item is held. The name element can refer to the descriptive name of the item's location at any of the three location-unit levels currently defined within the system (i.e., institution, campus, library). | Used to filter (if necessary) Provides a means to filter by item location. The UUID provided by mod-inventory-storage/item-storage/items:permanentLocationId will determine what name is shown here. |
| User Group ID (mod-circulation-storage/loan-storage:patronGroupId) | The UUID of the user (or "patron") group | Acts as a bridge between circulation and users modules. Provides a join point between mod-circulation-storage and mod-users/. Connects with: mod-users/groups:id |
| User Group Name (mod-users/groups:name) | The name of the user (or "patron" group | Provides a means to filter by patron group |