Koha Manual SIP2

User Manual:

Open the PDF directly: View PDF .
Page Count: 5

Introduction

Koha versions 3.0 and later include a functional implementation of the SIP2 protocol. It was

designed against the 3M SIP2 specifications, document version 2.12, April 11, 2006. It supports

ALL of the SIP (version 1) commands and almost all of the SIP2 commands.

Compatible Devices and Software include:

3M Self-Check (SC) Terminals

Envisionware

CASSIE PC reservation system by Librarica

Integratedtek

SIP2 messages supported by Koha

If the Koha Version column is blank, the SIP2 message is not yet supported.

#Message Name Koha

Version Note

23 Patron Status

Request 3.0

11 Checkout 3.0

09 Checkin 3.0

01 Block Patron 3.0

99 SC Status 3.0

97 Request ACS Resend 3.0

93 Login 3.0

63 Patron Information 3.0

35 End Patron Session 3.0

37 Fee Paid

17 Item Information 3.0

19 Item Status Update

25 Patron Enable 3.0

15 Hold 3.0 item-level holds not supported

29 Renew 3.0 title-level renew not supported, nor is “third party

allowed”

65 Renew All 3.0

Configuration

Create SIP user(s) in STAFF interface as normal for staff users. Set userid and password. 1.

Consider setting one of the notes fields to "SYSTEM USER -- DO NOT DELETE" to warn

against deletion. Note the expiration date will affect the SIP users' connection so consider

setting it far in the future.

TIP: Learn more in this manual on the Adding Staff Patrons page.

Set Permissions > grant "Circulate" permissions.2.

TIP: Learn more in this manual on the Patron Permissions page.

Koha uses syslogd facility "local6" to catch log messages. Edit your /etc/syslog.conf file to

handle them. For example, adding a line like the following to write all levels of messages to

/var/log/sipserver.log:

sudo bash

echo "local6.* /var/log/sipserver.log" >> /etc/syslog.conf

exit

Restart syslogd.4.

On command line, export KOHA_CONF and PERL5LIB as normal. Then copy the example

SIPconfig.xml file and edit the copy, like:

cd $PERL5LIB/C4/SIP

cp ./SIPconfig.xml ./SIPServer.xml

vi ./SIPServer.xml # or use whatever text editor you like

Edit the <accounts> section to contain a <login> element for each of your SIP user

accounts, including correct userid, password and institution (library). These are the

values you set in the STAFF interface in Configuration Step #1.

Edit the <institutions> section to contain an <institution> element for each of your

SIP users' libraries. Note: it is not necessary to include all institutions here, only

those to which SIP users belong.

Note the port number for TCP connections is controlled in this file also. 3.

Exapmle SIPServer.xml file with important points highlighted:

<error-detect enabled="true" />

<service

port="8023/tcp"

transport="telnet"

protocol="SIP/2.00"

timeout="60" />

<service

port="127.0.0.1:6001/tcp"

transport="RAW"

protocol="SIP/2.00"

timeout="60" />

</listeners>

<login id="sipterm1" password="term1" delimiter="|" error-detect="enabled"

institution="MAIN" />

<login id="envision" password="koha" delimiter="|" error-detect="enabled"

institution="CPL" />

</accounts>

<policy checkin="true" checkout="true" renewal="true"

status_update="false" offline="false"

timeout="100"

retries="5" />

</institution>

<policy checkin="true" checkout="true" renewal="true"

status_update="false" offline="false"

timeout="25"

retries="5" />

</institution>

</institutions>

</acsconfig>

Run command

From the SIP directory, start the SIP2 server as a background process like:

perl -I./ ./SIPServer.pm ./SIPServer.xml >~/sip_log.out 2>~/sip_log.err &

Note the same KOHA_CONF and PERL5LIB variables must be exported as always.

Note the redirected STDOUT and STDERR (logs) can be to arbitrary locations.

Stopping

Find the head SIP process ID that is running with "ps". Example:

$ ps -ef | grep SIP

atz4sip 5869 1 0 Oct28 ? 00:00:05 perl -I./ /home/atz4sip/koha/C4