Bug 34868: (QA follow-up) Rename new option, add comments
[koha.git] / etc / SIPconfig.xml
1 <acsconfig xmlns="http://openncip.org/acs-config/1.0/">
2 <!-- above address gets nothing, it's just a namespace -->
3   <error-detect enabled="true" />
4
5 <!--
6   Set Net::Server::PreFork runtime parameters
7   syslog_ident will identify SIP2 Koha server entries in syslog
8   See documentation for Net::Server
9   user and group select what user the service should run as
10   if started as root (e.g. in server startup ) the server will switch to
11   this user after binding to the socket it is listening on
12   For OpenSolaris, add: syslog_logsock=stream
13 -->
14   <server-params
15     min_servers='1'
16     min_spare_servers='0'
17     max_servers='1'
18     log_file='Sys::Syslog'
19     syslog_ident='koha_sip'
20     syslog_facility='local6'
21     setsid="1"
22     user='koha'
23     group='koha'
24     pid_file='/var/run/sipserver.pid'
25   />
26
27   <listeners>
28 <!-- vestigial HTTP, never implemented: just use the OPAC!
29     <service
30       port="0:8080/tcp"
31       transport="http"
32       protocol="NCIP/1.0" />
33 -->
34     <service
35       port="8023/tcp"
36       transport="telnet"
37       protocol="SIP/2.00"
38       timeout="60" />
39
40     <service
41       port="127.0.0.1:6001/tcp"
42       transport="RAW"
43       protocol="SIP/2.00"
44       client_timeout="600"
45       timeout="60" />
46 <!--- client_timeout times out active connections which have not received
47      input from the client. Many persistent connections will send a status request
48      every 5-7 mins so setting this to less than that will add instability to the connection
49      if explicitly set to zero, no timeout is applied to the connection.
50      NB the parameter timeout applies to the login process only and should be set to a lower value
51      to time out failed connections
52 -->
53   </listeners>
54
55   <accounts>
56       <login id="staff"  password="staff" delimiter="|" error-detect="enabled" institution="CPL" encoding="ascii" checked_in_ok="1" payment_type_writeoff="06" disallow_overpayment="1" />
57       <login id="koha"   password="koha"  delimiter="|" error-detect="enabled" institution="kohalibrary" encoding="utf8" />
58       <login id="koha2"  password="koha" institution="kohalibrary2" terminator="CR" />
59       <login id="lpl-sc" password="1234" institution="LPL" allow_fields="AO,AA,AE"/>
60       <!-- allow_fields hides all fields not in the list, it is the inverse of hide_fields ( hide_fields takes precedence ) -->
61       <login id="lpl-sc-beacock" password="xyzzy"
62              delimiter="|" error-detect="enabled" institution="LPL"
63              send_patron_home_library_in_af="1"
64              cv_send_00_on_success="1"
65              ct_always_send="1"
66              cv_triggers_alert="1"
67              allow_empty_passwords="1"
68              cr_item_field="shelving_location"
69              ae_field_template="[% patron.surname %][% IF patron.firstname %], [% patron.firstname %][% END %]"
70              da_field_template="[% patron.surname %][% IF patron.firstname %], [% patron.firstname %][% END %]"
71              av_field_template="[% accountline.description %] [% accountline.amountoutstanding | format('%.2f') %]"
72              hide_fields="BD,BE,BF,PB"
73              allow_additional_materials_checkout="1"
74              register_id=''
75              holds_block_checkin="0"
76              holds_get_captured="1"
77              prevcheckout_block_checkout="0"
78              overdues_block_checkout="1"
79              show_outstanding_amount="1"
80              show_checkin_message="0"
81              format_due_date="0"
82              inhouse_item_types=""
83              inhouse_patron_categories=""
84              lost_status_for_missing="4" <!-- defines which Koha lost status will return the circulation status 13 ( i.e. missing ) for this account -->
85              blocked_item_types="VM|MU"
86              seen_on_item_information="mark_found"> <!-- could be "keep_lost", empty to disable -->
87              <!-- show_checkin_message: If enabled, successful checking responses will contain an AF screen message -->
88              <!-- lost_block_checkout sets flag if patron has more than the given current checkouts that are lost ( itemlost > 0 by default ) -->
89              <!-- lost_block_checkout_value determines the minimum lost item value to count ( that is, the value in items.itemlost ) -->
90           <!-- Refer to syspref SIP2SortBinMapping for full explanation of sort bin mapping -->
91           <sort_bin_mapping mapping="CPL:itype:eq:BK:1"/>
92           <sort_bin_mapping mapping="CPL:location:eq:OFFICE:2"/>
93           <screen_msg_regex find="Greetings from Koha." replace="Welcome to your library!" />
94           <screen_msg_regex find="Invalid patron barcode." replace="Barcode not found, are you sure this is your library card?" />
95           <patron_attribute field="XY" code="CODE" />
96           <item_field field="ZY" code="permanent_location" />
97           <syspref_overrides>
98               <AllFinesNeedOverride>0</AllFinesNeedOverride>
99           </syspref_overrides>
100           <custom_patron_field field="DE" template="[% patron.dateexpiry %]" />
101           <custom_item_field field="IN" template="[% item.itemnumber %]" />
102       </login>
103   </accounts>
104
105 <!--
106 Institution tags are for enabled branches.  There needs to be one
107 institution stanza for each institution named in the accounts above.
108 The implementation attribute is actually used to find the code to run,
109 in our case "ILS".
110 -->
111
112 <institutions>
113     <institution id="MAIN" implementation="ILS" parms="">
114           <policy checkin="true" renewal="true" checkout="true"
115             status_update="false" offline="false"
116           timeout="100"
117             retries="5" />
118     </institution>
119     <institution id="CPL" implementation="ILS" parms="">
120           <policy checkin="true" renewal="true" checkout="true"
121             status_update="false" offline="false"
122           timeout="25"
123             retries="5" />
124     </institution>
125     <institution id="kohalibrary" implementation="ILS" parms="">
126           <policy checkin="true" renewal="false" checkout="true"
127             status_update="false" offline="false"
128           timeout="100"
129             retries="5" />
130     </institution>
131     <institution id="kohalibrary2" implementation="ILS" parms="">
132           <policy checkin="true" renewal="false" checkout="true"
133           timeout="100"
134             retries="3" />
135     </institution>
136     <institution id="LPL" implementation="ILS">
137           <policy checkin="true" renewal="false" checkout="true"
138           timeout="100"
139             retries="5" />
140     </institution>
141 </institutions>
142
143 <!-- This section allows system preferences to be overridden on a global basis.
144      If the same system preference is overridden at the login level, the login
145      version will take precedence.
146 -->
147 <syspref_overrides>
148       <AllFinesNeedOverride>0</AllFinesNeedOverride>
149 </syspref_overrides>
150 </acsconfig>