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 multiplier 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).
296 <term>termlist</term>
299 Specifies that this element is to be used as a
300 termlist, or browse facet. Values are tabulated from
301 incoming records, and a highscore of values (with
302 their associated frequency) is made available to the
303 client through the webservice API.
305 are 'yes' and 'no' (default).
314 This governs whether, and how elements are extracted
315 from individual records and merged into cluster
316 records. The possible values are: 'unique' (include
317 all unique elements), 'longest' (include only the
318 longest element (strlen), 'range' (calculate a range
319 of values across all matching records), 'all' (include
320 all elements), or 'no' (don't merge; this is the
327 <term>mergekey</term>
330 If set to '<literal>required</literal>', the value of this
331 metadata element is appended to the resulting mergekey if
332 the metadata is present in a record instance.
333 If the metadata element is not present, the a unique mergekey
334 will be generated instead.
337 If set to '<literal>optional</literal>', the value of this
338 metadata element is appended to the resulting mergekey if the
339 the metadata is present in a record instance. If the metadata
340 is not present, it will be empty.
343 If set to '<literal>no</literal>' or the mergekey attribute is
344 omitted, the metadata will not be used in the creation of a
351 <term id="facetrule">facetrule</term>
354 Specifies the ICU rule set to be used for normalizing
355 facets. If facetrule is omitted from metadata, the
356 rule set 'facet' is used.
362 <term id="metadata_limitmap">limitmap</term>
365 Specifies a default limitmap for this field. This is to avoid mass
366 configuring of targets. However it is important to review/do this on a per
367 target since it is usually target-specific. See limitmap for format.
373 <term id="metadata_facetmap">facetmap</term>
376 Specifies a default facetmap for this field. This is to avoid mass
377 configuring of targets. However it is important to review/do this on a per
378 target since it is usually target-specific. See facetmap for format.
387 This attribute allows you to make use of static database
388 settings in the processing of records. Three possible values
389 are allowed. 'no' is the default and doesn't do anything.
390 'postproc' copies the value of a setting with the same name
391 into the output of the normalization stylesheet(s). 'parameter'
392 makes the value of a setting with the same name available
393 as a parameter to the normalization stylesheet, so you
394 can further process the value inside of the stylesheet, or use
395 the value to decide how to deal with other data values.
398 The purpose of using settings in this way can either be to
399 control the behavior of normalization stylesheet in a database-
400 dependent way, or to easily make database-dependent values
401 available to display-logic in your user interface, without having
402 to implement complicated interactions between the user interface
403 and your configuration system.
408 </variablelist> <!-- attributes to metadata -->
414 <term id="servicexslt" xreflabel="xslt">xslt</term>
417 Defines a XSLT stylesheet. The <literal>xslt</literal>
418 element takes exactly one attribute <literal>id</literal>
419 which names the stylesheet. This can be referred to in target
420 settings <xref linkend="pzxslt"/>.
423 The content of the xslt element is the embedded stylesheet XML
428 <term id="icuchain" xreflabel="icu_chain">icu_chain</term>
431 Specifies a named ICU rule set. The icu_chain element must include
432 attribute 'id' which specifies the identifier (name) for the ICU
434 Pazpar2 uses the particular rule sets for particular purposes.
435 Rule set 'relevance' is used to normalize
436 terms for relevance ranking. Rule set 'sort' is used to
437 normalize terms for sorting. Rule set 'mergekey' is used to
438 normalize terms for making a mergekey and, finally. Rule set 'facet'
439 is normally used to normalize facet terms, unless
440 <xref linkend="facetrule">facetrule</xref> is given for a
444 The icu_chain element must also include a 'locale'
445 attribute which must be set to one of the locale strings
446 defined in ICU. The child elements listed below can be
447 in any order, except the 'index' element which logically
448 belongs to the end of the list. The stated tokenization,
449 transformation and charmapping instructions are performed
450 in order from top to bottom.
452 <variablelist> <!-- Level 2 -->
457 The attribute 'rule' defines the direction of the
458 per-character casemapping, allowed values are "l"
459 (lower), "u" (upper), "t" (title).
464 <term>transform</term>
467 Normalization and transformation of tokens follows
468 the rules defined in the 'rule' attribute. For
469 possible values we refer to the extensive ICU
470 documentation found at the
471 <ulink url="&url.icu.transform;">ICU
472 transformation</ulink> home page. Set filtering
473 principles are explained at the
474 <ulink url="&url.icu.unicode.set;">ICU set and
475 filtering</ulink> page.
480 <term>tokenize</term>
483 Tokenization is the only rule in the ICU chain
484 which splits one token into multiple tokens. The
485 'rule' attribute may have the following values:
486 "s" (sentence), "l" (line-break), "w" (word), and
487 "c" (character), the later probably not being
488 very useful in a pruning Pazpar2 installation.
494 From Pazpar2 version 1.1 the ICU wrapper from YAZ is used.
495 Refer to the <ulink url="&url.yaz.yaz-icu;">yaz-icu</ulink>
496 utility for more information.
502 <term>relevance</term>
505 Specifies the ICU rule set used for relevance ranking.
506 The child element of 'relevance' must be 'icu_chain' and the
507 'id' attribute of the icu_chain is ignored. This
508 definition is obsolete and should be replaced by the equivalent
511 <icu_chain id="relevance" locale="en">..<icu_chain>
521 Specifies the ICU rule set used for sorting.
522 The child element of 'sort' must be 'icu_chain' and the
523 'id' attribute of the icu_chain is ignored. This
524 definition is obsolete and should be replaced by the equivalent
527 <icu_chain id="sort" locale="en">..<icu_chain>
534 <term>mergekey</term>
537 Specifies ICU tokenization and transformation rules
538 for tokens that are used in Pazpar2's mergekey.
539 The child element of 'mergekey' must be 'icu_chain' and the
540 'id' attribute of the icu_chain is ignored. This
541 definition is obsolete and should be replaced by the equivalent
544 <icu_chain id="mergekey" locale="en">..<icu_chain>
554 Specifies ICU tokenization and transformation rules
555 for tokens that are used in Pazpar2's facets.
556 The child element of 'facet' must be 'icu_chain' and the
557 'id' attribute of the icu_chain is ignored. This
558 definition is obsolete and should be replaced by the equivalent
561 <icu_chain id="facet" locale="en">..<icu_chain>
571 Specifies a variable that will be inherited by all targets defined in settings
573 <set name="test" value="en"..<set>
580 <term>settings</term>
583 Specifies target settings for this service. Refer to
584 <xref linkend="target_settings"/>.
593 Specifies timeout parameters for this service.
594 The <literal>timeout</literal>
595 element supports the following attributes:
596 <literal>session</literal>, <literal>z3950_operation</literal>,
597 <literal>z3950_session</literal> which specifies
598 'session timeout', 'Z39.50 operation timeout',
599 'Z39.50 session timeout' respectively. The Z39.50 operation
600 timeout is the time Pazpar2 will wait for an active Z39.50/SRU
601 operation before it gives up (times out). The Z39.50 session
602 time out is the time Pazpar2 will keep the session alive for
603 an idle session (no operation).
606 The following is recommended but not required:
607 z3950_operation (30) < session (60) < z3950_session (180) .
608 The default values are given in parantheses.
612 </variablelist> <!-- Data elements in service directive -->
615 </variablelist> <!-- Data elements in server directive -->
620 <title>EXAMPLE</title>
622 Below is a working example configuration:
626 <?xml version="1.0" encoding="UTF-8"?>
627 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
629 <threads number="10"/>
631 <listen port="9004"/>
633 <metadata name="title" brief="yes" sortkey="skiparticle"
634 merge="longest" rank="6"/>
635 <metadata name="isbn" merge="unique"/>
636 <metadata name="date" brief="yes" sortkey="numeric"
637 type="year" merge="range" termlist="yes"/>
638 <metadata name="author" brief="yes" termlist="yes"
639 merge="longest" rank="2"/>
640 <metadata name="subject" merge="unique" termlist="yes" rank="3" limitmap="local:"/>
641 <metadata name="url" merge="unique"/>
642 <icu_chain id="relevance" locale="el">
643 <transform rule="[:Control:] Any-Remove"/>
645 <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
648 <settings src="mysettings"/>
649 <timeout session="60"/>
657 <refsect1 id="config-include">
658 <title>INCLUDE FACILITY</title>
660 The XML configuration may be partitioned into multiple files by using
661 the <literal>include</literal> element which takes a single attribute,
662 <literal>src</literal>. The of the <literal>src</literal> attribute is
663 regular Shell like glob-pattern. For example,
665 <include src="/etc/pazpar2/conf.d/*.xml"/>
669 The include facility requires Pazpar2 version 1.2.
673 <refsect1 id="target_settings">
674 <title>TARGET SETTINGS</title>
676 Pazpar2 features a cunning scheme by which you can associate various
677 kinds of attributes, or settings with search targets. This can be done
678 through XML files which are read at startup; each file can associate
679 one or more settings with one or more targets. The file format is generic
680 in nature, designed to support a wide range of application requirements. The
681 settings can be purely technical things, like, how to perform a title
682 search against a given target, or it can associate arbitrary name=value
683 pairs with groups of targets -- for instance, if you would like to
684 place all commercial full-text bases in one group for selection
685 purposes, or you would like to control what targets are accessible
686 to users by default. Per-database settings values can even be used
687 to drive sorting, facet/termlist generation, or end-user interface display
692 During startup, Pazpar2 will recursively read a specified directory
693 (can be identified in the pazpar2.cfg file or on the command line), and
694 process any settings files found therein.
698 Clients of the Pazpar2 webservice interface can selectively override
699 settings for individual targets within the scope of one session. This
700 can be used in conjunction with an external authentication system to
701 determine which resources are to be accessible to which users. Pazpar2
702 itself has no notion of end-users, and so can be used in conjunction
703 with any type of authentication system. Similarly, the authentication
704 tokens submitted to access-controlled search targets can similarly be
705 overridden, to allow use of Pazpar2 in a consortial or multi-library
706 environment, where different end-users may need to be represented to
707 some search targets in different ways. This, again, can be managed
708 using an external database or other lookup mechanism. Setting overrides
709 can be performed either using the
710 <link linkend="command-init">init</link> or the
711 <link linkend="command-settings">settings</link> webservice
716 In fact, every setting that applies to a database (except pz:id, which
717 can only be used for filtering targets to use for a search) can be overridden
718 on a per-session basis. This allows the client to override specific CCL fields
719 for searching, etc., to meet the needs of a session or user.
723 Finally, as an extreme case of this, the webservice client can
724 introduce entirely new targets, on the fly, as part of the
725 <link linkend="command-init">init</link> or
726 <link linkend="command-settings">settings</link> command.
727 This is useful if you desire to manage information
728 about your search targets in a separate application such as a database.
729 You do not need any static settings file whatsoever to run Pazpar2 -- as
730 long as the webservice client is prepared to supply the necessary
731 information at the beginning of every session.
736 The following discussion of practical issues related to session
737 and settings management are cast in terms of a user interface based on
738 Ajax/Javascript technology. It would apply equally well to many other
739 kinds of browser-based logic.
744 Typically, a Javascript client is not allowed to directly alter the
745 parameters of a session. There are two reasons for this. One has to do
746 with access to information; typically, information about a user will
747 be stored in a system on the server side, or it will be accessible in
748 some way from the server. However, since the Javascript client cannot
749 be entirely trusted (some hostile agent might in fact 'pretend' to be
750 a regular ws client), it is more robust to control session settings
751 from scripting that you run as part of your webserver. Typically, this
752 can be handled during the session initialization, as follows:
756 Step 1: The Javascript client loads, and asks the webserver for a
757 new Pazpar2 session ID. This can be done using a Javascript call, for
758 instance. Note that it is possible to submit Ajax HTTPXmlRequest calls
759 either to Pazpar2 or to the webserver that Pazpar2 is proxying
760 for. See (XXX Insert link to Pazpar2 protocol).
764 Step 2: Code on the webserver authenticates the user, by database lookup,
765 LDAP access, NCIP, etc. Determines which resources the user has access to,
766 and any user-specific parameters that are to be applied during this session.
770 Step 3: The webserver initializes a new Pazpar2 settings, and sets
771 user-specific parameters as necessary, using the init webservice
772 command. A new session ID is returned.
776 Step 4: The webserver returns this session ID to the Javascript
777 client, which then uses the session ID to submit searches, show
782 Step 5: When the Javascript client ceases to use the session,
783 Pazpar2 destroys any session-specific information.
787 <title>SETTINGS FILE FORMAT</title>
789 Each file contains a root element named <settings>. It may
790 contain one or more <set> elements. The settings and set
791 elements may contain the following attributes. Attributes in the set
792 node overrides those in the setting root element. Each set node must
793 specify (directly, or inherited from the parent node) at least a
794 target, name, and value.
802 This specifies the search target to which this setting should be
803 applied. Targets are identified by their Z39.50 URL, generally
804 including the host, port, and database name, (e.g.
805 <literal>bagel.indexdata.com:210/marc</literal>).
806 Two wildcard forms are accepted:
807 * (asterisk) matches all known targets;
808 <literal>bagel.indexdata.com:210/*</literal> matches all
809 known databases on the given host.
812 A precedence system determines what happens if there are
813 overlapping values for the same setting name for the same
814 target. A setting for a specific target name overrides a
815 setting which specifies target using a wildcard. This makes it
816 easy to set defaults for all targets, and then override them
817 for specific targets or hosts. If there are
818 multiple overlapping settings with the same name and target
819 value, the 'precedence' attribute determines what happens.
822 For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
823 which case, the actual host, port, etc is given by setting
824 <xref linkend="pzurl"/>.
832 The name of the setting. This can be anything you like.
833 However, Pazpar2 reserves a number of setting names for
834 specific purposes, all starting with 'pz:', and it is a good
835 idea to avoid that prefix if you make up your own setting
836 names. See below for a list of reserved variables.
844 The value of the setting. Generally, this can be anything you
845 want -- however, some of the reserved settings may expect
846 specific kinds of values.
851 <term>precedence</term>
854 This should be an integer. If not provided, the default value
855 is 0. If two (or more) settings have the same content for
856 target and name, the precedence value determines the outcome.
857 If both settings have the same precedence value, they are both
858 applied to the target(s). If one has a higher value, then the
859 value of that setting is applied, and the other one is ignored.
866 By setting defaults for target, name, or value in the root
867 settings node, you can use the settings files in many different
868 ways. For instance, you can use a single file to set defaults for
869 many different settings, like search fields, retrieval syntaxes,
870 etc. You can have one file per server, which groups settings for
871 that server or target. You could also have one file which associates
872 a number of targets with a given setting, for instance, to associate
873 many databases with a given category or class that makes sense
874 within your application.
878 The following examples illustrate uses of the settings system to
879 associate settings with targets to meet different requirements.
883 The example below associates a set of default values that can be
884 used across many targets. Note the wildcard for targets.
885 This associates the given settings with all targets for which no
886 other information is provided.
888 <settings target="*">
890 <!-- This file introduces default settings for pazpar2 -->
892 <!-- mapping for unqualified search -->
893 <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
895 <!-- field-specific mappings -->
896 <set name="pz:cclmap:ti" value="u=4 s=al"/>
897 <set name="pz:cclmap:su" value="u=21 s=al"/>
898 <set name="pz:cclmap:isbn" value="u=7"/>
899 <set name="pz:cclmap:issn" value="u=8"/>
900 <set name="pz:cclmap:date" value="u=30 r=r"/>
902 <set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
903 <set name="pz:limitmap:date" value="ccl:date"/>
905 <!-- Retrieval settings -->
907 <set name="pz:requestsyntax" value="marc21"/>
908 <set name="pz:elements" value="F"/>
910 <!-- Query encoding -->
911 <set name="pz:queryencoding" value="iso-8859-1"/>
913 <!-- Result normalization settings -->
915 <set name="pz:nativesyntax" value="iso2709"/>
916 <set name="pz:xslt" value="../etc/marc21.xsl"/>
924 The next example shows certain settings overridden for one target,
925 one which returns XML records containing DublinCore elements, and
926 which furthermore requires a username/password.
928 <settings target="funkytarget.com:210/db1">
929 <set name="pz:requestsyntax" value="xml"/>
930 <set name="pz:nativesyntax" value="xml"/>
931 <set name="pz:xslt" value="../etc/dublincore.xsl"/>
933 <set name="pz:authentication" value="myuser/password"/>
939 The following example associates a specific name/value combination
940 with a number of targets. The targets below are access-restricted,
941 and can only be used by users with special credentials.
943 <settings name="pz:allow" value="0">
944 <set target="funkytarget.com:210/*"/>
945 <set target="commercial.com:2100/expensiveDb"/>
953 <title>RESERVED SETTING NAMES</title>
955 The following setting names are reserved by Pazpar2 to control the
956 behavior of the client function.
961 <term>pz:cclmap:xxx</term>
964 This establishes a CCL field definition or other setting, for
965 the purpose of mapping end-user queries. XXX is the field or
966 setting name, and the value of the setting provides parameters
967 (e.g. parameters to send to the server, etc.). Please consult
968 the YAZ manual for a full overview of the many capabilities of
969 the powerful and flexible CCL parser.
972 Note that it is easy to establish a set of default parameters,
973 and then override them individually for a given target.
977 <varlistentry id="requestsyntax">
978 <term>pz:requestsyntax</term>
981 This specifies the record syntax to use when requesting
982 records from a given server. The value can be a symbolic name like
983 marc21 or xml, or it can be a Z39.50-style dot-separated OID.
988 <term>pz:elements</term>
991 The element set name to be used when retrieving records from a
997 <term>pz:piggyback</term>
1000 Piggybacking enables the server to retrieve records from the
1001 server as part of the search response in Z39.50. Almost all
1002 servers support this (or fail it gracefully), but a few
1003 servers will produce undesirable results.
1004 Set to '1' to enable piggybacking, '0' to disable it. Default
1005 is 1 (piggybacking enabled).
1010 <term>pz:nativesyntax</term>
1013 Specifies how Pazpar2 shoule map retrieved records to XML. Currently
1014 supported values are <literal>xml</literal>,
1015 <literal>iso2709</literal> and <literal>txml</literal>.
1018 The value <literal>iso2709</literal> makes Pazpar2 convert retrieved
1019 MARC records to MARCXML. In order to convert to XML, the exact
1020 chacater set of the MARC must be known (if not, the resulting
1021 XML is probably not well-formed). The character set may be
1022 specified by adding:
1023 <literal>;charset=</literal><replaceable>charset</replaceable> to
1024 <literal>iso2709</literal>. If omitted, a charset of
1025 MARC-8 is assumed. This is correct for most MARC21/USMARC records.
1028 The value <literal>txml</literal> is like <literal>iso2709</literal>
1029 except that records are converted to TurboMARC instead of MARCXML.
1032 The value <literal>xml</literal> is used if Pazpar2 retrieves
1033 records that are already XML (no conversion takes place).
1039 <term>pz:queryencoding</term>
1042 The encoding of the search terms that a target accepts. Most
1043 targets do not honor UTF-8 in which case this needs to be specified.
1044 Each term in a query will be converted if this setting is given.
1050 <term>pz:negotiation_charset</term>
1053 Sets character set for Z39.50 negotiation. Most targets do not support
1054 this, and some will even close connection if set (crash on server
1055 side or similar). If set, you probably want to set it to
1056 <literal>UTF-8</literal>.
1062 <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
1065 Is a comma separated list of of stylesheet names that specifies
1066 how to convert incoming records to the internal representation.
1069 For each name, the embedded stylesheets (XSL) that comes with the
1070 service definition are consulted first and takes precedence over
1071 external files; see <xref linkend="servicexslt"/>
1072 of service definition).
1073 If the name does not match an embedded stylesheet it is
1074 considered a filename.
1077 The suffix of each file specifies the kind of tranformation.
1078 Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
1079 "<literal>.mmap</literal>" will use the MMAP transform (described below).
1082 The special value "<literal>auto</literal>" will use a file
1083 which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
1085 <literal>'.xsl'</literal>.
1088 When mapping MARC records, XSLT can be bypassed for increased
1089 performance with the alternate "MARC map" format. Provide the
1090 path of a file with extension ".mmap" containing on each line:
1092 <field> <subfield> <metadata element></programlisting>
1099 To map the field value specify a subfield of '$'. To store a
1100 concatenation of all subfields, specify a subfield of '*'.
1105 <term>pz:authentication</term>
1108 Sets an authentication string for a given server. See the section on
1109 authorization and authentication for discussion.
1114 <term>pz:allow</term>
1117 Allows or denies access to the resources it is applied to. Possible
1118 values are '0' and '1'.
1119 The default is '1' (allow access to this resource).
1120 See the manual section on authorization and authentication for
1121 discussion about how to use this setting.
1126 <term>pz:maxrecs</term>
1129 Controls the maximum number of records to be retrieved from a
1130 server. The default is 100.
1135 <term>pz:presentchunk</term>
1138 Controls the chunk size in present requests. Pazpar2 will
1139 make (maxrecs / chunk) request(s). The default is 20.
1147 This setting can't be 'set' -- it contains the ID (normally
1148 ZURL) for a given target, and is useful for filtering --
1149 specifically when you want to select one or more specific
1150 targets in the search command.
1155 <term>pz:zproxy</term>
1158 The 'pz:zproxy' setting has the value syntax
1159 'host.internet.adress:port', it is used to tunnel Z39.50
1160 requests through the named Z39.50 proxy.
1166 <term>pz:apdulog</term>
1169 If the 'pz:apdulog' setting is defined and has other value than 0,
1170 then Z39.50 APDUs are written to the log.
1179 This setting enables
1180 <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
1182 It has four possible settings.
1183 'get', enables SRU access through GET requests. 'post' enables SRU/POST
1184 support, less commonly supported, but useful if very large requests are
1185 to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
1189 A value of 'solr' enables Solr client support. This is supported
1190 for Pazpar version 1.5.0 and later.
1196 <term>pz:sru_version</term>
1199 This allows SRU version to be specified. If unset Pazpar2
1200 will the default of YAZ (currently 1.2). Should be set
1201 to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
1207 <term>pz:pqf_prefix</term>
1210 Allows you to specify an arbitrary PQF query language substring.
1211 The provided string is prefixed to the user's query after it has been
1212 normalized to PQF internally in pazpar2.
1213 This allows you to attach complex 'filters' to queries for a given
1214 target, sometimes necessary to select sub-catalogs
1215 in union catalog systems, etc.
1221 <term>pz:pqf_strftime</term>
1224 Allows you to extend a query with dates and operators.
1225 The provided string allows certain substitutions and serves as a
1227 The special two character sequence '%%' gets converted to the
1228 original query. Other characters leading with the percent sign are
1229 conversions supported by strftime.
1230 All other characters are copied verbatim. For example, the string
1231 <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
1232 would search for current year combined with the original PQF (%%).
1235 This setting can also be used as more general alternative to
1236 pz:pqf_prefix -- a way of embedding the submitted query
1237 anywhere in the string rather than appending it to prefix. For
1238 example, if it is desired to omit all records satisfying the
1239 query <literal>@attr 1=pica.bib 0007</literal> then this
1240 subquery can be combined with the submitted query as the second
1241 argument of <literal>@andnot</literal> by using the
1242 pz:pqf_strftime value <literal>@not %% @attr 1=pica.bib
1249 <term>pz:sort</term>
1252 Specifies sort criteria to be applied to the result set.
1253 Only works for targets which support the sort service.
1259 <term>pz:recordfilter</term>
1262 Specifies a filter which allows Pazpar2 to only include
1263 records that meet a certain criteria in a result.
1264 Unmatched records will be ignored.
1265 The filter takes the form name, name~value, or name=value, which
1266 will include only records with metadata element (name) that has the
1267 substring (~value) given, or matches exactly (=value).
1268 If value is omitted all records with the named metadata element
1269 present will be included.
1275 <term>pz:preferred</term>
1278 Specifies that a target is preferred, e.g. possible local, faster
1279 target. Using block=pref on show command will wait for all these
1280 targets to return records before releasing the block.
1281 If no target is preferred, the block=pref will identical to block=1,
1282 which release when one target has returned records.
1287 <term>pz:block_timeout</term>
1290 (Not yet implemented).
1291 Specifies the time for which a block should be released anyway.
1296 <term>pz:termlist_term_count</term>
1299 Specifies number of facet terms to be requested from the target.
1300 The default is unspecified e.g. server-decided. Also see pz:facetmap.
1305 <term>pz:termlist_term_factor</term>
1308 Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
1309 When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
1310 facet with native (target-generated) facets, the later will dominated the dominate the facet list
1311 since they are generated based on the complete result set.
1312 By scaling up the facet count using the ratio between total hit count and the sample size,
1313 the total facet count can be approximated and thus better compared with native facets.
1314 This is not enabled by default.
1320 <term>pz:facetmap:<replaceable>name</replaceable></term>
1323 Specifies that for field <replaceable>name</replaceable>, the target
1324 supports (native) facets. The value is the name of the
1325 field on the target.
1329 At this point only Solr targets have been tested with this
1336 <varlistentry id="limitmap">
1337 <term>pz:limitmap:<replaceable>name</replaceable></term>
1340 Specifies attributes for limiting a search to a field - using
1341 the limit parameter for search. It can be used to filter locally
1342 or remotely (search in a target). In some cases the mapping of
1343 a field to a value is identical to an existing cclmap field; in
1344 other cases the field must be specified in a different way - for
1345 example to match a complete field (rather than parts of a subfield).
1348 The value of limitmap may have one of three forms: referral to
1349 an existing CCL field, a raw PQF string or a local limit. Leading string
1350 determines type; either <literal>ccl:</literal> for CCL field,
1351 <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
1352 for filtering in Pazpar2. The local filtering may be followed
1353 by a field a metadata field (default is to use the name of the
1358 The limitmap facility is supported for Pazpar2 version 1.6.0.
1359 Local filtering is supported in Pazpar2 1.6.6.
1365 <varlistentry id="pzurl">
1369 Specifies URL for the target and overrides the target ID.
1373 <literal>pz:url</literal> is only recognized for
1374 Pazpar2 1.6.4 and later.
1380 <varlistentry id="pzsortmap">
1381 <term>pz:sortmap:<replaceable>field</replaceable></term>
1384 Specifies native sorting for a target where
1385 <replaceable>field</replaceable> is a sort criteria (see command
1386 show). The value has to components separated by colon: strategy and
1387 native-field. Strategy is one of <literal>z3950</literal>,
1388 <literal>type7</literal>, <literal>cql</literal>,
1389 <literal>sru11</literal>, or <literal>embed</literal>.
1390 The second component, native-field, is the field that is recognized
1395 Only supported for Pazpar2 1.6.4 and later.
1407 <title>SEE ALSO</title>
1410 <refentrytitle>pazpar2</refentrytitle>
1411 <manvolnum>8</manvolnum>
1414 <refentrytitle>yaz-icu</refentrytitle>
1415 <manvolnum>1</manvolnum>
1418 <refentrytitle>pazpar2_protocol</refentrytitle>
1419 <manvolnum>7</manvolnum>
1424 <!-- Keep this comment at the end of the file
1427 nxml-child-indent: 1