Inventory app Version history

Owned by Khalilah Gambrell
Last updated: yesterday at 4:26 PM by Christine Schultz-Richert
3 min read

 

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

Overview

Action items

  1. Document business expectations? Where do we differ from Acquisitions? Some examples:

    1. ECS handling - change ownership

    2. Setting record for deletion

    3. Default display (sort, number to display, how to go through more history) - endless scroll? More?

  2. Document some user workflows (i.e. Single record overlay)

  3. Work with Kimie to revise UX ( )

    1. Remove “sort by”

    2. Remove examples where the app is identified as the trigger for the change

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

Inventory Audit log

Requirements overview

Requirement

Notes

Jira(s)

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)

  • ECS: This should be controlled by a central tenant feature flag

  • Should apply to all record types (in Inventory & MARC authority)

 

2

Include version history on:

  • Instance detail view (fourth pane)

  • Holdings detail view

  • Items detail view

  • source view for MARC source records (second pane)

 

 

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:

  • Added

  • Edited

  • Removed

 

 

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

  • Maybe with a “+More” button and may require a message notifying user that it may take some time to load

 

11

Present a toast message that loading additional changes may take time

 

 

12

Holdings & item deletion - Log in the audit

 

 

Questions

Question

Answer

Date

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

  • holdings ownership has changed in ECS

  • holdings moved to another instance

  • items moved to another holdings

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:

  • there is a situation where data is reordered within the record?

  • there is a situation where record is moved?

 

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

 

 

Khalilah Gambrell
23 hours ago

@Charlotte Whitt - we are aware that some institutions may decide to not track this information and we will offer the ability to not use this feature as a feature toggle.