Inventory app Version history
- Khalilah Gambrell
- Christine Schultz-Richert
Feature | UXPROD-4125: Inventory app | Audit log/Change tracker v1 (Folijet dev)Open UXPROD-4126: MARC authority app and Inventory app | Audit log/Change tracker v1 (Spitfire dev)Open |
Release | Sunflower |
Document status | draft |
- 1 Overview
- 1.1 Action items
- 1.2 In scope
- 1.3 Out of scope
- 1.4 Tech design
- 2 Requirements overview
- 3 Questions
Overview
Action items
Document business expectations? Where do we differ from Acquisitions? Some examples:
ECS handling - change ownership
Setting record for deletion
Default display (sort, number to display, how to go through more history) - endless scroll? More?
Document some user workflows (i.e. Single record overlay)
Work with Kimie to revise UX ()
Remove “sort by”
Remove examples where the app is identified as the trigger for the change
Write user stories
In scope
Log that contains
User who made the change
Date time of change
Change made
Feature toggle
Applied to both FOLIO and MARC source instances
Out of scope
Ability to rollback to and/or view previous versions
Ability to sort
Including the app that triggered the change
Exporting version history
Highlighting the fields changed
Tech design
Requirements overview
Requirement | Notes | Jira(s) | |
|---|---|---|---|
| 1 | Feature toggle so that libraries can set whether the feature is enabled (applies to both FOLIO and MARC source records) |
|
|
| 2 | Include version history on:
|
|
|
| 3 | Display the date and time of the change in local timezone |
|
|
| 4 | Display the source of the change (user vs system) |
|
|
| 5 | Identify as a “Change”, and indicate whether the field was:
|
|
|
| 6 | Indicate the field changed on Instances detail view for both FOLIO and MARC source records. Note: for MARC source records, the field changed should reflect the Instance field changed (see other requirement for Source view) |
|
|
| 7 | In Source view for MARC source records, identify the specific MARC fields (not to the point of indicators or subfields) changed |
|
|
| 8 | If a MARC field is changed that does NOT map to a FOLIO instance, do not include the change in the Instance detail view log |
|
|
| 9 | Ignore changes to metadata |
|
|
| 10 | Only include 15 changes in the log at a time |
|
|
| 11 | Present a toast message that loading additional changes may take time |
|
|
| 12 | Holdings & item deletion - Log in the audit |
|
|
Questions
Question | Answer | Date | |
|---|---|---|---|
| 1 | In the mockups, the user name is hyperlinked - does this just go to the user record? | Yes | Dec 20, 2024 |
| 2 | Assuming that the highlight of fields changed (as implemented by Acquisitions) should be considered out of scope? | Yes | Dec 20, 2024 |
| 3 | Do we indicate when one record is updated from changes made to another record (such as updating the call number on a holdings record which then updates the effective call number on the item record)? | If there is a field that is autogenerated/updated, needs to be reflected in item version history | Dec 20, 2024 |
| 4 | Do we include a change of “Shared” for ECS? | Yes. If a local record is shared, include a change of promoted to shared | Dec 20, 2024 |
| 5 | Do we include a change of “Derived” and “Duplicate” | Yes | Dec 20, 2024 |
| 6 | Do we include a change if
| Yes | Dec 20, 2024 |
| 7 | Is keeping one year of history sufficient? Potentially need some sort of workflow where a user can make a call to some sort of archive to get more history? | Needs further discussion |
|
| 8 | Do we need to track when fields are reordered in quickMARC? | Yes - indicate field and a action of “Moved”? - Ping acq about what they’re doing if:
|
|
| 9 | Confirm whether there will be changes logged when records are linked together? (might show with parent/child?) |
|
|
| 10 | Confirm whether a tag added to holdings will be reflected in change log |
|
|
| 11 | Confirm whether the linking of authorities to bibs be reflected in change log |
|
|