WISHLIST Add SIP Support for BF field on type 10 checkin responses

Bug #1528301 reported by Blake GH
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Evergreen
Wishlist
Unassigned
SIPServer
Wishlist
Unassigned

Bug Description

It would be nice if SIP would respond with the patron's phone number for triggered checkin holds.

The specific example request is:
09N20151211 13001720151211 130017APinstituion|AOinstituion|ABbarcode|ACsip3gf00b4r|CH|BIN|AY0AZE559

and an example response is:

101NYY20151211 130018AOinstituion|ABbarcode|AQlibrary|AJOld school|CK001|CRshelf|CShide|CTbranch|CYpatron barcode|DApatron name|CV01|AY0AZCDE2

We would like the response to include:

|BFhold_phone_notify_number

Revision history for this message
Thomas Berezansky (tsbere) wrote :

Looking at my copy of the specs I only find BF defined for patron information responses, not checkin response. As such I imagine very little out there even looks for it on checkins.

Revision history for this message
Blake GH (bmagic) wrote :

We have a library moving away from CircIT to Bibliotheca - and there is an issue here with the checkin fill hold notify phone number. CircIT would ask the server for the phone number on a separate query after the checkin filled a hold. Bibliotheca's software will not. We have asked them to change their software and they will not. So, I am changing ours.

Revision history for this message
Blake GH (bmagic) wrote :
Blake GH (bmagic)
tags: added: pullrequest
Changed in evergreen:
assignee: nobody → Blake GH (blake-j)
assignee: Blake GH (blake-j) → nobody
Revision history for this message
Martha Driscoll (mjdriscoll) wrote :

We have a library using an automated handler and asked for the phone number to be included on the hold slips. This is going to work great for them. The vendor (pv-supa) can add the phone number once it is included in the checkin message.

I have tested this and confirm that the hold phone number is included in the BF field of the checkin message when a hold is present on the checked-in item.

Revision history for this message
Martha Driscoll (mjdriscoll) wrote :
tags: added: signedoff
Michele Morgan (mmorgan)
Changed in evergreen:
milestone: none → 3.0-alpha
Revision history for this message
Galen Charlton (gmc) wrote :

Since including the BF field in the checkin response message is both an extension to the protocol /and/ exposes more personally identifiable information for patrons, it needs a configuration guard similar to the relais_extensions_to_msg24 (with a default value of false).

I'm removing the pullrequest tag on that basis, but the patches otherwise look good; they just need a supplement.

Changed in evergreen:
importance: Undecided → Wishlist
Changed in sipserver:
importance: Undecided → Wishlist
Changed in evergreen:
status: New → Confirmed
Changed in sipserver:
status: New → Confirmed
tags: removed: pullrequest signedoff
Changed in evergreen:
milestone: 3.0-beta → 3.next
Elaine Hardy (ehardy)
tags: added: sip wishlist
Revision history for this message
Jason Boyer (jboyer) wrote :

I've added an institution setting to enable this extension and have 2 new signoff branches based on current master at

Evergreen: https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/jboyer/lp1528301_hold_phone_checkin_so / working/user/jboyer/lp1528301_hold_phone_checkin_so

SIPServer: https://git.evergreen-ils.org/?p=working/SIPServer.git;a=shortlog;h=refs/heads/user/jboyer/lp1528301_config_check / working/user/jboyer/lp1528301_config_check

Jason Boyer (jboyer)
tags: added: pullrequest
Jason Boyer (jboyer)
Changed in evergreen:
milestone: 3.next → 3.4.3
Jason Boyer (jboyer)
Changed in evergreen:
milestone: 3.4.3 → 3.5-alpha
Changed in evergreen:
milestone: 3.5-beta → 3.5.0
Changed in evergreen:
milestone: 3.5.0 → 3.5.1
Changed in evergreen:
milestone: 3.5.1 → 3.5.2
milestone: 3.5.2 → 3.next
milestone: 3.next → 3.6-beta
Changed in evergreen:
milestone: 3.6-beta → 3.next
Revision history for this message
Martha Driscoll (mjdriscoll) wrote :

I tested the code along with the new institution setting and find that enabling the setting provides the patron phone number in the checkin response. Leaving the setting false does not include the patron phone number in the checkin response.

With <phone_ext_to_msg10 enabled="true" />
--> 09N20210924 16165220210924 161652AP|AO|AB31400005312322|AC|AY2AZF07E
<-- 101YNY20210924 161652AO|AB31400005312322|AQBEF|AJAnd then there were none |CK001|CRAdult Fiction|CSChristie (Mystery)|CTDAN|CY21397000002688|DAMJD|BF9787778844|CV01|AY2AZCDA6

With <phone_ext_to_msg10 enabled="false" />
--> 09N20210924 16194620210924 161946AP|AO|AB31400005312322|AC|AY2AZF072
<-- 101YNY20210924 161947AO|AB31400005312322|AQBEF|AJAnd then there were none |CK001|CRAdult Fiction|CSChristie (Mystery)|CTDAN|CY21397000002688|DAMJD|CV01|AY2AZD0C8

Here is my signoff for the Evergreen code:
https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/driscoll/LP1528301_sip_BF_with_setting-signoff

Here is my signoff for the SIPServer code:
https://git.evergreen-ils.org/?p=working/SIPServer.git;a=shortlog;h=refs/heads/user/driscoll/LP1528301_sip_BF_with_setting-signoff

tags: added: signedoff
tags: removed: wishlist
Revision history for this message
Galen Charlton (gmc) wrote :

Pushed to SIPServer and to Evergreen for inclusion in 3.9-beta. Thanks, Blake, Jason, and Martha!

Changed in evergreen:
milestone: 3.next → 3.9-beta
status: Confirmed → Fix Committed
Changed in sipserver:
status: Confirmed → Fix Committed
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers