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">
7 <!-- $Id: sru_z3950.xml,v 1.6 2007-05-09 21:23:08 adam Exp $ -->
8 <refentry id="ref-sru_z3950">
10 <refentrytitle>sru_z3950</refentrytitle>
11 <manvolnum>3mp</manvolnum>
12 <refmiscinfo>Metaproxy Module</refmiscinfo>
16 <refname>sru_z3950</refname>
17 <refpurpose>Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
20 <refsect1><title>DESCRIPTION</title>
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.
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.
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
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
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.
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.
54 The SRU <literal>scan</literal> operation is not supported.
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.
64 <refsect1><title>EXAMPLES</title>
66 A typical configuration looks like this:
68 <filter type="sru_z3950">
69 <database name="Default">
70 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
74 <database name="Dummy">
82 <refsect1><title>SEE ALSO</title>
85 <refentrytitle>metaproxy</refentrytitle>
86 <manvolnum>1</manvolnum>
94 <!-- Keep this comment at the end of the file
99 sgml-minimize-attributes:nil
100 sgml-always-quote-attributes:t
103 sgml-parent-document:nil
104 sgml-local-catalogs: nil
105 sgml-namecase-general:t