MM-ACRL Title Count

Owned by Angela Zoss (Old)
Feb 12, 2020

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."

Title Count:

Title counts are typically associated with bibliographic/instance, rather than item, records. However, traditional query approaches may differ in cases where a single FOLIO tenant hosts data for multiple institutions, or libraries that cross multiple lines of administrative authority. In such cases, the API architecture of FOLIO necessitates the involvement of item-relevant data elements for filtering purposes. 

For the ACRL and NCES annual survey, title counts will be broken down into the top-level categories of "tangible" and "electronic."

Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query

Instance ID (mod-inventory-storage/instance-storage/instances:id)

* Notated as instanceId in other branches of the module

UUID of the instance record

A title count is derived by counting instance IDs

Also provides a join point between mod-inventory-storage/instance-storage and mod-inventory-storage/holdings-storage - connects with:

mod-inventory-storage/holdings-storage:instanceId

Instance Suppression Status (mod-inventory-storage/instance-storage/instances:discoverySuppress)Indicates that the instance record is "suppressed" and should not be displayed in a discovery system

Used to filter (if necessary)

This element provides a means of excluding suppressed instance records from the total title count

A library may count all non-suppressed instance IDs to derive their title count. However, there may be instances where some filter mechanism must be used in order to select a subset of total titles. In such cases, one will typically filter by various bibliographic codings. In FOLIO these codings relate to instance format and type. There may also be a need for additional filtering by item-specific location, item-specific format, or both. Therefore, the following elements are being included in this report prototype to support this type of query refinement. 
Instance ID 2 (mod-inventory-storage/holdings-storage/holdings:instanceId)UUID for the instance record (found on holdings record)

Acts as a bridge between instance and holdings records. Provides a join point between mod-inventory-storage/holdings-storage and mod-inventory-storage/instance-storage. Connects with:

mod-inventory-storage/instance-storage:id

This join makes all holdings-level filtering possible.

Instance Format ID (mod-inventory-storage/instance-storage/instances:instanceFornatIds)

UUID associated with a particular instance format

Provides a join point between mod-inventory-storage/instance-storage and mod-inventory-storage/instance-format. Connects with:

mod-inventory-storage/instance-format:id

Instance Format Name (mod-inventory-storage/instance-formats:name)


Label for the instance format (e.g., "audio disc, online resource, etc.")

This element is traditionally associated with coding found on the MARC 008 (i.e., "form of item" and "type of material")

Used to filter (if necessary)

Provides a means to filter by instance format. This element is pulled into the report using the instanceFormatIds found in mod-inventory-storage/instance-storage. This element provides a human-readable material type that is easier to work than the instanceFormatIds, which takes the form of a long machine-readable UUID. 

Instance Type ID (mod-inventory-storage/instance-storage/instances:instanceTypeId)

UUID for a particular instance type

Provides a join point between mod-inventory-storage/instance-storage and mod-inventory-storage/instance-types. Connects with:

mod-inventory-storage/instance-types:id

Instance Type Name (mod-inventory-storage/instance-types:name)


Label for the instance type (e.g., "still image, computer dataset, etc.")

This element is traditionally associated with coding found on the MARC Leader (i.e., "type of record" and "bibliographic level")

Used to filter (if necessary)

This element provides a means to filter the title count by material type. This element is pulled into the report using the instanceTypeId found in mod-inventory-storage/instance-storage. This element provides a human-readable material type that is easier to work than the instanceTypeId, which takes the form of a long machine-readable UUID. 

Holdings ID (mod-inventory-storage/item-storage/items:holdingsRecordId)UUID for the holdings record

Acts as the bridge between holdings and item records. Provides a join point between mod-inventory-storage/holdings-storage and mod-inventory-storage/item-storage. Connects with:

mod-inventory-storage/holdings-storage/holdings:id

This join makes all item-level filtering possible.

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.

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.