[UXPROD-498] Remote Storage Integration Module (Caiasoft) - FOLIO Issue Tracker

XML

Word

Printable

Details

Type: New Feature
Status: Closed (View Workflow)
Priority: P3
Resolution: Done
Affects Version/s: None
Fix Version/s: R2 2021
Component/s: None
Labels:

Template:

UXPROD features
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
Back End Estimate:
XXL < 30 days
Estimation Notes and Assumptions:

Hide
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)

Show
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
Calculated Total Rank:
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~~, 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://wiki.folio.org/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://wiki.folio.org/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 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)

TestRail: Results

Attachments

Issue Links

is defined by

EDGCSOFT-1 Project Setup: edge-caiasoft

Closed

EDGCSOFT-2 Create edge-caiasoft GitHub repository

Closed

EDGCSOFT-4 Caiasoft Accession Flow (adding an item to remote storage)

Closed

EDGCSOFT-5 Requesting a Remote Storage Item for Circulation

Closed

EDGCSOFT-6 Returning an Item to remote storage

Closed

EDGCSOFT-7 Staff Slips support for CaiaSoft

Closed

EDGCSOFT-13 Deployment with aws params for credentials produces exception

Closed

EDGDEMATIC-9 Parsing API token information

Closed

EDGDEMATIC-19 Make deployment parameters configurable

Closed

MODINV-421 Permission error while executing GET /inventory/instances endpoint

Closed

MODRS-19 [SPIKE] Find out how to handle Cornell check-in workflow

Closed

MODRS-22 Health-check for mod-remote-storage

Closed

MODRS-23 Add CaiaSoft Provider to providers list

Closed

MODRS-24 Extend RS configuration to support accession/return workflows for CaiaSoft

Closed

MODRS-27 Refactor system user creation logic

Closed

MODRS-36 Mark fields as required

Closed

MODRS-37 CaiaSoft: Accession Flow

Closed

MODRS-38 Caiasoft: Requesting a Remote Storage Item for Circulation

Closed

MODRS-39 Caiasoft: Returning an Item to remote storage (Duke flow)

Closed

MODRS-40 Caiasoft: Holdings duplication during accession flow

Closed

MODRS-43 Caiasoft: Returning an Item to remote storage (Cornell flow)

Closed

MODRS-47 Accession Queue Record updating for CaiaSoft Integration

Closed

MODRS-56 Accession flow (Dematic) doesn't work

Closed

MODRS-57 Check-In item by corresponding holdId

Closed

UIRS-15 Remote Storage Settings: Credential properties (apiKey)

Closed

UIRS-16 Remote storage: Retrieval configuration

Closed

UIRS-17 Remote storage configuration - CaiaSoft

Closed

UIRS-21 Add CaiaSoft to remote storage dropdowns

Closed

UIRS-23 Create Settings > Remote storage > Accession workflow preference

Closed

UIRS-24 Create Settings > Remote storage > Returning workflow preference

Closed

UIRS-37 Update remote storage look and feel

Closed

relates to

UXPROD-1516 Automated Storage and Retrieval System Requests

Draft

UXPROD-2880 Remote storage: automatically split holdings

Closed

UXPROD-2881 Remote storage: bulk accessioning

Draft

UXPROD-2882 Remote storage: Deaccessioning

Draft

UXPROD-2696 Remote Storage Integration (Dematic thin thread)

Closed

UXPROD-2879 Remote storage: Reports

Blocked

(26 is defined by , 6 relates to)

Activity

People

Assignee:: Stephanie Buck

Reporter:: Cate Boerema

Front End Estimator:: Alex Mozolev

Back End Estimator:: Viachaslau Khandramai

Votes:: 0 Vote for this issue

Watchers:: 11 Start watching this issue

Dates

Created:: 11/Apr/18 4:23 PM

Updated:: 21/Jun/21 5:18 PM

Resolved:: 21/Jun/21 5:18 PM

Remote Storage Integration Module (Caiasoft)