Page tree
Skip to end of metadata
Go to start of metadata

Report Description Detail

This report is intended to be run ad-hoc, to provide details on items located in a chosen Location(s).

The model is based on ID322 (REP_189) which contains the same elements required for ID315 (UXPROD-892) and ID302 (UXPROD-880), with a few additional fields. Users should be able to choose one or more locations within the desired location hierarchy and then get an a count of items (based on Item ID) with in the location(s) or get a varying range of item details for those located there. Users should also be able to filter results for Discovery Suppression, Format, and/or Material type.


Start report with:

Institution | Campus | Library | Location Name


Filters:

Item Discovery Suppression | Holding Discovery Suppression | Instance Discovery Suppression | Instance Format | Instance Type | Item Material Type Name | Item Loan Type

Future (data not implemented yet): Date of Last Checkout | Number of Historic Charges/Loans


Data fields:

Item ID Count

OR

Call Number Prefix | Call No. | Call No. Suffix | Contributor/Author (Primary only) | Title | Index Title | Volume | Enumeration | Chronology | Copy Number | Item-Number of Pieces | Item-Number of Pieces Missing | Item Barcode | Item Status | Identifiers (ISBN | ISSN) | Publisher | Date of Publication | Item Id | Holding Id | Instance Id


See TAMU's similar example report from Voyager: https://docs.google.com/document/d/1ZZuK3XFi2IkKrQn8IDOtug2VP428E3IzNlJZP9adfrE/


Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query
Table name: mod-inventory-storage/locations

Location ID (mod-inventory-storage/location/locations:id)UUID for the Location record

Name (mod-inventory-storage/location/locations:name)Name of the Location
Code (mod-inventory-storage/location/locations:code)Code to represent a Location
Institution ID (mod-inventory-storage/location/locations:institutionId)ID to retrieve the Institution that a Location belongs to

Provides a join point between mod-inventory-storage/location to mod-inventory-storage/locationunit. This allows us to pull names and codes of an Institution.

locations:institutionId == mod-inventory-storage/locationunit/location-units/locinsts:id

Campus ID (mod-inventory-storage/location/locations:campusId)ID to retrieve the Campus that a Location belongs to

Provides a join point between mod-inventory-storage/location to mod-inventory-storage/locationunit. This allows us to pull names and codes of an Campus.

locations:campusId == mod-inventory-storage/locationunit/location-units/loccamps:id

Library ID (mod-inventory-storage/location/locations:libraryId)ID to retrieve the specific Library that a Location belongs to

Provides a join point between mod-inventory-storage/location to mod-inventory-storage/locationunit. This allows us to pull names and codes of an Library.

locations:libraryId == mod-inventory-storage/locationunit/location-units/loclibs:id

Table name: mod-inventory-storage/location-units

Institution Location ID (mod-inventory-storage/locationunit/location-units/locinsts:id)ID for an Institution

Provides a join point between mod-inventory-storage/locationunit/location-units and mod-inventory-storage/location/locations. This allows us to pull name and code of an institution.

locinsts:id == mod-inventory-storage/location/locations:institutionId

Institution Location Name (mod-inventory-storage/locationunit/location-units/locinsts:name)Name of the InstitutionAfter joining based on Location Institution ID fields, include Institution Name in report.
Institution Location Code (mod-inventory-storage/locationunit/location-units/locinsts:code)Code to represent the InstitutionAfter joining based on Location Institution ID fields, include Institution Code in report.

Campus Location ID (mod-inventory-storage/locationunit/location-units/loccamps:id)

ID for a Campus

Provides a join point between mod-inventory-storage/locationunit/location-units and mod-inventory-storage/location/locations. This allows us to pull name and code of a campus.

loccamps:id == mod-inventory-storage/location/locations:campusId

Campus Location Name (mod-inventory-storage/locationunit/location-units/loccamps:name)Name of the CampusAfter joining based on Location Campus ID fields, include Campus Name in report.
Campus Location Code (mod-inventory-storage/locationunit/location-units/loccamps:code)Code to represent the CampusAfter joining based on Location Campus ID fields, include Campus Code in report.
Library Location ID (mod-inventory-storage/locationunit/location-units/loclibs:id)ID for a Library

Provides a join point between mod-inventory-storage/locationunit/location-units and mod-inventory-storage/location/locations. This allows us to pull name and code of a Library.

loclibs:id == mod-inventory-storage/location/locations:libraryId

