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:
55 . max_servers will directly correspond to the number of allowed +SIP+ clients. Set the number accordingly, but
56 bear in mind that too many connections can exhaust memory. On a 4G RAM/4 CPU server (that is also running
57 evergreen), it is not recommended to exceed 100 +SIP+ client connections.
62 indexterm:[configuration files, oils_sip.xml]
64 . Type the following commands from the command prompt:
68 $ cp oils_sip.xml.example oils_sip.xml
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
82 VIEW_COPY_CHECKOUT_HISTORY
85 VIEW_USER_FINES_SUMMARY
86 VIEW_USER_TRANSACTIONS
91 INSERT INTO permission.grp_tree (name,parent,description,application_perm)
92 VALUES ('SIP', 1, 'SIP2 Client Systems', 'group_application.user.sip_client');
95 permission.grp_perm_map (grp, perm, depth, grantable)
99 permission.grp_tree g,
100 permission.perm_list p
108 'VIEW_COPY_CHECKOUT_HISTORY',
109 'VIEW_PERMIT_CHECKOUT',
111 'VIEW_USER_FINES_SUMMARY',
112 'VIEW_USER_TRANSACTIONS'
119 FROM permission.grp_perm_map pgpm
120 INNER JOIN permission.perm_list ppl ON pgpm.perm = ppl.id
121 INNER JOIN permission.grp_tree pgt ON pgt.id = pgpm.grp
122 WHERE pgt.name = 'SIP';
126 . For each account created in the +<login>+ section of oils_sip.xml, create a user (via the staff client user
127 editor) that has the same username and password and put that user into the +SIP+ group.
131 The expiration date will affect the +SIP+ users' connection so you might want to make a note of this
138 To start the +SIP+ server type the following commands from the command prompt:
143 $ oils_ctl.sh -d /openils/var/run -s /openils/conf/oils_sip.xml -a [start|stop|restart]_sip
157 It is useful to log +SIP+ requests to a separate file especially during initial setup by modifying your syslog config file.
161 $ sudo vi /etc/syslog.conf # maybe /etc/rsyslog.conf
166 local6.* -/var/log/SIP_evergreen.log
168 . Syslog expects the logfile to exist so create the file.
170 $ sudo touch /var/log/SIP_evergreen.log
174 $ sudo /etc/init.d/sysklogd restart
180 indexterm:[syslog-NG]
182 . Edit logging config.
184 sudo vi /etc/syslog-ng/syslog-ng.conf
188 # +SIP2+ for Evergreen
189 filter f_eg_sip { level(warn, err, crit) and facility(local6); };
190 destination eg_sip { file("var/log/SIP_evergreen.log"); };
191 log { source(s_all); filter(f_eg_sip); destination(eg_sip); };
193 . Syslog-ng expects the logfile to exist so create the file.
195 $ sudo touch /var/log/SIP_evergreen.log
199 $ sudo /etc/init.d/syslog-ng restart
205 Testing Your SIP Connection
206 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
208 * In the root directory of the SIPServer code:
212 * Edit SIPtest.pm, change the $instid, $server, $username, and $password variables. This will be
213 enough to test connectivity. To run all tests, you'll need to change all the variables in the _Configuration_ section.
215 $ PERL5LIB=../ perl 00sc_status.t
217 This should produce something like:
221 ok 1 - Invalid username
222 ok 2 - Invalid username
226 * Don't be dismayed at *Invalid Username*. That's just one of the many tests that are run.
231 . Once you have opened up either the +SIP+ OR +SIP2+ ports to be accessible from outside you can do some testing
232 via +telnet+. You can try this with localhost if you so wish, but we want to prove that +SIP2+ works from
233 non-localhost. Replace +$instid+, +$server+, +$barcode+, +$username+, and +$password+ variables below
237 ======================
238 We are using 6001 here which is associated with +SIP2+ as per our configuration.
239 ======================
241 $ telnet $server 6001
242 Connected to $server.
243 Escape character is '^]'.
244 9300CN**$username**|CO**$password**|CP**$instid**
250 . Now just copy in the following line (with variables replaced) you don't need to hit enter, just paste!
252 2300120080623 172148AO**$instid**|AA**$barcode**|AC$password|AD**$password**
254 You will get back the patron information for $barcode (something similar to the what's below).
256 24 Y 00120100113 170738AEFirstName MiddleName LastName|AA**$barcode**|BLY|CQY
257 |BHUSD|BV0.00|AFOK|AO**$instid**|
259 The response declares it is a valid patron BLY with a valid password CQY and shows the user's +$name+.
267 indexterm:[SIP Server, SIP Communication]
269 +SIP+ generally communicates over a +TCP+ connection (either raw sockets or over +telnet+), but can also
270 communicate via serial connections and other methods. In Evergreen, the most common deployment is a +RAW+ socket
271 connection on port 6001.
273 +SIP+ communication consists of strings of messages, each message request and response begin with a 2-digit
274 ``command'' - Requests usually being an odd number and responses usually increased by 1 to be an even number. The
275 combination numbers for the request command and response is often referred to as a _Message Pair_ (for example,
276 a 23 command is a request for patron status, a 24 response is a patron status, and the message pair 23/24 is patron
277 status message pair). The table in the next section shows the message pairs and a description of them.
279 For clarification, the ``Request'' is from the device (selfcheck or otherwise) to the ILS/ACS. The response is… the
280 response to the request ;).
282 Within each request and response, a number of fields (either a fixed width or separated with a | [pipe symbol] and
283 preceeded with a 2-character field identifier) are used. The fields vary between message pairs.
285 |===========================================================================
286 | *Pair* | *Name* | *Supported?* |*Details*
287 | 01 | Block Patron | Yes |<<01_block_patron, 01/Block_Patron>> - ACS responds with 24 Patron Status Response
288 | 09-10 | Checkin | Yes (with extensions) |<<09-10_checkin, 09/10_Checkin>>
289 | 11-12 | Checkout | Yes (no renewals) |<<11-12_checkout, 11/12_Checkout>>
290 | 15-16 | Hold | No |<<15-16_hold, 15/16_Hold>>
291 | 17-18 | Item Information | Yes (no extensions) |<<17-18_item_information, 17/18_Item_Information>>
292 | 19-20 | Item Status Update | No |<<19-20_item_status_update, 19/20_Item_Status_Update>> - Returns Patron Enable response, but doesn't make any changes in EG
293 | 23-24 | Patron Status | Yes |<<23-24_patron_status, 23/24_Patron_Status>> - 63/64 ``Patron Information'' preferred
294 | 25-26 | Patron Enable | No |<<25-26_patron_enable, 25/26_Patron_Enable>> - Used during system testing and validation
295 | 29-30 | Renew | NO (maybe?) |<<29-30_renew, 29/30_Renew>>
296 | 35-36 | End Session | Yes |<<35-36_end_session, 35/36_End_Session>>
297 | 37-38 | Fee Paid | No |<<37-38_fee_paid, 37/38_Fee_Paid>>
298 | 63-64 | Patron Information | Yes (no extensions) |<<63-64_patron_information, 63/64_Patron_Information>>
299 | 65-66 | Renew All | No |<<65-66_renew_all, 65/66_Renew_All>>
300 | 93-94 | Login | Yes |<<93-94_login, 93/94_Login>> - Must be first command to Evergreen ACS (via socket) or +SIP+ will terminate
301 | 97-96 | Resend last message | Yes |<<97-96_resend, 97/96_Resend>>
302 | 99-98 | SC-ACS Status | Yes |<<99-98_sc_and_acs_status, 99/98_SC_and_ACS_Status>>
303 |===========================================================================
305 anchor:01_block_patron[]
310 indexterm:[SelfCheck]
312 A selfcheck will issue a *Block Patron* command if a patron leaves their card in a selfcheck machine or if the
313 selfcheck detects tampering (such as attempts to disable multiple items during a single item checkout, multiple failed
316 In Evergreen, this command does the following:
318 * User alert message: _CARD BLOCKED BY SELF-CHECK MACHINE_ (this is independent of the AL _Blocked
319 Card Message_ field).
321 * Card is marked inactive.
323 The request looks like:
325 01<card retained><date>[fields AO, AL, AA, AC]
327 _Card Retained_: A single character field of Y or N - tells the ACS whether the SC has retained the card (ex: left in
330 _Date_: An 18 character field for the date/time when the block occurred.
332 _Format_: YYYYMMDDZZZZHHMMSS (ZZZZ being zone - 4 blanks when local time, ``Z'' (3 blanks and a Z)
333 represents UTC(GMT/Zulu)
335 _Fields_: See <<fields, Fields>> for more details.
337 The response is a 24 ``Patron Status Response'' with the following:
339 * Charge privileges denied
340 * Renewal privileges denied
341 * Recall privileges denied (hard-coded in every 24 or 64 response)
342 * hold privileges denied
343 * Screen Message 1 (AF): _blocked_
346 anchor:09-10_checkin[]
351 ~The request looks like:
353 09<No block (Offline)><xact date><return date>[Fields AP,AO,AB,AC,CH,BI]
355 _No Block (Offline)_: A single character field of _Y_ or _N_ - Offline transactions are not currently supported so send _N_.
357 _xact date_: an 18 character field for the date/time when the checkin occurred. Format:
358 YYYYMMDDZZZZHHMMSS (ZZZZ being zone - 4 blanks when local time, ``Z'' (3 blanks and a Z) represents
361 _Fields_: See <<fields, Fields>> for more details.
363 The response is a 10 ``Checkin Response'' with the following:
365 10<resensitize><magnetic media><alert><xact date>[Fields AO,AB,AQ,AJ,CL,AA,CK,CH,CR,CS,CT,CV,CY,DA,AF,AG]
367 Example (with a remote hold):
369 09N20100507 16593720100507 165937APCheckin Bin 5|AOBR1|AB1565921879|ACsip_01|
371 101YNY20100623 165731AOBR1|AB1565921879|AQBR1|AJPerl 5 desktop reference|CK001|CSQA76.73.P33V76 1996
372 |CTBR3|CY373827|DANicholas Richard Woodard|CV02|
374 Here you can see a hold alert for patron CY _373827_, named DA _Nicholas Richard Woodard_, to be picked up at CT
375 ``BR3''. Since the transaction is happening at AO ``BR1'', the alert type CV is 02 for _hold at remote library_. The
376 possible values for CV are:
384 * 03: ILL transfer (not used by EG)
390 indexterm:[magnetic media]
394 The logic for Evergreen to determine whether the content is magnetic_media comes from either legacy circ
395 scripts or search_config_circ_modifier. The default is non-magnetic. The same is true for media_type (default
396 001). Evergreen does not populate the collection_code because it does not really have any, but it will provide
397 the call_number where available.
399 Unlike the +item_id+ (barcode), the +title_id+ is actually a title string, unless the configuration forces the
400 return of the bib ID.
402 Don't be confused by the different branches that can show up in the same response line.
404 * AO is where the transaction took place,
406 * AQ is the ``permanent location'', and
408 * CT is the _destination location_ (i.e., pickup lib for a hold or target lib for a transfer).
411 anchor:11-12_checkout[]
425 anchor:17-18_item_information[]
427 17/18 Item Information
428 ^^^^^^^^^^^^^^^^^^^^^^
430 The request looks like:
432 17<xact_date>[fields: AO,AB,AC]
434 The request is very terse. AC is optional.
436 The following response structure is for +SIP2+. (Version 1 of the protocol had only 6 total fields.)
438 18<circulation_status><security_marker><fee_type><xact_date>
439 [fields: CF,AH,CJ,CM,AB,AJ,BG,BH,BV,CK,AQ,AP,CH,AF,AG,+CT,+CS]
443 1720060110 215612AOBR1|ABno_such_barcode|
445 1801010120100609 162510ABno_such_barcode|AJ|
447 1720060110 215612AOBR1|AB1565921879|
449 1810020120100623 171415AB1565921879|AJPerl 5 desktop reference|CK001|AQBR1|APBR1|BGBR1
450 |CTBR3|CSQA76.73.P33V76 1996|
452 The first case is with a bogus barcode. The latter shows an item with a circulation_status of _10_ for _in transit between
453 libraries_. The known values of +circulation_status+ are enumerated in the spec.
455 indexterm:[Automated Material Handling (AMH)]
457 EXTENSIONS: The CT field for _destination location_ and CS _call number_ are used by Automated Material Handling
461 anchor:19-20_item_status_update[]
463 19/20 Item Status Update
464 ^^^^^^^^^^^^^^^^^^^^^^^^
467 anchor:23-24_patron_status[]
474 2300120060101 084235AOUWOLS|AAbad_barcode|ACsip_01|ADbad_password|
476 24YYYY 00120100507 013934AE|AAbad_barcode|BLN|AOUWOLS|
478 2300120060101 084235AOCONS|AA999999|ACsip_01|ADbad_password|
480 24 Y 00120100507 022318AEDoug Fiander|AA999999|BLY|CQN|BHUSD|BV0.00|AFOK|AOCONS|
482 2300120060101 084235AOCONS|AA999999|ACsip_01|ADuserpassword|LY|CQN|BHUSD|BV0.00|AFOK|AOCONS|
484 24 Y 00120100507 022803AEDoug Fiander|AA999999|BLY|CQY|BHUSD|BV0.00|AFOK|AOCONS|
486 . The BL field (+SIP2+, optional) is _valid patron_, so the _N_ value means _bad_barcode_ doesn't match a patron, the
487 _Y_ value means 999999 does.
489 . The CQ field (+SIP2+, optional) is _valid password_, so the _N_ value means _bad_password_ doesn't match 999999's
490 password, the _Y_ means _userpassword_ does.
492 So if you were building the most basic +SIP2+ authentication client, you would check for _|CQY|_ in the response to
493 know the user's barcode and password are correct (|CQY| implies |BLY|, since you cannot check the password
494 unless the barcode exists). However, in practice, depending on the application, there are other factors to consider in
495 authentication, like whether the user is blocked from checkout, owes excessive fines, reported their card lost, etc.
496 These limitations are reflected in the 14-character _patron status_ string immediately following the _24_ code. See the
497 field definitions in your copy of the spec.
500 anchor:25-26_patron_enable[]
513 Evergreen ACS status message indicates _renew_ is supported.
516 anchor:35-36_end_session[]
521 3520100505 115901AOBR1|AA999999|
523 36Y20100507 161213AOCONS|AA999999|AFThank you!|
525 The _Y/N_ code immediately after the 36 indicates _success/failure_. Failure is not particularly meaningful or important
526 in this context, and for evergreen it is hardcoded _Y_.
530 anchor:37-38_fee_paid[]
538 anchor:63-64_patron_information[]
540 63/64 Patron Information
541 ^^^^^^^^^^^^^^^^^^^^^^^^
543 Attempting to retrieve patron info with a bad barcode:
545 6300020060329 201700 AOBR1|AAbad_barcode|
547 64YYYY 00020100623 141130000000000000000000000000AE|AAbad_barcode|BLN|AOBR1|
549 Attempting to retrieve patron info with a good barcode (but bad patron password):
551 6300020060329 201700 AOBR1|AA999999|ADbadpwd|
553 64 Y 00020100623 141130000000000000000000000000AA999999|AEDavid J. Fiander|BHUSD|BV0.00
554 |BD2 Meadowvale Dr. St Thomas, ON Canada
556 90210|BEdjfiander@somemail.com|BF(519) 555 1234|AQBR1|BLY|CQN|PB19640925|PCPatrons
557 |PIUnfiltered|AFOK|AOBR1|
559 See <<23-24_patron_status, 23/24 Patron Status>> for info on +BL+ and +CQ+ fields.
563 anchor:65-66_renew_all[]
578 9300CNsip_01|CObad_value|CPBR1|
580 [Connection closed by foreign host.]
583 9300CNsip_01|COsip_01|CPBR1|
587 _941_ means successful terminal login. _940_ or getting dropped means failure.
590 anchor:97-96_resend[]
596 anchor:99-98_sc_and_acs_status[]
598 99/98 SC and ACS Status
599 ^^^^^^^^^^^^^^^^^^^^^^^
601 99<status code><max print width><protocol version>
603 All 3 fields are required:
607 * 1: SC is out of paper
609 * 2: SC shutting down
611 * status code - 1 character
613 * max print width - 3 characters - the integer number of characters the client can print
615 * protocol version - 4 characters - x.xx
617 98<on-line status><checkin ok><checkout ok><ACS renewal policy>
618 <status update ok><offline ok><timeout period>
620 <retries allowed><date/time sync><protocol version><institution id>
621 <library name><supported messages><terminal
623 location><screen message><print line>
629 98YYYYNN60000320100510 1717202.00AOCONS|BXYYYYYYYYYNYNNNYN|
631 The Supported Messages field +BX+ appears only in +SIP2+, and specifies whether 16 different +SIP+ commands are
632 supported by the +ACS+ or not.
640 All fixed-length fields in a communication will appear before the first variable-length field. This allows for simple
641 parsing. Variable-length fields are by definition delimited, though there will not necessarily be an initial delimiter
642 between the last fixed-length field and the first variable-length one. It would be unnecessary, since you should know
643 the exact position where that field begins already.