Koha/C4/SIP
Nick Clemens 41b5db64b3
Bug 20816: Add ability to define custom templated fields in SIP patron responses
To test:
 1 - You will need to enable SIP on your testing instance
    cp etc/SIPconfig.xml /etc/koha/sites/kohadev/
    sudo koha-start-sip
    add a user listed in the SIPconfig to your system and give them permissions (superlibrarian works)
    on koha-testing-docker you should be able to start sip with user koha/koha without any adjustments
 2 - If you copied the above file you should be set to get custom field DE with dateexpiry
     Otherwise edit the sip login for the user to have a custom section like:
		  <login id="koha"   password="koha"  delimiter="|" error-detect="enabled" institution="kohalibrary" encoding="utf8" >
			  <custom_patron_field field="DE" template="[% patron.dateexpiry %]" />
		  </login>
 3 - send a status test using the sip cli tester:
     perl misc/sip_cli_emulator.pl -a 127.0.0.1 -p 6001 -su koha -sp koha -l kohalibrary --patron 23529001000463 -m patron_status_request
 4 - send an information test using the sip cli tester:
     perl misc/sip_cli_emulator.pl -a 127.0.0.1 -p 6001 -su koha -sp koha -l kohalibrary --patron 23529001000463 -m patron_information
 5 - confirm you receive the DE field with a dateexpiry
 6 - Add your own custom fields and confirm it works with several
         <custom_patron_field field="EW" template="Phone: [% patron.phone %] Email: [% patron.email %]" />
 7 - prove -v t/db_dependent/SIP/Patron.t
 8 - prove -v t/db_dependent/SIP/

Signed-off-by: Andrew Fuerste-Henry <andrew@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2020-04-22 13:31:59 +01:00
..
ILS Bug 20816: Add ability to define custom templated fields in SIP patron responses 2020-04-22 13:31:59 +01:00
Sip Bug 20816: Add ability to define custom templated fields in SIP patron responses 2020-04-22 13:31:59 +01:00
t Bug 18432 : Follow up - Updating to use they/them 2017-04-21 10:56:43 -04:00
acstest.py
example_institution_dump.sh
ILS.pm Bug 24828: Add ability to specify cash register in SIP config 2020-03-25 13:51:02 +00:00
ILS.pod
interactive_item_dump.pl Bug 17196: Move marcxml out of the biblioitems table 2017-01-13 13:49:26 +00:00
interactive_patron_check_password.pl
interactive_patron_dump.pl
interactive_renew_all_dump.pl
Makefile
README
Sip.pm Bug 20816: Add ability to define custom templated fields in SIP patron responses 2020-04-22 13:31:59 +01:00
SIPServer.pm Bug 23640: Flushing L1 on every SIP connection 2020-02-10 08:57:53 +00:00
test.txt
xmlparse.pl

README for Open NSIP 3M-SIP Server

DEPENDENCIES

SIPServer is written entirely in Perl, but it require these CPAN
perl modules to run:

     Net::Server - The SIP server is a Net::Server::Prefork server
     XML::LibXML
     XML::Parser
     XML::Simple - for parsing the config file
     UNIVERSAL::require - for loading the correct ILS interface module
     Clone - for running the test cases

LOGGING

SIPServer uses syslog() for status and debugging messages.  All
syslog messages are logged using the syslog facility 'local6'.
If you need to change this, because something else on your system
is already using that facililty, just change the definition of
'LOG_SIP' at the top of the file SIPServer.pm

Make sure to update your syslog configuration to capture facility
'local6' and record it.