Library Location Name (mod-inventory-storage/locationunit/location-units/loclibs:name)Name of the LibraryAfter joining based on Location Library ID fields, include Library Name in report.
Library Location Code (mod-inventory-storage/locationunit/location-units/loclibs:code)Code to represent the LibraryAfter joining based on Location Library ID fields, include Library Code in report.
Table name: mod-inventory-storage/item-storage/items

Effective Location (calculated in LDP)The item's effective location (calculated from permanent and temporary locations of holdings and items)
Temporary Location ID (mod-inventory-storage/item-storage/items:temporaryLocationId)UUID for Location to correspond to where an item has temporarily been located

Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/location.

items:temporaryLocationId == mod-inventory-storage/location/locations:id

Permanent Location ID (mod-inventory-storage/item-storage/items:permanentLocationId)UUID for Location to correspond to where an item permanently resides

Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/location.

items:permanentLocationId == mod-inventory-storage/location/locations:id

Item ID (mod-inventory-storage/item-storage/items:id)UUID for an item.This element will be counted to determine number of item matching the selected location(s) and criteria (Count(id)).
Discovery Suppress (mod-inventory/item-storage/items:discoverySuppress)Records the fact that the record should not be displayed in a discovery systemThis data element can be used to filter the report for Item Discovery Suppress where True or False.
Material Type ID (mod-inventory-storage/item-storage/items:materialTypeId)UUID for the type of material an item is

Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/material-type. This allows us to get the name for the material type.

items:materialTypeId == mod-inventory-storage/material-type/mtypes:id

Perm Loan Type (mod-inventory-storage/item-storage/items:permanentLoanTypeId)UUID for a loan type

Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/loan-type. This allows us to pull the location name and code.

items:permanentLoanTypeId == mod-inventory-storage/loan-type/loantypes:id

Temp Loan Type (mod-inventory-storage/item-storage/items:temporaryLoanTypeId)UUID for a loan type

Provides a join point between mod-inventory-storage/item-storage and mod-inventory-storage/loan-type.This allows us to pull the location name and code

items:temporaryLoanTypeId == mod-inventory-storage/loan-type/loantypes:id

Item Barcode (mod-inventory-storage/item-storage/items:barcode)Barcode to identify an item
Volume (mod-inventory-storage/item-storage/items:volume)Item's Volume designation (e.g. Vol.1, v.2, etc.)
Enumeration (mod-inventory-storage/item-storage/items:enumeration)Item's Enumeration designation (e.g. No.1, pt.2, etc.)
Chronology (mod-inventory-storage/item-storage/items:chronology)Item's Chronology designation (e.g. 2019, 1999, etc.)
Copy Number (mod-inventory-storage/item-storage/items:{copyNumbers})Item's Copy Number (e.g. Copy 1, c.2, etc.)
Number of Pieces (mod-inventory-storage/item-storage/items:numberOfPieces)Number of pieces that are part of an item (e.g. CDs in a boxset, Book and DVD ROM, etc.)
Number of Missing Pieces (mod-inventory-storage/item-storage/items:numberOfMissingPieces)

Call Number Prefix (mod-inventory-storage/item-storage/items:itemLevelCallNumberPrefix)Term that precedes a call number
Call Number (mod-inventory-storage/item-storage/items:itemLevelCallNumber)Call Number for an Item
Call Number Suffix (mod-inventory-storage/item-storage/items:itemLevelCallNumberSuffix)Term or number(s) that follow a Call Number
Call Number Type ID (mod-inventory-storage/item-storage/items:itemLevelCallNumberTypeId)ID for a Call Number Type

Provides a join between mod-inventory-storage/item-storage and mod-inventory-storage/call-number-type. This allows us to determine the type of call number listed.

items:itemLevelCallNumberTypeId == mod-inventory-storage/call-number-type/callNumberTypes:id

Status Name (mod-inventory-storage/item-storage/items:status:name)

The Status of an Item (e.g. Available, Checked out, In transit, etc.)

This data element can be used to filter the report to include or exclude specific status names.
Item's Holding Record ID (mod-inventory-storage/item-storage/items:holdingsRecordId)ID linking an Item to a Holding record

Provides a join between mod-inventory-storage/item-storage and mod-inventory-storage/holdings-storage. This allows us to pull the holding data to ultimately get at the instance data.

items:holdingsRecordId == mod-inventory-storage/holdings-storage/holdings:id

