Koha SIP2 Server Capabilities

From Koha Wiki

Jump to: navigation, search
Home > Documentation

Contents

Supported Messages

  • Patron Status Request (23)
  • Checkout (11)
  • Checkin (09)
  • Block Patron (01)
  • SC Status (99)
  • Request ACS Resend (97)
  • Login (93)
  • Patron Information (63)
  • End Patron Session (35)
  • Fee Paid (37)
  • Item Information (17)
  • Item Status Update (19)
  • Patron Enable (25)
  • Hold (15)
  • Renew (29)
  • Renew All (65)

Configuration Options

Koha's SIP configuration file defines parameters as xml entities:

Server Params <server-params>

Server params defines a number of universal SIP server settings including:

  • min_servers - The fewest instances of the SIP server that will always be running
  • min_spare_servers - The fewest extra instances of the SIP server that are not in use

Listeners

The <listeners> section defines a set of services that the SIP server makes available for use. Each <service> instance has the following options:

  • port - The port defines what IP protocol, port and ip address this server uses. For example "192.168.1.20:6001/tcp" would listen to port 6001 for the ip address 192.168.1.20 only using tcp. The ip address can be left off to listen on all IP addresses ( e.g. "6001/tcp" )
  • transport - Defines if this service is used for communication over telnet, or using RAW socket connections
  • timeout - Defines how long the connection will be allowed to stay open without communication before it is closed automatically. This setting defers to the institution timeout setting.

Acounts

The <accounts> section defines a set of logins that may be used across all define services for the SIP2 server. Each login must match a valid Koha user Each <login> instance has the following options:

  • id - This is the id of the Koha user the account will act as
  • password - The password of the Koha user account
  • delimeter - The character used to separate fields in messages ( default is the pipe ( | ) character )
  • error-detect - Defines if error correction is enabled for this login
  • institution - Defines the institution id and also the location code for this sip login.
  • encoding - The character coding to use, default is utf8 but ascii is also available for services that cannot handle utf-8 encoded data
  • send_patron_home_library_in_af - The SIP2 standard has no provision for transmitting a patron's home library code. If this option is enabled, that code will be transmitted as an AF field for Patron Information and Patron Status Requests

Screen Message Regular Expressions

Each SIP server account may have one or more screen message regular expressions. These regex's allow you to change the language of outgoing AF fields. Each <screen_msg_regex> has the following options:

  • find - May be a string or regex for the text on which to match
  • replace - May be a string with which to replace them match or to transport the match

Institutions

Within the <institutions> block must be an instance of <institution> for each institution used in the <accounts> section of the configuration. Each <institution> contains a policy block. The <policy> block has the following options:

  • checkin - Defines if logins using this institution can check in items
  • renewal - Defines if logins using the institution can renew items for patrons
  • checkout - Defines if logins using the institution can check out items to patrons
  • status_update - Defines if logins using the institution can update patron status ( e.g. block a patron's card )
  • offline - Fines of the logins using the institution can process offline operations
  • timeout - Defines how long the connection will be allowed to stay open without communication before it is closed automatically. This setting take precedence over the service timeout setting.
  • retries - Defines the number of retries that are allowed for a specific transaction

Relevant bugs/patches

  • Bug 16694 - Limit SIP2 auth by patron attribute
Personal tools