BOOK-IT 8.0. SIP2 implementation in the Z39.70 server

Transcription

1 BOOK-IT Axiell Sverige AB, Box 24014, LUND. Besöksadress: Fältspatsvägen 4, LUND Tel , e-post:

2 Table of contents 1 Introduction Supported client messages Supported server messages Patron Status Response Checkout Response Checkin Response ACS Status Request SC Resend Login Response Patron Information Response End Session Response Fee Paid Response Item Information Response Item Status Update Response NOT SUPPORTED Patron Enable Response NOT SUPPORTED Hold Response NOT SUPPORTED Renew Response See Checkout Response Renew All Response AXIELL Sverige AB 2 (20)

3 1 Introduction Below a description of how the SIP2 protocol is implemented in the Z39.70 server of BOOK-IT. Local extensions to the protocol that have been made to extend the exchange of information are marked in grey. For further details regarding the SIP2 protocol see documentation located on Internet for example: AXIELL Sverige AB 3 (20)

4 2 Supported client messages PATRON_STATUS CHECKOUT CHECKIN BLOCK_PATRON SC_STATUS RESEND LOGIN PATRON_INFO END_SESSION FEE_PAID no Please note: It is very important that a correct value is sent in the AO field so that correct checks can be made in the database. See ACS Status. Please note: RENEW is also supported via this message. To make a RENEW send a Y in the 3 rd position. Please note: Important not to send a returndate if it s considered a normal transaction. If returndate is sent BOOK-IT will handle it as an offline transaction and no sorting will be made. This means that sortbin 99 (waste) will be returned in this case. This is also the case when sending a Y in no block. Always send N in the no block field when normal online transactions is considered. Please also note: Important to send a value in the AP field. Use the value received from the AN field in message 98. Supported in version 6.0. Not activated by default. Please note: It is very important that a correct value is sent in the AO field so that correct checks can be made in the database. See ACS Status. ITEM_INFO Local extensions have been made for the AF and CF fields in version 6.0. ITEM_STATUS no PATRON_ENABLE no HOLD no RENEW Please note: To renew a single item, use CHECKOUT with a Y in the 3 rd position. RENEW_ALL Please note: It is very important that a correct value is sent in the AO field so that correct checks can be made in the database. See ACS Status. AXIELL Sverige AB 4 (20)

5 3 Supported server messages 3.1 Patron Status Response 24 2-char, fixed-length required field When not ok: "YYYY " patron status 14-char, fixed-length required field When ok: " " language 3-char, fixed-length required field institution id AO variable-length required field patron identifier AA variable-length required field personal name AE variable-length required field 2.00 valid patron BL 1-char, optional field: Y or N 2.00 valid patron password CQ 1-char, optional field: Y or N 2.00 currency type BH 3-char, fixed-length optional field 2.00 fee amount BV variable-length optional field. The amount of fees owed by this patron. screen message AF variable-length optional field print line AG variable-length optional field AXIELL Sverige AB 5 (20)

6 3.2 Checkout Response 12 2-char, fixed-length required field ok 1-char, fixed-length required field: 0 or 1. renewal ok 1-char, fixed-length required field: Y or N. magnetic media 1-char, fixed-length required field: Y or N or U. desensitize 1-char, fixed-length required field: Y or N or U. institution id AO variable-length required field patron identifier AA variable-length required field item identifier AB variable-length required field title identifier AJ variable-length required field due date AH variable-length required field 2.00 fee type BT 2-char, fixed-length optional field (01 thru 99). The type of fee associated with checking out this item. no 2.00 security inhibit CI 1-char, fixed-length optional field : Y or N currency type BH 3-char fixed-length optional field 2.00 fee amount BV variable-length optional field. The amount of fee associated with checking out this item media type CK 3-char, fixed-length optional field no 2.00 item properties CH variable-length optional field no 2.00 transaction id BK variable-length optional field. May be assigned by the ACS when checking out the item involves a fee. no screen message AF variable-length optional field no print line AG variable-length optional field no AXIELL Sverige AB 6 (20)

