1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3 <!ENTITY copyright SYSTEM "copyright.xml">
4 <!ENTITY % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-sru_z3950">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>sru_z3950</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>sru_z3950</refname>
21 <refpurpose>Metaproxy Module transforming SRU web service requests to
22 Z39.50 Metaproxy packages</refpurpose>
25 <refsect1><title>DESCRIPTION</title>
27 The <literal>sru_z3950</literal> Metaproxy filter transforms valid
28 SRU GET/POST/SOAP requests to Z39.50 requests, and wraps the
29 received hit counts and XML records into suitable SRU response messages.
32 Multiple database elements defining the names of the accepted
33 databases are allowed in the configuration file. Each
34 of them must contain their own explain record, or must be empty.
36 records come in SRU and Z39.50 flavors, and this filter requires
37 the SRU version. See the
38 <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
39 standard pages and the
40 <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
44 Optionally the default stylesheet may be specified. If the client
45 do not specify a stylesheet, the CDATA of element
46 <literal>stylesheet</literal> is used.
49 All Z39.50 packages and all HTTP packages that do not resolve to
50 one configured database name are passed unaltered to the next
54 The SRU <literal>explain</literal> operation is supported,
55 returning either the absolute minimum required by the standard, or
56 a full pre-defined ZeeReX explain record.
59 It supports the SRU <literal>searchRetrieve</literal> operation, which
60 is transformed into successive Z39.50 <literal>init</literal>,
61 <literal>search</literal> and <literal>present</literal> requests.
64 The SRU <literal>scan</literal> operation is not supported.
67 This filter does not handle CQL-to-PQF translations. In case that
68 the backends do not understand CQL, you need to append the
69 <literal>cql_pqf</literal> metaproxy filter.
72 This module supports the following SRU extra parameters:
78 Specifies backend Z39.50 target.
83 <term>x-max-sockets</term>
86 Specifies maximum number of sockets to use for a Z39.50 backend
87 client (for one given target host/db).
92 <term>x-session-id</term>
95 Allow a user-defined session ID to be attached to filter
96 log that follows sru_z3950. The ID is present in the
97 log files and not available to the SRU webservice. In order
98 to log material out via SRU, the x-log-enable may be used
104 <term>x-log-enable</term>
107 Controls whether log is to be collected for filters that
108 sru_z3950. Log data is extra response data's log element.
109 A value of 1 enables logging; other value disables
118 <refsect1><title>SCHEMA</title>
119 <literallayout><xi:include
120 xi:href="../xml/schema/filter_sru_z3950.rnc"
122 xmlns:xi="http://www.w3.org/2001/XInclude" />
126 <refsect1><title>EXAMPLES</title>
128 A typical configuration looks like this:
130 <filter type="sru_z3950">
131 <stylesheet>/my.xsl</stylesheet>
132 <database name="Default">
133 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
137 <database name="Dummy">
145 <refsect1><title>SEE ALSO</title>
148 <refentrytitle>metaproxy</refentrytitle>
149 <manvolnum>1</manvolnum>
157 <!-- Keep this comment at the end of the file