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