%idcommon;
]>
<refentry id="ref-sru_z3950">
+ <refentryinfo>
+ <productname>Metaproxy</productname>
+ <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
<refmeta>
<refentrytitle>sru_z3950</refentrytitle>
<manvolnum>3mp</manvolnum>
- <refmiscinfo>Metaproxy Module</refmiscinfo>
+ <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sru_z3950</refname>
- <refpurpose>Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
+ <refpurpose>Metaproxy Module transforming SRU web service requests to
+ Z39.50 Metaproxy packages</refpurpose>
</refnamediv>
<refsect1><title>DESCRIPTION</title>
<para>
The <literal>sru_z3950</literal> Metaproxy filter transforms valid
- SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
+ SRU GET/POST/SOAP requests to Z39.50 requests, and wraps the
received hit counts and XML records into suitable SRU response messages.
</para>
<para>
</para>
<para>
It supports the SRU <literal>searchRetrieve</literal> operation, which
- is transformed into successive Z3950 <literal>init</literal>,
+ is transformed into successive Z39.50 <literal>init</literal>,
<literal>search</literal> and <literal>present</literal> requests.
</para>
<para>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>x-session-id</term>
+ <listitem>
+ <para>
+ Allow a user-defined session ID to be attached to filter
+ log that follows sru_z3950. The ID is present in the
+ log files and not available to the SRU webservice. In order
+ to log material out via SRU, the x-log-enable may be used
+ instead.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>x-log-enable</term>
+ <listitem>
+ <para>
+ Controls whether log is to be collected for filters that
+ sru_z3950. Log data is extra response data's log element.
+ A value of 1 enables logging; other value disables
+ logging (default).
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
+ <refsect1><title>SCHEMA</title>
+ <literallayout><xi:include
+ xi:href="../xml/schema/filter_sru_z3950.rnc"
+ xi:parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </literallayout>
+ </refsect1>
+
<refsect1><title>EXAMPLES</title>
<para>
A typical configuration looks like this:
<!-- Keep this comment at the end of the file
Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
End:
-->