Number of Pieces (mod-inventory-storage/item-storage/items:numberOfPieces)Number of pieces an item has includedUsed when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set).
Table name: mod-inventory-storage/material-types

Material Type ID (mod-inventory-storage/material-type/mtypes:id)UUID of a material type

Provides a join point between mod-inventory-storage/material-type and mod-inventory-storage/item-storage.

mtypes:id == mod-inventory-storage/item-storage/items:materialTypeId

Material Type Name (mod-inventory-storage/material-type/mtypes:name)Name of material type describing an itemAfter joining based on Material Types ID, include Material Type Name in report.
Table name: mod-inventory-storage/loan-types

Loan Type ID (mod-inventory-storage/loan-type/loantypes:id)UUID for a loan type

Provides a join between mod-inventory-storage/loan-type and mod-inventory-storage/items.

loantype:id == mod-inventory-storage/item-storage/items:permanentLoanTypeId

loantype:id == mod-inventory-storage/item-storage/items:temporaryLoanTypeId

Loan Type Name (mod-inventory-storage/loan-type/loantypes:name)Name for a loan type ("Can circulate", "Reading room", "Course reserve", etc.)After joining based on Loan Type ID fields, include Loan Type Name in report.
Table name: mod-inventory-storage/call-number-types

Call Number Type ID (mod-inventory-storage/call-number-type/callNumberTypes:id)UUID for a Call Number Type

Provides a join between mod-inventory-storage/call-number-type and mod-inventory-storage/item-storage.

callNumberTypes:id == mod-inventory-storage/item-storage/items:itemLevelCallNumberTypeId

Call Number Type ID (mod-inventory-storage/call-number-type/callNumberTypes:name)Name of the Call Number type (e.g. LC or Dewy)

callNumberTypes:name == "LC", "Dewey", etc.

Table name: mod-inventory-storage/holdings-storage/holding

Holding ID (mod-inventory-storage/holdings-storage/holdings:id)UUID for a Holdings record

Provides a join between mod-inventory-storage/holding-storage to mod-inventory/item-storage. This allows us to gain access to instance level details.

holdings:id == mod-inventory-storage/item-storage/items:holdingsRecordId

Discovery Suppress (mod-inventory-storage/holdings-storage/holdings:discoverySuppress)Records the fact that the record should not be displayed in a discovery systemThis data element can be used to filter the report for Holding Discovery Suppress where True or False.
Holding's Instance ID (mod-inventory-storage/holdings-storage/holdings:instanceId)UUID to link a Holdings record to an Instance

Provides a join between mod-inventory-storage/holding-storage to mod-inventory/instance-storage. This allows us to pull the bibliographic data in the instance record.

holdings:instanceId == mod-inventory-storage/instance-storage/instances:id

Table name: mod-inventory-storage/instance-storage/isntances

Instance ID (mod-inventory-storage/instance-storage/instances:id)UUID for an Instance record

Provides a join between mod-inventory-storage and mod-inventory-storage/holdings-storage.

instances:id == mod-inventory-storage/holdings-storage/holdings:instanceId

Discovery Suppress (mod-inventory-storage/instance-storage/instances:discoverySuppress)Records the fact that the record should not be displayed in a discovery systemThis data element can be used to filter the report for Instance Discovery Suppress where True or False.
Instance Type ID (mod-inventory-storage/instance-storage/instances:instanceTypeId)The unique term for the resource type

Provides a join between mod-inventory-storage and mod-inventory-storage/instance-type. This allows us to access the Instance Type Name and Code.

instances:instanceTypeId == mod-inventory-storage/instance-type/instanceTypes:id

Instance Format ID (mod-inventory-storage/instance-storage/instances:instanceFormatIds)The unique term for the resource format

*Repeatable field*

Provides a join between mod-inventory-storage/instance-storage and mod-inventory-storage/instance-format. This allows us to access the Instance Format Name and Code.

instances:instanceFormatIds == mod-inventory-storage/instance-format/instanceFormats:id

