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"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY % entities SYSTEM "entities.ent">
9 <!ENTITY % idcommon SYSTEM "common/common.ent">
12 <refentry id="pazpar2_conf">
14 <productname>Pazpar2</productname>
15 <productnumber>&version;</productnumber>
18 <refentrytitle>Pazpar2 conf</refentrytitle>
19 <manvolnum>5</manvolnum>
23 <refname>pazpar2_conf</refname>
24 <refpurpose>Pazpar2 Configuration</refpurpose>
29 <command>pazpar2.conf</command>
33 <refsect1><title>DESCRIPTION</title>
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.
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
49 <refsect1><title>FORMAT</title>
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.
60 <refsect2 id="config-server"><title>server</title>
62 This section governs overall behavior of the server. The data
63 elements are described below. From Pazpar2 version 1.2 this is
66 <variablelist> <!-- level 1 -->
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.
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,
106 <term>relevance / sort / mergekey</term>
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.
118 <term>settings</term>
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
127 <xref linkend="target_settings"/> for more information.
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.
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.
153 <variablelist> <!-- Level 2 -->
154 <varlistentry><term>metadata</term>
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:
165 <variablelist> <!-- level 3 -->
166 <varlistentry><term>name</term>
169 This is the name of the data element. It is matched
170 against the 'type' attribute of the
172 in the normalized record. A warning is produced if
173 metadata elements with an unknown name are
175 normalized record. This name is also used to
177 data elements in the records returned by the
178 webservice API, and to name sort lists and browse
184 <varlistentry><term>type</term>
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.
197 <varlistentry><term>brief</term>
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'.
208 <varlistentry><term>sortkey</term>
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
220 <varlistentry><term>rank</term>
223 Specifies that this element is to be used to
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
230 elements of this type. The default is '0', which
231 excludes this element from the rank calculation.
236 <varlistentry><term>termlist</term>
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.
245 are 'yes' and 'no' (default).
250 <varlistentry><term>merge</term>
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
265 <varlistentry><term>mergekey</term>
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.
275 <varlistentry><term>setting</term>
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.
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.
299 </variablelist> <!-- attributes to metadata -->
305 <term>relevance</term>
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.
318 <variablelist> <!-- Level 2 -->
319 <varlistentry><term>casemap</term>
322 The attribute 'rule' defines the direction of the
323 per-character casemapping, allowed values are "l"
324 (lower), "u" (upper), "t" (title).
328 <varlistentry><term>transform</term>
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.
343 <varlistentry><term>tokenize</term>
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.
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.
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>.
376 <term>mergekey</term>
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>.
387 <term>settings</term>
390 Specifies target settings for this service. Refer to
391 <xref linkend="target_settings"/>.
396 </variablelist> <!-- Data elements in service directive -->
400 </variablelist> <!-- Data elements in server directive -->
405 <refsect1><title>EXAMPLE</title>
406 <para>Below is a working example configuration:
408 <?xml version="1.0" encoding="UTF-8"?>
409 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
412 <listen port="9004"/>
414 <metadata name="title" brief="yes" sortkey="skiparticle"
415 merge="longest" rank="6"/>
416 <metadata name="isbn" merge="unique"/>
417 <metadata name="date" brief="yes" sortkey="numeric"
418 type="year" merge="range" termlist="yes"/>
419 <metadata name="author" brief="yes" termlist="yes"
420 merge="longest" rank="2"/>
421 <metadata name="subject" merge="unique" termlist="yes" rank="3"/>
422 <metadata name="url" merge="unique"/>
424 <icu_chain id="relevance" locale="el">
425 <transform rule="[:Control:] Any-Remove"/>
427 <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
431 <settings src="mysettings"/>
439 <refsect1 id="config-include"><title>INCLUDE FACILITY</title>
441 The XML configuration may be partitioned into multiple files by using
442 the <literal>include</literal> element which takes a single attribute,
443 <literal>src</literal>. The of the <literal>src</literal> attribute is
444 regular Shell like glob-pattern. For example,
446 <include src="/etc/pazpar2/conf.d/*.xml"/>
450 The include facility requires Pazpar2 version 1.2.
454 <refsect1 id="target_settings"><title>TARGET SETTINGS</title>
456 Pazpar2 features a cunning scheme by which you can associate various
457 kinds of attributes, or settings with search targets. This can be done
458 through XML files which are read at startup; each file can associate
459 one or more settings with one or more targets. The file format is generic
460 in nature, designed to support a wide range of application requirements. The
461 settings can be purely technical things, like, how to perform a title
462 search against a given target, or it can associate arbitrary name=value
463 pairs with groups of targets -- for instance, if you would like to
464 place all commercial full-text bases in one group for selection
465 purposes, or you would like to control what targets are accessible
466 to users by default. Per-database settings values can even be used
467 to drive sorting, facet/termlist generation, or end-user interface display
472 During startup, Pazpar2 will recursively read a specified directory
473 (can be identified in the pazpar2.cfg file or on the command line), and
474 process any settings files found therein.
478 Clients of the Pazpar2 webservice interface can selectively override
479 settings for individual targets within the scope of one session. This
480 can be used in conjunction with an external authentication system to
481 determine which resources are to be accessible to which users. Pazpar2
482 itself has no notion of end-users, and so can be used in conjunction
483 with any type of authentication system. Similarly, the authentication
484 tokens submitted to access-controlled search targets can similarly be
485 overridden, to allow use of Pazpar2 in a consortial or multi-library
486 environment, where different end-users may need to be represented to
487 some search targets in different ways. This, again, can be managed
488 using an external database or other lookup mechanism. Setting overrides
489 can be performed either using the
490 <link linkend="command-init">init</link> or the
491 <link linkend="command-settings">settings</link> webservice
496 In fact, every setting that applies to a database (except pz:id, which
497 can only be used for filtering targets to use for a search) can be overridden
498 on a per-session basis. This allows the client to override specific CCL fields
499 for searching, etc., to meet the needs of a session or user.
503 Finally, as an extreme case of this, the webservice client can
504 introduce entirely new targets, on the fly, as part of the
505 <link linkend="command-init">init</link> or
506 <link linkend="command-settings">settings</link> command.
507 This is useful if you desire to manage information
508 about your search targets in a separate application such as a database.
509 You do not need any static settings file whatsoever to run Pazpar2 -- as
510 long as the webservice client is prepared to supply the necessary
511 information at the beginning of every session.
516 The following discussion of practical issues related to session and settings
517 management are cast in terms of a user interface based on Ajax/Javascript
518 technology. It would apply equally well to many other kinds of browser-based logic.
523 Typically, a Javascript client is not allowed to directly alter the parameters
524 of a session. There are two reasons for this. One has to do with access
525 to information; typically, information about a user will be stored in a
526 system on the server side, or it will be accessible in some way from the server.
527 However, since the Javascript client cannot be entirely trusted (some hostile
528 agent might in fact 'pretend' to be a regular ws client), it is more robust
529 to control session settings from scripting that you run as part of your
530 webserver. Typically, this can be handled during the session initialization,
535 Step 1: The Javascript client loads, and asks the webserver for a new Pazpar2
536 session ID. This can be done using a Javascript call, for instance. Note that
537 it is possible to submit Ajax HTTPXmlRequest calls either to Pazpar2 or to the
538 webserver that Pazpar2 is proxying for. See (XXX Insert link to Pazpar2 protocol).
542 Step 2: Code on the webserver authenticates the user, by database lookup,
543 LDAP access, NCIP, etc. Determines which resources the user has access to,
544 and any user-specific parameters that are to be applied during this session.
548 Step 3: The webserver initializes a new Pazpar2 settings, and sets user-specific
549 parameters as necessary, using the init webservice command. A new session ID is
554 Step 4: The webserver returns this session ID to the Javascript client, which then
555 uses the session ID to submit searches, show results, etc.
559 Step 5: When the Javascript client ceases to use the session, Pazpar2 destroys
560 any session-specific information.
563 <refsect2><title>SETTINGS FILE FORMAT</title>
565 Each file contains a root element named <settings>. It may
566 contain one or more <set> elements. The settings and set
567 elements may contain the following attributes. Attributes in the set node
568 overrides those in the setting root element. Each set node must
569 specify (directly, or inherited from the parent node) at least a
570 target, name, and value.
578 This specifies the search target to which this setting should be
579 applied. Targets are identified by their Z39.50 URL, generally
580 including the host, port, and database name, (e.g.
581 <literal>bagel.indexdata.com:210/marc</literal>).
582 Two wildcard forms are accepted:
583 * (asterisk) matches all known targets;
584 <literal>bagel.indexdata.com:210/*</literal> matches all
585 known databases on the given host.
588 A precedence system determines what happens if there are
589 overlapping values for the same setting name for the same
590 target. A setting for a specific target name overrides a
591 setting which specifies target using a wildcard. This makes it
592 easy to set defaults for all targets, and then override them
593 for specific targets or hosts. If there are
594 multiple overlapping settings with the same name and target
595 value, the 'precedence' attribute determines what happens.
603 The name of the setting. This can be anything you like.
604 However, Pazpar2 reserves a number of setting names for
605 specific purposes, all starting with 'pz:', and it is a good
606 idea to avoid that prefix if you make up your own setting
607 names. See below for a list of reserved variables.
615 The value of the setting. Generally, this can be anything you
616 want -- however, some of the reserved settings may expect
617 specific kinds of values.
622 <term>precedence</term>
625 This should be an integer. If not provided, the default value
626 is 0. If two (or more) settings have the same content for
627 target and name, the precedence value determines the outcome.
628 If both settings have the same precedence value, they are both
629 applied to the target(s). If one has a higher value, then the
630 value of that setting is applied, and the other one is ignored.
637 By setting defaults for target, name, or value in the root
638 settings node, you can use the settings files in many different
639 ways. For instance, you can use a single file to set defaults for
640 many different settings, like search fields, retrieval syntaxes,
641 etc. You can have one file per server, which groups settings for
642 that server or target. You could also have one file which associates
643 a number of targets with a given setting, for instance, to associate
644 many databases with a given category or class that makes sense
645 within your application.
649 The following examples illustrate uses of the settings system to
650 associate settings with targets to meet different requirements.
654 The example below associates a set of default values that can be
655 used across many targets. Note the wildcard for targets.
656 This associates the given settings with all targets for which no
657 other information is provided.
659 <settings target="*">
661 <!-- This file introduces default settings for pazpar2 -->
663 <!-- mapping for unqualified search -->
664 <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
666 <!-- field-specific mappings -->
667 <set name="pz:cclmap:ti" value="u=4 s=al"/>
668 <set name="pz:cclmap:su" value="u=21 s=al"/>
669 <set name="pz:cclmap:isbn" value="u=7"/>
670 <set name="pz:cclmap:issn" value="u=8"/>
671 <set name="pz:cclmap:date" value="u=30 r=r"/>
673 <!-- Retrieval settings -->
675 <set name="pz:requestsyntax" value="marc21"/>
676 <set name="pz:elements" value="F"/>
678 <!-- Query encoding -->
679 <set name="pz:queryencoding" value="iso-8859-1"/>
681 <!-- Result normalization settings -->
683 <set name="pz:nativesyntax" value="iso2709"/>
684 <set name="pz:xslt" value="../etc/marc21.xsl"/>
692 The next example shows certain settings overridden for one target,
693 one which returns XML records containing DublinCore elements, and
694 which furthermore requires a username/password.
696 <settings target="funkytarget.com:210/db1">
697 <set name="pz:requestsyntax" value="xml"/>
698 <set name="pz:nativesyntax" value="xml"/>
699 <set name="pz:xslt" value="../etc/dublincore.xsl"/>
701 <set name="pz:authentication" value="myuser/password"/>
707 The following example associates a specific name/value combination
708 with a number of targets. The targets below are access-restricted,
709 and can only be used by users with special credentials.
711 <settings name="pz:allow" value="0">
712 <set target="funkytarget.com:210/*"/>
713 <set target="commercial.com:2100/expensiveDb"/>
720 <refsect2><title>RESERVED SETTING NAMES</title>
722 The following setting names are reserved by Pazpar2 to control the
723 behavior of the client function.
728 <term>pz:cclmap:xxx</term>
731 This establishes a CCL field definition or other setting, for
732 the purpose of mapping end-user queries. XXX is the field or
733 setting name, and the value of the setting provides parameters
734 (e.g. parameters to send to the server, etc.). Please consult
735 the YAZ manual for a full overview of the many capabilities of
736 the powerful and flexible CCL parser.
739 Note that it is easy to establish a set of default parameters,
740 and then override them individually for a given target.
745 <term>pz:requestsyntax</term>
748 This specifies the record syntax to use when requesting
749 records from a given server. The value can be a symbolic name like
750 marc21 or xml, or it can be a Z39.50-style dot-separated OID.
755 <term>pz:elements</term>
758 The element set name to be used when retrieving records from a
764 <term>pz:piggyback</term>
767 Piggybacking enables the server to retrieve records from the
768 server as part of the search response in Z39.50. Almost all
769 servers support this (or fail it gracefully), but a few
770 servers will produce undesirable results.
771 Set to '1' to enable piggybacking, '0' to disable it. Default
772 is 1 (piggybacking enabled).
777 <term>pz:nativesyntax</term>
780 The representation (syntax) of the retrieval records. Currently
781 recognized values are iso2709 and xml.
784 For iso2709, can also specify a native character set, e.g. "iso2709;latin-1".
785 If no character set is provided, MARC-8 is assumed.
788 If pz:nativesyntax is not specified, pazpar2 will attempt to determine
789 the value based on the response from the server.
795 <term>pz:queryencoding</term>
798 The encoding of the search terms that a target accepts. Most
799 targets do not honor UTF-8 in which case this needs to be specified.
800 Each term in a query will be converted if this setting is given.
809 Provides the path of an XSLT stylesheet which will be used to
810 map incoming records to the internal representation.
815 <term>pz:authentication</term>
818 Sets an authentication string for a given server. See the section on
819 authorization and authentication for discussion.
824 <term>pz:allow</term>
827 Allows or denies access to the resources it is applied to. Possible
828 values are '0' and '1'. The default is '1' (allow access to this resource).
829 See the manual section on authorization and authentication for discussion
830 about how to use this setting.
835 <term>pz:maxrecs</term>
838 Controls the maximum number of records to be retrieved from a
839 server. The default is 100.
847 This setting can't be 'set' -- it contains the ID (normally
848 ZURL) for a given target, and is useful for filtering --
849 specifically when you want to select one or more specific
850 targets in the search command.
855 <term>pz:zproxy</term>
858 The 'pz:zproxy' setting has the value syntax
859 'host.internet.adress:port', it is used to tunnel Z39.50
860 requests through the named Z39.50 proxy.
866 <term>pz:apdulog</term>
869 If the 'pz:apdulog' setting is defined and has other value than 0,
870 then Z39.50 APDUs are written to the log.
879 This setting enables SRU/SRW support. It has three possible settings.
880 'get', enables SRU access through GET requests. 'post' enables SRU/POST
881 support, less commonly supported, but useful if very large requests are
882 to be submitted. 'srw' enables the SRW variation of the protocol.
888 <term>pz:sru_version</term>
891 This allows SRU version to be specified. If unset Pazpar2
892 will the default of YAZ (currently 1.2). Should be set
899 <term>pz:pqf_prefix</term>
902 Allows you to specify an arbitrary PQF query language substring. The provided
903 string is prefixed the user's query after it has been normalized to PQF
904 internally in pazpar2. This allows you to attach complex 'filters' to
905 queries for a gien target, sometimes necessary to select sub-catalogs
906 in union catalog systems, etc.
915 Specifies sort criteria to be applied to the result set. Only works for targets
916 which support the sort service.
924 <refsect1><title>SEE ALSO</title>
927 <refentrytitle>pazpar2</refentrytitle>
928 <manvolnum>8</manvolnum>
931 <refentrytitle>yaz-icu</refentrytitle>
932 <manvolnum>1</manvolnum>
935 <refentrytitle>pazpar2_protocol</refentrytitle>
936 <manvolnum>7</manvolnum>
941 <!-- Keep this comment at the end of the file
946 sgml-minimize-attributes:nil
947 sgml-always-quote-attributes:t
950 sgml-parent-document:nil
951 sgml-local-catalogs: nil
952 sgml-namecase-general:t