- <variablelist>
- <varlistentry>
- <term>pz:cclmap:xxx</term>
- <listitem>
- <para>
- This establishes a CCL field definition or other setting, for
- the purpose of mapping end-user queries. XXX is the field or
- setting name, and the value of the setting provides parameters
- (e.g. parameters to send to the server, etc.). Please consult
- the YAZ manual for a full overview of the many capabilities of
- the powerful and flexible CCL parser.
- </para>
- <para>
- Note that it is easy to etablish a set of default parameters,
- and then override them individually for a given target.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:requestsyntax</term>
- <listitem>
- <para>
- This specifies the record syntax to use when requesting
- records from a given server. The value can be a symbolic name like
- marc21 or xml, or it can be a Z39.50-style dot-separated OID.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:elements</term>
- <listitem>
- <para>
- The element set name to be used when retrieving records from a
- server.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:piggyback</term>
- <listitem>
- <para>
- Piggybacking enables the server to retrieve records from the
- server as part of the search response in Z39.50. Almost all
- servers support this (or fail it gracefully), but a few
- servers will produce undesirable results.
- Set to '1' to enable piggybacking, '0' to disable it. Default
- is 1 (piggybacking enabled).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:nativesyntax</term>
- <listitem>
- <para>
- The representation (syntax) of the retrieval records. Currently
- recognized values are iso2709 and xml.
- </para>
- <para>
- For iso2709, can also specify a native character set, e.g. "iso2709;latin-1".
- If no character set is provided, MARC-8 is assumed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:xslt</term>
- <listitem>
- <para>
- Provides the path of an XSLT stylesheet which will be used to
- map incoming records to the internal representation.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:authentication</term>
- <listitem>
- <para>
- Sets an authentication string for a given server. See the section on
- authorization and authentication for discussion.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:allow</term>
- <listitem>
- <para>
- Allows or denies access to the resources it is applied to. Possible
- values are '0' and '1'. The default is '1' (allow access to this resource).
- See the manual section on authorization and authentication for discussion
- about how to use this setting.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:maxrecs</term>
- <listitem>
- <para>
- Controls the maximum number of records to be retrieved from a
- server. The default is 100.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pz:id</term>
- <listitem>
- <para>
- This setting can't be 'set' -- it contains the ID (normally
- ZURL) for a given target, and is useful for filtering --
- specifically when you want to select one or more specific
- targets in the search command.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
+ <varlistentry>
+ <term>pz:xslt</term>
+ <listitem>
+ <para>
+ Is a comma separated list of of files that specifies
+ how to convert incoming records to the internal representation.
+ </para>
+ <para>
+ The suffix of each file specifies the kind of tranformation.
+ Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
+ "<literal>.mmap</literal>" will use the MMAP transform (described below).
+ </para>
+ <para>
+ The special value "<literal>auto</literal>" will use a file
+ which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
+ value followed by
+ <literal>'.xsl'</literal>.
+ </para>
+ <para>
+ When mapping MARC records, XSLT can be bypassed for increased
+ performance with the alternate "MARC map" format. Provide the
+ path of a file with extension ".mmap" containing on each line:
+ <programlisting>
+ <field> <subfield> <metadata element></programlisting>
+ For example:
+ <programlisting>
+ 245 a title
+ 500 $ description
+ 773 * citation</programlisting>
+ To map the field value specify a subfield of '$'. To store a
+ concatenation of all subfields, specify a subfield of '*'.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:authentication</term>
+ <listitem>
+ <para>
+ Sets an authentication string for a given server. See the section on
+ authorization and authentication for discussion.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:allow</term>
+ <listitem>
+ <para>
+ Allows or denies access to the resources it is applied to. Possible
+ values are '0' and '1'. The default is '1' (allow access to this resource).
+ See the manual section on authorization and authentication for discussion
+ about how to use this setting.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:maxrecs</term>
+ <listitem>
+ <para>
+ Controls the maximum number of records to be retrieved from a
+ server. The default is 100.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:id</term>
+ <listitem>
+ <para>
+ This setting can't be 'set' -- it contains the ID (normally
+ ZURL) for a given target, and is useful for filtering --
+ specifically when you want to select one or more specific
+ targets in the search command.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:zproxy</term>
+ <listitem>
+ <para>
+ The 'pz:zproxy' setting has the value syntax
+ 'host.internet.adress:port', it is used to tunnel Z39.50
+ requests through the named Z39.50 proxy.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:apdulog</term>
+ <listitem>
+ <para>
+ If the 'pz:apdulog' setting is defined and has other value than 0,
+ then Z39.50 APDUs are written to the log.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:sru</term>
+ <listitem>
+ <para>
+ This setting enables
+ <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">SOLR</ulink>
+ support.
+ It has four possible settings.
+ 'get', enables SRU access through GET requests. 'post' enables SRU/POST
+ support, less commonly supported, but useful if very large requests are
+ to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
+ the protocol.
+ </para>
+ <para>
+ A value of 'solr' anables SOLR client support. This is supported
+ for Pazpar version 1.5.0 and later.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:sru_version</term>
+ <listitem>
+ <para>
+ This allows SRU version to be specified. If unset Pazpar2
+ will the default of YAZ (currently 1.2). Should be set
+ to 1.1 or 1.2. For SOLR, the current supported/tested version is 1.4
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:pqf_prefix</term>
+ <listitem>
+ <para>
+ Allows you to specify an arbitrary PQF query language substring.
+ The provided string is prefixed the user's query after it has been
+ normalized to PQF internally in pazpar2.
+ This allows you to attach complex 'filters' to queries for a given
+ target, sometimes necessary to select sub-catalogs
+ in union catalog systems, etc.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:pqf_strftime</term>
+ <listitem>
+ <para>
+ Allows you to extend a query with dates and operators.
+ The provided string allows certain substitutions and serves as a
+ format string.
+ The special two character sequence '%%' gets converted to the
+ original query. Other characters leading with the percent sign are
+ conversions supported by strftime.
+ All other characters are copied verbatim. For example, the string
+ <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
+ would search for current year combined with the original PQF (%%).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:sort</term>
+ <listitem>
+ <para>
+ Specifies sort criteria to be applied to the result set.
+ Only works for targets which support the sort service.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:recordfilter</term>
+ <listitem>
+ <para>
+ Specifies a filter which allows Pazpar2 to only include
+ records that meet a certain criteria in a result. Unmatched records
+ will be ignored. The filter takes the form name, name~value, or name=value, which
+ will include only records with metadata element (name) that has the
+ substring (~value) given, or matches exactly (=value). If value is omitted all records
+ with the named
+ metadata element present will be included.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:termlist_term_count</term>
+ <listitem>
+ <para>
+ Specifies that the target should return up to n terms for each facets (where termlist="yes"). This implies
+ that the target can return facets on the search command. Requesting facets on targets that doesn't,
+ will return unpredictable or error result.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:termlist_term_sort</term>
+ <listitem>
+ <para>
+ Specifies how the terms should be sorted. (Not yet implemented)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:preferred</term>
+ <listitem>
+ <para>
+ Specifies that a target is preferred, e.g. possible local, faster target. Using block=pref on show command
+ will wait for all these targets to return records before releasing the block. If no target is preferred,
+ the block=pref will identical to block=1, which release when one target has returned records.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:block_timeout</term>
+ <listitem>
+ <para>
+ (Not yet implemented). Specifies the time for which a block should be released anyway.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>