Ordering functionality that FOLIO needs to stay competitive (UXPROD-3440)

[UXPROD-3215] Display a history of edits for the Order and Order line records Created: 12/Aug/21  Updated: 29/Jan/24  Resolved: 28/Mar/23

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Orchid (R1 2023)
Parent: Ordering functionality that FOLIO needs to stay competitive

Type: New Feature Priority: P3
Reporter: Dennis Bridges Assignee: Dennis Bridges
Resolution: Done Votes: 0
Labels: LC-priority1, LC1, acq-dev-grooming, acq-morningglory-candidate, acquisitions, consortia-ebsco, galileo, loc
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
defines UXPROD-204 Display a history of edits for a reco... Draft
is defined by UIOR-1065 Align the "Created by" and "Created o... Closed
is defined by UISACQCOMP-139 Do not display version history card w... Closed
is defined by MODAUD-138 Spike: Define schema how to store fie... Closed
is defined by MODAUD-140 Create tables to store audit logs for... Closed
is defined by MODAUD-141 Add Kafka infrastructure code to mod-... Closed
is defined by MODAUD-142 Implement kafka consumer for Order Ch... Closed
is defined by MODAUD-143 Implement kafka consumer for Order Li... Closed
is defined by MODAUD-144 Implement endpoint to retrieve Order ... Closed
is defined by MODAUD-145 Implement endpoint to retrieve Order ... Closed
is defined by MODORDSTOR-323 Implement transactional outbox patter... Closed
is defined by MODORDSTOR-324 Add audit log message schemas and pro... Closed
is defined by MODORDSTOR-325 Replace PGUtil for Edit Order to use ... Closed
is defined by MODORDSTOR-326 Replace PGUtil for Edit Order Line to... Closed
is defined by MODORDSTOR-327 Create script for performance testing... Closed
is defined by MODORDSTOR-332 Implement lock mechanism for Outbox E... Closed
is defined by MODORDSTOR-333 Improve handling of audit log for cre... Closed
is defined by UIOR-857 User can click Change log icon to vie... Closed
is defined by UIOR-858 Display all versions in change log in... Closed
is defined by UIOR-860 Show in version history record view, ... Closed
is defined by UIOR-1035 Cancel/dismiss version history and re... Closed
is defined by UIOR-1036 Display selected version in POL view Closed
is defined by UIOR-1057 Display selected version in PO view Closed
is defined by UIOR-1070 Manual appears as false in version hi... Closed
is defined by UIOR-1072 Reason for closure is not highlighted... Closed
is defined by UIOR-1073 Odd change field listed when adding f... Closed
is defined by UISACQCOMP-131 Spike: Display all versions in change... Closed
is defined by UISACQCOMP-146 Extend the "HIT" area for a card in v... Closed
Relates
relates to UXPROD-1141 Create, close, cancel, Purchase Orders Closed
relates to UXPROD-910 Change Tracker Open
relates to UXPROD-4125 Inventory app | Audit log/Change trac... Open
relates to UXPROD-4126 MARC authority app | Audit log/Change... Open
relates to UISACQCOMP-129 Change log: add common components to ... Closed
relates to UXPROD-4040 Capture log of deleted records Draft
Release: Orchid (R1 2023)
Epic Link: Ordering functionality that FOLIO needs to stay competitive
Front End Estimate: XL < 15 days
Front-End Confidence factor: Low
Back End Estimate: XXL < 30 days
Estimation Notes and Assumptions: 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
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
Solution Architect: Raman Auramau

 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://folio-org.atlassian.net/wiki/x/agVU

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://folio-org.atlassian.net/wiki/x/agVU

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



 Comments   
Comment by Khalilah Gambrell [ 01/Nov/22 ]

Dennis Bridges  - will this be available a stripes component OR will it be designed in a way that it serves as a pattern for other apps?

 

cc: John Coburn Zak Burke 

Comment by Dennis Bridges [ 02/Nov/22 ]

As mentioned in the sprint demo today. Our goal is to make as much of this universal as possible. When collecting the original requirements I reviewed this will appinteraction and other SIG groups and it was clear that there were similar requirements in other applications as well as other acquisitions apps. Thus we are storing the information in mod audit and using familiar FOLIO patterns (Ie. card layout and 4th pane) to expose data to users.

Comment by Dennis Bridges [ 28/Mar/23 ]

All stories resolved for release in Orchid

Generated at Fri Feb 09 00:30:15 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.