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>
568 <term>ccldirective</term>
571 Customizes the CCL parsing (interpretation of query parameter
573 The name and value of the CCL directive is gigen by attributes
574 'name' and 'value' respectively. Refer to possible list of names
577 url="http://www.indexdata.com/yaz/doc/tools.html#ccl.directives.table">
588 Customizes the ranking (relevance) algorithm.
589 Attribute 'cluster' is a boolean
590 that controls whether Pazpar2 should boost ranking for merged
591 records. Is 'yes' by default. A value of 'no' will make
592 Pazpar2 average ranking of each record in a cluster.
595 This configuration was added in pazpar2 1.6.18.
600 <varlistentry id="sort-default">
601 <term>sort-default</term>
604 Specifies the default sort criteria (default 'relevance'),
605 which previous was hard-coded as default criteria in search.
606 This is a fix/work-around to avoid re-searching when using
607 target-based sorting. In order for this to work efficient,
608 the search must also have the sort critera parameter; otherwise
609 pazpar2 will do re-searching on search criteria changes, if
610 changed between search and show command.
613 This configuration was added in pazpar2 1.6.20.
623 Specifies a variable that will be inherited by all targets defined in settings
625 <set name="test" value="en"..<set>
632 <term>settings</term>
635 Specifies target settings for this service. Refer to
636 <xref linkend="target_settings"/>.
645 Specifies timeout parameters for this service.
646 The <literal>timeout</literal>
647 element supports the following attributes:
648 <literal>session</literal>, <literal>z3950_operation</literal>,
649 <literal>z3950_session</literal> which specifies
650 'session timeout', 'Z39.50 operation timeout',
651 'Z39.50 session timeout' respectively. The Z39.50 operation
652 timeout is the time Pazpar2 will wait for an active Z39.50/SRU
653 operation before it gives up (times out). The Z39.50 session
654 time out is the time Pazpar2 will keep the session alive for
655 an idle session (no operation).
658 The following is recommended but not required:
659 z3950_operation (30) < session (60) < z3950_session (180) .
660 The default values are given in parantheses.
664 </variablelist> <!-- Data elements in service directive -->
667 </variablelist> <!-- Data elements in server directive -->
672 <title>EXAMPLE</title>
674 Below is a working example configuration:
678 <?xml version="1.0" encoding="UTF-8"?>
679 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
681 <threads number="10"/>
683 <listen port="9004"/>
685 <metadata name="title" brief="yes" sortkey="skiparticle"
686 merge="longest" rank="6"/>
687 <metadata name="isbn" merge="unique"/>
688 <metadata name="date" brief="yes" sortkey="numeric"
689 type="year" merge="range" termlist="yes"/>
690 <metadata name="author" brief="yes" termlist="yes"
691 merge="longest" rank="2"/>
692 <metadata name="subject" merge="unique" termlist="yes" rank="3" limitmap="local:"/>
693 <metadata name="url" merge="unique"/>
694 <icu_chain id="relevance" locale="el">
695 <transform rule="[:Control:] Any-Remove"/>
697 <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
700 <settings src="mysettings"/>
701 <timeout session="60"/>
709 <refsect1 id="config-include">
710 <title>INCLUDE FACILITY</title>
712 The XML configuration may be partitioned into multiple files by using
713 the <literal>include</literal> element which takes a single attribute,
714 <literal>src</literal>. The of the <literal>src</literal> attribute is
715 regular Shell like glob-pattern. For example,
717 <include src="/etc/pazpar2/conf.d/*.xml"/>
721 The include facility requires Pazpar2 version 1.2.
725 <refsect1 id="target_settings">
726 <title>TARGET SETTINGS</title>
728 Pazpar2 features a cunning scheme by which you can associate various
729 kinds of attributes, or settings with search targets. This can be done
730 through XML files which are read at startup; each file can associate
731 one or more settings with one or more targets. The file format is generic
732 in nature, designed to support a wide range of application requirements. The
733 settings can be purely technical things, like, how to perform a title
734 search against a given target, or it can associate arbitrary name=value
735 pairs with groups of targets -- for instance, if you would like to
736 place all commercial full-text bases in one group for selection
737 purposes, or you would like to control what targets are accessible
738 to users by default. Per-database settings values can even be used
739 to drive sorting, facet/termlist generation, or end-user interface display
744 During startup, Pazpar2 will recursively read a specified directory
745 (can be identified in the pazpar2.cfg file or on the command line), and
746 process any settings files found therein.
750 Clients of the Pazpar2 webservice interface can selectively override
751 settings for individual targets within the scope of one session. This
752 can be used in conjunction with an external authentication system to
753 determine which resources are to be accessible to which users. Pazpar2
754 itself has no notion of end-users, and so can be used in conjunction
755 with any type of authentication system. Similarly, the authentication
756 tokens submitted to access-controlled search targets can similarly be
757 overridden, to allow use of Pazpar2 in a consortial or multi-library
758 environment, where different end-users may need to be represented to
759 some search targets in different ways. This, again, can be managed
760 using an external database or other lookup mechanism. Setting overrides
761 can be performed either using the
762 <link linkend="command-init">init</link> or the
763 <link linkend="command-settings">settings</link> webservice
768 In fact, every setting that applies to a database (except pz:id, which
769 can only be used for filtering targets to use for a search) can be overridden
770 on a per-session basis. This allows the client to override specific CCL fields
771 for searching, etc., to meet the needs of a session or user.
775 Finally, as an extreme case of this, the webservice client can
776 introduce entirely new targets, on the fly, as part of the
777 <link linkend="command-init">init</link> or
778 <link linkend="command-settings">settings</link> command.
779 This is useful if you desire to manage information
780 about your search targets in a separate application such as a database.
781 You do not need any static settings file whatsoever to run Pazpar2 -- as
782 long as the webservice client is prepared to supply the necessary
783 information at the beginning of every session.
788 The following discussion of practical issues related to session
789 and settings management are cast in terms of a user interface based on
790 Ajax/Javascript technology. It would apply equally well to many other
791 kinds of browser-based logic.
796 Typically, a Javascript client is not allowed to directly alter the
797 parameters of a session. There are two reasons for this. One has to do
798 with access to information; typically, information about a user will
799 be stored in a system on the server side, or it will be accessible in
800 some way from the server. However, since the Javascript client cannot
801 be entirely trusted (some hostile agent might in fact 'pretend' to be
802 a regular ws client), it is more robust to control session settings
803 from scripting that you run as part of your webserver. Typically, this
804 can be handled during the session initialization, as follows:
808 Step 1: The Javascript client loads, and asks the webserver for a
809 new Pazpar2 session ID. This can be done using a Javascript call, for
810 instance. Note that it is possible to submit Ajax HTTPXmlRequest calls
811 either to Pazpar2 or to the webserver that Pazpar2 is proxying
812 for. See (XXX Insert link to Pazpar2 protocol).
816 Step 2: Code on the webserver authenticates the user, by database lookup,
817 LDAP access, NCIP, etc. Determines which resources the user has access to,
818 and any user-specific parameters that are to be applied during this session.
822 Step 3: The webserver initializes a new Pazpar2 settings, and sets
823 user-specific parameters as necessary, using the init webservice
824 command. A new session ID is returned.
828 Step 4: The webserver returns this session ID to the Javascript
829 client, which then uses the session ID to submit searches, show
834 Step 5: When the Javascript client ceases to use the session,
835 Pazpar2 destroys any session-specific information.
839 <title>SETTINGS FILE FORMAT</title>
841 Each file contains a root element named <settings>. It may
842 contain one or more <set> elements. The settings and set
843 elements may contain the following attributes. Attributes in the set
844 node overrides those in the setting root element. Each set node must
845 specify (directly, or inherited from the parent node) at least a
846 target, name, and value.
854 This specifies the search target to which this setting should be
855 applied. Targets are identified by their Z39.50 URL, generally
856 including the host, port, and database name, (e.g.
857 <literal>bagel.indexdata.com:210/marc</literal>).
858 Two wildcard forms are accepted:
859 * (asterisk) matches all known targets;
860 <literal>bagel.indexdata.com:210/*</literal> matches all
861 known databases on the given host.
864 A precedence system determines what happens if there are
865 overlapping values for the same setting name for the same
866 target. A setting for a specific target name overrides a
867 setting which specifies target using a wildcard. This makes it
868 easy to set defaults for all targets, and then override them
869 for specific targets or hosts. If there are
870 multiple overlapping settings with the same name and target
871 value, the 'precedence' attribute determines what happens.
874 For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
875 which case, the actual host, port, etc is given by setting
876 <xref linkend="pzurl"/>.
884 The name of the setting. This can be anything you like.
885 However, Pazpar2 reserves a number of setting names for
886 specific purposes, all starting with 'pz:', and it is a good
887 idea to avoid that prefix if you make up your own setting
888 names. See below for a list of reserved variables.
896 The value of the setting. Generally, this can be anything you
897 want -- however, some of the reserved settings may expect
898 specific kinds of values.
903 <term>precedence</term>
906 This should be an integer. If not provided, the default value
907 is 0. If two (or more) settings have the same content for
908 target and name, the precedence value determines the outcome.
909 If both settings have the same precedence value, they are both
910 applied to the target(s). If one has a higher value, then the
911 value of that setting is applied, and the other one is ignored.
918 By setting defaults for target, name, or value in the root
919 settings node, you can use the settings files in many different
920 ways. For instance, you can use a single file to set defaults for
921 many different settings, like search fields, retrieval syntaxes,
922 etc. You can have one file per server, which groups settings for
923 that server or target. You could also have one file which associates
924 a number of targets with a given setting, for instance, to associate
925 many databases with a given category or class that makes sense
926 within your application.
930 The following examples illustrate uses of the settings system to
931 associate settings with targets to meet different requirements.
935 The example below associates a set of default values that can be
936 used across many targets. Note the wildcard for targets.
937 This associates the given settings with all targets for which no
938 other information is provided.
940 <settings target="*">
942 <!-- This file introduces default settings for pazpar2 -->
944 <!-- mapping for unqualified search -->
945 <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
947 <!-- field-specific mappings -->
948 <set name="pz:cclmap:ti" value="u=4 s=al"/>
949 <set name="pz:cclmap:su" value="u=21 s=al"/>
950 <set name="pz:cclmap:isbn" value="u=7"/>
951 <set name="pz:cclmap:issn" value="u=8"/>
952 <set name="pz:cclmap:date" value="u=30 r=r"/>
954 <set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
955 <set name="pz:limitmap:date" value="ccl:date"/>
957 <!-- Retrieval settings -->
959 <set name="pz:requestsyntax" value="marc21"/>
960 <set name="pz:elements" value="F"/>
962 <!-- Query encoding -->
963 <set name="pz:queryencoding" value="iso-8859-1"/>
965 <!-- Result normalization settings -->
967 <set name="pz:nativesyntax" value="iso2709"/>
968 <set name="pz:xslt" value="../etc/marc21.xsl"/>
976 The next example shows certain settings overridden for one target,
977 one which returns XML records containing DublinCore elements, and
978 which furthermore requires a username/password.
980 <settings target="funkytarget.com:210/db1">
981 <set name="pz:requestsyntax" value="xml"/>
982 <set name="pz:nativesyntax" value="xml"/>
983 <set name="pz:xslt" value="../etc/dublincore.xsl"/>
985 <set name="pz:authentication" value="myuser/password"/>
991 The following example associates a specific name/value combination
992 with a number of targets. The targets below are access-restricted,
993 and can only be used by users with special credentials.
995 <settings name="pz:allow" value="0">
996 <set target="funkytarget.com:210/*"/>
997 <set target="commercial.com:2100/expensiveDb"/>
1005 <title>RESERVED SETTING NAMES</title>
1007 The following setting names are reserved by Pazpar2 to control the
1008 behavior of the client function.
1013 <term>pz:cclmap:xxx</term>
1016 This establishes a CCL field definition or other setting, for
1017 the purpose of mapping end-user queries. XXX is the field or
1018 setting name, and the value of the setting provides parameters
1019 (e.g. parameters to send to the server, etc.). Please consult
1020 the YAZ manual for a full overview of the many capabilities of
1021 the powerful and flexible CCL parser.
1024 Note that it is easy to establish a set of default parameters,
1025 and then override them individually for a given target.
1029 <varlistentry id="requestsyntax">
1030 <term>pz:requestsyntax</term>
1033 This specifies the record syntax to use when requesting
1034 records from a given server. The value can be a symbolic name like
1035 marc21 or xml, or it can be a Z39.50-style dot-separated OID.
1040 <term>pz:elements</term>
1043 The element set name to be used when retrieving records from a
1049 <term>pz:piggyback</term>
1052 Piggybacking enables the server to retrieve records from the
1053 server as part of the search response in Z39.50. Almost all
1054 servers support this (or fail it gracefully), but a few
1055 servers will produce undesirable results.
1056 Set to '1' to enable piggybacking, '0' to disable it. Default
1057 is 1 (piggybacking enabled).
1062 <term>pz:nativesyntax</term>
1065 Specifies how Pazpar2 shoule map retrieved records to XML. Currently
1066 supported values are <literal>xml</literal>,
1067 <literal>iso2709</literal> and <literal>txml</literal>.
1070 The value <literal>iso2709</literal> makes Pazpar2 convert retrieved
1071 MARC records to MARCXML. In order to convert to XML, the exact
1072 chacater set of the MARC must be known (if not, the resulting
1073 XML is probably not well-formed). The character set may be
1074 specified by adding:
1075 <literal>;charset=</literal><replaceable>charset</replaceable> to
1076 <literal>iso2709</literal>. If omitted, a charset of
1077 MARC-8 is assumed. This is correct for most MARC21/USMARC records.
1080 The value <literal>txml</literal> is like <literal>iso2709</literal>
1081 except that records are converted to TurboMARC instead of MARCXML.
1084 The value <literal>xml</literal> is used if Pazpar2 retrieves
1085 records that are already XML (no conversion takes place).
1091 <term>pz:queryencoding</term>
1094 The encoding of the search terms that a target accepts. Most
1095 targets do not honor UTF-8 in which case this needs to be specified.
1096 Each term in a query will be converted if this setting is given.
1102 <term>pz:negotiation_charset</term>
1105 Sets character set for Z39.50 negotiation. Most targets do not support
1106 this, and some will even close connection if set (crash on server
1107 side or similar). If set, you probably want to set it to
1108 <literal>UTF-8</literal>.
1114 <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
1117 Is a comma separated list of of stylesheet names that specifies
1118 how to convert incoming records to the internal representation.
1121 For each name, the embedded stylesheets (XSL) that comes with the
1122 service definition are consulted first and takes precedence over
1123 external files; see <xref linkend="servicexslt"/>
1124 of service definition).
1125 If the name does not match an embedded stylesheet it is
1126 considered a filename.
1129 The suffix of each file specifies the kind of tranformation.
1130 Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
1131 "<literal>.mmap</literal>" will use the MMAP transform (described below).
1134 The special value "<literal>auto</literal>" will use a file
1135 which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
1137 <literal>'.xsl'</literal>.
1140 When mapping MARC records, XSLT can be bypassed for increased
1141 performance with the alternate "MARC map" format. Provide the
1142 path of a file with extension ".mmap" containing on each line:
1144 <field> <subfield> <metadata element></programlisting>
1151 To map the field value specify a subfield of '$'. To store a
1152 concatenation of all subfields, specify a subfield of '*'.
1157 <term>pz:authentication</term>
1160 Sets an authentication string for a given server. See the section on
1161 authorization and authentication for discussion.
1166 <term>pz:allow</term>
1169 Allows or denies access to the resources it is applied to. Possible
1170 values are '0' and '1'.
1171 The default is '1' (allow access to this resource).
1172 See the manual section on authorization and authentication for
1173 discussion about how to use this setting.
1178 <term>pz:maxrecs</term>
1181 Controls the maximum number of records to be retrieved from a
1182 server. The default is 100.
1187 <term>pz:presentchunk</term>
1190 Controls the chunk size in present requests. Pazpar2 will
1191 make (maxrecs / chunk) request(s). The default is 20.
1199 This setting can't be 'set' -- it contains the ID (normally
1200 ZURL) for a given target, and is useful for filtering --
1201 specifically when you want to select one or more specific
1202 targets in the search command.
1207 <term>pz:zproxy</term>
1210 The 'pz:zproxy' setting has the value syntax
1211 'host.internet.adress:port', it is used to tunnel Z39.50
1212 requests through the named Z39.50 proxy.
1218 <term>pz:apdulog</term>
1221 If the 'pz:apdulog' setting is defined and has other value than 0,
1222 then Z39.50 APDUs are written to the log.
1231 This setting enables
1232 <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
1234 It has four possible settings.
1235 'get', enables SRU access through GET requests. 'post' enables SRU/POST
1236 support, less commonly supported, but useful if very large requests are
1237 to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
1241 A value of 'solr' enables Solr client support. This is supported
1242 for Pazpar version 1.5.0 and later.
1248 <term>pz:sru_version</term>
1251 This allows SRU version to be specified. If unset Pazpar2
1252 will the default of YAZ (currently 1.2). Should be set
1253 to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
1259 <term>pz:pqf_prefix</term>
1262 Allows you to specify an arbitrary PQF query language substring.
1263 The provided string is prefixed to the user's query after it has been
1264 normalized to PQF internally in pazpar2.
1265 This allows you to attach complex 'filters' to queries for a given
1266 target, sometimes necessary to select sub-catalogs
1267 in union catalog systems, etc.
1273 <term>pz:pqf_strftime</term>
1276 Allows you to extend a query with dates and operators.
1277 The provided string allows certain substitutions and serves as a
1279 The special two character sequence '%%' gets converted to the
1280 original query. Other characters leading with the percent sign are
1281 conversions supported by strftime.
1282 All other characters are copied verbatim. For example, the string
1283 <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
1284 would search for current year combined with the original PQF (%%).
1287 This setting can also be used as more general alternative to
1288 pz:pqf_prefix -- a way of embedding the submitted query
1289 anywhere in the string rather than appending it to prefix. For
1290 example, if it is desired to omit all records satisfying the
1291 query <literal>@attr 1=pica.bib 0007</literal> then this
1292 subquery can be combined with the submitted query as the second
1293 argument of <literal>@andnot</literal> by using the
1294 pz:pqf_strftime value <literal>@not %% @attr 1=pica.bib
1301 <term>pz:sort</term>
1304 Specifies sort criteria to be applied to the result set.
1305 Only works for targets which support the sort service.
1311 <term>pz:recordfilter</term>
1314 Specifies a filter which allows Pazpar2 to only include
1315 records that meet a certain criteria in a result.
1316 Unmatched records will be ignored.
1317 The filter takes the form name, name~value, or name=value, which
1318 will include only records with metadata element (name) that has the
1319 substring (~value) given, or matches exactly (=value).
1320 If value is omitted all records with the named metadata element
1321 present will be included.
1327 <term>pz:preferred</term>
1330 Specifies that a target is preferred, e.g. possible local, faster
1331 target. Using block=pref on show command will wait for all these
1332 targets to return records before releasing the block.
1333 If no target is preferred, the block=pref will identical to block=1,
1334 which release when one target has returned records.
1339 <term>pz:block_timeout</term>
1342 (Not yet implemented).
1343 Specifies the time for which a block should be released anyway.
1348 <term>pz:termlist_term_count</term>
1351 Specifies number of facet terms to be requested from the target.
1352 The default is unspecified e.g. server-decided. Also see pz:facetmap.
1357 <term>pz:termlist_term_factor</term>
1360 Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
1361 When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
1362 facet with native (target-generated) facets, the later will dominated the dominate the facet list
1363 since they are generated based on the complete result set.
1364 By scaling up the facet count using the ratio between total hit count and the sample size,
1365 the total facet count can be approximated and thus better compared with native facets.
1366 This is not enabled by default.
1372 <term>pz:facetmap:<replaceable>name</replaceable></term>
1375 Specifies that for field <replaceable>name</replaceable>, the target
1376 supports (native) facets. The value is the name of the
1377 field on the target.
1381 At this point only Solr targets have been tested with this
1388 <varlistentry id="limitmap">
1389 <term>pz:limitmap:<replaceable>name</replaceable></term>
1392 Specifies attributes for limiting a search to a field - using
1393 the limit parameter for search. It can be used to filter locally
1394 or remotely (search in a target). In some cases the mapping of
1395 a field to a value is identical to an existing cclmap field; in
1396 other cases the field must be specified in a different way - for
1397 example to match a complete field (rather than parts of a subfield).
1400 The value of limitmap may have one of three forms: referral to
1401 an existing CCL field, a raw PQF string or a local limit. Leading string
1402 determines type; either <literal>ccl:</literal> for CCL field,
1403 <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
1404 for filtering in Pazpar2. The local filtering may be followed
1405 by a field a metadata field (default is to use the name of the
1410 The limitmap facility is supported for Pazpar2 version 1.6.0.
1411 Local filtering is supported in Pazpar2 1.6.6.
1417 <varlistentry id="pzurl">
1421 Specifies URL for the target and overrides the target ID.
1425 <literal>pz:url</literal> is only recognized for
1426 Pazpar2 1.6.4 and later.
1432 <varlistentry id="pzsortmap">
1433 <term>pz:sortmap:<replaceable>field</replaceable></term>
1436 Specifies native sorting for a target where
1437 <replaceable>field</replaceable> is a sort criteria (see command
1438 show). The value has to components separated by colon: strategy and
1439 native-field. Strategy is one of <literal>z3950</literal>,
1440 <literal>type7</literal>, <literal>cql</literal>,
1441 <literal>sru11</literal>, or <literal>embed</literal>.
1442 The second component, native-field, is the field that is recognized
1447 Only supported for Pazpar2 1.6.4 and later.
1459 <title>SEE ALSO</title>
1462 <refentrytitle>pazpar2</refentrytitle>
1463 <manvolnum>8</manvolnum>
1466 <refentrytitle>yaz-icu</refentrytitle>
1467 <manvolnum>1</manvolnum>
1470 <refentrytitle>pazpar2_protocol</refentrytitle>
1471 <manvolnum>7</manvolnum>
1476 <!-- Keep this comment at the end of the file
1479 nxml-child-indent: 1