doc/pazpar2_conf.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   3  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   4 [
   5      <!ENTITY % local SYSTEM "local.ent">
   6      %local;
   7      <!ENTITY % entities SYSTEM "entities.ent">
   8      %entities;
   9      <!ENTITY % idcommon SYSTEM "common/common.ent">
  10      %idcommon;
  11 ]>
  12 <!-- $Id: pazpar2_conf.xml,v 1.30 2007-08-01 11:48:26 quinn Exp $ -->
  13 <refentry id="pazpar2_conf">
  14  <refentryinfo>
  15   <productname>Pazpar2</productname>
  16   <productnumber>&version;</productnumber>
  17  </refentryinfo>
  18  <refmeta>
  19   <refentrytitle>Pazpar2 conf</refentrytitle>
  20   <manvolnum>5</manvolnum>
  21  </refmeta>
  22
  23  <refnamediv>
  24   <refname>pazpar2_conf</refname>
  25   <refpurpose>Pazpar2 Configuration</refpurpose>
  26  </refnamediv>
  27
  28  <refsynopsisdiv>
  29   <cmdsynopsis>
  30    <command>pazpar2.conf</command>
  31   </cmdsynopsis>
  32  </refsynopsisdiv>
  33
  34  <refsect1><title>DESCRIPTION</title>
  35   <para>
  36    The Pazpar2 configuration file, together with any referenced XSLT files,
  37    govern Pazpar2's behavior as a client, and control the normalization and
  38    extraction of data elements from incoming result records, for the
  39    purposes of merging, sorting, facet analysis, and display.
  40   </para>
  41
  42   <para>
  43    The file is specified using the option -f on the Pazpar2 command line.
  44    There is not presently a way to reload the configuration file without
  45    restarting Pazpar2, although this will most likely be added some time
  46    in the future.
  47   </para>
  48  </refsect1>
  49
  50  <refsect1><title>FORMAT</title>
  51   <para>
  52    The configuration file is XML-structured. It must be valid XML. All
  53    elements specific to Pazpar2 should belong to the namespace
  54    <literal>http://www.indexdata.com/pazpar2/1.0</literal>
  55    (this is assumed in the
  56    following examples). The root element is named <literal>pazpar2</literal>.
  57    Under the  root element are a number of elements which group categories of
  58    information. The categories are described below.
  59   </para>
  60
  61   <refsect2 id="config-server"><title>server</title>
  62    <para>
  63     This section governs overall behavior of the client. The data
  64     elements are described below.
  65    </para>
  66    <variablelist> <!-- level 1 -->
  67     <varlistentry>
  68      <term>listen</term>
  69      <listitem>
  70       <para>
  71        Configures the webservice -- this controls how you can connect
  72        to Pazpar2 from your browser or server-side code. The
  73        attributes 'host' and 'port' control the binding of the
  74        server. The 'host' attribute can be used to bind the server to
  75        a secondary IP address of your system, enabling you to run
  76        Pazpar2 on port 80 alongside a conventional web server. You
  77        can override this setting on the command line using the option -h.
  78       </para>
  79      </listitem>
  80     </varlistentry>
  81
  82     <varlistentry>
  83      <term>proxy</term>
  84      <listitem>
  85       <para>
  86        If this item is given, Pazpar2 will forward all incoming HTTP
  87        requests that do not contain the filename 'search.pz2' to the
  88        host and port specified using the 'host' and 'port'
  89        attributes. The 'myurl' attribute is required, and should provide
  90        the base URL of the server. Generally, the HTTP URL for the host
  91        specified in the 'listen' parameter. This functionality is
  92        crucial if you wish to use
  93        Pazpar2 in conjunction with browser-based code (JS, Flash,
  94        applets, etc.) which operates in a security sandbox. Such code
  95        can only connect to the same server from which the enclosing
  96        HTML page originated. Pazpar2s proxy functionality enables you
  97        to host all of the main pages (plus images, CSS, etc) of your
  98        application on a conventional webserver, while efficiently
  99        processing webservice requests for metasearch status, results,
 100        etc.
 101       </para>
 102      </listitem>
 103     </varlistentry>
 104
 105     <varlistentry>
 106      <term>icu_chain</term>
 107      <listitem>
 108       <para>
 109        Definition of ICU tokenization and normalization rules
 110        are used if ICU support is compiled in.  The 'id'
 111        attribute is currently not used, and the 'locale'
 112        attribute must be set to one of the locale strings
 113        defined in ICU. The child elements listed below can be
 114        in any order, except the 'index' element which logically
 115        belongs to the end of the list. The stated tokenization,
 116        normalization and charmapping instructions are performed
 117        in order from top to bottom.
 118       </para>
 119       <variablelist> <!-- Level 2 -->
 120        <varlistentry><term>casemap</term>
 121         <listitem>
 122          <para>
 123           The attribute 'rule' defines the direction of the
 124           per-character casemapping, allowed values are "l"
 125           (lower), "u" (upper), "t" (title).
 126          </para>
 127         </listitem>
 128        </varlistentry>
 129        <varlistentry><term>normalize</term>
 130         <listitem>
 131          <para>
 132           Normalization and transformation of tokens follows
 133           the rules defined in the 'rule' attribute. For
 134           possible values we refer to the extensive ICU
 135           documentation found at the
 136           <ulink url="&url.icu.transform;">ICU
 137            transformation</ulink> home page. Set filtering
 138           principles are explained at the
 139           <ulink url="&url.icu.unicode.set;">ICU set and
 140            filtering</ulink> page.
 141          </para>
 142         </listitem>
 143        </varlistentry>
 144        <varlistentry><term>tokenize</term>
 145         <listitem>
 146          <para>
 147           Tokenization is the only rule in the ICU chain
 148           which splits one token into multiple tokens. The
 149           'rule' attribute may have the following values:
 150           "s" (sentence), "l" (line-break), "w" (word), and
 151           "c" (character), the later probably not being
 152           very useful in a pruning Pazpar2 installation.
 153          </para>
 154         </listitem>
 155        </varlistentry>
 156        <varlistentry><term>index</term>
 157         <listitem>
 158          <para>
 159           Finally the 'index' element instruction - without
 160           any 'rule' attribute - is used to store the tokens
 161           after chain processing in the relevance ranking
 162           unit of Pazpar2. It will always be the last
 163           instruction in the chain.
 164          </para>
 165         </listitem>
 166        </varlistentry>
 167       </variablelist>
 168      </listitem>
 169     </varlistentry>
 170
 171     <varlistentry>
 172      <term>service</term>
 173      <listitem>
 174       <para>
 175        This nested element controls the behavior of Pazpar2 with
 176        respect to your data model. In Pazpar2, incoming records are
 177        normalized, using XSLT, into an internal representation.
 178        The 'service' section controls the further processing and
 179        extraction of data from the internal representation, primarily
 180        through the 'metadata' sub-element.
 181       </para>
 182
 183       <variablelist> <!-- Level 2 -->
 184        <varlistentry><term>metadata</term>
 185         <listitem>
 186          <para>
 187           One of these elements is required for every data element in
 188           the internal representation of the record (see
 189           <xref linkend="data_model"/>. It governs
 190           subsequent processing as pertains to sorting, relevance
 191           ranking, merging, and display of data elements. It supports
 192           the following attributes:
 193          </para>
 194
 195          <variablelist> <!-- level 3 -->
 196           <varlistentry><term>name</term>
 197            <listitem>
 198             <para>
 199              This is the name of the data element. It is matched
 200              against the 'type' attribute of the
 201              'metadata' element
 202              in the normalized record. A warning is produced if
 203              metadata elements with an unknown name are
 204              found in the
 205              normalized record. This name is also used to
 206              represent
 207              data elements in the records returned by the
 208              webservice API, and to name sort lists and browse
 209              facets.
 210             </para>
 211            </listitem>
 212           </varlistentry>
 213
 214           <varlistentry><term>type</term>
 215            <listitem>
 216             <para>
 217              The type of data element. This value governs any
 218              normalization or special processing that might take
 219              place on an element. Possible values are 'generic'
 220              (basic string), 'year' (a range is computed if
 221              multiple years are found in the record). Note: This
 222              list is likely to increase in the future.
 223             </para>
 224            </listitem>
 225           </varlistentry>
 226
 227           <varlistentry><term>brief</term>
 228            <listitem>
 229             <para>
 230              If this is set to 'yes', then the data element is
 231              includes in brief records in the webservice API. Note
 232              that this only makes sense for metadata elements that
 233              are merged (see below). The default value is 'no'.
 234             </para>
 235            </listitem>
 236           </varlistentry>
 237
 238           <varlistentry><term>sortkey</term>
 239            <listitem>
 240             <para>
 241              Specifies that this data element is to be used for
 242              sorting. The possible values are 'numeric' (numeric
 243              value), 'skiparticle' (string; skip common, leading
 244              articles), and 'no' (no sorting). The default value is
 245              'no'.
 246             </para>
 247            </listitem>
 248           </varlistentry>
 249
 250           <varlistentry><term>rank</term>
 251            <listitem>
 252             <para>
 253              Specifies that this element is to be used to
 254              help rank
 255              records against the user's query (when ranking is
 256              requested). The value is an integer, used as a
 257              multiplier against the basic TF*IDF score. A value of
 258              1 is the base, higher values give additional
 259              weight to
 260              elements of this type. The default is '0', which
 261              excludes this element from the rank calculation.
 262             </para>
 263            </listitem>
 264           </varlistentry>
 265
 266           <varlistentry><term>termlist</term>
 267            <listitem>
 268             <para>
 269              Specifies that this element is to be used as a
 270              termlist, or browse facet. Values are tabulated from
 271              incoming records, and a highscore of values (with
 272              their associated frequency) is made available to the
 273              client through the webservice API.
 274              The possible values
 275              are 'yes' and 'no' (default).
 276             </para>
 277            </listitem>
 278           </varlistentry>
 279
 280           <varlistentry><term>merge</term>
 281            <listitem>
 282             <para>
 283              This governs whether, and how elements are extracted
 284              from individual records and merged into cluster
 285              records. The possible values are: 'unique' (include
 286              all unique elements), 'longest' (include only the
 287              longest element (strlen), 'range' (calculate a range
 288              of values across all matching records), 'all' (include
 289              all elements), or 'no' (don't merge; this is the
 290                           default);
 291             </para>
 292            </listitem>
 293           </varlistentry>
 294
 295           <varlistentry><term>setting</term>
 296            <listitem>
 297             <para>
 298               This attribute allows you to make use of static database
 299               settings in the processing of records. Three possible values
 300               are allowed. 'no' is the default and doesn't do anything.
 301               'postproc' copies the value of a setting with the same name
 302               into the output of the normalization stylesheet(s). 'parameter'
 303               makes the value of a setting with the same name available
 304               as a parameter to the normalization stylesheet, so you
 305               can further process the value inside of the stylesheet, or use
 306               the value to decide how to deal with other data values.
 307             </para>
 308             <para>
 309             </para>
 310               The purpose of using settings in this way can either be to
 311               control the behavior of normalization stylesheet in a database-
 312               dependent way, or to easily make database-dependent values
 313               available to display-logic in your user interface, without having
 314               to implement complicated interactions between the user interface
 315               and your configuration system.
 316            </listitem>
 317           </varlistentry>
 318          </variablelist> <!-- attributes to metadata -->
 319
 320         </listitem>
 321        </varlistentry>
 322       </variablelist>     <!-- Data elements in service directive -->
 323      </listitem>
 324     </varlistentry>
 325    </variablelist>           <!-- Data elements in server directive -->
 326   </refsect2>
 327
 328  </refsect1>
 329
 330  <refsect1><title>EXAMPLE</title>
 331   <para>Below is a working example configuration:
 332   <screen><![CDATA[
 333 <?xml version="1.0" encoding="UTF-8"?>
 334 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
 335
 336 <server>
 337   <listen port="9004"/>
 338   <proxy host="us1.indexdata.com" myurl="us1.indexdata.com"/>
 339
 340   <!-- optional ICU ranking configuration example -->
 341   <!--
 342   <icu_chain id="el:word" locale="el">
 343     <normalize rule="[:Control:] Any-Remove"/>
 344     <tokenize rule="l"/>
 345     <normalize rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
 346     <casemap rule="l"/>
 347     <index/>
 348   </icu_chain>
 349   -->
 350
 351   <service>
 352     <metadata name="title" brief="yes" sortkey="skiparticle" merge="longest" rank="6"/>
 353     <metadata name="isbn" merge="unique"/>
 354     <metadata name="date" brief="yes" sortkey="numeric" type="year" merge="range"
 355             termlist="yes"/>
 356     <metadata name="author" brief="yes" termlist="yes" merge="longest" rank="2"/>
 357     <metadata name="subject" merge="unique" termlist="yes" rank="3"/>
 358     <metadata name="url" merge="unique"/>
 359   </service>
 360 </server>
 361
 362 </pazpar2>
 363 ]]></screen>
 364   </para>
 365  </refsect1>
 366
 367  <refsect1 id="target_settings"><title>TARGET SETTINGS</title>
 368   <para>
 369    Pazpar2 features a cunning scheme by which you can associate various
 370    kinds of attributes, or settings with search targets. This can be done
 371    through XML files which are read at startup; each file can associate
 372    one or more settings with one or more targets. The file format is generic
 373    in nature, designed to support a wide range of application requirements. The
 374    settings can be purely technical things, like, how to perform a title
 375    search against a given target, or it can associate arbitrary name=value
 376    pairs with groups of targets -- for instance, if you would like to
 377    place all commercial full-text bases in one group for selection
 378    purposes, or you would like to control what targets are accessible
 379    to users by default. Per-database settings values can even be used
 380    to drive sorting, facet/termlist generation, or end-user interface display
 381    logic.
 382   </para>
 383
 384   <para>
 385    During startup, Pazpar2 will recursively read a specified directory
 386    (can be identified in the pazpar2.cfg file or on the command line), and
 387    process any settings files found therein.
 388   </para>
 389
 390   <para>
 391    Clients of the Pazpar2 webservice interface can selectively override
 392    settings for individual targets within the scope of one session. This
 393    can be used in conjunction with an external authentication system to
 394    determine which resources are to be accessible to which users. Pazpar2
 395    itself has no notion of end-users, and so can be used in conjunction
 396    with any type of authentication system. Similarly, the authentication
 397    tokens submitted to access-controlled search targets can similarly be
 398    overridden, to allow use of Pazpar2 in a consortial or multi-library
 399    environment, where different end-users may need to be represented to
 400    some search targets in different ways. This, again, can be managed
 401    using an external database or other lookup mechanism. Setting overrides
 402    can be performed either using the 'init' or the 'settings' webservice
 403    command.
 404   </para>
 405
 406   <para>
 407    In fact, every setting that applies to a database (except pz:id, which
 408    can only be used for filtering targets to use for a search) can be overridden
 409    on a per-session basis. This allows the client to override specific CCL fields
 410    for searching, etc., to meet the needs of a session or user.
 411   </para>
 412
 413   <para>
 414    Finally, as an extreme case of this, the webservice client can
 415    introduce entirely new targets, on the fly, as part of the init or
 416    settings command. This is useful if you desire to manage information
 417    about your search targets in a separate application such as a database.
 418    You do not need any static settings file whatsoever to run Pazpar2 -- as
 419    long as the webservice client is prepared to supply the necessary
 420    information at the beginning of every session.
 421   </para>
 422
 423   <note>
 424    <para>
 425     The following discussion of practical issues related to session and settings
 426     management are cast in terms of a user interface based on Ajax/Javascript
 427     technology. It would apply equally well to many other kinds of browser-based logic.
 428    </para>
 429   </note>
 430
 431   <para>
 432    Typically, a Javascript client is not allowed to  directly alter the parameters
 433    of a session. There are two reasons for this. One has to do with access
 434    to information; typically, information about a user will be stored in a
 435    system on the server side, or it will be accessible in some way from the server.
 436    However, since the Javascript client cannot be entirely trusted (some hostile
 437    agent might in fact 'pretend' to be a regular ws client), it is more robust
 438    to control session settings from scripting that you run as part of your
 439    webserver. Typically, this can be handled during the session initialization,
 440    as follows:
 441   </para>
 442
 443   <para>
 444    Step 1: The Javascript client loads, and asks the webserver for a new Pazpar2
 445    session ID. This can be done using a Javascript call, for instance. Note that
 446    it is possible to submit Ajax HTTPXmlRequest calls either to Pazpar2 or to the
 447    webserver that Pazpar2 is proxying for. See (XXX Insert link to Pazpar2 protocol).
 448     </para>
 449
 450   <para>
 451    Step 2: Code on the webserver authenticates the user, by database lookup,
 452    LDAP access, NCIP, etc. Determines which resources the user has access to,
 453    and any user-specific parameters that are to be applied during this session.
 454   </para>
 455
 456   <para>
 457    Step 3: The webserver initializes a new Pazpar2 settings, and sets user-specific
 458    parameters as necessary, using the init webservice command. A new session ID is
 459    returned.
 460   </para>
 461
 462   <para>
 463    Step 4: The webserver returns this session ID to the Javascript client, which then
 464    uses the session ID to submit searches, show results, etc.
 465   </para>
 466
 467   <para>
 468    Step 5: When the Javascript client ceases to use the session, Pazpar2 destroys
 469    any session-specific information.
 470   </para>
 471
 472   <refsect2><title>SETTINGS FILE FORMAT</title>
 473    <para>
 474     Each file contains a root element named &lt;settings&gt;. It may
 475     contain one or more &lt;set&gt; elements. The settings and set
 476     elements may contain the following attributes. Attributes in the set node
 477     overrides those in the setting root element. Each set node must
 478     specify (directly, or inherited from the parent node) at least a
 479     target, name, and value.
 480    </para>
 481
 482    <variablelist>
 483     <varlistentry>
 484      <term>target</term>
 485      <listitem>
 486       <para>
 487        This specifies the search target to which this setting should be
 488        applied. Targets are identified by their Z39.50 URL, generally
 489        including the host, port, and database name, (e.g.
 490        <literal>bagel.indexdata.com:210/marc</literal>).
 491        Two wildcard forms are accepted:
 492        * (asterisk) matches all known targets;
 493        <literal>bagel.indexdata.com:210/*</literal> matches all
 494        known databases on the given host.
 495       </para>
 496       <para>
 497        A precedence system determines what happens if there are
 498        overlapping values for the same setting name for the same
 499        target. A setting for a specific target name overrides a
 500        setting which specifies target using a wildcard. This makes it
 501        easy to set defaults for all targets, and then override them
 502        for specific targets or hosts. If there are
 503        multiple overlapping settings with the same name and target
 504        value, the 'precedence' attribute determines what happens.
 505       </para>
 506      </listitem>
 507     </varlistentry>
 508     <varlistentry>
 509      <term>name</term>
 510      <listitem>
 511       <para>
 512        The name of the setting. This can be anything you like.
 513        However, Pazpar2 reserves a number of setting names for
 514        specific purposes, all starting with 'pz:', and it is a good
 515        idea to avoid that prefix if you make up your own setting
 516        names. See below for a list of reserved variables.
 517       </para>
 518      </listitem>
 519     </varlistentry>
 520     <varlistentry>
 521      <term>value</term>
 522      <listitem>
 523       <para>
 524        The value of the setting. Generally, this can be anything you
 525        want -- however, some of the reserved settings may expect
 526        specific kinds of values.
 527       </para>
 528      </listitem>
 529     </varlistentry>
 530     <varlistentry>
 531      <term>precedence</term>
 532      <listitem>
 533       <para>
 534        This should be an integer. If not provided, the default value
 535        is 0. If two (or more) settings have the same content for
 536        target and name, the precedence value determines the outcome.
 537        If both settings have the same precedence value, they are both
 538        applied to the target(s). If one has a higher value, then the
 539        value of that setting is applied, and the other one is ignored.
 540       </para>
 541      </listitem>
 542     </varlistentry>
 543    </variablelist>
 544
 545    <para>
 546     By setting defaults for target, name, or value in the root
 547     settings node, you can use the settings files in many different
 548     ways. For instance, you can use a single file to set defaults for
 549     many different settings, like search fields, retrieval syntaxes,
 550     etc. You can have one file per server, which groups settings for
 551     that server or target. You could also have one file which associates
 552     a number of targets with a given setting, for instance, to associate
 553     many databases with a given category or class that makes sense
 554     within your application.
 555    </para>
 556
 557    <para>
 558     The following examples illustrate uses of the settings system to
 559     associate settings with targets to meet different requirements.
 560    </para>
 561
 562    <para>
 563     The example below associates a set of default values that can be
 564     used across many targets. Note the wildcard for targets.
 565     This associates the given settings with all targets for which no
 566     other information is provided.
 567     <screen><![CDATA[
 568 <settings target="*">
 569
 570   <!-- This file introduces default settings for pazpar2 -->
 571   <!-- $Id: pazpar2_conf.xml,v 1.30 2007-08-01 11:48:26 quinn Exp $ -->
 572
 573   <!-- mapping for unqualified search -->
 574   <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
 575
 576   <!-- field-specific mappings -->
 577   <set name="pz:cclmap:ti" value="u=4 s=al"/>
 578   <set name="pz:cclmap:su" value="u=21 s=al"/>
 579   <set name="pz:cclmap:isbn" value="u=7"/>
 580   <set name="pz:cclmap:issn" value="u=8"/>
 581   <set name="pz:cclmap:date" value="u=30 r=r"/>
 582
 583   <!-- Retrieval settings -->
 584
 585   <set name="pz:requestsyntax" value="marc21"/>
 586   <!-- <set name="pz:elements" value="F"/> NOT YET IMPLEMENTED -->
 587
 588   <!-- Result normalization settings -->
 589
 590   <set name="pz:nativesyntax" value="iso2709"/>
 591   <set name="pz:xslt" value="../etc/marc21.xsl"/>
 592
 593 </settings>
 594
 595         ]]></screen>
 596    </para>
 597
 598    <para>
 599     The next example shows certain settings overridden for one target,
 600     one which returns XML records containing DublinCore elements, and
 601     which furthermore requires a username/password.
 602     <screen><![CDATA[
 603 <settings target="funkytarget.com:210/db1">
 604   <set name="pz:requestsyntax" value="xml"/>
 605   <set name="pz:nativesyntax" value="xml"/>
 606   <set name="pz:xslt" value="../etc/dublincore.xsl"/>
 607
 608   <set name="pz:authentication" value="myuser/password"/>
 609 </settings>
 610         ]]></screen>
 611    </para>
 612
 613    <para>
 614     The following example associates a specific name/value combination
 615     with a number of targets. The targets below are access-restricted,
 616     and can only be used by users with special credentials.
 617     <screen><![CDATA[
 618 <settings name="pz:allow" value="0">
 619   <set target="funkytarget.com:210/*"/>
 620   <set target="commercial.com:2100/expensiveDb"/>
 621 </settings>
 622         ]]></screen>
 623    </para>
 624
 625   </refsect2>
 626
 627   <refsect2><title>RESERVED SETTING NAMES</title>
 628    <para>
 629     The following setting names are reserved by Pazpar2 to control the
 630     behavior of the client function.
 631    </para>
 632
 633    <variablelist>
 634     <varlistentry>
 635      <term>pz:cclmap:xxx</term>
 636      <listitem>
 637       <para>
 638        This establishes a CCL field definition or other setting, for
 639        the purpose of mapping end-user queries. XXX is the field or
 640        setting name, and the value of the setting provides parameters
 641        (e.g. parameters to send to the server, etc.). Please consult
 642        the YAZ manual for a full overview of the many capabilities of
 643        the powerful and flexible CCL parser.
 644       </para>
 645       <para>
 646        Note that it is easy to establish a set of default parameters,
 647        and then override them individually for a given target.
 648       </para>
 649      </listitem>
 650     </varlistentry>
 651     <varlistentry>
 652      <term>pz:requestsyntax</term>
 653      <listitem>
 654       <para>
 655        This specifies the record syntax to use when requesting
 656        records from a given server. The value can be a symbolic name like
 657        marc21 or xml, or it can be a Z39.50-style dot-separated OID.
 658       </para>
 659      </listitem>
 660     </varlistentry>
 661     <varlistentry>
 662      <term>pz:elements</term>
 663      <listitem>
 664       <para>
 665        The element set name to be used when retrieving records from a
 666        server (not yet implemented).
 667       </para>
 668      </listitem>
 669     </varlistentry>
 670     <varlistentry>
 671      <term>pz:piggyback</term>
 672      <listitem>
 673       <para>
 674        Piggybacking enables the server to retrieve records from the
 675        server as part of the search response in Z39.50. Almost all
 676        servers support this (or fail it gracefully), but a few
 677        servers will produce undesirable results.
 678        Set to '1' to enable piggybacking, '0' to disable it. Default
 679        is 1 (piggybacking enabled).
 680       </para>
 681      </listitem>
 682     </varlistentry>
 683     <varlistentry>
 684      <term>pz:nativesyntax</term>
 685      <listitem>
 686       <para>
 687        The representation (syntax) of the retrieval records. Currently
 688        recognized values are iso2709 and xml.
 689       </para>
 690       <para>
 691        For iso2709, can also specify a native character set, e.g. "iso2709;latin-1".
 692        If no character set is provided, MARC-8 is assumed.
 693       </para>
 694      </listitem>
 695     </varlistentry>
 696     <varlistentry>
 697      <term>pz:xslt</term>
 698      <listitem>
 699       <para>
 700        Provides the path of an XSLT stylesheet which will be used to
 701        map incoming records to the internal representation.
 702       </para>
 703      </listitem>
 704     </varlistentry>
 705     <varlistentry>
 706      <term>pz:authentication</term>
 707      <listitem>
 708       <para>
 709        Sets an authentication string for a given server. See the section on
 710        authorization and authentication for discussion.
 711       </para>
 712      </listitem>
 713     </varlistentry>
 714     <varlistentry>
 715      <term>pz:allow</term>
 716      <listitem>
 717       <para>
 718        Allows or denies access to the resources it is applied to. Possible
 719        values are '0' and '1'. The default is '1' (allow access to this resource).
 720        See the manual section on authorization and authentication for discussion
 721        about how to use this setting.
 722       </para>
 723      </listitem>
 724     </varlistentry>
 725     <varlistentry>
 726      <term>pz:maxrecs</term>
 727      <listitem>
 728       <para>
 729        Controls the maximum number of records to be retrieved from a
 730        server. The default is 100 (not yet implemented).
 731       </para>
 732      </listitem>
 733     </varlistentry>
 734     <varlistentry>
 735      <term>pz:id</term>
 736      <listitem>
 737       <para>
 738        This setting can't be 'set' -- it contains the ID (normally
 739        ZURL) for a given target, and is useful for filtering --
 740        specifically when you want to select one or more specific
 741        targets in the search command.
 742       </para>
 743      </listitem>
 744     </varlistentry>
 745     <varlistentry>
 746      <term>pz:zproxy</term>
 747      <listitem>
 748       <para>
 749        The 'pz:zproxy' setting has the value syntax
 750        'host.internet.adress:port', it is used to tunnel Z39.50
 751        requests through the named Z39.50 proxy.
 752       </para>
 753      </listitem>
 754     </varlistentry>
 755
 756     <varlistentry>
 757      <term>pz:apdulog</term>
 758      <listitem>
 759       <para>
 760        If the 'pz:apdulog' setting is defined and has other value than 0,
 761        then Z39.50 APDUs are written to the log.
 762       </para>
 763      </listitem>
 764     </varlistentry>
 765    </variablelist>
 766   </refsect2>
 767
 768  </refsect1>
 769  <refsect1><title>SEE ALSO</title>
 770   <para>
 771    Pazpar2:
 772    <citerefentry>
 773     <refentrytitle>pazpar2</refentrytitle>
 774     <manvolnum>8</manvolnum>
 775    </citerefentry>
 776   </para>
 777   <para>
 778    Pazpar2 protocol:
 779    <citerefentry>
 780     <refentrytitle>pazpar2_protocol</refentrytitle>
 781     <manvolnum>7</manvolnum>
 782    </citerefentry>
 783   </para>
 784  </refsect1>
 785 </refentry>
 786 <!-- Keep this comment at the end of the file
 787 Local variables:
 788 mode: sgml
 789 sgml-omittag:t
 790 sgml-shorttag:t
 791 sgml-minimize-attributes:nil
 792 sgml-always-quote-attributes:t
 793 sgml-indent-step:1
 794 sgml-indent-data:t
 795 sgml-parent-document:nil
 796 sgml-local-catalogs: nil
 797 sgml-namecase-general:t
 798 End:
 799 -->