Title (mod-inventory-storage/instance-storage/instances:title)The primary title (or label) associated with the resource
Index Title (mod-inventory-storage/instance-storage/instances:indexTitle)Title normalized for browsing and searching; based on the title with articles removed
Publisher (mod-inventory-storage/instance-storage/instances:publication{publisher}Name of publisher, distributor, etc.*Repeatable field*
Date of Publication (mod-inventory-storage/instance-storage/instances:publication{dateOfPublication}Date (year YYYY) of publication, distribution, etc.*Repeatable field*
Contributor Name (mod-inventory-storage/instance-storage/instances:contributors{name})Personal, corporate, or meeting name that contributed to a work

*Repeatable field*

Only pull the contributor that is marked as the primary contributor.

Identifier Value (mod-inventory-storage/instance-storage/instances:contributors{primary})Boolean for if contributor is main contributor

*Repeatable field*

instances:contributors{primary} == True

Identifier Value (mod-inventory-storage/instance-storage/instances:identifiers{identiferTypeId})UUID for a lookup table to make the connection with a name and the type of contributor they are

*Repeatable field*

Provides a join between mod-inventory-storage/instance-storage and mod-inventory-storage/identifier-type. This allows us to determine what the identifier is.

instances:identifiers{identiferTypeId} == mod-inventory-storage/identifier-type/identiferTypes:id

Identifier Value (mod-inventory-storage/instance-storage/instances:identifiers{value})An identification of an item (e.g. ISBN, ISSN)

*Repeatable field*

?Possible to pull out and put in to the different columns? If multiple for the same type (isbn, issn, etc) combine into the same cells and separate with delimiter.

Table name: mod-inventory-storage/instance-types

Instance Type ID (mod-inventory-storage/instance-type/instanceTypes:id)UUID for instance type

Provides a join between mod-inventory-storage/instance-type and mod-inventory-storage/instance-storage.

instanceTypes:id == mod-inventory-storage/instance-storage/instances:instanceFormatIds

Instance Type Name (mod-inventory-storage/instance-type/instanceTypes:name)Name of the instance type ("still image", "computer dataset", "tactile text", etc.)
After joining based on Instance Type ID, include Instance Type Name. This data element can be used to filter the report including or excluding selected Names.
Instance Type Code (mod-inventory-storage/instance-type/instanceTypes:code)Code of the instance type ("sti", "cod", "tct", etc.)
After joining based on Instance Type ID, include Instance Type Code. This data element can be used to filter the report including or excluding selected Codes.
Table name: mod-inventory-storage/instance-formats

Instance Format ID (mod-inventory-storage/instance-format/instanceFormats:id)UUID for an instance format

Provides a join between mod-inventory-storage/instance-format and mod-inventory-storage/instance-storage.

instanceFormats:id == mod-inventory-storage/instance-storage/

Instance Format Name (mod-inventory-storage/instance-format/instanceFormats:name)Name of an instance format ("audio – audio disc", "audio – cassette", "computer – online resource")After joining based on Instance Format ID, include Instance Format Name. This data element can be used to filter the report including or excluding selected Names.
Instance Format Code (mod-inventory-storage/instance-format/instanceFormats:code)Code for an instance format ("sd", "ss", "cr", etc.)After joining based on Instance Type ID, include Instance Format Code. This data element can be used to filter the report including or excluding selected Code.
Table name: mod-inventory-storage/identifier-types

Identifier Type ID (mod-inventory-storage/identifier-type/identiferTypes:id)UUID of an identifier type

Provides a join between mod-inventory-storage/identifier-type and (mod-inventory-storage/instance-storage/instances:identifiers{identiferTypeId}.

identiferTypes:id == mod-inventory-storage/instance-storage/instances:identifiers{identiferTypeId}

Identifier Type Name (mod-inventory-storage/identifier-type/identiferTypes:name)Name of the type of an identifier (e.g. ISBN, ISSN)identiferTypes:name == "isbn", "issn", etc.
TBD

Not implemented - Last Transaction Date (TBD)Date of the last time an item circulated
Not implemented -  Historic Charges/Transactions (TBD)Number of times and item was checked-out



  • Eric Pennington get in touch with Emma Boettcher about questions in Historic Loan data.
    • Emma said these are being discussed, but not worked on yet. UXPROD-283 tracking of previous statuses (capture last transaction date bit), and UXPROD-1327 for at-a-glance info about how many times an item has circulated.
  • Eric Pennington ask Charlotte Whitt or Laura Wright about how LC Call Numbers are stored: Call Number Prefix/Suffix and if Classification is stored.
    • Talked with Laura and she told me about there is a subgroup being formed to look at call number searching and maybe this work will help. No work done yet.
  • Eric Pennington add in item piece counts.
  • No labels