4 indexterm:[Automated Circulation System]
6 indexterm:[Automated Material Handling]
8 +SIP+, standing for +Standard Interchange Protocol+, was developed by the +3M corporation+ to be a common
9 protocol for data transfer between ILS' (referred to in +SIP+ as an _ACS_, or _Automated Circulation System_) and a
10 third party device. Originally, the protocol was developed for use with _3M SelfCheck_ (often abbreviated SC, not to
11 be confused with Staff Client) systems, but has since expanded to other companies and devices. It is now common
12 to find +SIP+ in use in several other vendors' SelfCheck systems, as well as other non-SelfCheck devices. Some
15 * Patron Authentication (computer access, subscription databases)
16 * Automated Material Handling (AMH)
17 ** The automated sorting of items, often to bins or book carts, based on shelving location or other programmable
20 Installing the SIP Server
21 ~~~~~~~~~~~~~~~~~~~~~~~~~
25 This is a rough intro to installing the +SIP+ server for Evergreen.
30 Current +SIP+ server code lives at in the Evergreen git repository:
33 git clone git://git.evergreen-ils.org/SIPServer.git SIPServer
36 Configuring the Server
37 ^^^^^^^^^^^^^^^^^^^^^^
39 indexterm:[configuration files, oils_sip.xml]
41 . Type the following commands from the command prompt:
45 $ cp oils_sip.xml.example oils_sip.xml
47 . Edit oils_sip.xml. Change the commented out <server-params> section to this:
56 . max_servers will directly correspond to the number of allowed +SIP+ clients. Set the number accordingly, but
57 bear in mind that too many connections can exhaust memory. On a 4G RAM/4 CPU server (that is also running
58 evergreen), it is not recommended to exceed 100 +SIP+ client connections.
63 indexterm:[configuration files, oils_sip.xml]
65 . Type the following commands from the command prompt:
70 . In the +<accounts>+ section, add +SIP+ client login information. Make sure that all +<logins>+ use the same
71 institution attribute, and make sure the institution is listed in +<institutions>+. All attributes in the
72 +<login>+ section will be used by the +SIP+ client.
74 . In Evergreen, create a new profile group called +SIP+. This group should be a sub-group of +Users+ (not +Staff+
75 or +Patrons+). Set _Editing Permission_ as *group_application.user.sip_client* and give the group the following
83 VIEW_COPY_CHECKOUT_HISTORY
86 VIEW_USER_FINES_SUMMARY
87 VIEW_USER_TRANSACTIONS
92 INSERT INTO permission.grp_tree (name,parent,description,application_perm)
93 VALUES ('SIP', 1, 'SIP2 Client Systems', 'group_application.user.sip_client');
96 permission.grp_perm_map (grp, perm, depth, grantable)
100 permission.grp_tree g,
101 permission.perm_list p
109 'VIEW_COPY_CHECKOUT_HISTORY',
110 'VIEW_PERMIT_CHECKOUT',
112 'VIEW_USER_FINES_SUMMARY',
113 'VIEW_USER_TRANSACTIONS'
120 FROM permission.grp_perm_map pgpm
121 INNER JOIN permission.perm_list ppl ON pgpm.perm = ppl.id
122 INNER JOIN permission.grp_tree pgt ON pgt.id = pgpm.grp
123 WHERE pgt.name = 'SIP';
127 . For each account created in the +<login>+ section of oils_sip.xml, create a user (via the staff client user
128 editor) that has the same username and password and put that user into the +SIP+ group.
132 The expiration date will affect the +SIP+ users' connection so you might want to make a note of this
139 To start the +SIP+ server type the following commands from the command prompt:
144 $ oils_ctl.sh -a [start|stop|restart]_sip
158 It is useful to log +SIP+ requests to a separate file especially during initial setup by modifying your syslog config file.
162 $ sudo vi /etc/syslog.conf # maybe /etc/rsyslog.conf
167 local6.* -/var/log/SIP_evergreen.log
169 . Syslog expects the logfile to exist so create the file.
171 $ sudo touch /var/log/SIP_evergreen.log
175 $ sudo /etc/init.d/sysklogd restart
181 indexterm:[syslog-NG]
183 . Edit logging config.
185 sudo vi /etc/syslog-ng/syslog-ng.conf
189 # +SIP2+ for Evergreen
190 filter f_eg_sip { level(warn, err, crit) and facility(local6); };
191 destination eg_sip { file("var/log/SIP_evergreen.log"); };
192 log { source(s_all); filter(f_eg_sip); destination(eg_sip); };
194 . Syslog-ng expects the logfile to exist so create the file.
196 $ sudo touch /var/log/SIP_evergreen.log
200 $ sudo /etc/init.d/syslog-ng restart
206 Testing Your SIP Connection
207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
209 * In the root directory of the SIPServer code:
213 * Edit SIPtest.pm, change the $instid, $server, $username, and $password variables. This will be
214 enough to test connectivity. To run all tests, you'll need to change all the variables in the _Configuration_ section.
216 $ PERL5LIB=../ perl 00sc_status.t
218 This should produce something like:
222 ok 1 - Invalid username
223 ok 2 - Invalid username
227 * Don't be dismayed at *Invalid Username*. That's just one of the many tests that are run.
232 Once you have opened up either the +SIP+ OR +SIP2+ ports to be accessible from outside you can do some testing
233 via +telnet+. In the following tests:
235 * Replace +$server+ with your server hostname (or +localhost+ if you want to
236 skip testing external access for now);
237 * Replace +$username+, +$password+, and +$instid+ with the corresponding values
238 in the +<accounts>+ section of your SIP configuration file;
239 * Replace the +$user_barcode+ and +$user_password+ variables with the values
243 Comments because we don't want to indent these numbered bullets!
246 . Start by testing your ability to log into the SIP server:
249 ======================
250 We are using 6001 here which is associated with +SIP2+ as per our configuration.
251 ======================
253 $ telnet $server 6001
254 Connected to $server.
255 Escape character is '^]'.
256 9300CN$username|CO$password|CP$instid
258 If successful, the SIP server returns a +941+ result. A result of +940+,
259 however, indicates an unsuccessful login attempt. Check the +<accounts>+
260 section of your SIP configuration and try agin.
262 . Once you have logged in successfully, replace the variables in the following
263 line and paste it into the telnet session:
265 2300120080623 172148AO$instid|AA$user_barcode|AC$password|AD$user_password
267 If successful, the SIP server returns the patron information for $barcode,
268 similar to the following:
270 24 Y 00120100113 170738AEFirstName MiddleName LastName|AA$barcode|BLY|CQY
271 |BHUSD|BV0.00|AFOK|AO$instid|
273 The response declares it is a valid patron BLY with a valid password CQY and shows the user's +$name+.
281 indexterm:[SIP Server, SIP Communication]
283 +SIP+ generally communicates over a +TCP+ connection (either raw sockets or over +telnet+), but can also
284 communicate via serial connections and other methods. In Evergreen, the most common deployment is a +RAW+ socket
285 connection on port 6001.
287 +SIP+ communication consists of strings of messages, each message request and response begin with a 2-digit
288 ``command'' - Requests usually being an odd number and responses usually increased by 1 to be an even number. The
289 combination numbers for the request command and response is often referred to as a _Message Pair_ (for example,
290 a 23 command is a request for patron status, a 24 response is a patron status, and the message pair 23/24 is patron
291 status message pair). The table in the next section shows the message pairs and a description of them.
293 For clarification, the ``Request'' is from the device (selfcheck or otherwise) to the ILS/ACS. The response is… the
294 response to the request ;).
296 Within each request and response, a number of fields (either a fixed width or separated with a | [pipe symbol] and
297 preceded with a 2-character field identifier) are used. The fields vary between message pairs.
299 |===========================================================================
300 | *Pair* | *Name* | *Supported?* |*Details*
301 | 01 | Block Patron | Yes |<<sip_01_block_patron, 01/Block_Patron>> - ACS responds with 24 Patron Status Response
302 | 09-10 | Checkin | Yes (with extensions) |<<sip_09-10_checkin, 09/10_Checkin>>
303 | 11-12 | Checkout | Yes (no renewals) |<<sip_11-12_checkout, 11/12_Checkout>>
304 | 15-16 | Hold | Partially supported |<<sip_15-16_hold, 15/16_Hold>>
305 | 17-18 | Item Information | Yes (no extensions) |<<sip_17-18_item_information, 17/18_Item_Information>>
306 | 19-20 | Item Status Update | No |<<sip_19-20_item_status_update, 19/20_Item_Status_Update>> - Returns Patron Enable response, but doesn't make any changes in EG
307 | 23-24 | Patron Status | Yes |<<sip_23-24_patron_status, 23/24_Patron_Status>> - 63/64 ``Patron Information'' preferred
308 | 25-26 | Patron Enable | No |<<sip_25-26_patron_enable, 25/26_Patron_Enable>> - Used during system testing and validation
309 | 29-30 | Renew | Yes |<<sip_29-30_renew, 29/30_Renew>>
310 | 35-36 | End Session | Yes |<<sip_35-36_end_session, 35/36_End_Session>>
311 | 37-38 | Fee Paid | Yes |<<sip_37-38_fee_paid, 37/38_Fee_Paid>>
312 | 63-64 | Patron Information | Yes (no extensions) |<<sip_63-64_patron_information, 63/64_Patron_Information>>
313 | 65-66 | Renew All | Yes |<<sip_65-66_renew_all, 65/66_Renew_All>>
314 | 93-94 | Login | Yes |<<sip_93-94_login, 93/94_Login>> - Must be first command to Evergreen ACS (via socket) or +SIP+ will terminate
315 | 97-96 | Resend last message | Yes |<<sip_97-96_resend, 97/96_Resend>>
316 | 99-98 | SC-ACS Status | Yes |<<sip_99-98_sc_and_acs_status, 99/98_SC_and_ACS_Status>>
317 |===========================================================================
319 anchor:sip_01_block_patron[]
324 indexterm:[SelfCheck]
326 A selfcheck will issue a *Block Patron* command if a patron leaves their card in a selfcheck machine or if the
327 selfcheck detects tampering (such as attempts to disable multiple items during a single item checkout, multiple failed
330 In Evergreen, this command does the following:
332 * User alert message: _CARD BLOCKED BY SELF-CHECK MACHINE_ (this is independent of the AL _Blocked
333 Card Message_ field).
335 * Card is marked inactive.
337 The request looks like:
339 01<card retained><date>[fields AO, AL, AA, AC]
341 _Card Retained_: A single character field of Y or N - tells the ACS whether the SC has retained the card (ex: left in
344 _Date_: An 18 character field for the date/time when the block occurred.
346 _Format_: YYYYMMDDZZZZHHMMSS (ZZZZ being zone - 4 blanks when local time, ``Z'' (3 blanks and a Z)
347 represents UTC(GMT/Zulu)
349 _Fields_: See <<fields, Fields>> for more details.
351 The response is a 24 ``Patron Status Response'' with the following:
353 * Charge privileges denied
354 * Renewal privileges denied
355 * Recall privileges denied (hard-coded in every 24 or 64 response)
356 * hold privileges denied
357 * Screen Message 1 (AF): _blocked_
360 anchor:sip_09-10_checkin[]
365 ~The request looks like:
367 09<No block (Offline)><xact date><return date>[Fields AP,AO,AB,AC,CH,BI]
369 _No Block (Offline)_: A single character field of _Y_ or _N_ - Offline transactions are not currently supported so send _N_.
371 _xact date_: an 18 character field for the date/time when the checkin occurred. Format:
372 YYYYMMDDZZZZHHMMSS (ZZZZ being zone - 4 blanks when local time, ``Z'' (3 blanks and a Z) represents
375 _Fields_: See <<fields, Fields>> for more details.
377 The response is a 10 ``Checkin Response'' with the following:
379 10<resensitize><magnetic media><alert><xact date>[Fields AO,AB,AQ,AJ,CL,AA,CK,CH,CR,CS,CT,CV,CY,DA,AF,AG]
381 Example (with a remote hold):
383 09N20100507 16593720100507 165937APCheckin Bin 5|AOBR1|AB1565921879|ACsip_01|
385 101YNY20100623 165731AOBR1|AB1565921879|AQBR1|AJPerl 5 desktop reference|CK001|CSQA76.73.P33V76 1996
386 |CTBR3|CY373827|DANicholas Richard Woodard|CV02|
388 Here you can see a hold alert for patron CY _373827_, named DA _Nicholas Richard Woodard_, to be picked up at CT
389 ``BR3''. Since the transaction is happening at AO ``BR1'', the alert type CV is 02 for _hold at remote library_. The
390 possible values for CV are:
398 * 03: ILL transfer (not used by EG)
404 indexterm:[magnetic media]
408 The logic for Evergreen to determine whether the content is magnetic_media comes from either legacy circ
409 scripts or search_config_circ_modifier. The default is non-magnetic. The same is true for media_type (default
410 001). Evergreen does not populate the collection_code because it does not really have any, but it will provide
411 the call_number where available.
413 Unlike the +item_id+ (barcode), the +title_id+ is actually a title string, unless the configuration forces the
414 return of the bib ID.
416 Don't be confused by the different branches that can show up in the same response line.
418 * AO is where the transaction took place,
420 * AQ is the ``permanent location'', and
422 * CT is the _destination location_ (i.e., pickup lib for a hold or target lib for a transfer).
425 anchor:sip_11-12_checkout[]
431 anchor:sip_15-16_hold[]
436 Evergreen supports the Hold message for the purpose of canceling
437 holds. It does not currently support creating hold requests via SIP2.
440 anchor:sip_17-18_item_information[]
442 17/18 Item Information
443 ^^^^^^^^^^^^^^^^^^^^^^
445 The request looks like:
447 17<xact_date>[fields: AO,AB,AC]
449 The request is very terse. AC is optional.
451 The following response structure is for +SIP2+. (Version 1 of the protocol had only 6 total fields.)
453 18<circulation_status><security_marker><fee_type><xact_date>
454 [fields: CF,AH,CJ,CM,AB,AJ,BG,BH,BV,CK,AQ,AP,CH,AF,AG,+CT,+CS]
458 1720060110 215612AOBR1|ABno_such_barcode|
460 1801010120100609 162510ABno_such_barcode|AJ|
462 1720060110 215612AOBR1|AB1565921879|
464 1810020120100623 171415AB1565921879|AJPerl 5 desktop reference|CK001|AQBR1|APBR1|BGBR1
465 |CTBR3|CSQA76.73.P33V76 1996|
467 The first case is with a bogus barcode. The latter shows an item with a circulation_status of _10_ for _in transit between
468 libraries_. The known values of +circulation_status+ are enumerated in the spec.
470 indexterm:[Automated Material Handling (AMH)]
472 EXTENSIONS: The CT field for _destination location_ and CS _call number_ are used by Automated Material Handling
476 anchor:sip_19-20_item_status_update[]
478 19/20 Item Status Update
479 ^^^^^^^^^^^^^^^^^^^^^^^^
482 anchor:sip_23-24_patron_status[]
489 2300120060101 084235AOUWOLS|AAbad_barcode|ACsip_01|ADbad_password|
491 24YYYY 00120100507 013934AE|AAbad_barcode|BLN|AOUWOLS|
493 2300120060101 084235AOCONS|AA999999|ACsip_01|ADbad_password|
495 24 Y 00120100507 022318AEDoug Fiander|AA999999|BLY|CQN|BHUSD|BV0.00|AFOK|AOCONS|
497 2300120060101 084235AOCONS|AA999999|ACsip_01|ADuserpassword|LY|CQN|BHUSD|BV0.00|AFOK|AOCONS|
499 24 Y 00120100507 022803AEDoug Fiander|AA999999|BLY|CQY|BHUSD|BV0.00|AFOK|AOCONS|
501 . The BL field (+SIP2+, optional) is _valid patron_, so the _N_ value means _bad_barcode_ doesn't match a patron, the
502 _Y_ value means 999999 does.
504 . The CQ field (+SIP2+, optional) is _valid password_, so the _N_ value means _bad_password_ doesn't match 999999's
505 password, the _Y_ means _userpassword_ does.
507 So if you were building the most basic +SIP2+ authentication client, you would check for _|CQY|_ in the response to
508 know the user's barcode and password are correct (|CQY| implies |BLY|, since you cannot check the password
509 unless the barcode exists). However, in practice, depending on the application, there are other factors to consider in
510 authentication, like whether the user is blocked from checkout, owes excessive fines, reported their card lost, etc.
511 These limitations are reflected in the 14-character _patron status_ string immediately following the _24_ code. See the
512 field definitions in your copy of the spec.
515 anchor:sip_25-26_patron_enable[]
523 anchor:sip_29-30_renew[]
528 Evergreen supports the Renew message.
531 anchor:sip_35-36_end_session[]
536 3520100505 115901AOBR1|AA999999|
538 36Y20100507 161213AOCONS|AA999999|AFThank you!|
540 The _Y/N_ code immediately after the 36 indicates _success/failure_. Failure is not particularly meaningful or important
541 in this context, and for evergreen it is hardcoded _Y_.
545 anchor:sip_37-38_fee_paid[]
550 Evergreen supports the Fee Paid message.
553 anchor:sip_63-64_patron_information[]
555 63/64 Patron Information
556 ^^^^^^^^^^^^^^^^^^^^^^^^
558 Attempting to retrieve patron info with a bad barcode:
560 6300020060329 201700 AOBR1|AAbad_barcode|
562 64YYYY 00020100623 141130000000000000000000000000AE|AAbad_barcode|BLN|AOBR1|
564 Attempting to retrieve patron info with a good barcode (but bad patron password):
566 6300020060329 201700 AOBR1|AA999999|ADbadpwd|
568 64 Y 00020100623 141130000000000000000000000000AA999999|AEDavid J. Fiander|BHUSD|BV0.00
569 |BD2 Meadowvale Dr. St Thomas, ON Canada
571 90210|BEdjfiander@somemail.com|BF(519) 555 1234|AQBR1|BLY|CQN|PB19640925|PCPatrons
572 |PIUnfiltered|AFOK|AOBR1|
574 See <<sip_23-24_patron_status, 23/24 Patron Status>> for info on +BL+ and +CQ+ fields.
578 anchor:sip_65-66_renew_all[]
583 Evergreen supports the Renew All message.
586 anchor:sip_93-94_login[]
593 9300CNsip_01|CObad_value|CPBR1|
595 [Connection closed by foreign host.]
598 9300CNsip_01|COsip_01|CPBR1|
602 _941_ means successful terminal login. _940_ or getting dropped means failure.
605 anchor:sip_97-96_resend[]
611 anchor:sip_99-98_sc_and_acs_status[]
613 99/98 SC and ACS Status
614 ^^^^^^^^^^^^^^^^^^^^^^^
616 99<status code><max print width><protocol version>
618 All 3 fields are required:
622 * 1: SC is out of paper
624 * 2: SC shutting down
626 * status code - 1 character
628 * max print width - 3 characters - the integer number of characters the client can print
630 * protocol version - 4 characters - x.xx
632 98<on-line status><checkin ok><checkout ok><ACS renewal policy>
633 <status update ok><offline ok><timeout period>
635 <retries allowed><date/time sync><protocol version><institution id>
636 <library name><supported messages><terminal
638 location><screen message><print line>
644 98YYYYNN60000320100510 1717202.00AOCONS|BXYYYYYYYYYNYNNNYN|
646 The Supported Messages field +BX+ appears only in +SIP2+, and specifies whether 16 different +SIP+ commands are
647 supported by the +ACS+ or not.
655 All fixed-length fields in a communication will appear before the first variable-length field. This allows for simple
656 parsing. Variable-length fields are by definition delimited, though there will not necessarily be an initial delimiter
657 between the last fixed-length field and the first variable-length one. It would be unnecessary, since you should know
658 the exact position where that field begins already.