SIP Administration

Server parameters and listeners are intentionally not included in this work and must still be configured in the SIPConfig.xml file.Institutions

Navigate to Administration > SIP2

Institutions 

Example Scenario

1. Navigate to Administration > SIP2 > Institutions > New Institution
   
2. Fill in the configuration settings for the Institution:
1. Name: Provide a name that matches the BRANCHCODE of the new branch
   
2. Implementation:  ILS
   
3. Checkin: Yes
4. Checkout: Yes
5. Offline: No
   
1. Generally, SIP devices stop functioning when the connection drops, so this doesn't come into play very often.
   
2. If you have a device that it says it can keep a record of the offline transactions, please contact our systems team to confirm that the record it keeps is able to be used.
   
6. Renewal: Yes
   
7. Retries: 5
   
8. Status Update: No
   
9. Timeout: 600
   
3. Submit

Account

Account Set Up SIP

Accounts - SIP

Example Scenario

1. First, you must create a borrower account so that it can authenticate with Koha
   
2. Patrons > New Patron > Choose an account type like Staff or System
   
3. Fill in the information for the patron. Here are some recommended values:
   
1. First name: ***SIP ACCOUNT***
   
2. Surname: sip_service_location
   
1. examples: sip_lockers_north, sip_evisionware_main, or, in the case of a system wide service, sip_overdrive
   
3. Card number: (all lowercase duplicate of the surname)
   
4. Category: Staff or System
   
5. Home library: location of service or main location for system wide service
   
6. Expiration date: something far out, like 01-01-2100
   
7. Username: (all lowercase duplicate of the surname)
   
8. Password: something 12 characters in length.
   
1. Avoid ambiguous characters like o's, l's, i's, parenthesis, and the pipe character
   
2. WARNING: this is the only place that the password is kept, so ensure that it is known since it cannot be retrieved, only reset
4. Assign the necessary permissions to the account:
   
1. Check out and check in items (circulate): all
   
2. Staff access, allows viewing of catalogue in staff interface: checked
   
3. Add, modify and view patron information (borrowers) > Search, list and view patrons (list_borrowers): checked
   
4. Allow staff to change logged in library (loggedinlibrary): checked
   
   
5. Navigate to Administration > SIP2 > Accounts > New Account
   
6. Fill in the Details section for the account. Recommended settings are:
   
1. Staff userid for SIP2 authentication: the username from your recently created borrower account
   
2. Institution: the institution (location) you want any statistics attributed
3. Allow additional materials checkout: yes - the popup that circ staff see when there are companion pieces they need to be aware of, do you want to allow those or not?
   
4. Allow empty password: no - there are certain situations where a library may choose to allow this. That is your choice.
5. Allow fields: leave blank - if you would rather only allow certain sip fields sent from Koha. 
   
1. Please contact Support before changing these settings
6. Blocked item types: leave blank - should some item types not be allowed to be checked out with this accouunt? If so, select them (multiples are allowed)
   
7. Checked in OK: yes - if an item isn't checked out, is it ok to check it in again?
   
8. CR item field: collection code - the default - shelving location is also an option
   
9. Convert nonprinting characters: leave blank
10. CT Always send: yes
    
11. CV always send 00 on success: yes
    
12. CV triggers alert: no
    
13. Delimiter: | - the pipe - **you do need to type that in
14. Disallow overpayment: yes
15. Encoding: uft8
    
16. Error detect: yes
    
17. Format due date: no
    
18. Hide fields: leave blank
    
1. Please contact Support before changing these settings
19. Holds block checkin: no
    
20. Holds get captured: no - automatically assign them when they are checked in?
    
1. Some holds lockers are able to use this to change an item from "in transit" to "waiting" which would require the value to be: yes
21. Inhouse item types: leave blank - any item types that can be checked out but the RFID security not turned off.
22. Inhouse patron categories: leave blank
23. Lost block checkout: leave blank - do you want lost items to prevent checkouts? how many?
    
24. Lost block checkout value: leave blank - the authorized value code number for the LOST category, the minimum code number that the item must have for it to count towards their total
    
25. Lost status for missing: leave blank - which is it? missing
    
26. Overdues block checkout: no
    
27. payment type writeoff: leave as is
28. Cash register: if needed
    
29. Seen on item information: leave blank - useful for RFID wands - what should happen if a lost item is scanned?
30. Send patron home library in AF: no
    
31. Show checkin message: yes
    
32. Show outstanding amount: no
    
33. Terminator: CR
    
7. Provide any custom SIP Response Mappings
   
1. This is where specific pieces of data like Custom Patron Attributes or Item Information can be added to the SIP messages that Koha sends.
   
2. Example - Custom patron field
   
1. Field (the SIP field that this information will be sent in - 2 letters): XB
   
2. Template: [% patron.borrowernumber %]
   
3. Example - Patron Attribute
   
1. Field (the SIP field that this information will be sent in - 2 letters): UC
   
2. Code: INTERNET (the code value assigned to the patron attribute found within Administration > Patrons and circulation > Patron attribute types)
   
4. Example - Custom item field
   
1. Field: (the SIP field that this information will be sent in - 2 letters): XA
   
2. Template: [% item.itype %]
   
8. Provide any Syspref overrides
   
1. This would be if there are system preferences that you would like to be except from for this particular sip account:
   
2. Example - You would like a patron to be allowed to use a computer no matter how many fines they have:
   
1. Variable:  noissuescharge (must match the casing of the system preference as seen in the system preferences section of the administration module)
2. Value: 9999 (provide an amount that is so high a patron would have difficulty ever reaching)
   
9. Provide any specific templates for the AE, AV, and DE field of the SIP response message
   
1. The examples provided in the boxes are common templates that have been used by partners:
   
2. Examples
1. AE field template: [% patron.surname %][% IF patron.firstname %], [% patron.firstname %][% END %]
2. AV field template: [% accountline.description %][% accountline.amountoutstanding | format('%.2f') %]
   
3. DE field template: [% patron.surname %][% IF patron.firstname %], [% patron.firstname %][% END %]
   

SIP is a highly customizable communication tool. If you have questions or wish to discuss possibilities please send us a ticket.

System Preferences

System Preference

Once the account has been made (or modified) at the next call from the sip account, it will pull the updated configuration from the database. If changes do not appear to be applying, please send us a ticket.