[UXPROD-3215] Display a history of edits for the Order and Order line records - FOLIO Issue Tracker

XML

Word

Printable

Details

Type: New Feature
Status: Closed (View Workflow)
Priority: P3
Resolution: Done
Affects Version/s: None
Fix Version/s: Orchid (R1 2023)
Component/s: None
Labels:

Template:

UXPROD features
Release:
Orchid (R1 2023)
Epic Link:
Ordering functionality extended
Front End Estimate:
XL < 15 days
Front-End Confidence factor:
Low
Back End Estimate:
XXL < 30 days
Estimation Notes and Assumptions:

Hide
Confidence is low as we do not have an agreed-upon approach for tracking changes in the backend. Also, the goal is to implement in such a way that this approach could be used elsewhere. This additional complexity raises the risk of estimates being inaccurate.

Show
Confidence is low as we do not have an agreed-upon approach for tracking changes in the backend. Also, the goal is to implement in such a way that this approach could be used elsewhere. This additional complexity raises the risk of estimates being inaccurate.
Development Team:
Thunderjet
Calculated Total Rank:
Kiwi Planning Points (DO NOT CHANGE):
1
PO Rank:
57.71
Rank: Chalmers (Impl Aut 2019):
R5
Rank: Chicago (MVP Sum 2020):
R4
Rank: Cornell (Full Sum 2021):
R2
Rank: Duke (Full Sum 2021):
R1
Rank: 5Colleges (Full Jul 2021):
R2
Rank: FLO (MVP Sum 2020):
R4
Rank: GBV (MVP Sum 2020):
R4
Rank: Grand Valley (Full Sum 2021):
R4
Rank: hbz (TBD):
R4
Rank: Hungary (MVP End 2020):
R1
Rank: Lehigh (MVP Summer 2020):
R2
Rank: Leipzig (Full TBD):
R1
Rank: Leipzig (ERM Aut 2019):
R4
Rank: MI State-Lib of MI (Sum 2021):
R4
Rank: MO State (MVP June 2020):
R4
Rank: TAMU (MVP Jan 2021):
R2
Rank: U of AL (MVP Oct 2020):
R2

Description

Current situation or problem: Not enough metadata is captured regarding record activity. Some records (eg. order) are edited frequently and often by different users OR integrations. Currently it is only possible to see who last edited the order and who created it. This could make it really difficult to troubleshoot orders over time and uncover why something has not been fulfilled or what the implications are of cancelling it etc.

In scope
Add a table that tracks what edits have been made to order and order line since its creation
Track edits made by users
Track edits made through integrations
Track edits made by other Modules
Investigate how this type of functionality could be implemented in a way that is replicable by other applications

Out of scope
Implement this tracking for records other than order or order line

Use case(s)

See wiki page at https://wiki.folio.org/x/MpnhAw

Proposed solution/stories
Add table to each record with row entries for each edit
Add full screen view for table of edits
Track edits made by users AND other modules

Links to additional info

Analysis continuing in wiki at https://wiki.folio.org/x/MpnhAw

Technical information and design are available at https://wiki.folio.org/display/DD/Acquisition+Event+Log

TestRail: Results

Attachments

Issue Links

defines

UXPROD-204 Display a history of edits for a record that is being viewed in acquisitions

Draft

is defined by

MODAUD-138 Spike: Define schema how to store fields for acquisitions audit logs

Closed

MODAUD-140 Create tables to store audit logs for orders and order lines

Closed

MODAUD-141 Add Kafka infrastructure code to mod-audit

Closed

MODAUD-142 Implement kafka consumer for Order Change events

Closed

MODAUD-143 Implement kafka consumer for Order Line Change events

Closed

MODAUD-144 Implement endpoint to retrieve Order Change events

Closed

MODAUD-145 Implement endpoint to retrieve Order Line Change events

Closed

MODORDSTOR-323 Implement transactional outbox pattern to store audit log in the transactional manner

Closed

MODORDSTOR-324 Add audit log message schemas and producer for sending these Kafka messages

Closed

MODORDSTOR-325 Replace PGUtil for Edit Order to use PostgresClient directly

Closed

MODORDSTOR-326 Replace PGUtil for Edit Order Line to use PostgresClient directly

Closed

MODORDSTOR-327 Create script for performance testing of Create Audit logs flow

Closed

MODORDSTOR-332 Implement lock mechanism for Outbox Event Log

Closed

MODORDSTOR-333 Improve handling of audit log for createdDate and createdBy

Closed

UIOR-857 User can click Change log icon to view the Change log

Closed

UIOR-858 Display all versions in change log in fourth pane

Closed

UIOR-860 Show in version history record view, which fields have been edited

Closed

UIOR-1035 Cancel/dismiss version history and reload current version

Closed

UIOR-1036 Display selected version in POL view

Closed

UIOR-1057 Display selected version in PO view

Closed

UIOR-1065 Align the "Created by" and "Created on" fields with BE changes

Closed

UIOR-1070 Manual appears as false in version history even when true

Closed

UIOR-1072 Reason for closure is not highlighted in version history when edited

Closed

UIOR-1073 Odd change field listed when adding fund distribution to open order

Closed

UISACQCOMP-131 Spike: Display all versions in change log in fourth pane

Closed

UISACQCOMP-139 Do not display version history card without changes.

Closed

UISACQCOMP-146 Extend the "HIT" area for a card in version history to full header

Closed

relates to

UXPROD-1141 Create, close, cancel, Purchase Orders

Closed

UISACQCOMP-129 Change log: add common components to display version history on the fourth pane

Closed

UXPROD-910 Change Tracker

Open

UXPROD-4040 Capture log of deleted records

Draft

UXPROD-4125 Inventory app | Audit log/Change tracker v1

Open

UXPROD-4126 MARC authority app | Audit log/Change tracker

Open

mentioned in: Page Loading...; Page Loading...; Page Loading...

(23 is defined by , 6 relates to, 3 mentioned in)

Activity

People

Assignee:: Dennis Bridges

Reporter:: Dennis Bridges

Solution Architect:: Raman Auramau

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Dates

Created:: 12/Aug/21 7:06 PM

Updated:: 08/Sep/23 6:54 PM

Resolved:: 28/Mar/23 2:27 PM

Display a history of edits for the Order and Order line records