User Tools

Site Tools


evergreen-admin:sip_support

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
evergreen-admin:sip_support [2010/06/09 13:12]
jatzberger
evergreen-admin:sip_support [2012/11/08 13:42]
gmcharlton [SIP Support] reference to Evergreen manual is now out of date
Line 4: Line 4:
 Installation instructions for SIP on Evergreen can be found [[sip|here]]. Installation instructions for SIP on Evergreen can be found [[sip|here]].
  
-A test SIP server ​can be accessed using information [[demo:​sip_credentials|here]].+FIXME We need a new demonstration ​server ​for SIP.
  
 Where page numbers are cited, we are referring to the "​3M(tm) Standard Interchange Protocol: Describes 3M Standard Interchange Protocol Version 2.0" document, revision 2.10 updated 9/17/1998. Where page numbers are cited, we are referring to the "​3M(tm) Standard Interchange Protocol: Describes 3M Standard Interchange Protocol Version 2.0" document, revision 2.10 updated 9/17/1998.
- 
 ===== Background ===== ===== Background =====
 SIP, standing for Standard Interchange Protocol, was developed by the 3M corporation to be a common protocol for data transfer between ILS' (referred to in SIP as an "​ACS",​ or "​Automated Circulation System"​) and a third party device. ​ Originally, the protocol was developed for use with 3M SelfCheck (often abbreviated SC, not to be confused with Staff Client) systems, but has since expanded to other companies and devices. ​ It is now common to find SIP in use in several other vendors'​ SelfCheck systems, as well as other non-SelfCheck devices. ​ Some examples include: SIP, standing for Standard Interchange Protocol, was developed by the 3M corporation to be a common protocol for data transfer between ILS' (referred to in SIP as an "​ACS",​ or "​Automated Circulation System"​) and a third party device. ​ Originally, the protocol was developed for use with 3M SelfCheck (often abbreviated SC, not to be confused with Staff Client) systems, but has since expanded to other companies and devices. ​ It is now common to find SIP in use in several other vendors'​ SelfCheck systems, as well as other non-SelfCheck devices. ​ Some examples include:
Line 86: Line 85:
 <​code>​ <​code>​
 09N20100507 ​   16593720100507 ​   165937APCheckin Bin 5|AOBR1|AB1565921879|ACsip_01| 09N20100507 ​   16593720100507 ​   165937APCheckin Bin 5|AOBR1|AB1565921879|ACsip_01|
-101YNY20100603 ​   205022AOBR1|AB1565921879|AQExample Branch 1|AJPerl 5 desktop reference|CK001|CTBR3|CY373827|DANicholas Richard Woodard|CV02|+101YNY20100623 ​   165731AOBR1|AB1565921879|AQBR1|AJPerl 5 desktop reference|CK001|CSQA76.73.P33V76 1996|CTBR3|CY373827|DANicholas Richard Woodard|CV02|
 </​code>​ </​code>​
  
Line 113: Line 112:
  
 <​code>​ <​code>​
-17<​xact_date>​AO<​institution_id>​|AB<​item_id>​|[Fields: AC - terminal password]+17<​xact_date>​[fieldsAO,AB,AC]
 </​code>​ </​code>​
  
-The following structure is for SIP2.  Version 1 of the protocol had only 6 total fields.+The request is very terse. ​ AC is optional. 
 + 
 +The following ​response ​structure is for SIP2.  ​(Version 1 of the protocol had only 6 total fields.)
 <​code>​ <​code>​
-18<​circulation_status><​security_marker><​fee_type><​xact_date>​[Fields: CF,​AH,​CJ,​CM,​AB,​AJ,​BG,​BH,​BV,​CK,​AQ,​AP,​CH,​AF,​AG]+18<​circulation_status><​security_marker><​fee_type><​xact_date>​[fields: CF,​AH,​CJ,​CM,​AB,​AJ,​BG,​BH,​BV,​CK,​AQ,​AP,​CH,​AF,​AG,+CT,+CS]
 </​code>​ </​code>​
  
Line 126: Line 127:
 1720060110 ​   215612AOBR1|ABno_such_barcode| 1720060110 ​   215612AOBR1|ABno_such_barcode|
 1801010120100609 ​   162510ABno_such_barcode|AJ| 1801010120100609 ​   162510ABno_such_barcode|AJ|
-1720060110 ​   215612AOBR1|AB858115052035+1720060110 ​   215612AOBR1|AB1565921879
-1810020120100609 ​   162445AB858115052035|AJTribal unit |CK001|AQExample Branch 1|APExample Branch 1|BGExample Branch 1|+1810020120100623 ​   171415AB1565921879|AJPerl 5 desktop reference|CK001|AQBR1|APBR1|BGBR1|CTBR3|CSQA76.73.P33V76 1996|
 </​code>​ </​code>​
  
-The first case is with a bogus barcode. ​ The latter shows an item with a circulation_status of "​10"​ for "in transit between libraries"​. ​ The known values of circulation_status are enumerated in the spec.+The first case is with a bogus barcode. ​ The latter shows an item with a circulation_status of "​10"​ for "in transit between libraries"​. ​ The known values of circulation_status are enumerated in the spec.   
 + 
 +EXTENSIONS: The CT field for "​destination location"​ and CS "call number"​ are used by Automated Material Handling systems.  ​
  
 ==== 19/20 Item Status Update ==== ==== 19/20 Item Status Update ====
Line 163: Line 166:
 ==== 37/38 Fee Paid ==== ==== 37/38 Fee Paid ====
 Not implemented. Not implemented.
- 
 ==== 63/64 Patron Information ==== ==== 63/64 Patron Information ====
 +Attempting to retrieve patron info with a bad barcode:
 +<​code>​
 +6300020060329 ​   201700 ​         AOBR1|AAbad_barcode|
 +64YYYY ​         00020100623 ​   141130000000000000000000000000AE|AAbad_barcode|BLN|AOBR1|
 +</​code>​
 +
 +Attempting to retrieve patron info with a good barcode (but bad patron password):
 +<​code>​
 +6300020060329 ​   201700 ​         AOBR1|AA999999|ADbadpwd|
 +64  Y           ​00020100623 ​   141130000000000000000000000000AA999999|AEDavid J. Fiander|BHUSD|BV0.00|BD2 Meadowvale Dr. St Thomas, ON Canada 90210|BEdjfiander@somemail.com|BF(519) 555 1234|AQBR1|BLY|CQN|PB19640925|PCPatrons|PIUnfiltered|AFOK|AOBR1|
 +</​code>​
 +
 +See 23/24 Patron Status for info on BL and CQ fields.  ​
 +
 ==== 65/66 Renew All ==== ==== 65/66 Renew All ====
 Not yet supported.  ​ Not yet supported.  ​
evergreen-admin/sip_support.txt · Last modified: 2012/11/08 13:42 by gmcharlton

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.