57ebda4596245fc5779dcaf10ad4685d174b1b8c
[Evergreen.git] / Open-ILS / examples / oils_sip.xml.example
1 <?xml version="1.0"?>
2 <acsconfig xmlns="http://openncip.org/acs-config/1.0/">
3
4         <error-detect enabled="true" />
5
6   <!-- Set Net::Server::PreFork runtime parameters -->
7         <!--  <server-params
8            min_servers='1'
9            min_spare_servers='0' /> -->
10   
11   
12         <listeners>
13                 <service
14                         port="0:8080/tcp"
15                         transport="http"
16                         protocol="NCIP/1.0" />
17
18                 <service
19                         port="8023/tcp"
20                         transport="telnet"
21                         protocol="SIP/1.00"
22                         timeout="60" />
23
24                 <service
25                         port="127.0.0.1:6001/tcp"
26                         transport="RAW" 
27                         protocol="SIP/2.00"
28                         timeout="60" />
29         </listeners>
30
31         <accounts>
32                 <login id="scclient" password="clientpwd" institution="gapines"/>
33         </accounts>
34
35         <!-- Institution tags will hold stuff used to interface to -->
36         <!-- the rest of the ILS: authentication parameters, etc.  I -->
37         <!-- don't know what yet, so it'll just be blank.  But there -->
38         <!-- needs to be one institution stanza for each institution -->
39         <!-- named in the accounts above. -->
40         <institutions>
41
42
43                 <institution id="gapines" implementation="OpenILS::SIP">
44
45                         <!-- This defines what actions we want to allow 
46                                 remote clients (self-check machines) to perform -->
47                         <policy 
48                                 checkin="true" 
49                                 checkout="true" 
50                                 renewal="true" 
51                                 status_update="false" 
52                                 offline="false" 
53                                 timeout="600" 
54                                 retries="3"/>
55         
56                         <!-- The default encoding defined in the SIP specification is -->
57                         <!-- ASCII, which isn't great for French, Spanish, Armenian. -->
58                         <!-- You can specify a different encoding here, based on the -->
59                         <!-- encodings supported by your SIP client and your Encode -->
60                         <!-- module; run the following command to get a list of supported -->
61                         <!-- encodings: -->
62                         <!--   perl -MEncode -le "print for Encode->encodings(':all')" -->
63
64                         <!-- UTF-8 is the recommended encoding if your SIP client supports it -->
65                         <encoding>ascii</encoding>
66
67                         <!-- implementation specific config options go here -->
68                         <implementation_config>
69                                 <bootstrap>SYSCONFDIR/opensrf_core.xml</bootstrap>
70                                 <currency>USD</currency>
71
72                                 <!-- These defines what this SIP code has the ability to support -->
73                                 <supports>
74                                         <item name='magnetic media' value='true'/>
75                                         <item name='security inhibit' value='false'/>
76                                         <item name='offline operation' value='false'/>
77                                         <item name='patron status request' value='true'/>
78                                         <item name='checkout' value='true'/>
79                                         <item name='checkin' value='true'/>
80                                         <item name='block patron' value='true'/>
81                                         <item name='acs status' value='true'/>
82                                         <item name='login' value='true'/>
83                                         <item name='patron information' value='true'/>
84                                         <item name='end patron session' value='true'/>
85                                         <item name='fee paid' value='true'/>
86                                         <item name='item information' value='true'/>
87                                         <item name='item status update' value='false'/>
88                                         <item name='patron enable' value='false'/>
89                                         <item name='hold' value='false'/>
90                                         <item name='renew' value='true'/>
91                                         <item name='renew all' value='true'/>
92                                 </supports>
93                                 <options>
94                                         <!-- msg64, the patron information request can be
95                                           made to return item barcodes by setting
96                                           the option 'msg64_summary_datatype' to 'barcode'
97                                           as below. Any other value, or no value at all
98                                           will cause OpenILS::SIP to return the title
99                                           in response to a message 64 request, which was the
100                                           default behaviour in previous versions of Evergreen.
101                                         -->
102                                         <option name='msg64_summary_datatype' value='barcode' />
103
104
105                     <!--
106                         When set, holds will be returned to the SIP client as copy
107                         barcodes instead of title strings.  This is useful, in 
108                         particular, for making subsequent calls for hold cancellation.  
109                     -->
110                     <!--
111                     <option name='msg64_hold_datatype' value='barcode' />
112                     -->
113
114                                         <!--
115                                                 If enabled, the PC field in patron-info requests will return the non-translated profile name
116                                         <option name='patron_type_uses_code' value='true' />
117                                         -->
118
119                     <!--
120                         By default, most dates use the SIP date format.  Some,
121                         like circulation due dates, use the ISO8601 date format 
122                         instead.  If this setting is set to true, all dates will
123                         use the SIP date format.
124                     <option name='use_sip_date_format' value='true' />
125                     -->
126
127                                         <!--
128                                                 If enabled, return the calculated value for the recall
129                                                 flag instead of always returning not-OK
130                                         <option name='patron_calculate_recal_ok' value='true' />
131                                         -->
132
133                                 </options>
134
135                 <checkin_override>
136                     <event>COPY_ALERT_MESSAGE</event>
137                     <event>COPY_BAD_STATUS</event>
138                     <event>COPY_STATUS_MISSING</event>
139                     <!--
140                     <event>COPY_STATUS_LOST</event>
141                     -->
142                 </checkin_override>
143
144                 <checkout_override>
145                     <event>COPY_ALERT_MESSAGE</event>
146                 </checkout_override>
147
148                 <!-- If uncommented, SIP2 checkins will capture local holds as transits, instead of marking as ready for pickup. -->
149                 <!--
150                 <checkin_hold_as_transit>1</checkin_hold_as_transit>
151                 -->
152
153                         </implementation_config>
154         
155                 </institution>
156         
157         </institutions>
158 </acsconfig>
159
160 <!--
161     vim:noet:ts=4:sw=4:
162 -->