Store separate loan and request status for items
RCA Group
Description
Environment
Potential Workaround
blocks
is blocked by
Checklist
hideTestRail: Results
Activity
Marc Johnson August 16, 2018 at 10:37 AM
Am closing this as it has been superseded by the ongoing conversations around item status
Cate Boerema October 11, 2017 at 1:28 PM
Sounds good. Thanks, Marc!
Marc Johnson October 11, 2017 at 12:40 PMEdited
Hi @Cate Boerema,
Thank you for the reporting context on the separation of item status, it is useful to understand that need better (and how it relates to some of the conversations Jakub and I have had about keeping them separate for other reasons) and how we want the separate states to not be presented to the user. And for the reminder about sentence casing, I will be diligent of that when making the changes.
I’ve been working through how these different changes will work together, and how they impact each other, with Ian and I think we have identified a sequence of work that helps us make progress whilst also allow us to address these topics.
As part of this, I believe that including the overall item status in the loan action history and changing the loan / loan action history when a request is made, is likely to have an impact on both how we split the states and on where the overall status is determined. I am happy to expand on the reasoning behind this (and the options I think are available) now if that would be helpful (otherwise I’ll include those thoughts in during 4 of the proposal below)?
As per our brief follow up conversation, I have raised [FOLIO-892] to discuss the value of an explicit status on the loan, once we also have a snapshot of the overall item status present in the loan and/or loan action history.
Considerations
Make progress on item status changing upon requests and including a snapshot of the overall item status in the loan action history
Need for further investigation the impact that storing a snapshot of the overall item status on
Allow for ongoing inventory work (shelving locations) to complete before making the status separation change
Proposed Sequence
1. Change the overall item status when a request is made (https://folio-org.atlassian.net/browse/CIRC-39#icft=CIRC-39, https://folio-org.atlassian.net/browse/UIIT-42#icft=UIIT-42)
2. Include overall item status in loan action history (https://folio-org.atlassian.net/browse/CIRCSTORE-27#icft=CIRCSTORE-27, https://folio-org.atlassian.net/browse/CIRC-38#icft=CIRC-38, https://folio-org.atlassian.net/browse/UIIT-42#icft=UIIT-42, https://folio-org.atlassian.net/browse/UIU-177#icft=UIU-177 or https://folio-org.atlassian.net/browse/UIU-179#icft=UIU-179)
3. Include request actions in loan action history (https://folio-org.atlassian.net/browse/CIRC-40#icft=CIRC-40, https://folio-org.atlassian.net/browse/UIIT-42#icft=UIIT-42, https://folio-org.atlassian.net/browse/UIU-253#icft=UIU-253)
Determine which loan to be changed
4. Split item status and derive overall status (https://folio-org.atlassian.net/browse/MODINV-19#icft=MODINV-19)Store the separate states for an item (https://folio-org.atlassian.net/browse/MODINVSTOR-16#icft=MODINVSTOR-16)
Do further design investigation into the impact on this of storing a snapshot of overall item status in loan action history (ideally with input from @Jakub Skoczen if he is back)
I think I can make good progress on the first 3 of these (and hopefully write up my thoughts on status split) this week, we can then review on Monday if there is potential value in splitting this work up between other people. Does this sound like a sensible plan?
I’ll raise, and expand upon, the specific questions I have on the individual backend issues (unless you'd prefer me to ask them on the frontend issues instead).
Cate Boerema October 10, 2017 at 10:26 AMEdited
Hi Marc, the user benefit of retaining a separate item loan status and item request status on the back-end while displaying a combined item status in the UI is that it makes the creation of certain reports easier. So, if I want to generate a report on all the items currently checked out, I could just filter by item loan status = checked out instead of having to filter by item status = checked out OR checked out - recalled OR checked out - hold. Other than reporting, I really don't want to see/deal with separate item loan status and item request status in FOLIO. I just want to see overall item status.
With that in mind, I don't think we want to loan status values to differ much from the item status values (except that item status values sometimes also include request status ones). Also, please note, we should be using sentence case throughout FOLIO. So please use "Checked out" instead of "Checked Out".
Inline.
When checking out an item
Loan status should be Open Checked out
The loan action history should have a new entry with action of Check Out and item status of Checked Out
Item loan status should be Checked out
I don't understand how "item loan status" differs from "loan status" in the first bullet. I am assuming the are the same.
Overall item status should be Checked Out
When checking in / returning an item
Loan status should be Closed Available
The loan action history should have a new entry with action of Check In and item status of Checked In Available
Item loan status should be Available
Overall item status should be Available
When renewing an existing loan
Loan status should be Open Checked out
The loan action history should have a new entry with action of Renew and item status of Checked Out
Item loan status should be Checked Out
Overall item status should be Checked Out Actually, it would just be unchanged from whatever it was before which could also have been Checked out - hold etc
When requesting an item that is checked out to another patron
Loan status should be Open Checked out
The loan action history should have an entry with action of Hold Requested / Recall Requested and item status of Checked Out - Held / Checked Out - Recalled
Item loan status should be Checked Out
Item request status should be Held / Recalled
Overall item status should be Checked Out - Held / Checked Out - Recalled
What should happen when an item is returned after a request (e.g. should the item request status change)? Yes, but we haven't worked through the requirements of how yet.
Does this reflect the extent of the changes we are expecting (inc soon to be added actions)? This is all I know of at the moment but I fully expect there will be many more actions to log (e.g. notification sent, fine charged etc) some of which will change the status and some of which will not.
Marc Johnson October 9, 2017 at 4:44 PM
@Cate Boerema @Jakub Skoczen
Following the conversations in today's meetings, and in order to help design the solution for this and the backend to support https://folio-org.atlassian.net/browse/UIU-179#icft=UIU-179, I wanted to clarify what are the consequences of loan or request actions, that we want to model in the near future. I wasn't sure where to ask this, so I chose here, if there is a better place, please let me know and I'll move it.
When checking out an item
Loan status should be Open
The loan action history should have a new entry with action of Check Out and item status of Checked Out
Item loan status should be Checked Out
Overall item status should be Checked Out
When checking in / returning an item
Loan status should be Closed
The loan action history should have a new entry with action of Check In and item status of Checked In
Item loan status should be Available
Overall item status should be Available
When renewing an existing loan
Loan status should be Open
The loan action history should have a new entry with action of Renew and item status of Checked Out
Item loan status should be Checked Out
Overall item status should be Checked Out
When requesting an item that is checked out to another patron
Loan status should be Open
The loan action history should have an entry with action of Hold Requested / Recall Requested and item status of Checked Out - Held / Checked Out - Recalled
Item loan status should be Checked Out
Item request status should be Held / Recalled
Overall item status should be Checked Out - Held / Checked Out - Recalled
What should happen when an item is returned after a request (e.g. should the item request status change)?
Does this reflect the extent of the changes we are expecting (inc soon to be added actions)?
In order to differentiate between different aspects of the item status, and change them independently, store a separate loan and request status for an item. An overall item status needs to be derived from these states (additional separate states may be added in the future).
Related Resources
Resource Access Item Status
https://folio-org.atlassian.net/wiki/display/RA/Circulation+components#Circulationcomponents-itemstatuses
Codex Metadata
https://folio-org.atlassian.net/browse/UIIT-20?jql=text%20~%20%22codex%22
JSON Schema: https://folio-org.atlassian.net/wiki/pages/viewpage.action?pageId=5854462
Inventory Metadata
https://folio-org.atlassian.net/wiki/display/PLATFORM/Inventory+Metadata+Elements