<listitem>
<para>
URL of Web service to be used to fetch target profile
- for a given database (udb). The special sequence
+ for a given database (udb) of type searchable. The special sequence
<literal>%db</literal> of the URL is replaced by the
actual database specified as part of Search.
</para>
+ <para>
+ The special sequence <literal>%realm</literal> is replaced by value
+ of attribute <literal>realm</literal> or by realm DATABASE argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>attribute <literal>content_url</literal></term>
+ <listitem>
+ <para>
+ URL of Web service to be used to fetch target profile
+ for a given database (udb) of type content. Semantics otherwise like
+ <literal>url</literal> attribute above.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
+ <term>attribute <literal>realm</literal></term>
+ <listitem>
+ <para>
+ The default realm value. Used for %realm in URL, unless
+ specified in DATABASE argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>attribute <literal>proxy</literal></term>
<listitem>
<para>
</para>
<variablelist>
<varlistentry>
- <term>authentication</term><listitem>
+ <term id="zoom-torus-authentication">authentication</term><listitem>
<para>
Authentication parameters to be sent to the target. For
Z39.50 targets, this will be sent as part of the
- Init Request.
+ Init Request. Authentication consists of two components: username
+ and password, separated by a slash.
</para>
<para>
If this value is omitted or empty no authentication information is sent.
</varlistentry>
<varlistentry>
- <term>cfProxy</term><listitem>
+ <term id="zoom-torus-cfproxy">cfProxy</term><listitem>
<para>
Specifies HTTP proxy for the target in the form
<replaceable>host</replaceable>:<replaceable>port</replaceable>.
</varlistentry>
<varlistentry>
- <term>cfSubDb</term><listitem>
+ <term>cfSubDB</term><listitem>
<para>
Specifies sub database for a Connector Framework based target.
</para>
</listitem>
</varlistentry>
- <varlistentry id="contentConnector">
+ <varlistentry id="zoom-torus-contentConnector">
<term>contentConnector</term><listitem>
<para>
Specifies a database for content-based proxy'ing.
</varlistentry>
<varlistentry>
+ <term>sruVersion</term><listitem>
+ <para>
+ Specifies the SRU version to use. It unset, version 1.2 will be
+ used. Some servers do not support this version, in which case
+ version 1.1 or even 1.0 could be set it.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>transform</term><listitem>
<para>
Specifies a XSL stylesheet filename to be used if record
The value of this field is a string that generates a dynamic link
based on record content. If the resulting string is non-zero in length
a new field, <literal>metadata</literal> with attribute
- <literal>type="generated-url"</literal>.
+ <literal>type="generated-url"</literal> is generated.
The contents of this field is the result of the URL recipe conversion.
The urlRecipe value may refer to an existing metadata element by
${field[pattern/result/flags]}, which will take content
of field and perform a regular expression conversion using the pattern
given. For example: <literal>${md-title[\s+/+/g]}</literal> takes
- metadadata element <literal>title</literal> and converts one or more
+ metadata element <literal>title</literal> and converts one or more
spaces to a plus character.
</para>
<para>
- If the <link linkend="contentConnector">contentConnector</link>
+ If the <link linkend="zoom-torus-contentConnector">contentConnector</link>
setting also defined, the resulting value is
- augmented with a session string as well as the content proxy server.
+ augmented with a session string as well as host name of the
+ content proxy server.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
+ <title>DATABASE parameters</title>
+ <para>
+ Extra information may be carried in the Z39.50 Database or SRU path,
+ such as authentication to be passed to backend etc. Some of
+ the parameters override TARGET profile values. The format is
+ </para>
+ <para>
+ udb,parm1=value1&parm2=value2&...
+ </para>
+ <para>
+ Where udb is the unique database recognised by the backend and parm1,
+ value1, .. are parameters to be passed. The following describes the
+ supported parameters. Like form values in HTTP the parameters and
+ values are URL encoded. The separator, though, between udb and parameters
+ is a comma rather than a question mark. What follows question mark are
+ HTTP arguments (in this case SRU arguments).
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>user</term>
+ <listitem>
+ <para>
+ Specifies user to be passed to backend. If this parameter is
+ omitted, the user will be taken from TARGET profile setting
+ <link linkend="zoom-torus-authentication">
+ <literal>authentication</literal>
+ </link>
+ .
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>password</term>
+ <listitem>
+ <para>
+ Specifies password to be passed to backend. If this parameters is
+ omitted, the password will be taken from TARGET profile setting
+ <link linkend="zoom-torus-authentication">
+ <literal>authentication</literal>
+ </link>
+ .
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>proxy</term>
+ <listitem>
+ <para>
+ Specifies one or more proxies for backend. If this parameter is
+ omitted, the proxy will be taken from TARGET profile setting
+ <link linkend="zoom-torus-cfproxy">
+ <literal>cfProxy</literal></link>.
+ The parameter is a list of comma-separated host:port entries.
+ Bost host and port must be given for each proxy.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cproxysession</term>
+ <listitem>
+ <para>
+ Session ID for content proxy. This parameter is, generally,
+ not used by anything but the content proxy itself.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nocproxy</term>
+ <listitem>
+ <para>
+ If this parameter is specified, content-proyxing is disabled
+ for the search.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>realm</term>
+ <listitem>
+ <para>
+ Session realm to be used for this target, changed the resulting
+ URL to be used for getting a target profile, by changing the
+ value that gets substituted for the %realm string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>x-parm</term>
+ <listitem>
+ <para>
+ All parameters that has prefix x, dash are passed verbatim
+ to the backend.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
<title>SCHEMA</title>
<literallayout><xi:include
xi:href="../xml/schema/filter_zoom.rnc"
projects / metaproxy-moved-to-github.git / blobdiff