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