Feature #13269

Add new CSV report for physical storage location reporting

Added by Mike Cantelon 8 months ago. Updated 4 months ago.

Status:VerifiedStart date:03/02/2020
Priority:MediumDue date:
Assignee:Dan Gillean% Done:

100%

Category:Reporting
Target version:Release 2.6.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:

Description

In feature #13268, we will be adding the ability to associate accession records with physical storage containers. This related enhancement will provide authenticated users with a new report that can be generated from the physical storage module on containers, locations, and related descriptions and accessions.

Users will be able to launch a new physical storage report from the physical storage browse page. When the report button is clicked, several additional options to configure the report (all checked by default) will be available, including options to:

  • Include unlinked containers: if unchecked, then storage containers with no associated descriptions or accessions will not appear in the report
  • Include containers linked to accessions: if unchecked then containers that are only linked to accessions will not be included in the report
  • Include containres linked to descriptions: if unchecked then containers that are only linked to descriptions will not be included in the report

By default, all 3 options will be checked, meaning that all storage containers will be included in the report. If a physical object doesn't have related holdings (i.e. links to descriptions or accessions), a CSV row will be included for the physical object but with no holding details in the related columns.

Mockups of the web GUI options attached. When triggered via the user interface, the report generation will be managed by the job scheduler. The task generating the report will also be available via the command-line interface.

List of proposed columns to be included in the report CSV (subject to change until developed):

Physical storage container columns
  • storageName
  • storageLocation
  • storageType
Related record columns
  • entityType
  • Description columns
    • descriptionIdentifier
    • descriptionTitle
    • levelOfDescription
    • extentAndMedium
  • Accession record columns
    • accessionNumber
    • accessionTitle
    • accessionExtent

Possible CLI options:

--suppress-empty-physical-storage or --suppress-non-empty-physical-storage (not both)

--holding-type (error if --suppress-non-empty-physical-storage also set)

Translation of web GUI options to CLI options:

If not A: --suppress-empty-physical-storage

If not B but C: --holding-type=accessions

If not C but B: --holding-type=descriptions

storage-report-options.png (159 KB) Mike Cantelon, 03/02/2020 07:30 PM

export-button.png (301 KB) Mike Cantelon, 03/02/2020 11:13 PM


Related issues

Related to Access to Memory (AtoM) - Bug #13372: Physical storage report: Cancel button on configuration p... Verified 06/29/2020

History

#1 Updated by Mike Cantelon 8 months ago

(Added mockup of button that triggers generation of report.)

#2 Updated by Dan Gillean 8 months ago

  • Subject changed from At task and web UI support for CSV exporting physical objects and their holdings to Add new CSV report for physical storage location reporting
  • Description updated (diff)
  • Category set to Reporting
  • Target version set to Release 2.6.0
  • Sponsored changed from No to Yes

#3 Updated by Mike Cantelon 7 months ago

  • Status changed from In progress to Code Review
  • Assignee deleted (Mike Cantelon)

#4 Updated by Steve Breker 7 months ago

CR complete - looks good!

#5 Updated by Mike Cantelon 7 months ago

(Was merged into qa/2.6.x)

#6 Updated by Dan Gillean 7 months ago

  • Status changed from Code Review to QA/Review

#7 Updated by Mike Cantelon 7 months ago

Feedback from demo:

  • Make the GUI checkboxes indicate inclusive, rather than exclusive, holding types but filter out other types in CSV output
  • Add level of description column
  • Check sort order to make sure it's correct
  • In task help specify that description means information object
  • In task help add list of supported types

#8 Updated by Dan Gillean 7 months ago

  • Status changed from QA/Review to In progress
  • Assignee set to Mike Cantelon

#9 Updated by Mike Cantelon 7 months ago

  • Status changed from In progress to Code Review
  • Assignee deleted (Mike Cantelon)

#10 Updated by Mike Cantelon 7 months ago

  • Assignee set to Steve Breker

#11 Updated by Steve Breker 7 months ago

Looks great Mike!

#12 Updated by Mike Cantelon 7 months ago

  • Status changed from Code Review to Feedback
  • Assignee changed from Steve Breker to Mike Cantelon

Thanks Steve!

#13 Updated by Mike Cantelon 7 months ago

  • Status changed from Feedback to QA/Review
  • Assignee changed from Mike Cantelon to Evelyn McLellan

Merged, cherry picked to client repo, and deployed.

#14 Updated by Dan Gillean 5 months ago

  • Status changed from QA/Review to Verified

#15 Updated by Dan Gillean 4 months ago

  • Assignee changed from Evelyn McLellan to Dan Gillean

Starting docs on this now.

#16 Updated by Dan Gillean 4 months ago

  • Related to Bug #13372: Physical storage report: Cancel button on configuration page does not return user to Storage browse page added

#17 Updated by Dan Gillean 4 months ago

  • % Done changed from 0 to 100
  • Requires documentation deleted (Yes)

Also available in: Atom PDF