7 3.3 Checkin Response 10 2-char, fixed-length required field ok 1-char, fixed-length required field: 0 or 1. resensitize 1-char, fixed-length required field: Y or N. magnetic media 1-char, fixed-length required field: Y or N or U. alert 1-char, fixed-length required field: Y or N. institution id AO variable-length required field item identifier AB variable-length required field permanent location AQ variable-length required field title identifier AJ variable-length optional field 2.00 sort bin CL variable-length optional field 2.00 patron identifier AA variable-length optional field. Id of the patron who had the item checked out media type CK 3-char, fixed-length optional field (empty) 2.00 item properties CH variable-length optional field no screen message AF variable-length optional field print line AG variable-length optional field reservationid DE Id of a reservation that has been caught. (This is a local extension) AXIELL Sverige AB 7 (20)

8 3.4 ACS Status Field ID Format Z3970 BOOK-IT char, fixed-length required field on-line status 1-char, fixed-length required field: Y or N. checkin ok 1-char, fixed-length required field: Y or N. checkout ok 1-char, fixed-length required field: Y or N. ACS renewal policy 1-char, fixed-length required field: Y or N. status update ok 1-char, fixed-length required field: Y or N. off-line ok 1-char, fixed-length required field: Y or N. timeout period 3-char, fixed-length required field retries allowed 3-char, fixed-length required field date / time sync protocol version 4-char, fixed-length required field: x.xx Please note: This value must be used when the following requests are being made: Patron Status Patron Information institution id AO variable-length required field Renew All library name AM variable-length optional field 2.00 supported messages BX variable-length required field terminal location AN variable-length optional field screen message AF variable-length optional field print line AG variable-length optional field no AXIELL Sverige AB 8 (20)

9 3.5 Request SC Resend 96 2-char, fixed-length required field 3.6 Login Response 94 2-char, fixed-length required field ok 1-char, fixed-length required field: 0 or 1. AXIELL Sverige AB 9 (20)

10 3.7 Patron Information Response 64 2-char, fixed-length required field When not ok: "YYYY " patron status 14-char, fixed-length required field When ok: " " language 3-char, fixed-length required field 2.00 hold items count 4-char, fixed-length required field 2.00 overdue items count 4-char, fixed-length required field 2.00 charged items count 4-char, fixed-length required field 2.00 fine items count 4-char, fixed-length required field, always "0000" 2.00 recall items count 4-char, fixed-length required field, always "0000" 2.00 unavailable holds count 4-char, fixed-length required field Borrowed item count AI Number of borrowed copies. Local extension. Was used in version 5.6. Always 0 in version 6.0. institution id AO variable-length required field patron identifier AA variable-length required field personal name AE variable-length required field 2.00 hold items limit BZ 4-char, fixed-length optional field, always "0" 2.00 overdue items limit CA 4-char, fixed-length optional field, always "0" 2.00 charged items limit CB 4-char, fixed-length optional field, always "0" 2.00 valid patron BL 1-char, optional field: Y or N valid patron password CQ 1-char, optional field: Y or N. AXIELL Sverige AB 10 (20)

11 2.00 currency type BH 3-char fixed-length optional field 2.00 fee amount BV 2.00 fee limit CC 2.00 hold items AS 2.00 overdue items AT 2.00 charged items AU 2.00 fine items AV 2.00 recall items BU 2.00 unavailable hold items CD variable-length optional field. The amount of fees owed by this patron. variable-length optional field. The fee limit amount. variable-length optional field (this field should be sent for each hold item). variable-length optional field (this field should be sent for each overdue item). variable-length optional field (this field should be sent for each charged item). variable-length optional field (this field should be sent for each fine item). variable-length optional field ( this field should be sent for each recall item). variable-length optional field (this field should be sent for each unavailable hold item). books at home AW Was used in version 5.6. Removed in 6.0. no 2.00 home address BD variable-length optional field address BE variable-length optional field 2.00 home phone number BF variable-length optional field screen message AF variable-length optional field print line AG variable-length optional field no - a list with ids of available hold items (ids of the actual reservations) a list with ids of copies with overdue loan time a list with ids of books at home no no a list with unavailable hold items (Title information) AXIELL Sverige AB 11 (20)

12 3.8 End Session Response 36 2-char, fixed-length required field 2.00 end session 1-char, fixed-length required field: Y or N. institution id AO variable-length required field patron identifier AA variable-length required field screen message AF variable-length optional field no print line AG variable-length optional field no AXIELL Sverige AB 12 (20)

