Requests (UXPROD-790)

[UXPROD-498] Remote Storage Integration Module (Caiasoft) Created: 11/Apr/18  Updated: 21/Jun/21  Resolved: 21/Jun/21

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: R2 2021
Parent: Requests

Type: New Feature Priority: P3
Reporter: Cate Boerema (Inactive) Assignee: Stephanie Buck
Resolution: Done Votes: 0
Labels: cap-mvp, po-mvp, q4-2019-at-risk, q4-2019-spillover, r2-2021-at-risk, requests
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by MODRS-56 Accession flow (Dematic) doesn't work Closed
is defined by EDGCSOFT-1 Project Setup: edge-caiasoft Closed
is defined by EDGCSOFT-2 Create edge-caiasoft GitHub repository Closed
is defined by EDGCSOFT-4 Caiasoft Accession Flow (adding an it... Closed
is defined by EDGCSOFT-5 Requesting a Remote Storage Item for ... Closed
is defined by EDGDEMATIC-9 Parsing API token information Closed
is defined by EDGDEMATIC-19 Make deployment parameters configurable Closed
is defined by MODRS-19 [SPIKE] Find out how to handle Cornel... Closed
is defined by MODRS-22 Health-check for mod-remote-storage Closed
is defined by MODRS-23 Add CaiaSoft Provider to providers list Closed
is defined by MODRS-24 Extend RS configuration to support ac... Closed
is defined by MODRS-27 Refactor system user creation logic Closed
is defined by MODRS-36 Mark fields as required Closed
is defined by MODRS-37 CaiaSoft: Accession Flow Closed
is defined by MODRS-47 Accession Queue Record updating for C... Closed
is defined by MODRS-57 Check-In item by corresponding holdId Closed
is defined by UIRS-15 Remote Storage Settings: Credential p... Closed
is defined by UIRS-21 Add CaiaSoft to remote storage dropdowns Closed
is defined by UIRS-23 Create Settings > Remote storage > Ac... Closed
is defined by UIRS-24 Create Settings > Remote storage > Re... Closed
is defined by UIRS-37 Update remote storage look and feel Closed
is defined by EDGCSOFT-6 Returning an Item to remote storage Closed
is defined by EDGCSOFT-7 Staff Slips support for CaiaSoft Closed
is defined by EDGCSOFT-13 Deployment with aws params for creden... Closed
is defined by MODINV-421 Permission error while executing GET ... Closed
is defined by MODRS-38 Caiasoft: Requesting a Remote Storage... Closed
is defined by MODRS-39 Caiasoft: Returning an Item to remote... Closed
is defined by MODRS-40 Caiasoft: Holdings duplication during... Closed
is defined by MODRS-43 Caiasoft: Returning an Item to remote... Closed
is defined by UIRS-16 Remote storage: Retrieval configuration Closed
is defined by UIRS-17 Remote storage configuration - CaiaSoft Closed
Relates
relates to UXPROD-2880 Remote storage: automatically split h... Closed
relates to UXPROD-2882 Remote storage: Deaccessioning Draft
relates to UXPROD-1516 Automated Storage and Retrieval Syste... Draft
relates to UXPROD-2881 Remote storage: bulk accessioning Draft
relates to UXPROD-2696 Remote Storage Integration (Dematic t... Closed
relates to UXPROD-2879 Remote storage: Reports Blocked
Potential Workaround: Cate Boerema: As far as I know, there is no workaround for this for institutions that use remote storage (many). For this reason, I have significantly increased the ranking and marked po-mvp
Epic Link: Requests
Front End Estimate: Medium < 5 days
Front End Estimator: Alex Mozolev
Back End Estimate: XXL < 30 days
Back End Estimator: Viachaslau Khandramai (Inactive)
Estimation Notes and Assumptions: Cate reduced back end estimate from 10 to 5 days because it is now thought that Caiasoft will develop the edge apis. All that will be left for FOLIO developers will be any settings pages that might be needed (and that might also be able to be developed by Caiasoft)
Development Team: Firebird
PO Rank: 100
PO Ranking Note: 2019-07-12: Increased the ranking relative to calculated because, as far as I know, there is no workaround for institutions that have remote storage (many).
Cap Plan Fix Version (DO NOT CHANGE): R2 2021
Rank: Chalmers (Impl Aut 2019): R4
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): R4
Rank: Grand Valley (Full Sum 2021): R1
Rank: hbz (TBD): R4
Rank: Hungary (MVP End 2020): R1
Rank: Lehigh (MVP Summer 2020): R1
Rank: Leipzig (Full TBD): R5
Rank: MO State (MVP June 2020): R5
Rank: TAMU (MVP Jan 2021): R1
Rank: U of AL (MVP Oct 2020): R2

 Description   

Update 2021-1-13
This feature will cover must-have features for Summer 2021 go-live institutions:

  • Accession
  • Requesting an item for circulation
  • Returning an item to remote storage

The Accession workflow will require some development work around APIs and edge-APIs. Mikhail Fokanov is working with Laura Beatham at CaiaSoft to review code.

Remote storage configuration and settings development are covered in UXPROD-2696 Closed , along with the bulk of development needed for Requesting items and Returning items. They use the same workflows.

Caiasoft MVP workflows & requirements doc: https://drive.google.com/file/d/1iS8nKYkIP4Q7BA0i8tU6csLqvgEiYRta/view?usp=sharing

Cornell Caiasoft workflows: https://docs.google.com/document/d/1TP4nSNtEkvOnT-tE2yhwqElVtf2aW--EefW9OKhBLjc/edit?usp=sharing

Duke Caiasoft workflows: https://docs.google.com/document/d/1e3vSoerJgYoZpCWW7mDUTaMdfPjVIwCoJdSdOPdMOQU/edit?usp=sharing 

Vision document: https://docs.google.com/document/d/1kMTq4D6PBWsTrEOsn-GIUgFt7vbGKxA2/edit#

Update 2019-12-17 Current planning is that Caiasoft will do the bulk of the development on the edge apis. Still reserving some time on this feature for FOLIO development for any settings pages that might be needed.

Purpose: Implement a FOLIO/Caiasoft integration module that would could serve as a model for integration with other remote storage systems (many of the FOLIO community institutions have homegrown systems). For details on remote storage systems and SMEs in the FOLIO community, please see: https://folio-org.atlassian.net/wiki/display/RA/RA+-+Off-site+integration?focusedCommentId=14463074#comment-14463074 The Smith-developed homegrown remote storage system used by 5 Colleges is up on Github if people want to take a look at how that works: https://github.com/SmithCollegeLibraries/sis-inventory-management

Current thinking on design: Original thinking on design (see below) was that we could leverage existing page request functionality for remote storage requests and all we really needed was to ensure we had an edge api for page requesting. We still intend to leverage page request functionality, but we have decided to develop a FOLIO/Caiasoft Integration Module which would serve as an abstraction layer between the two systems. This will help protect the integration against disruption as both systems are likely to change and direct integration would be brittle.

The current thinking is documented in detail on the FOLIO wiki here: https://folio-org.atlassian.net/wiki/display/RA/Caiasoft+Managed+Remote+Storage

NOTE: A separate feature has been created for the work needed to support automated storage and retreival systems (like the one in place at Chicago). See UXPROD-1516 Draft for details.

-------------------------------------

Original (old) thinking on design:

  • Existing page request functionality should work for remote storage requests
  • FOLIO needs an API that remote storage systems can call to determine what new page requests have been created for remote storage locations
  • API response should include data such as:
    • Requested item barcode
    • Requested item's effective location
  • Process will work something like this:
    • Page request is created in FOLIO for item with effective location of, say, "Remote storage A"
    • The remote storage system calls API to determine if new page requests have been created for items in "Remote storage A" - this may happen on-demand or on a regular chron job
    • When the new request comes through, staff retrieves the requested item from remote storage and scans it into FOLIO check in app at the service point in the remote storage facility
    • FOLIO tells the staff where the item needs to be routed to fulfill the request (to the pickup service point specified in the request)


 Comments   
Comment by Anya [ 29/Mar/19 ]

Comment from March Meeting: Check for UA as long as FOLIO can route for a different annex systems - patty.wanninger

Comment by Cate Boerema (Inactive) [ 04/Apr/19 ]

Removed all the dev estimates because the scope has significantly changed. Current thinking is that we don't need a special request type, but that we just need an API for integration with remote storage systems.

Comment by Cate Boerema (Inactive) [ 15/May/19 ]

Matt Reno would you be able to provide an estimate for this feature? Seems up your alley, as it looks like just an (edge?) api. LMK if you have questions.

Comment by Matt Reno [ 16/May/19 ]

Cate Boerema, I would think that implementing a simple edge API for returning page requests would take 1 resource 1 sprint to complete. This is assuming requirements gathering is already complete and it is clear what the endpoints for the API are, what content the API returns, format, etc.

Comment by Marc Johnson [ 16/May/19 ]

Matt Reno Is that estimate based upon the API being added to an existing edge module, or does it include introducing a new edge module?

Comment by Matt Reno [ 16/May/19 ]

Marc Johnson I was basing the estimate on creating a new edge module. A lot of boilerplate work is taken care of by using edge-common.

Comment by Marc Johnson [ 16/May/19 ]

Matt Reno Fair enough. It seemed small to me for that situation, so I wanted to ask. You've had personal experience of that work and I haven't, so I'll trust your evaluation.

Comment by Cate Boerema (Inactive) [ 20/May/19 ]

Thanks Matt Reno! For UXPROD features, estimates are entered into the "Backend estimate" field (edit record to view this field) and you should also add your name as the Backend estimator. I've done this on this issue so you are all set here, but I thought I'd mention it for future reference. Thanks!

Comment by Tod Olson [ 26/Jul/19 ]

If the description of CAIASOFT Integration is representative, and the needs for this ticket and for UXPROD-1516 Draft are remarkably similar. There may be considerable reuse between the two.

Comment by Hkaplanian [ 02/Aug/19 ]

Tod Olson, are UXPROD 1516 and this issue the same? How can we determine what the differences are? Can they use the same APIs? Just wondering based on my discussions with Caiasoft.

Comment by Tod Olson [ 05/Aug/19 ]

Hkaplanian I'm not certain if this is exactly the same as UXPROD-1516 Draft , or if they are just darn close. They are certainly closely related.

For the case of the ASR at UChicago, we will be talking with Dematic to find out what their API requirements are. I suspect they will be slightly different from Caiasoft on the wire, but hope that we can either built a shim or reuse the underlying parts of the Caiasoft module.

Comment by Cate Boerema (Inactive) [ 06/Sep/19 ]

Hkaplanian and Tod Olson this is different then UXPROD-1516 Draft . Our intention was to leverage the existing "Page" request type for remote storage requests. That means the only work needed to complete this feature is API work.

UXPROD-1516 Draft is specific to automated storage and retrieval systems and, per discussion with David Bottorff and Cheryl Malmborg, the best approach for those is to create a new request type. So the work needed for that will require the creation of a new request type in FOLIO. The edge apis created for this feature should be reusable for the integration on that one.

Comment by Andrea Loigman [ 31/Oct/19 ]

I see that this is now on the Q4 at risk list. I understand why that has happened, but I can state categorically that no institution with offsite storage will be able to go live without this feature.

Comment by Cate Boerema (Inactive) [ 06/Nov/19 ]

Understood, Andrea Loigman. The reason for the delay has been time required to iron out the design. On the plus side, the design is basically complete and Laura Beatham has agreed to have Caiasoft do the development! It sounds like she is pretty confident they could get this done quickly.
Still, given we are only a few weeks away from the Q4 module release deadline and this isn't started, I am going to go ahead and move the fix version ot Q1 2020.

Comment by Khalilah Gambrell [ 10/Dec/19 ]

Cate Boerema - should this feature be assigned to Vega?

Comment by Cate Boerema (Inactive) [ 10/Dec/19 ]

I removed the assignment. At this point it could go to any team (assuming there is even work to do that Caiasoft isn't doing themselves)

Comment by Debra Howell [ 08/Oct/20 ]

Cate Boerema and Stephanie Buck Can we please get an update on this feature? It is critical to go-live. Thanks!

Comment by Stephanie Buck [ 08/Oct/20 ]

Hi Debra Howell. I will be updating this feature in the next week or so. It is still planned to be completed in time for institutions to implement in June 2021.

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