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 % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-sru_z3950">
9 <refentrytitle>sru_z3950</refentrytitle>
10 <manvolnum>3mp</manvolnum>
11 <refmiscinfo>Metaproxy Module</refmiscinfo>
15 <refname>sru_z3950</refname>
16 <refpurpose>Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
19 <refsect1><title>DESCRIPTION</title>
21 The <literal>sru_z3950</literal> Metaproxy filter transforms valid
22 SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
23 received hit counts and XML records into suitable SRU response messages.
26 Multiple database elements defining the names of the accepted
27 databases are allowed in the configuration file. Each
28 of them must contain their own explain record, or must be empty.
30 records come in SRU and Z39.50 flavors, and this filter requires
31 the SRU version. See the
32 <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
33 standard pages and the
34 <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
38 All Z39.50 packages and all HTTP packages that do not resolve to
39 one configured database name are passed unaltered to the next
43 The SRU <literal>explain</literal> operation is supported,
44 returning either the absolute minimum required by the standard, or
45 a full pre-defined ZeeReX explain record.
48 It supports the SRU <literal>searchRetrieve</literal> operation, which
49 is transformed into successive Z3950 <literal>init</literal>,
50 <literal>search</literal> and <literal>present</literal> requests.
53 The SRU <literal>scan</literal> operation is not supported.
56 This filter does not handle CQL-to-PQF translations. In case that
57 the backends do not understand CQL, you need to append the
58 <literal>cql_pqf</literal> metaproxy filter. This filter
59 still needs to be implemented.
63 <refsect1><title>EXAMPLES</title>
65 A typical configuration looks like this:
67 <filter type="sru_z3950">
68 <database name="Default">
69 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
73 <database name="Dummy">
81 <refsect1><title>SEE ALSO</title>
84 <refentrytitle>metaproxy</refentrytitle>
85 <manvolnum>1</manvolnum>
93 <!-- Keep this comment at the end of the file
98 sgml-minimize-attributes:nil
99 sgml-always-quote-attributes:t
102 sgml-parent-document:nil
103 sgml-local-catalogs: nil
104 sgml-namecase-general:t