13 3.9 Fee Paid Response 38 2-char, fixed-length required field 2.00 payment accepted 1-char, fixed-length required field: Y or N. institution id AO variable-length required field patron identifier AA variable-length required field 2.00 transaction id BK variable-length optional field. May be assigned by the ACS to acknowledge that the payment was received. no screen message AF variable-length optional field no print line AG variable-length optional field no AXIELL Sverige AB 13 (20)

14 3.10 Item Information Response 18 2-char, fixed-length required field 2.00 circulation status 2-char, fixed-length required field (00 thru 99) 2.00 security marker 2-char, fixed-length required field (00 thru 99) 2.00 fee type 2-char, fixed-length required field (01 thru 99). The type of fee associated with checking out this item hold queue length CF variable-length optional field A due date H variable-length optional field 18-char, fixed-length optional field: 2.00 recall date CJ 2.00 hold pickup date C M 18-char, fixed-length optional field: item identifier AB variable-length required field title identifier AJ variable-length required field 2.00 owner B G variable-length optional field 2.00 currency type BH 3 char, fixed-length optional field 2.00 fee amount BV variable-length optional field. The amount of the fee associated with this item. C 2.00 media type K 3-char, fixed-length optional field 2.00 permanent location A variable-length optional field AXIELL Sverige AB 14 (20)

15 Q 2.00 current location AP variable-length optional field Yes 2.00 item properties screen message print line C H variable-length optional field AF variable-length optional field A G variable-length optional field no - CHSeqNo:191 PickUpPlace:Tumba bibliotek (available hold items) - AFLastCirculationDate: Id: The number after Id: is the catalogue ID that the actual copy is related to. AXIELL Sverige AB 15 (20)

16 3.11 Item Status Update Response NOT SUPPORTED 20 2-char, fixed-length required field 2.00 item properties ok 1-char, fixed-length required field: 0 or 1. item identifier AB variable-length required field title identifier AJ variable-length optional field 2.00 item properties CH variable-length optional field screen message AF variable-length optional field print line AG variable-length optional field AXIELL Sverige AB 16 (20)

17 3.12 Patron Enable Response NOT SUPPORTED 26 2-char, fixed-length required field patron status 14-char, fixed-length required field language 3-char, fixed-length required field institution id AO variable-length required field patron identifier AA variable-length required field personal name AE variable-length required field 2.00 valid patron BL 1-char, optional field: Y or N valid patron password CQ 1-char, optional field: Y or N. screen message AF variable-length optional field print line AG variable-length optional field AXIELL Sverige AB 17 (20)

18 3.13 Hold Response NOT SUPPORTED 16 2-char, fixed-length required field ok 1-char, fixed-length required field: 0 or available 1-char, fixed-length required field: Y or N. 18-char, fixed-length optional field: 2.00 expiration date BW 2.00 queue position BR variable-length optional field 2.00 pickup location BS variable-length optional field institution id AO variable-length required field patron identifier AA variable-length required field item identifier AB variable-length optional field title identifier AJ variable-length optional field screen message AF variable-length optional field print line AG variable-length optional field AXIELL Sverige AB 18 (20)

19 3.14 Renew Response See Checkout Response AXIELL Sverige AB 19 (20)

20 3.15 Renew All Response 66 2-char, fixed-length required field ok 1-char, fixed-length required field: 0 or renewed count 4-char fixed-length required field 2.00 unrenewed count 4-char fixed-length required field institution id AO variable-length required field 2.00 renewed items BM 2.00 unrenewed items BN renewed items main entry renewed items due date unrenewed items main entry DM DC DN variable-length optional field (this field is sent for each renewed item) variable-length optional field (this field is sent for each unrenewed item) variable-length optional field (this field is sent for each renewed item). Local extension. variable-length optional field (this field is sent for each renewed item). Local extension. variable-length optional field (this field is sent for each unrenewed item). Local extension. variable-length optional field (this field is sent for unrenewed items due date DD each unrenewed item). Local extension. screen message AF variable-length optional field no print line AG variable-length optional field no AXIELL Sverige AB 20 (20)