Circ Rules and Loan Policies (UXPROD-789)

[UXPROD-875] Loan Rules: Exceptions, Modifiers and Special Selectors Created: 10/Jun/18  Updated: 03/Jan/24  Resolved: 16/Nov/20

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

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

Attachments: PNG File screenshot-1.png    
Issue links:
Blocks
is blocked by CIRC-17 Add priority keyword to loan rule engine Closed
is blocked by CIRC-18 Add "all" keyword to loan rule engine Closed
is blocked by CIRC-19 Add ! (negation) operator to loan rul... Closed
Defines
is defined by UICIRC-505 Priority line - lists the relative we... Closed
is defined by UICIRC-506 Keyword all - allowed by backend Closed
is defined by UICIRC-507 Modifer ! (not) - preceding value ent... Closed
Potential Workaround: It's not clear that additional work is needed on the front end to support the back-end functionality already enabled - except to possibly add instructions for use in comment fields as part of default implementation.
Epic Link: Circ Rules and Loan Policies
Front End Estimate: Large < 10 days
Front End Estimator: Michal Kuklis
Front-End Confidence factor: Medium
Back End Estimator: Julian Ladisch
Estimation Notes and Assumptions: No back-end work because it is already there.
Development Team: Firebird
PO Rank: 60
PO Ranking Note: Lowering the ranking for this because the back-end work is complete, but no specific front-end work has been identified. Supported characters for this already work when entered manually (modifiers; special selectors). Priority (exceptions) is supported by ordering the priority line as desired by staff.
Rank: Chalmers (Impl Aut 2019): R5
Rank: Chicago (MVP Sum 2020): R1
Rank: Cornell (Full Sum 2021): R1
Rank: Duke (Full Sum 2021): R1
Rank: 5Colleges (Full Jul 2021): R4
Rank: FLO (MVP Sum 2020): R4
Rank: GBV (MVP Sum 2020): R2
Rank: Grand Valley (Full Sum 2021): R2
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): R2
Rank: TAMU (MVP Jan 2021): R1
Rank: U of AL (MVP Oct 2020): R2

 Description   

Ability to specify exceptions with loan rules. See the following Discuss post:

https://discuss.folio.org/t/loan-rules-ux-iteration-4/834

Start watching about 16:41 for exceptions, modifiers and special selectors

Exception means that at least two rules match. There is a priority so that the exception rule applies and not the general rule. See circulation rules documentation about multiple matching rules: https://github.com/folio-org/mod-circulation/blob/master/doc/circulationrules.md#multiple-matching-rules

There is only one modifier: The exclamation mark used for negation. "! department-head" matches all but the department-head group.

There is only one special selector: The all keyword. "all" means all values of that type, for example all patron groups or all locations.

Status:
This feature is fully functional in both the backend and the frontend.
The only missing work is adding them to the pull-down menu in the front-end. The "priority" line, the "!" modifier and the "all" keyword can be edited via the keyboard in the circulation rules text editor. However, the pull-down menu in the circulation rules text editor does not contain them so you cannot use the mouse to insert them.



 Comments   
Comment by Julian Ladisch [ 21/Jun/18 ]

The back-end work for this has been finished.

Comment by Erin Nettifee [ 09/Sep/19 ]

Can the documentation for https://github.com/folio-org/mod-circulation/blob/master/doc/circulationrules.md be updated to add the negation features? We've been starting to focus on learning circ rules and had no idea that negation was a thing, because it wasn't in the docs.

ETA: I'm dumb. It was in the criteria section. It would be helpful to see an example of how it works in the docs, I guess. But I apologize for missing it.

Comment by Julian Ladisch [ 10/Sep/19 ]

Erin Nettifee Do you want me to move the example g !visitor !undergrad into a line on its own to visually stand out? Or do you have a better example?

Comment by Erin Nettifee [ 11/Sep/19 ]

I think it would help if there was a section or specific callout to modifiers and special selectors, and then in that section mention both all and ! and how they work.

Other than the example, there's no other direction about how ! works - as opposed to combining criteria and all that, for which there are specific examples of how to do it given.

Comment by Cate Boerema (Inactive) [ 04/Sep/20 ]

Cheryl Malmborg, teams are looking for ui-only features and this seems to be one. See the "status"comment in the body of the feature. Can you please write stories for this so someone can pick it up? When stories are ready, you can change the status of the feature to Analysis complete. Thanks much!

Comment by Cheryl Malmborg [ 17/Sep/20 ]

Adding user stories for front-end work on priority line, keyword and modifier:

1. Priority line - lists the relative weight of the possible criteria
e.g. priority: t,g,s,b,c,a,m
Currently there is no drop down menu when entering these. The staff member needs to know the codes.
Provide drop down menu with code and description to make entry easier and less error prone.

2. Keyword all - allowed by backend
Currently it is an allowed value, but not listed in the drop down lists for the various criteria.
Add to drop down lists so that it can be entered using the mouse rather than needing to be typed.

3. Modifer ! (not) - preceding value entered for a criteria, means any value except
Currently needs to be typed.
Add to drop down so that it can be entered using the mouse rather than being typed.

See the existing attachment for an example of how this might look.

Comment by Debra Howell [ 29/Sep/20 ]

Interested in the status of this feature.

Comment by Cate Boerema (Inactive) [ 30/Sep/20 ]

Hi Debra Howell. The Firebird team was looking into potentially pickup up this feature, as it only requires frontend development only and they had a bit of excess frontend capacity. Stephanie Buck is the PO for that team and can probably tell us more about the status.

Stephanie Buck, if Firebird is going to pick this up, could you please add them as the development team and specify the Fix Version? Please keep in mind that this UICIRC is a "platform core" module so it will need to be ready for release on October 7th. If you don't think this feature will be complete by then, it should be targeted for R1 (Iris release). Thanks much!

Comment by Stephanie Buck [ 30/Sep/20 ]

Hi Debra Howell and Cate Boerema.

Firebird is the listed developer. We're still planning our feature capacity, but should know in the next week or two if it will make it into R1.

Comment by Victoria_Smelova [ 13/Nov/20 ]

Stephanie Buck, Looks like we've completed all the stories for this feature. Could you please review and confirm if anything else is expected in scope of the feature?

Comment by Cheryl Malmborg [ 13/Nov/20 ]

I tested in snapshot.dev. It looks good. We had decided to do only the drop downs option for 'all' and '!'. Both work.

Comment by Stephanie Buck [ 16/Nov/20 ]

Thanks, Cheryl Malmborg. I'll go ahead and close this feature as done.

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