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                 <!--
  33                 Fine Item Detail returned by the Patron Information Request is
  34                 manufacturer-specific.  We support the following formats:
  35                 3m,  Swyer_A, Swyer_B, and EG_Legacy (default).
  36                 Specify which treatment you want in the av_format attribute.
  37                 For example: <login id="sc" password="pwd" institution="main" av_format="3m">
  38                 -->
  39                 <login id="scclient" password="clientpwd" institution="gapines"/>
  40         </accounts>
  41
  42         <!-- Institution tags will hold stuff used to interface to -->
  43         <!-- the rest of the ILS: authentication parameters, etc.  I -->
  44         <!-- don't know what yet, so it'll just be blank.  But there -->
  45         <!-- needs to be one institution stanza for each institution -->
  46         <!-- named in the accounts above. -->
  47         <institutions>
  48
  49
  50                 <institution id="gapines" implementation="OpenILS::SIP">
  51
  52                         <!-- This defines what actions we want to allow
  53                                 remote clients (self-check machines) to perform -->
  54                         <policy
  55                                 checkin="true"
  56                                 checkout="true"
  57                                 renewal="true"
  58                                 status_update="false"
  59                                 offline="false"
  60                                 timeout="600"
  61                                 retries="3"/>
  62
  63                         <!-- The default encoding defined in the SIP specification is -->
  64                         <!-- ASCII, which isn't great for French, Spanish, Armenian. -->
  65                         <!-- You can specify a different encoding here, based on the -->
  66                         <!-- encodings supported by your SIP client and your Encode -->
  67                         <!-- module; run the following command to get a list of supported -->
  68                         <!-- encodings: -->
  69                         <!--   perl -MEncode -le "print for Encode->encodings(':all')" -->
  70
  71                         <!-- UTF-8 is the recommended encoding if your SIP client supports it -->
  72                         <encoding>ascii</encoding>
  73
  74                         <!-- implementation specific config options go here -->
  75                         <implementation_config>
  76                                 <bootstrap>SYSCONFDIR/opensrf_core.xml</bootstrap>
  77                                 <currency>USD</currency>
  78
  79                                 <!-- These defines what this SIP code has the ability to support -->
  80                                 <supports>
  81                                         <item name='magnetic media' value='true'/>
  82                                         <item name='security inhibit' value='false'/>
  83                                         <item name='offline operation' value='false'/>
  84                                         <item name='patron status request' value='true'/>
  85                                         <item name='checkout' value='true'/>
  86                                         <item name='checkin' value='true'/>
  87                                         <item name='block patron' value='true'/>
  88                                         <item name='acs status' value='true'/>
  89                                         <item name='login' value='true'/>
  90                                         <item name='patron information' value='true'/>
  91                                         <item name='end patron session' value='true'/>
  92                                         <item name='fee paid' value='true'/>
  93                                         <item name='item information' value='true'/>
  94                                         <item name='item status update' value='false'/>
  95                                         <item name='patron enable' value='false'/>
  96                                         <item name='hold' value='false'/>
  97                                         <item name='renew' value='true'/>
  98                                         <item name='renew all' value='true'/>
  99                                 </supports>
 100                                 <options>
 101                                         <!-- msg64, the patron information request can be
 102                                           made to return item barcodes by setting
 103                                           the option 'msg64_summary_datatype' to 'barcode'
 104                                           as below. Any other value, or no value at all
 105                                           will cause OpenILS::SIP to return the title
 106                                           in response to a message 64 request, which was the
 107                                           default behaviour in previous versions of Evergreen.
 108                                         -->
 109                                         <option name='msg64_summary_datatype' value='barcode' />
 110
 111
 112                     <!--
 113                         When set, holds will be returned to the SIP client as copy
 114                         barcodes instead of title strings.  This is useful, in
 115                         particular, for making subsequent calls for hold cancellation.
 116                     -->
 117                     <!--
 118                     <option name='msg64_hold_datatype' value='barcode' />
 119                     -->
 120
 121                     <!--
 122                         When set, hold items details will return only available holds to the SIP client.
 123                     -->
 124                     <!--
 125                     <option name='msg64_hold_items_available' value='true' />
 126                     -->
 127
 128                                         <!--
 129                                                 If enabled, the PC field in patron-info requests will return the non-translated profile name
 130                                         <option name='patron_type_uses_code' value='true' />
 131                                         -->
 132
 133                     <!--
 134                         By default, most dates use the SIP date format.  Some,
 135                         like circulation due dates, use the ISO8601 date format
 136                         instead.  If this setting is set to true, all dates will
 137                         use the SIP date format.
 138                     <option name='use_sip_date_format' value='true' />
 139                     -->
 140
 141                                         <!--
 142                                                 If enabled, return the calculated value for the recall
 143                                                 flag instead of always returning not-OK
 144                                         <option name='patron_calculate_recal_ok' value='true' />
 145                                         -->
 146
 147                                 </options>
 148
 149                 <checkin_override>
 150                     <event>COPY_ALERT_MESSAGE</event>
 151                     <event>COPY_BAD_STATUS</event>
 152                     <event>COPY_STATUS_MISSING</event>
 153                     <!--
 154                     <event>COPY_STATUS_LOST</event>
 155                     -->
 156                 </checkin_override>
 157
 158                 <checkout_override>
 159                     <event>COPY_ALERT_MESSAGE</event>
 160                 </checkout_override>
 161
 162                 <!-- If uncommented, SIP2 checkins will capture local holds as transits, instead of marking as ready for pickup. -->
 163                 <!--
 164                 <checkin_hold_as_transit>1</checkin_hold_as_transit>
 165                 -->
 166
 167                         </implementation_config>
 168
 169                 </institution>
 170
 171         </institutions>
 172 </acsconfig>
 173
 174 <!-- vim:noet:ts=4:sw=4: -->