SIP2: Protocol for self-checkout (UXPROD-1001)

[UXPROD-1002] SIP2: Protocol for self-checkout - initial implementation Created: 12/Jul/18  Updated: 16/Sep/20  Resolved: 26/Jun/19

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Q2 2019
Parent: SIP2: Protocol for self-checkout

Type: New Feature Priority: P1
Reporter: Cate Boerema (Inactive) Assignee: Magda Zacharska
Resolution: Done Votes: 0
Labels: chalmers_visit_nov, external_sys_int, library_dependent, q1-2019-spillover, q2.2-2019, resourceaccess
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Cloners
clones UXPROD-557 NCIP: Protocol for ILL, Resource Shar... Closed
Defines
defines UXPROD-1001 SIP2: Protocol for self-checkout Closed
is defined by SIP2-11 SIP2: Login - startup of SC with Soc... Closed
is defined by SIP2-31 SIP2: Normal Item Checkout Closed
is defined by SIP2-32 SIP2: Normal Item Checkin Closed
is defined by SIP2-46 SIP2: Test happy path for item check in Closed
is defined by SIP2-12 SIP2: Request ACS Resend Closed
is defined by SIP2-28 SIP2: Backend Configuration - store c... Closed
is defined by SIP2-36 SIP2: Item Checkout - Item not availa... Closed
is defined by SIP2-37 SIP2: Item Checkout - Patron is not a... Closed
is defined by SIP2-38 SIP2: Encryption of the messages exch... Closed
is defined by SIP2-1 SIP2: Spike Task Closed
is defined by SIP2-2 SIP2: Define Edge API Closed
is defined by SIP2-3 SIP2: Github Project Basics Closed
is defined by SIP2-4 SIP2: Define Edge API Closed
is defined by SIP2-5 SIP2: Github Project Basics for Edge Closed
is defined by SIP2-8 SIP2: SC Status Closed
is defined by SIP2-9 SIP2: FOLIO Status - Startup and shu... Closed
is defined by SIP2-10 SIP2: Login Closed
is defined by SIP2-15 SIP2: Patron Status Response Closed
is defined by SIP2-16 SIP2: Patron Information Closed
is defined by SIP2-17 SIP2: Patron Information Response Closed
is defined by SIP2-18 SIP2: Checkout Closed
is defined by SIP2-19 SIP2: Checkout Response Closed
is defined by SIP2-20 SIP2: Checkin Closed
is defined by SIP2-30 SIP2: API test setup and cleanup Closed
is defined by SIP2-44 SIP2: Setup test environment for exch... Closed
is defined by UXPROD-21 SIP2: Checkin Response Closed
is defined by UXPROD-1360 SIP2: Edge API tests Closed
Relates
relates to UXPROD-1898 SIP2: Protocol for self-checkout - Bl... Open
relates to UXPROD-1899 SIP2: Protocol for self-checkout - Fe... Open
relates to UXPROD-1764 ILL between FOLIO libraries Open
relates to UXPROD-1799 SIP2: Protocol for self-checkout - bu... Closed
relates to UXPROD-1895 SIP2: Protocol for self-checkout - ad... Closed
Epic Link: SIP2: Protocol for self-checkout
Front End Estimator: Jakub Skoczen
Back End Estimate: XXL < 30 days
Back End Estimator: Jakub Skoczen
Estimation Notes and Assumptions: Assuming front-end only for settings.
CB: Needs to be re-estimated, as the estimates for this were for BOTH NCIP and SIP2
MMZ: Re-estimated based on the Chalmers needs. It seems that the library currently supports checking out and checking in only. All the required configuration will be handled by the back end for now.
Development Team: Prokopovych
Rank: BNCF (MVP Feb 2020): R4
Rank: Chalmers (Impl Aut 2019): R1
Rank: Chicago (MVP Sum 2020): R1
Rank: Cornell (Full Sum 2021): R1
Rank: Duke (Full Sum 2021): R1
Rank: 5Colleges (Full Jul 2021): R1
Rank: FLO (MVP Sum 2020): R1
Rank: GBV (MVP Sum 2020): R1
Rank: hbz (TBD): R1
Rank: Lehigh (MVP Summer 2020): R1
Rank: Leipzig (Full TBD): R1
Rank: MO State (MVP June 2020): R1
Rank: TAMU (MVP Jan 2021): R1
Rank: U of AL (MVP Oct 2020): R1

 Description   

