Circ Rules and Loan Policies (UXPROD-789)

[UXPROD-876] Loan Rules: Syntax Error Warnings Created: 10/Jun/18  Updated: 15/Apr/22

Status: Draft
Project: UX Product
Components: None
Affects versions: None
Fix versions: None
Parent: Circ Rules and Loan Policies

Type: New Feature Priority: P3
Reporter: Cate Boerema (Inactive) Assignee: Cheryl Malmborg
Resolution: Unresolved Votes: 0
Labels: po-mvp, round_iv
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by CIRC-480 Backend for UICIRC-297: loan type Open
is defined by CIRC-481 Backend for UICIRC-297: shelving loca... Open
is defined by CIRC-482 Backend for UICIRC-297: library Open
is defined by CIRC-483 Backend for UICIRC-297: institution Open
is defined by CIRC-484 Backend for UICIRC-297: campus Open
is defined by CIRC-485 Backend for UICIRC-297: material type Open
is defined by CIRC-486 Backend for UICIRC-297: patron group Open
is defined by CIRC-487 Backend for UICIRC-297: loan policies Closed
is defined by CIRC-488 Backend for UICIRC-297: notice policies Closed
is defined by CIRC-489 Backend for UICIRC-297: request policies Closed
is defined by CIRC-490 Backend for UICIRC-297: overdue fine ... Closed
is defined by CIRC-491 Backend for UICIRC-297: lost item fee... Closed
is defined by UICIRC-297 Circulation Rules Editor - Missed cri... Closed
Potential Workaround: The editor currently provides support for comment fields. Examples for syntax formats could be included as comments in default implementations to lessen the opportunity for erroneous entry.
Epic Link: Circ Rules and Loan Policies
Front End Estimator: Julian Ladisch
Front-End Confidence factor: High
Back End Estimate: Small < 3 days
Back End Estimator: Julian Ladisch
Estimation Notes and Assumptions: I assume that all validation warnings prevent saving the loan rules; this requires no front-end work.

If they should be a warning that can be overwritten then we need some additional front end work.
Development Team: Vega
Kiwi Planning Points (DO NOT CHANGE): 1
PO Rank: 111
PO Ranking Note: Leaving this as ranked by voters, especially since it is small. Validation warnings are present when blocking save, but often don't provide user-friendly responses (e.g., reference UUIDs that are not visible in the interface).
Rank: BNCF (MVP Feb 2020): R1
Rank: Chalmers (Impl Aut 2019): R4
Rank: Chicago (MVP Sum 2020): R1
Rank: Cornell (Full Sum 2021): R4
Rank: Duke (Full Sum 2021): R1
Rank: 5Colleges (Full Jul 2021): R2
Rank: FLO (MVP Sum 2020): R1
Rank: GBV (MVP Sum 2020): R2
Rank: Grand Valley (Full Sum 2021): R1
Rank: hbz (TBD): R1
Rank: Hungary (MVP End 2020): R1
Rank: Lehigh (MVP Summer 2020): R2
Rank: Leipzig (Full TBD): R1
Rank: MO State (MVP June 2020): R1
Rank: TAMU (MVP Jan 2021): R1
Rank: U of AL (MVP Oct 2020): R2

 Description   

Helpful inline error messages withing Loan rules feature

https://discuss.folio.org/t/loan-rules-ux-iteration-4/834
Start watching around 19:35



 Comments   
Comment by Michal Kuklis [ 18/Jun/18 ]

Cate Boerema the partial support for this should be already in place. When we try to save the invalid rules and the validation fails on the server we do get back the error with the exact line which is then displayed inside of the editor. I'm not sure however if all validation cases are currently supported (for example nested rules). Perhaps Julian Ladisch could help here?

Comment by Julian Ladisch [ 19/Jun/18 ]

If the loan rules cannot be saved a helpful inline error message at the position of the syntax error shows up. This feature "Loan Rules: Syntax Error Warnings" is fully implemented.

The two nested rules that contradict each other are not a syntax error but a semantic error. They can be saved and the loan rules will work (the inner rule will never match). There is no warning for this case yet.

Please create separate feature requests for all validations warnings that should be implemented: UXPROD-959

Comment by Cate Boerema (Inactive) [ 19/Jun/18 ]

Thanks Julian Ladisch. I renamed this feature "Loan Rule: Syntax and Validation Warnings" as I don't want a separate feature for validation warnings. I'll delete UXPROD-959.

User stories will eventually be created for the separate validation warnings that should be implemented. For now, I just need a high-level estimate on this feature for remaining back and front end work to produce helpful error messages to users. I see there are some already appearing in FOLIO, but they aren't very user friendly and don't seem to cover many cases (for example, I nested a material-type rule under another material type rule as Filip showed in the video and no error message was displayed).

Can you provide a high-level estimate? Thanks!

Comment by Julian Ladisch [ 19/Jun/18 ]

There are a few syntax error messages that already have been improved, see the notifyErrorListeners lines in
https://github.com/folio-org/mod-circulation/blob/master/src/main/antlr4/org/folio/circulation/loanrules/LoanRules.g4

Each type of warning or error message can be implemented in the back-end in less than a day.

Comment by Cate Boerema (Inactive) [ 19/Jun/18 ]

Thanks and good clarification regarding warnings vs errors. I think I will change the summary of this to Syntax and Validation Errors.

Comment by Cate Boerema (Inactive) [ 19/Jun/18 ]

Julian Ladisch, I see you listed yourself as the frontend estimator but there is no frontend estimate. Is this because you don't believe any frontend work is needed for this?

Comment by Julian Ladisch [ 19/Jun/18 ]

I assume that all validation warnings prevent saving the loan rules.

If they should be a warning that the user can overwrite then we need some additional front end work.

Comment by Julian Ladisch [ 19/Jun/18 ]

The back-end produces all messages and sends them to the front-end including line and column information. No front-end work is required to add more or alter existing messages.

Comment by Stephanie Buck [ 13/Apr/22 ]

Cheryl Malmborg, is this feature still relevant given it's created date?

Comment by Stephanie Buck [ 15/Apr/22 ]

Requirements need to be vetted again. 

Comment by Cheryl Malmborg [ 15/Apr/22 ]

Stephanie Buck This is still relevant. I am able to add invalid values by typing them rather than using the drop down lists.

The requirements are the same. The rules should not be saved if any value entered does not exist in the relevant policy or location.

The current work-around is to use only the drop-down lists.

For clarity, jiras which refer to loan rules should now refer to circulation rules. Is it OK to change these or will that lead to more confusion?

Comment by Stephanie Buck [ 15/Apr/22 ]

Thank you, Cheryl Malmborg! Please feel free to update what needs updating. 

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