doc/sru_z3950.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: sru_z3950.xml,v 1.4 2007-01-08 12:27:27 marc Exp $ -->
   8 <refentry>
   9  <refmeta>
  10   <refentrytitle>sru_z3950</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12   <refmiscinfo>Metaproxy Module</refmiscinfo>
  13  </refmeta>
  14
  15  <refnamediv>
  16   <refname>sru_z3950</refname>
  17   <refpurpose>transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    The <literal>sru_z3950</literal> Metaproxy filter transforms valid
  23    SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
  24    received hit counts and XML records into suitable SRU response messages.
  25   </para>
  26   <para>
  27    Multiple database elements defining the names of the accepted
  28    databases are allowed in the configuration file. Each
  29    of them must contain their own explain record, or must be empty.
  30    Notice that explain
  31    records come in SRU and Z39.50 flavors, and this filter requires
  32    the SRU version. See the
  33    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  34    standard pages and the
  35    <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
  36    for more information.
  37   </para>
  38   <para>
  39    All Z39.50 packages and all HTTP packages that do not resolve to
  40    one configured database name are passed unaltered to the next
  41    filters on the route.
  42    </para>
  43   <para>
  44    The SRU <literal>explain</literal> operation is supported,
  45    returning either the absolute minimum required by the standard, or
  46    a  full  pre-defined ZeeReX explain record.
  47   </para>
  48   <para>
  49    It supports the SRU <literal>searchRetrieve</literal> operation, which
  50    is transformed into successive Z3950 <literal>init</literal>,
  51    <literal>search</literal> and <literal>present</literal> requests.
  52   </para>
  53   <para>
  54    The SRU <literal>scan</literal> operation is not supported.
  55    </para>
  56   <para>
  57    This filter does not handle CQL-to-PQF translations. In case that
  58    the backends do not understand CQL, you need to append the
  59    <literal>cql_pqf</literal> metaproxy filter. This filter
  60    still needs to be implemented.
  61    </para>
  62  </refsect1>
  63
  64  <refsect1><title>EXAMPLES</title>
  65   <para>
  66    A typical configuration looks like this:
  67    <screen><![CDATA[
  68     <filter type="sru_z3950">
  69       <database name="Default">
  70         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  71           ...
  72         </explain>
  73       </database>
  74       <database name="Dummy">
  75     </filter>
  76
  77 ]]>
  78    </screen>
  79   </para>
  80  </refsect1>
  81
  82  <refsect1><title>SEE ALSO</title>
  83   <para>
  84    <citerefentry>
  85     <refentrytitle>metaproxy</refentrytitle>
  86     <manvolnum>1</manvolnum>
  87    </citerefentry>
  88   </para>
  89  </refsect1>
  90
  91  &copyright;
  92 </refentry>
  93
  94 <!-- Keep this comment at the end of the file
  95 Local variables:
  96 mode: sgml
  97 sgml-omittag:t
  98 sgml-shorttag:t
  99 sgml-minimize-attributes:nil
 100 sgml-always-quote-attributes:t
 101 sgml-indent-step:1
 102 sgml-indent-data:t
 103 sgml-parent-document:nil
 104 sgml-local-catalogs: nil
 105 sgml-namecase-general:t
 106 End:
 107 -->