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