Standard Interchange Protocol (SIP) was originally developed by 3M. SIP2 (version 2 of the protocol) is the most commonly adopted by library automation vendors standard for communication between ILS and self-service kiosks.

The specification: http://multimedia.3m.com/mws/media/355361O/sip2-protocol.pdf

Initial implementation includes:

  • Tenant level configuration (through API calls to mod-configuration)
  • Kiosk level configuration (through API calls to mod-configuration)
  • Check-in, check-out operation
  • Support following self-service kiosk requests and FOLIO responses:
    • Login
    • Request ACS Resend
    • Patron Status
    • Patron Information
    • Check-out
    • Check-in


 Comments   
Comment by Cate Boerema (Inactive) [ 12/Jul/18 ]

NOTE: the ranks here were made for a combined NCIP and SIP2 feature.

Comment by Cate Boerema (Inactive) [ 17/Jul/18 ]

Despite the fact that we will support NCIP ( UXPROD-991 Closed ), it seems that SIP2 is still a must-have for institutions using self-check (most). Most self-check vendors have not implemented NCIP and rely still on SIP2. This is per feedback from Andrea and the RA SIG. Ingolf also provided this feedback from the German library consortia:
-------------------------------------
Here are the requirements of hbz and GBV for SIP2 and NCIP support:

In the criteria catalog for next generation systems, from hbz and GBV, NCIP and SIP2 are both rated "must have".

Here are the relevant four lines out of that catalog:
topic - requirement - rating
SIP2 - The system can use the full functionality of the SIP2 interface, which is required for the operation of self service loan/return machines and self service pay machines. - must have
NCIP - The system can use the full functionality of the NCIP interface (Z39.83), which is required for the operation of self-service machines, at least the Core Services (Check In Item, Check Out Item, Lookup Item, Lookup User, Renew Item, Accept Item, Cancel Request Item, Recall Item, Request Item). - must have
NCIP for ILL - The system supports NCIP (Z39.83) for the integration of interlibrary loans using the following standard protocolls: ISO10160/10161 and ANSI/NISO z39.83 (NCIP). - must have (depends)
SLNP - The system can handle ILL using SLNP (Simple Library Network Protocol). The supported SLNP commands are SLNPFLBestellung (lending and receiving), SLNPPFLDatenAenderung (cancellation etc), SLNPInfo2FLServer, SLNPFLHistory and SLNPKleineKasse. - must have (depends)

It means that some libraries in the two networks use SIP2 for self service machines. SIP2 is required by libraries which use Bibliotheca automatons.
Other libraries use NCIP for self-service machines.

hbz uses the SLNP protocol for communication with the central ILL server.
GBV does not use NCIP for the communication of the ILS with the ILL server. Only a single library of the GBV network uses NCIP, and this is for the booking of ILL fees.
---------------------------------------
I will put something in the backlog for SLNP support, as we aren't yet tracking that.

Comment by Theodor Tolstoy (One-Group.se) [ 09/Oct/18 ]

Chalmers need either NCIP or SIP2, and needs to know which one is going to get developed first...

Comment by Cate Boerema (Inactive) [ 10/Oct/18 ]

Theodor Tolstoy (One-Group.se), NCIP will be developed first: UXPROD-557 Closed . If you have questions about which services are specifically planned for the Q4 release, check out that epic. Michelle has tagged a most (all?) of them for Q4 2018.

Comment by Theodor Tolstoy (One-Group.se) [ 16/Oct/18 ]

we will leave this for go-live until we have met with the vendor of the self-service machines. Will likely not need this, but in case they do not support NCIP things might change.

Comment by Theodor Tolstoy (One-Group.se) [ 15/Nov/18 ]

After discussions with Chalmers' Kiosk vendor, it is now clear that they will not be able to support NCIP in the foreseeable future. Therefore, SIP2 is once again a feature needed for Go-live

Comment by Cate Boerema (Inactive) [ 09/Jan/19 ]

Hi Hkaplanian, this feature should only be marked analysis complete when all the user stories are written.

Comment by Cate Boerema (Inactive) [ 13/Feb/19 ]

Current planning indicates this will not make Q1 2019 release as originally planned. I have changed the fix version to Q2 and added the label "q1-2019-carryover".

Comment by Magda Zacharska [ 26/Jun/19 ]

Covers initial version that supports check out and check in functionality

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