1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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>
16 <info><orgname>Index Data</orgname></info>
20 <refentrytitle>Pazpar2 conf</refentrytitle>
21 <manvolnum>5</manvolnum>
22 <refmiscinfo class="manual">File formats and conventions</refmiscinfo>
26 <refname>pazpar2_conf</refname>
27 <refpurpose>Pazpar2 Configuration</refpurpose>
32 <command>pazpar2.conf</command>
37 <title>DESCRIPTION</title>
39 The Pazpar2 configuration file, together with any referenced XSLT files,
40 govern Pazpar2's behavior as a client, and control the normalization and
41 extraction of data elements from incoming result records, for the
42 purposes of merging, sorting, facet analysis, and display.
46 The file is specified using the option -f on the Pazpar2 command line.
47 There is not presently a way to reload the configuration file without
48 restarting Pazpar2, although this will most likely be added some time
56 The configuration file is XML-structured. It must be well-formed XML. All
57 elements specific to Pazpar2 should belong to the namespace
58 <literal>http://www.indexdata.com/pazpar2/1.0</literal>
59 (this is assumed in the
60 following examples). The root element is named "<literal>pazpar2</literal>".
61 Under the root element are a number of elements which group categories of
62 information. The categories are described below.
65 <refsect2 id="config-threads">
66 <title>threads</title>
68 This section is optional and is supported for Pazpar2 version 1.3.1 and
69 later . It is identified by element "<literal>threads</literal>" which
70 may include one attribute "<literal>number</literal>" which specifies
71 the number of worker-threads that the Pazpar2 instance is to use.
72 A value of 0 (zero) disables worker-threads (all work is carried out
76 <refsect2 id="config-server">
79 This section governs overall behavior of a server endpoint. It is identified
80 by the element "server" which takes an optional attribute, "id", which
81 identifies this particular Pazpar2 server. Any string value for "id"
86 elements are described below. From Pazpar2 version 1.2 this is
89 <variablelist> <!-- level 1 -->
94 Configures the webservice -- this controls how you can connect
95 to Pazpar2 from your browser or server-side code. The
96 attributes 'host' and 'port' control the binding of the
97 server. The 'host' attribute can be used to bind the server to
98 a secondary IP address of your system, enabling you to run
99 Pazpar2 on port 80 alongside a conventional web server. You
100 can override this setting on the command line using the option -h.
109 If this item is given, Pazpar2 will forward all incoming HTTP
110 requests that do not contain the filename 'search.pz2' to the
111 host and port specified using the 'host' and 'port'
112 attributes. The 'myurl' attribute is required, and should provide
113 the base URL of the server. Generally, the HTTP URL for the host
114 specified in the 'listen' parameter. This functionality is
115 crucial if you wish to use
116 Pazpar2 in conjunction with browser-based code (JS, Flash,
117 applets, etc.) which operates in a security sandbox. Such code
118 can only connect to the same server from which the enclosing
119 HTML page originated. Pazpar2s proxy functionality enables you
120 to host all of the main pages (plus images, CSS, etc) of your
121 application on a conventional webserver, while efficiently
122 processing webservice requests for metasearch status, results,
129 <term>icu_chain</term>
132 Specifies character set normalization for relevancy / sorting /
133 mergekey and facets - for the server. These definitions serves as
134 default for services that don't have these given. For the meaning
135 of these settings refer to the
136 <xref linkend="icuchain"/> element inside service.
142 <term>relevance / sort / mergekey / facet</term>
145 Obsolete. Use element icu_chain instead.
151 <term>settings</term>
154 Specifies target settings for the server.. These settings serves
155 as default for all services which don't have these given.
156 The settings element requires one attribute 'src' which specifies
157 a settings file or a directory . If a directory is given all
158 files with suffix <filename>.xml</filename> is read from this
160 <xref linkend="target_settings"/> for more information.
169 This nested element controls the behavior of Pazpar2 with
170 respect to your data model. In Pazpar2, incoming records are
171 normalized, using XSLT, into an internal representation.
172 The 'service' section controls the further processing and
173 extraction of data from the internal representation, primarily
174 through the 'metadata' sub-element.
177 Pazpar2 version 1.2 and later allows multiple service elements.
178 Multiple services must be given a unique ID by specifying
179 attribute <literal>id</literal>.
180 A single service may be unnamed (service ID omitted). The
181 service ID is referred to in the
182 <link linkend="command-init"><literal>init</literal></link> webservice
183 command's <literal>service</literal> parameter.
186 <variablelist> <!-- Level 2 -->
188 <term>metadata</term>
191 One of these elements is required for every data element in
192 the internal representation of the record (see
193 <xref linkend="data_model"/>. It governs
194 subsequent processing as pertains to sorting, relevance
195 ranking, merging, and display of data elements. It supports
196 the following attributes:
199 <variablelist> <!-- level 3 -->
204 This is the name of the data element. It is matched
205 against the 'type' attribute of the
207 in the normalized record. A warning is produced if
208 metadata elements with an unknown name are
210 normalized record. This name is also used to
212 data elements in the records returned by the
213 webservice API, and to name sort lists and browse
223 The type of data element. This value governs any
224 normalization or special processing that might take
225 place on an element. Possible values are 'generic'
226 (basic string), 'year' (a range is computed if
227 multiple years are found in the record). Note: This
228 list is likely to increase in the future.
237 If this is set to 'yes', then the data element is
238 includes in brief records in the webservice API. Note
239 that this only makes sense for metadata elements that
240 are merged (see below). The default value is 'no'.
249 Specifies that this data element is to be used for
250 sorting. The possible values are 'numeric' (numeric
251 value), 'skiparticle' (string; skip common, leading
252 articles), and 'no' (no sorting). The default value is
262 Specifies that this element is to be used to
264 records against the user's query (when ranking is
266 The valus is of the form
270 where M is an integer, used as a
271 weight against the basic TF*IDF score. A value of
272 1 is the base, higher values give additional weight to
273 elements of this type. The default is '0', which
274 excludes this element from the rank calculation.
277 F is a CCL field and N is the multipler for terms
278 that matches those part of the CCL field in search.
279 The F+N combo allows the system to use a different
280 multipler for a certain field. For example, a rank value of
281 "<literal>1 au 3</literal>" gives a multipler of 3 for
282 all terms part of the au(thor) terms and 1 for everything else.
285 For Pazpar2 1.6.13 and later, the rank may also defined
286 "per-document", by the normalization stylesheet.
289 The per field rank was introduced in Pazpar2 1.6.15. Earlier
290 releases only allowed a rank value M (simple integer).
292 See <xref linkend="relevance_ranking"/> for more
298 <term>termlist</term>
301 Specifies that this element is to be used as a
302 termlist, or browse facet. Values are tabulated from
303 incoming records, and a highscore of values (with
304 their associated frequency) is made available to the
305 client through the webservice API.
307 are 'yes' and 'no' (default).
316 This governs whether, and how elements are extracted
317 from individual records and merged into cluster
318 records. The possible values are: 'unique' (include
319 all unique elements), 'longest' (include only the
320 longest element (strlen), 'range' (calculate a range
321 of values across all matching records), 'all' (include
322 all elements), or 'no' (don't merge; this is the
329 <term>mergekey</term>
332 If set to '<literal>required</literal>', the value of this
333 metadata element is appended to the resulting mergekey if
334 the metadata is present in a record instance.
335 If the metadata element is not present, the a unique mergekey
336 will be generated instead.
339 If set to '<literal>optional</literal>', the value of this
340 metadata element is appended to the resulting mergekey if the
341 the metadata is present in a record instance. If the metadata
342 is not present, it will be empty.
345 If set to '<literal>no</literal>' or the mergekey attribute is
346 omitted, the metadata will not be used in the creation of a
353 <term id="facetrule">facetrule</term>
356 Specifies the ICU rule set to be used for normalizing
357 facets. If facetrule is omitted from metadata, the
358 rule set 'facet' is used.
364 <term id="limitcluster">limitcluster</term>
367 Allow a limit on merged metadata. The value of this attribute
368 is the name of actual metadata content to be used for matching
369 (most often same name as metadata name).
373 Requires Pazpar2 1.6.23 or later.
380 <term id="metadata_limitmap">limitmap</term>
383 Specifies a default limitmap for this field. This is to avoid mass
384 configuring of targets. However it is important to review/do this on a per
385 target since it is usually target-specific. See limitmap for format.
391 <term id="metadata_facetmap">facetmap</term>
394 Specifies a default facetmap for this field. This is to avoid mass
395 configuring of targets. However it is important to review/do this on a per
396 target since it is usually target-specific. See facetmap for format.
405 This attribute allows you to make use of static database
406 settings in the processing of records. Three possible values
407 are allowed. 'no' is the default and doesn't do anything.
408 'postproc' copies the value of a setting with the same name
409 into the output of the normalization stylesheet(s). 'parameter'
410 makes the value of a setting with the same name available
411 as a parameter to the normalization stylesheet, so you
412 can further process the value inside of the stylesheet, or use
413 the value to decide how to deal with other data values.
416 The purpose of using settings in this way can either be to
417 control the behavior of normalization stylesheet in a database-
418 dependent way, or to easily make database-dependent values
419 available to display-logic in your user interface, without having
420 to implement complicated interactions between the user interface
421 and your configuration system.
426 </variablelist> <!-- attributes to metadata -->
432 <term id="servicexslt" xreflabel="xslt">xslt</term>
435 Defines a XSLT stylesheet. The <literal>xslt</literal>
436 element takes exactly one attribute <literal>id</literal>
437 which names the stylesheet. This can be referred to in target
438 settings <xref linkend="pzxslt"/>.
441 The content of the xslt element is the embedded stylesheet XML
446 <term id="icuchain" xreflabel="icu_chain">icu_chain</term>
449 Specifies a named ICU rule set. The icu_chain element must include
450 attribute 'id' which specifies the identifier (name) for the ICU
452 Pazpar2 uses the particular rule sets for particular purposes.
453 Rule set 'relevance' is used to normalize
454 terms for relevance ranking. Rule set 'sort' is used to
455 normalize terms for sorting. Rule set 'mergekey' is used to
456 normalize terms for making a mergekey and, finally. Rule set 'facet'
457 is normally used to normalize facet terms, unless
458 <xref linkend="facetrule">facetrule</xref> is given for a
462 The icu_chain element must also include a 'locale'
463 attribute which must be set to one of the locale strings
464 defined in ICU. The child elements listed below can be
465 in any order, except the 'index' element which logically
466 belongs to the end of the list. The stated tokenization,
467 transformation and charmapping instructions are performed
468 in order from top to bottom.
470 <variablelist> <!-- Level 2 -->
475 The attribute 'rule' defines the direction of the
476 per-character casemapping, allowed values are "l"
477 (lower), "u" (upper), "t" (title).
482 <term>transform</term>
485 Normalization and transformation of tokens follows
486 the rules defined in the 'rule' attribute. For
487 possible values we refer to the extensive ICU
488 documentation found at the
489 <ulink url="&url.icu.transform;">ICU
490 transformation</ulink> home page. Set filtering
491 principles are explained at the
492 <ulink url="&url.icu.unicode.set;">ICU set and
493 filtering</ulink> page.
498 <term>tokenize</term>
501 Tokenization is the only rule in the ICU chain
502 which splits one token into multiple tokens. The
503 'rule' attribute may have the following values:
504 "s" (sentence), "l" (line-break), "w" (word), and
505 "c" (character), the later probably not being
506 very useful in a pruning Pazpar2 installation.
512 From Pazpar2 version 1.1 the ICU wrapper from YAZ is used.
513 Refer to the <ulink url="&url.yaz.yaz-icu;">yaz-icu</ulink>
514 utility for more information.
520 <term>relevance</term>
523 Specifies the ICU rule set used for relevance ranking.
524 The child element of 'relevance' must be 'icu_chain' and the
525 'id' attribute of the icu_chain is ignored. This
526 definition is obsolete and should be replaced by the equivalent
529 <icu_chain id="relevance" locale="en">..<icu_chain>
539 Specifies the ICU rule set used for sorting.
540 The child element of 'sort' must be 'icu_chain' and the
541 'id' attribute of the icu_chain is ignored. This
542 definition is obsolete and should be replaced by the equivalent
545 <icu_chain id="sort" locale="en">..<icu_chain>
552 <term>mergekey</term>
555 Specifies ICU tokenization and transformation rules
556 for tokens that are used in Pazpar2's mergekey.
557 The child element of 'mergekey' must be 'icu_chain' and the
558 'id' attribute of the icu_chain is ignored. This
559 definition is obsolete and should be replaced by the equivalent
562 <icu_chain id="mergekey" locale="en">..<icu_chain>
572 Specifies ICU tokenization and transformation rules
573 for tokens that are used in Pazpar2's facets.
574 The child element of 'facet' must be 'icu_chain' and the
575 'id' attribute of the icu_chain is ignored. This
576 definition is obsolete and should be replaced by the equivalent
579 <icu_chain id="facet" locale="en">..<icu_chain>
586 <term>ccldirective</term>
589 Customizes the CCL parsing (interpretation of query parameter
591 The name and value of the CCL directive is gigen by attributes
592 'name' and 'value' respectively. Refer to possible list of names
595 url="http://www.indexdata.com/yaz/doc/tools.html#ccl.directives.table">
606 Customizes the ranking (relevance) algorithm. Also known as
607 rank tweaks. The rank element
608 accepts the following attributes - all being optional:
615 Attribute 'cluster' is a boolean
616 that controls whether Pazpar2 should boost ranking for merged
617 records. Is 'yes' by default. A value of 'no' will make
618 Pazpar2 average ranking of each record in a cluster.
626 Attribute 'debug' is a boolean
627 that controls whether Pazpar2 should include details
628 about ranking for each document in the show command's
629 response. Enable by using value "yes", disable by using
630 value "no" (default).
638 Attribute 'follow' is a a floating point number greater than
639 or equal to 0. A positive number will boost weight for terms
640 that occur close to each other (proximity, distance).
641 A value of 1, will double the weight if two terms are in
642 proximity distance of 1 (next to each other). The default
643 value of 'follow' is 0 (order will not affect weight).
651 Attribute 'lead' is a floating point number.
652 It controls if term weight should be reduced by position
653 from start in a metadata field. A positive value of 'lead'
654 will reduce weight as it apperas further away from the lead
655 of the field. Default value is 0 (no reduction of weight by
664 Attribute 'length' determines how/if term weight should be
665 divided by lenght of metadata field. A value of "linear"
666 divide by length. A value of "log" will divide by log2(length).
667 A value of "none" will leave term weight as is (no division).
668 Default value is "linear".
674 Refer to <xref linkend="relevance_ranking"/> to see how
675 these tweaks are used in computation of score.
678 Customization of ranking algorithm was introduced with
679 Pazpar2 1.6.18. The semantics of some of the fields changed
680 in versions up to 1.6.22.
685 <varlistentry id="sort-default">
686 <term>sort-default</term>
689 Specifies the default sort criteria (default 'relevance'),
690 which previous was hard-coded as default criteria in search.
691 This is a fix/work-around to avoid re-searching when using
692 target-based sorting. In order for this to work efficient,
693 the search must also have the sort critera parameter; otherwise
694 pazpar2 will do re-searching on search criteria changes, if
695 changed between search and show command.
698 This configuration was added in pazpar2 1.6.20.
708 Specifies a variable that will be inherited by all targets defined in settings
710 <set name="test" value="en"..<set>
717 <term>settings</term>
720 Specifies target settings for this service. Refer to
721 <xref linkend="target_settings"/>.
730 Specifies timeout parameters for this service.
731 The <literal>timeout</literal>
732 element supports the following attributes:
733 <literal>session</literal>, <literal>z3950_operation</literal>,
734 <literal>z3950_session</literal> which specifies
735 'session timeout', 'Z39.50 operation timeout',
736 'Z39.50 session timeout' respectively. The Z39.50 operation
737 timeout is the time Pazpar2 will wait for an active Z39.50/SRU
738 operation before it gives up (times out). The Z39.50 session
739 time out is the time Pazpar2 will keep the session alive for
740 an idle session (no operation).
743 The following is recommended but not required:
744 z3950_operation (30) < session (60) < z3950_session (180) .
745 The default values are given in parantheses.
749 </variablelist> <!-- Data elements in service directive -->
752 </variablelist> <!-- Data elements in server directive -->
757 <title>EXAMPLE</title>
759 Below is a working example configuration:
763 <?xml version="1.0" encoding="UTF-8"?>
764 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
766 <threads number="10"/>
768 <listen port="9004"/>
770 <metadata name="title" brief="yes" sortkey="skiparticle"
771 merge="longest" rank="6"/>
772 <metadata name="isbn" merge="unique"/>
773 <metadata name="date" brief="yes" sortkey="numeric"
774 type="year" merge="range" termlist="yes"/>
775 <metadata name="author" brief="yes" termlist="yes"
776 merge="longest" rank="2"/>
777 <metadata name="subject" merge="unique" termlist="yes" rank="3" limitmap="local:"/>
778 <metadata name="url" merge="unique"/>
779 <icu_chain id="relevance" locale="el">
780 <transform rule="[:Control:] Any-Remove"/>
782 <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
785 <settings src="mysettings"/>
786 <timeout session="60"/>
794 <refsect1 id="config-include">
795 <title>INCLUDE FACILITY</title>
797 The XML configuration may be partitioned into multiple files by using
798 the <literal>include</literal> element which takes a single attribute,
799 <literal>src</literal>. The of the <literal>src</literal> attribute is
800 regular Shell like glob-pattern. For example,
802 <include src="/etc/pazpar2/conf.d/*.xml"/>
806 The include facility requires Pazpar2 version 1.2.
810 <refsect1 id="target_settings">
811 <title>TARGET SETTINGS</title>
813 Pazpar2 features a cunning scheme by which you can associate various
814 kinds of attributes, or settings with search targets. This can be done
815 through XML files which are read at startup; each file can associate
816 one or more settings with one or more targets. The file format is generic
817 in nature, designed to support a wide range of application requirements. The
818 settings can be purely technical things, like, how to perform a title
819 search against a given target, or it can associate arbitrary name=value
820 pairs with groups of targets -- for instance, if you would like to
821 place all commercial full-text bases in one group for selection
822 purposes, or you would like to control what targets are accessible
823 to users by default. Per-database settings values can even be used
824 to drive sorting, facet/termlist generation, or end-user interface display
829 During startup, Pazpar2 will recursively read a specified directory
830 (can be identified in the pazpar2.cfg file or on the command line), and
831 process any settings files found therein.
835 Clients of the Pazpar2 webservice interface can selectively override
836 settings for individual targets within the scope of one session. This
837 can be used in conjunction with an external authentication system to
838 determine which resources are to be accessible to which users. Pazpar2
839 itself has no notion of end-users, and so can be used in conjunction
840 with any type of authentication system. Similarly, the authentication
841 tokens submitted to access-controlled search targets can similarly be
842 overridden, to allow use of Pazpar2 in a consortial or multi-library
843 environment, where different end-users may need to be represented to
844 some search targets in different ways. This, again, can be managed
845 using an external database or other lookup mechanism. Setting overrides
846 can be performed either using the
847 <link linkend="command-init">init</link> or the
848 <link linkend="command-settings">settings</link> webservice
853 In fact, every setting that applies to a database (except pz:id, which
854 can only be used for filtering targets to use for a search) can be overridden
855 on a per-session basis. This allows the client to override specific CCL fields
856 for searching, etc., to meet the needs of a session or user.
860 Finally, as an extreme case of this, the webservice client can
861 introduce entirely new targets, on the fly, as part of the
862 <link linkend="command-init">init</link> or
863 <link linkend="command-settings">settings</link> command.
864 This is useful if you desire to manage information
865 about your search targets in a separate application such as a database.
866 You do not need any static settings file whatsoever to run Pazpar2 -- as
867 long as the webservice client is prepared to supply the necessary
868 information at the beginning of every session.
873 The following discussion of practical issues related to session
874 and settings management are cast in terms of a user interface based on
875 Ajax/Javascript technology. It would apply equally well to many other
876 kinds of browser-based logic.
881 Typically, a Javascript client is not allowed to directly alter the
882 parameters of a session. There are two reasons for this. One has to do
883 with access to information; typically, information about a user will
884 be stored in a system on the server side, or it will be accessible in
885 some way from the server. However, since the Javascript client cannot
886 be entirely trusted (some hostile agent might in fact 'pretend' to be
887 a regular ws client), it is more robust to control session settings
888 from scripting that you run as part of your webserver. Typically, this
889 can be handled during the session initialization, as follows:
893 Step 1: The Javascript client loads, and asks the webserver for a
894 new Pazpar2 session ID. This can be done using a Javascript call, for
895 instance. Note that it is possible to submit Ajax HTTPXmlRequest calls
896 either to Pazpar2 or to the webserver that Pazpar2 is proxying
897 for. See (XXX Insert link to Pazpar2 protocol).
901 Step 2: Code on the webserver authenticates the user, by database lookup,
902 LDAP access, NCIP, etc. Determines which resources the user has access to,
903 and any user-specific parameters that are to be applied during this session.
907 Step 3: The webserver initializes a new Pazpar2 settings, and sets
908 user-specific parameters as necessary, using the init webservice
909 command. A new session ID is returned.
913 Step 4: The webserver returns this session ID to the Javascript
914 client, which then uses the session ID to submit searches, show
919 Step 5: When the Javascript client ceases to use the session,
920 Pazpar2 destroys any session-specific information.
924 <title>SETTINGS FILE FORMAT</title>
926 Each file contains a root element named <settings>. It may
927 contain one or more <set> elements. The settings and set
928 elements may contain the following attributes. Attributes in the set
929 node overrides those in the setting root element. Each set node must
930 specify (directly, or inherited from the parent node) at least a
931 target, name, and value.
939 This specifies the search target to which this setting should be
940 applied. Targets are identified by their Z39.50 URL, generally
941 including the host, port, and database name, (e.g.
942 <literal>bagel.indexdata.com:210/marc</literal>).
943 Two wildcard forms are accepted:
944 * (asterisk) matches all known targets;
945 <literal>bagel.indexdata.com:210/*</literal> matches all
946 known databases on the given host.
949 A precedence system determines what happens if there are
950 overlapping values for the same setting name for the same
951 target. A setting for a specific target name overrides a
952 setting which specifies target using a wildcard. This makes it
953 easy to set defaults for all targets, and then override them
954 for specific targets or hosts. If there are
955 multiple overlapping settings with the same name and target
956 value, the 'precedence' attribute determines what happens.
959 For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
960 which case, the actual host, port, etc is given by setting
961 <xref linkend="pzurl"/>.
969 The name of the setting. This can be anything you like.
970 However, Pazpar2 reserves a number of setting names for
971 specific purposes, all starting with 'pz:', and it is a good
972 idea to avoid that prefix if you make up your own setting
973 names. See below for a list of reserved variables.
981 The value of the setting. Generally, this can be anything you
982 want -- however, some of the reserved settings may expect
983 specific kinds of values.
988 <term>precedence</term>
991 This should be an integer. If not provided, the default value
992 is 0. If two (or more) settings have the same content for
993 target and name, the precedence value determines the outcome.
994 If both settings have the same precedence value, they are both
995 applied to the target(s). If one has a higher value, then the
996 value of that setting is applied, and the other one is ignored.
1003 By setting defaults for target, name, or value in the root
1004 settings node, you can use the settings files in many different
1005 ways. For instance, you can use a single file to set defaults for
1006 many different settings, like search fields, retrieval syntaxes,
1007 etc. You can have one file per server, which groups settings for
1008 that server or target. You could also have one file which associates
1009 a number of targets with a given setting, for instance, to associate
1010 many databases with a given category or class that makes sense
1011 within your application.
1015 The following examples illustrate uses of the settings system to
1016 associate settings with targets to meet different requirements.
1020 The example below associates a set of default values that can be
1021 used across many targets. Note the wildcard for targets.
1022 This associates the given settings with all targets for which no
1023 other information is provided.
1025 <settings target="*">
1027 <!-- This file introduces default settings for pazpar2 -->
1029 <!-- mapping for unqualified search -->
1030 <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
1032 <!-- field-specific mappings -->
1033 <set name="pz:cclmap:ti" value="u=4 s=al"/>
1034 <set name="pz:cclmap:su" value="u=21 s=al"/>
1035 <set name="pz:cclmap:isbn" value="u=7"/>
1036 <set name="pz:cclmap:issn" value="u=8"/>
1037 <set name="pz:cclmap:date" value="u=30 r=r"/>
1039 <set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
1040 <set name="pz:limitmap:date" value="ccl:date"/>
1042 <!-- Retrieval settings -->
1044 <set name="pz:requestsyntax" value="marc21"/>
1045 <set name="pz:elements" value="F"/>
1047 <!-- Query encoding -->
1048 <set name="pz:queryencoding" value="iso-8859-1"/>
1050 <!-- Result normalization settings -->
1052 <set name="pz:nativesyntax" value="iso2709"/>
1053 <set name="pz:xslt" value="../etc/marc21.xsl"/>
1061 The next example shows certain settings overridden for one target,
1062 one which returns XML records containing DublinCore elements, and
1063 which furthermore requires a username/password.
1065 <settings target="funkytarget.com:210/db1">
1066 <set name="pz:requestsyntax" value="xml"/>
1067 <set name="pz:nativesyntax" value="xml"/>
1068 <set name="pz:xslt" value="../etc/dublincore.xsl"/>
1070 <set name="pz:authentication" value="myuser/password"/>
1076 The following example associates a specific name/value combination
1077 with a number of targets. The targets below are access-restricted,
1078 and can only be used by users with special credentials.
1080 <settings name="pz:allow" value="0">
1081 <set target="funkytarget.com:210/*"/>
1082 <set target="commercial.com:2100/expensiveDb"/>
1090 <title>RESERVED SETTING NAMES</title>
1092 The following setting names are reserved by Pazpar2 to control the
1093 behavior of the client function.
1098 <term>pz:cclmap:xxx</term>
1101 This establishes a CCL field definition or other setting, for
1102 the purpose of mapping end-user queries. XXX is the field or
1103 setting name, and the value of the setting provides parameters
1104 (e.g. parameters to send to the server, etc.). Please consult
1105 the YAZ manual for a full overview of the many capabilities of
1106 the powerful and flexible CCL parser.
1109 Note that it is easy to establish a set of default parameters,
1110 and then override them individually for a given target.
1114 <varlistentry id="requestsyntax">
1115 <term>pz:requestsyntax</term>
1118 This specifies the record syntax to use when requesting
1119 records from a given server. The value can be a symbolic name like
1120 marc21 or xml, or it can be a Z39.50-style dot-separated OID.
1125 <term>pz:elements</term>
1128 The element set name to be used when retrieving records from a
1134 <term>pz:piggyback</term>
1137 Piggybacking enables the server to retrieve records from the
1138 server as part of the search response in Z39.50. Almost all
1139 servers support this (or fail it gracefully), but a few
1140 servers will produce undesirable results.
1141 Set to '1' to enable piggybacking, '0' to disable it. Default
1142 is 1 (piggybacking enabled).
1147 <term>pz:nativesyntax</term>
1150 Specifies how Pazpar2 shoule map retrieved records to XML. Currently
1151 supported values are <literal>xml</literal>,
1152 <literal>iso2709</literal> and <literal>txml</literal>.
1155 The value <literal>iso2709</literal> makes Pazpar2 convert retrieved
1156 MARC records to MARCXML. In order to convert to XML, the exact
1157 chacater set of the MARC must be known (if not, the resulting
1158 XML is probably not well-formed). The character set may be
1159 specified by adding:
1160 <literal>;charset=</literal><replaceable>charset</replaceable> to
1161 <literal>iso2709</literal>. If omitted, a charset of
1162 MARC-8 is assumed. This is correct for most MARC21/USMARC records.
1165 The value <literal>txml</literal> is like <literal>iso2709</literal>
1166 except that records are converted to TurboMARC instead of MARCXML.
1169 The value <literal>xml</literal> is used if Pazpar2 retrieves
1170 records that are already XML (no conversion takes place).
1176 <term>pz:queryencoding</term>
1179 The encoding of the search terms that a target accepts. Most
1180 targets do not honor UTF-8 in which case this needs to be specified.
1181 Each term in a query will be converted if this setting is given.
1187 <term>pz:negotiation_charset</term>
1190 Sets character set for Z39.50 negotiation. Most targets do not support
1191 this, and some will even close connection if set (crash on server
1192 side or similar). If set, you probably want to set it to
1193 <literal>UTF-8</literal>.
1199 <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
1202 Is a comma separated list of of stylesheet names that specifies
1203 how to convert incoming records to the internal representation.
1206 For each name, the embedded stylesheets (XSL) that comes with the
1207 service definition are consulted first and takes precedence over
1208 external files; see <xref linkend="servicexslt"/>
1209 of service definition).
1210 If the name does not match an embedded stylesheet it is
1211 considered a filename.
1214 The suffix of each file specifies the kind of tranformation.
1215 Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
1216 "<literal>.mmap</literal>" will use the MMAP transform (described below).
1219 The special value "<literal>auto</literal>" will use a file
1220 which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
1222 <literal>'.xsl'</literal>.
1225 When mapping MARC records, XSLT can be bypassed for increased
1226 performance with the alternate "MARC map" format. Provide the
1227 path of a file with extension ".mmap" containing on each line:
1229 <field> <subfield> <metadata element></programlisting>
1236 To map the field value specify a subfield of '$'. To store a
1237 concatenation of all subfields, specify a subfield of '*'.
1242 <term>pz:authentication</term>
1245 Sets an authentication string for a given server. See the section on
1246 authorization and authentication for discussion.
1251 <term>pz:allow</term>
1254 Allows or denies access to the resources it is applied to. Possible
1255 values are '0' and '1'.
1256 The default is '1' (allow access to this resource).
1257 See the manual section on authorization and authentication for
1258 discussion about how to use this setting.
1263 <term>pz:maxrecs</term>
1266 Controls the maximum number of records to be retrieved from a
1267 server. The default is 100.
1272 <term>pz:presentchunk</term>
1275 Controls the chunk size in present requests. Pazpar2 will
1276 make (maxrecs / chunk) request(s). The default is 20.
1284 This setting can't be 'set' -- it contains the ID (normally
1285 ZURL) for a given target, and is useful for filtering --
1286 specifically when you want to select one or more specific
1287 targets in the search command.
1292 <term>pz:zproxy</term>
1295 The 'pz:zproxy' setting has the value syntax
1296 'host.internet.adress:port', it is used to tunnel Z39.50
1297 requests through the named Z39.50 proxy.
1303 <term>pz:apdulog</term>
1306 If the 'pz:apdulog' setting is defined and has other value than 0,
1307 then Z39.50 APDUs are written to the log.
1316 This setting enables
1317 <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
1319 It has four possible settings.
1320 'get', enables SRU access through GET requests. 'post' enables SRU/POST
1321 support, less commonly supported, but useful if very large requests are
1322 to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
1326 A value of 'solr' enables Solr client support. This is supported
1327 for Pazpar version 1.5.0 and later.
1333 <term>pz:sru_version</term>
1336 This allows SRU version to be specified. If unset Pazpar2
1337 will the default of YAZ (currently 1.2). Should be set
1338 to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
1344 <term>pz:pqf_prefix</term>
1347 Allows you to specify an arbitrary PQF query language substring.
1348 The provided string is prefixed to the user's query after it has been
1349 normalized to PQF internally in pazpar2.
1350 This allows you to attach complex 'filters' to queries for a given
1351 target, sometimes necessary to select sub-catalogs
1352 in union catalog systems, etc.
1358 <term>pz:pqf_strftime</term>
1361 Allows you to extend a query with dates and operators.
1362 The provided string allows certain substitutions and serves as a
1364 The special two character sequence '%%' gets converted to the
1365 original query. Other characters leading with the percent sign are
1366 conversions supported by strftime.
1367 All other characters are copied verbatim. For example, the string
1368 <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
1369 would search for current year combined with the original PQF (%%).
1372 This setting can also be used as more general alternative to
1373 pz:pqf_prefix -- a way of embedding the submitted query
1374 anywhere in the string rather than appending it to prefix. For
1375 example, if it is desired to omit all records satisfying the
1376 query <literal>@attr 1=pica.bib 0007</literal> then this
1377 subquery can be combined with the submitted query as the second
1378 argument of <literal>@andnot</literal> by using the
1379 pz:pqf_strftime value <literal>@not %% @attr 1=pica.bib
1386 <term>pz:sort</term>
1389 Specifies sort criteria to be applied to the result set.
1390 Only works for targets which support the sort service.
1396 <term>pz:recordfilter</term>
1399 Specifies a filter which allows Pazpar2 to only include
1400 records that meet a certain criteria in a result.
1401 Unmatched records will be ignored.
1402 The filter takes the form name, name~value, or name=value, which
1403 will include only records with metadata element (name) that has the
1404 substring (~value) given, or matches exactly (=value).
1405 If value is omitted all records with the named metadata element
1406 present will be included.
1412 <term>pz:preferred</term>
1415 Specifies that a target is preferred, e.g. possible local, faster
1416 target. Using block=pref on show command will wait for all these
1417 targets to return records before releasing the block.
1418 If no target is preferred, the block=pref will identical to block=1,
1419 which release when one target has returned records.
1424 <term>pz:block_timeout</term>
1427 (Not yet implemented).
1428 Specifies the time for which a block should be released anyway.
1433 <term>pz:termlist_term_count</term>
1436 Specifies number of facet terms to be requested from the target.
1437 The default is unspecified e.g. server-decided. Also see pz:facetmap.
1442 <term>pz:termlist_term_factor</term>
1445 Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
1446 When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
1447 facet with native (target-generated) facets, the later will dominated the dominate the facet list
1448 since they are generated based on the complete result set.
1449 By scaling up the facet count using the ratio between total hit count and the sample size,
1450 the total facet count can be approximated and thus better compared with native facets.
1451 This is not enabled by default.
1457 <term>pz:facetmap:<replaceable>name</replaceable></term>
1460 Specifies that for field <replaceable>name</replaceable>, the target
1461 supports (native) facets. The value is the name of the
1462 field on the target.
1466 At this point only Solr targets have been tested with this
1473 <varlistentry id="limitmap">
1474 <term>pz:limitmap:<replaceable>name</replaceable></term>
1477 Specifies attributes for limiting a search to a field - using
1478 the limit parameter for search. It can be used to filter locally
1479 or remotely (search in a target). In some cases the mapping of
1480 a field to a value is identical to an existing cclmap field; in
1481 other cases the field must be specified in a different way - for
1482 example to match a complete field (rather than parts of a subfield).
1485 The value of limitmap may have one of three forms: referral to
1486 an existing CCL field, a raw PQF string or a local limit. Leading string
1487 determines type; either <literal>ccl:</literal> for CCL field,
1488 <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
1489 for filtering in Pazpar2. The local filtering may be followed
1490 by a field a metadata field (default is to use the name of the
1494 For Pazpar2 version 1.6.23 and later the limitmap may include multiple
1495 specifications, separated by <literal>,</literal> (comma).
1497 <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
1501 The limitmap facility is supported for Pazpar2 version 1.6.0.
1502 Local filtering is supported in Pazpar2 1.6.6.
1508 <varlistentry id="pzurl">
1512 Specifies URL for the target and overrides the target ID.
1516 <literal>pz:url</literal> is only recognized for
1517 Pazpar2 1.6.4 and later.
1523 <varlistentry id="pzsortmap">
1524 <term>pz:sortmap:<replaceable>field</replaceable></term>
1527 Specifies native sorting for a target where
1528 <replaceable>field</replaceable> is a sort criteria (see command
1529 show). The value has to components separated by colon: strategy and
1530 native-field. Strategy is one of <literal>z3950</literal>,
1531 <literal>type7</literal>, <literal>cql</literal>,
1532 <literal>sru11</literal>, or <literal>embed</literal>.
1533 The second component, native-field, is the field that is recognized
1538 Only supported for Pazpar2 1.6.4 and later.
1550 <title>SEE ALSO</title>
1553 <refentrytitle>pazpar2</refentrytitle>
1554 <manvolnum>8</manvolnum>
1557 <refentrytitle>yaz-icu</refentrytitle>
1558 <manvolnum>1</manvolnum>
1561 <refentrytitle>pazpar2_protocol</refentrytitle>
1562 <manvolnum>7</manvolnum>
1567 <!-- Keep this comment at the end of the file
1570 nxml-child-indent: 1