Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems (UXPROD-2598)

[UXPROD-2782] Handle Check-In of INN-Reach Items Created: 26/Oct/20  Updated: 18/Feb/22  Resolved: 18/Feb/22

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Lotus (R1 2022)
Parent: Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems

Type: New Feature Priority: TBD
Reporter: Brooks Travis Assignee: Brooks Travis
Resolution: Done Votes: 0
Labels: consortia, d2ir-circulation-flow
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by MODINREACH-164 INN-Reach Circulation Flow: React to ... Closed
is defined by MODINREACH-169 INN-Reach Circulation Flow: React to ... Closed
is defined by MODINREACH-175 INN-Reach Circulation Flow: React to ... Closed
is defined by UIINREACH-78 INN-Reach Staff Interface: Receive Sh... Closed
is defined by UIINREACH-109 INN-Reach Staff Interface: Print Slip... Closed
is defined by MODINREACH-150 INN-Reach Circulation Flow Action: Re... Closed
Relates
relates to MODINREACH-157 INN-Reach Circulation Flow Action: Re... Closed
relates to UIINREACH-80 INN-Reach Staff Interface: INN-Reach ... Closed
relates to UXPROD-2903 Handle Checkout of INN-Reach Items by... Closed
Requires
requires UXPROD-2673 Implement Oauth2 Consumer for Request... Closed
requires UXPROD-3380 Add Kafka Message Queues to Select Ci... Closed
Epic Link: Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems
Front End Estimate: Out of scope
Back End Estimate: XL < 15 days
Development Team: Volaris
PO Rank: 90
Rank: Chicago (MVP Sum 2020): R5
Rank: Cornell (Full Sum 2021): R5
Rank: Duke (Full Sum 2021): R5
Rank: 5Colleges (Full Jul 2021): R5
Rank: GBV (MVP Sum 2020): R5
Rank: Grand Valley (Full Sum 2021): R2
Rank: MO State (MVP June 2020): R2
Rank: TAMU (MVP Jan 2021): R5
Rank: U of AL (MVP Oct 2020): R5

 Description   

Current situation or problem:
FOLIO items lent or borrowed via INN-Reach will need to be checked in when received, returned, or expired from the hold shelf. These transactions should trigger calls from FOLIO to the INN-Reach central server, when required by the transaction type:

  • Report Item Received (Borrowing Site)
  • Return Uncirculated Item/Hold shelf expired (Borrowing Site)
  • Item In Transit/Borrower Returned Item (Borrowing Site)
  • Final Item Check-in (Owning Site)

This should generally be accomplished using the built-in FOLIO "Check In" app, if possible, with an exception for items not properly checked out by the lending library (a.k.a. "Report Unshipped Item Received"). In this case an interface should be provided to determine the associated request and notify the central server of receipt.

In scope

  • An interface/UI function to review outstanding INN-Reach requests and associate a received item for which there is no corresponding shipped item notification.
  • A method to notify the INN-Reach module(s) when items are checked in to FOLIO's standard check-in app.
  • Logic in INN-Reach module(s) to initiate proper API calls for relevant checked-in items, based on status of INN-Reach transaction associated with said item.

Out of scope

Use case(s)

Proposed solution/stories

Thin Thread (R1 2022: Lotus):

When items associated with an open INN-Reach transaction are checked in, they can be checked in via one of the following workflows:

  • A dedicated check-in "mode" in the INN-Reach App that duplicates the functionality and interface of the standard FOLIO Check In app but also performs the following operations when an item is checked in:
    1. Looks up the INN-Reach circulation transaction associated with the item.
    2. If the item has not been received and FOLIO request status is "Open - in transit" (borrowing site):
      • Initiate an "ITEM_RECEIVED" status update to the INN-Reach central server
    3. If the item has an associated loan (borrowing site):
      • Initiate an "IN_TRANSIT" status update to the INN-Reach central server for the item.
    4. If the item has not been checked out and the hold shelf expiration has passed (borrowing site):
      • Initiate an "RETURN_UNCIRCULATED" status update to the INN-Reach central server for the item.
    5. If the item has an associated loan (owning site)
      • Initiate a "FINAL_CHECKIN" status update to the INN-Reach central server for the item.
    6. If the item is not found in FOLIO Inventory, present a dialog box with the following message:
      • No INN-Reach transaction found for this item. Item may not have been checked out by owning site.
  • The built-in Check In app:
    1. Item is checked in and the standard check-in operations are performed.
    2. An "in-transit" modal is presented because the home location of the item is INN-Reach (TBD)
    3. Staff then checks the item in, again, via the dedicated INN-Reach check-in interface described above.

Preferred Solution (R2 2022: Morning Glory or Later):
Add PubSub/Kafka message publication to circulation check-in transactions and create a listener for these messages in INN-Reach module(s) and:

  1. Look up the INN-Reach circulation transaction associated with the item.
  2. If the item has not been received and FOLIO request status is "Open - in transit" (borrowing site):
    • Initiate an "ITEM_RECEIVED" status update to the INN-Reach central server
  3. If the item has an associated loan (borrowing site):
    • Initiate an "IN_TRANSIT" status update to the INN-Reach central server for the item.
  4. If the item has not been checked out and the hold shelf expiration has passed (borrowing site):
    • Initiate an "RETURN_UNCIRCULATED" status update to the INN-Reach central server for the item.
  5. If the item has an associated loan (owning site)
    • Initiate a "FINAL_CHECKIN" status update to the INN-Reach central server for the item.

Links to additional info

Questions

  • How do we handle the possibility that a suffix has been added to the barcode of the item to account for/avoid potential collision with an existing local item record?
    • Disambiguation check?


 Comments   
Comment by Brooks Travis [ 18/Feb/22 ]

Verified in Rancher

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