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
326 Pazpar 1.6.24 also offers a new value for merge, 'first', which
327 is like 'all' but only takes all from first database that returns
328 the particular metadata field.
334 <term>mergekey</term>
337 If set to '<literal>required</literal>', the value of this
338 metadata element is appended to the resulting mergekey if
339 the metadata is present in a record instance.
340 If the metadata element is not present, the a unique mergekey
341 will be generated instead.
344 If set to '<literal>optional</literal>', the value of this
345 metadata element is appended to the resulting mergekey if the
346 the metadata is present in a record instance. If the metadata
347 is not present, it will be empty.
350 If set to '<literal>no</literal>' or the mergekey attribute is
351 omitted, the metadata will not be used in the creation of a
358 <term id="facetrule">facetrule</term>
361 Specifies the ICU rule set to be used for normalizing
362 facets. If facetrule is omitted from metadata, the
363 rule set 'facet' is used.
369 <term id="limitcluster">limitcluster</term>
372 Allow a limit on merged metadata. The value of this attribute
373 is the name of actual metadata content to be used for matching
374 (most often same name as metadata name).
378 Requires Pazpar2 1.6.23 or later.
385 <term id="metadata_limitmap">limitmap</term>
388 Specifies a default limitmap for this field. This is to avoid mass
389 configuring of targets. However it is important to review/do this on a per
390 target since it is usually target-specific. See limitmap for format.
396 <term id="metadata_facetmap">facetmap</term>
399 Specifies a default facetmap for this field. This is to avoid mass
400 configuring of targets. However it is important to review/do this on a per
401 target since it is usually target-specific. See facetmap for format.
410 This attribute allows you to make use of static database
411 settings in the processing of records. Three possible values
412 are allowed. 'no' is the default and doesn't do anything.
413 'postproc' copies the value of a setting with the same name
414 into the output of the normalization stylesheet(s). 'parameter'
415 makes the value of a setting with the same name available
416 as a parameter to the normalization stylesheet, so you
417 can further process the value inside of the stylesheet, or use
418 the value to decide how to deal with other data values.
421 The purpose of using settings in this way can either be to
422 control the behavior of normalization stylesheet in a database-
423 dependent way, or to easily make database-dependent values
424 available to display-logic in your user interface, without having
425 to implement complicated interactions between the user interface
426 and your configuration system.
431 </variablelist> <!-- attributes to metadata -->
437 <term id="servicexslt" xreflabel="xslt">xslt</term>
440 Defines a XSLT stylesheet. The <literal>xslt</literal>
441 element takes exactly one attribute <literal>id</literal>
442 which names the stylesheet. This can be referred to in target
443 settings <xref linkend="pzxslt"/>.
446 The content of the xslt element is the embedded stylesheet XML
451 <term id="icuchain" xreflabel="icu_chain">icu_chain</term>
454 Specifies a named ICU rule set. The icu_chain element must include
455 attribute 'id' which specifies the identifier (name) for the ICU
457 Pazpar2 uses the particular rule sets for particular purposes.
458 Rule set 'relevance' is used to normalize
459 terms for relevance ranking. Rule set 'sort' is used to
460 normalize terms for sorting. Rule set 'mergekey' is used to
461 normalize terms for making a mergekey and, finally. Rule set 'facet'
462 is normally used to normalize facet terms, unless
463 <xref linkend="facetrule">facetrule</xref> is given for a
467 The icu_chain element must also include a 'locale'
468 attribute which must be set to one of the locale strings
469 defined in ICU. The child elements listed below can be
470 in any order, except the 'index' element which logically
471 belongs to the end of the list. The stated tokenization,
472 transformation and charmapping instructions are performed
473 in order from top to bottom.
475 <variablelist> <!-- Level 2 -->
480 The attribute 'rule' defines the direction of the
481 per-character casemapping, allowed values are "l"
482 (lower), "u" (upper), "t" (title).
487 <term>transform</term>
490 Normalization and transformation of tokens follows
491 the rules defined in the 'rule' attribute. For
492 possible values we refer to the extensive ICU
493 documentation found at the
494 <ulink url="&url.icu.transform;">ICU
495 transformation</ulink> home page. Set filtering
496 principles are explained at the
497 <ulink url="&url.icu.unicode.set;">ICU set and
498 filtering</ulink> page.
503 <term>tokenize</term>
506 Tokenization is the only rule in the ICU chain
507 which splits one token into multiple tokens. The
508 'rule' attribute may have the following values:
509 "s" (sentence), "l" (line-break), "w" (word), and
510 "c" (character), the later probably not being
511 very useful in a pruning Pazpar2 installation.
517 From Pazpar2 version 1.1 the ICU wrapper from YAZ is used.
518 Refer to the <ulink url="&url.yaz.yaz-icu;">yaz-icu</ulink>
519 utility for more information.
525 <term>relevance</term>
528 Specifies the ICU rule set used for relevance ranking.
529 The child element of 'relevance' must be 'icu_chain' and the
530 'id' attribute of the icu_chain is ignored. This
531 definition is obsolete and should be replaced by the equivalent
534 <icu_chain id="relevance" locale="en">..<icu_chain>
544 Specifies the ICU rule set used for sorting.
545 The child element of 'sort' must be 'icu_chain' and the
546 'id' attribute of the icu_chain is ignored. This
547 definition is obsolete and should be replaced by the equivalent
550 <icu_chain id="sort" locale="en">..<icu_chain>
557 <term>mergekey</term>
560 Specifies ICU tokenization and transformation rules
561 for tokens that are used in Pazpar2's mergekey.
562 The child element of 'mergekey' must be 'icu_chain' and the
563 'id' attribute of the icu_chain is ignored. This
564 definition is obsolete and should be replaced by the equivalent
567 <icu_chain id="mergekey" locale="en">..<icu_chain>
577 Specifies ICU tokenization and transformation rules
578 for tokens that are used in Pazpar2's facets.
579 The child element of 'facet' must be 'icu_chain' and the
580 'id' attribute of the icu_chain is ignored. This
581 definition is obsolete and should be replaced by the equivalent
584 <icu_chain id="facet" locale="en">..<icu_chain>
591 <term>ccldirective</term>
594 Customizes the CCL parsing (interpretation of query parameter
596 The name and value of the CCL directive is gigen by attributes
597 'name' and 'value' respectively. Refer to possible list of names
600 url="http://www.indexdata.com/yaz/doc/tools.html#ccl.directives.table">
611 Customizes the ranking (relevance) algorithm. Also known as
612 rank tweaks. The rank element
613 accepts the following attributes - all being optional:
620 Attribute 'cluster' is a boolean
621 that controls whether Pazpar2 should boost ranking for merged
622 records. Is 'yes' by default. A value of 'no' will make
623 Pazpar2 average ranking of each record in a cluster.
631 Attribute 'debug' is a boolean
632 that controls whether Pazpar2 should include details
633 about ranking for each document in the show command's
634 response. Enable by using value "yes", disable by using
635 value "no" (default).
643 Attribute 'follow' is a a floating point number greater than
644 or equal to 0. A positive number will boost weight for terms
645 that occur close to each other (proximity, distance).
646 A value of 1, will double the weight if two terms are in
647 proximity distance of 1 (next to each other). The default
648 value of 'follow' is 0 (order will not affect weight).
656 Attribute 'lead' is a floating point number.
657 It controls if term weight should be reduced by position
658 from start in a metadata field. A positive value of 'lead'
659 will reduce weight as it apperas further away from the lead
660 of the field. Default value is 0 (no reduction of weight by
669 Attribute 'length' determines how/if term weight should be
670 divided by lenght of metadata field. A value of "linear"
671 divide by length. A value of "log" will divide by log2(length).
672 A value of "none" will leave term weight as is (no division).
673 Default value is "linear".
679 Refer to <xref linkend="relevance_ranking"/> to see how
680 these tweaks are used in computation of score.
683 Customization of ranking algorithm was introduced with
684 Pazpar2 1.6.18. The semantics of some of the fields changed
685 in versions up to 1.6.22.
690 <varlistentry id="sort-default">
691 <term>sort-default</term>
694 Specifies the default sort criteria (default 'relevance'),
695 which previous was hard-coded as default criteria in search.
696 This is a fix/work-around to avoid re-searching when using
697 target-based sorting. In order for this to work efficient,
698 the search must also have the sort critera parameter; otherwise
699 pazpar2 will do re-searching on search criteria changes, if
700 changed between search and show command.
703 This configuration was added in pazpar2 1.6.20.
713 Specifies a variable that will be inherited by all targets defined in settings
715 <set name="test" value="en"..<set>
722 <term>settings</term>
725 Specifies target settings for this service. Refer to
726 <xref linkend="target_settings"/>.
735 Specifies timeout parameters for this service.
736 The <literal>timeout</literal>
737 element supports the following attributes:
738 <literal>session</literal>, <literal>z3950_operation</literal>,
739 <literal>z3950_session</literal> which specifies
740 'session timeout', 'Z39.50 operation timeout',
741 'Z39.50 session timeout' respectively. The Z39.50 operation
742 timeout is the time Pazpar2 will wait for an active Z39.50/SRU
743 operation before it gives up (times out). The Z39.50 session
744 time out is the time Pazpar2 will keep the session alive for
745 an idle session (no operation).
748 The following is recommended but not required:
749 z3950_operation (30) < session (60) < z3950_session (180) .
750 The default values are given in parantheses.
754 </variablelist> <!-- Data elements in service directive -->
757 </variablelist> <!-- Data elements in server directive -->
762 <title>EXAMPLE</title>
764 Below is a working example configuration:
768 <?xml version="1.0" encoding="UTF-8"?>
769 <pazpar2 xmlns="http://www.indexdata.com/pazpar2/1.0">
771 <threads number="10"/>
773 <listen port="9004"/>
775 <metadata name="title" brief="yes" sortkey="skiparticle"
776 merge="longest" rank="6"/>
777 <metadata name="isbn" merge="unique"/>
778 <metadata name="date" brief="yes" sortkey="numeric"
779 type="year" merge="range" termlist="yes"/>
780 <metadata name="author" brief="yes" termlist="yes"
781 merge="longest" rank="2"/>
782 <metadata name="subject" merge="unique" termlist="yes" rank="3" limitmap="local:"/>
783 <metadata name="url" merge="unique"/>
784 <icu_chain id="relevance" locale="el">
785 <transform rule="[:Control:] Any-Remove"/>
787 <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
790 <settings src="mysettings"/>
791 <timeout session="60"/>
799 <refsect1 id="config-include">
800 <title>INCLUDE FACILITY</title>
802 The XML configuration may be partitioned into multiple files by using
803 the <literal>include</literal> element which takes a single attribute,
804 <literal>src</literal>. The of the <literal>src</literal> attribute is
805 regular Shell like glob-pattern. For example,
807 <include src="/etc/pazpar2/conf.d/*.xml"/>
811 The include facility requires Pazpar2 version 1.2.
815 <refsect1 id="target_settings">
816 <title>TARGET SETTINGS</title>
818 Pazpar2 features a cunning scheme by which you can associate various
819 kinds of attributes, or settings with search targets. This can be done
820 through XML files which are read at startup; each file can associate
821 one or more settings with one or more targets. The file format is generic
822 in nature, designed to support a wide range of application requirements. The
823 settings can be purely technical things, like, how to perform a title
824 search against a given target, or it can associate arbitrary name=value
825 pairs with groups of targets -- for instance, if you would like to
826 place all commercial full-text bases in one group for selection
827 purposes, or you would like to control what targets are accessible
828 to users by default. Per-database settings values can even be used
829 to drive sorting, facet/termlist generation, or end-user interface display
834 During startup, Pazpar2 will recursively read a specified directory
835 (can be identified in the pazpar2.cfg file or on the command line), and
836 process any settings files found therein.
840 Clients of the Pazpar2 webservice interface can selectively override
841 settings for individual targets within the scope of one session. This
842 can be used in conjunction with an external authentication system to
843 determine which resources are to be accessible to which users. Pazpar2
844 itself has no notion of end-users, and so can be used in conjunction
845 with any type of authentication system. Similarly, the authentication
846 tokens submitted to access-controlled search targets can similarly be
847 overridden, to allow use of Pazpar2 in a consortial or multi-library
848 environment, where different end-users may need to be represented to
849 some search targets in different ways. This, again, can be managed
850 using an external database or other lookup mechanism. Setting overrides
851 can be performed either using the
852 <link linkend="command-init">init</link> or the
853 <link linkend="command-settings">settings</link> webservice
858 In fact, every setting that applies to a database (except pz:id, which
859 can only be used for filtering targets to use for a search) can be overridden
860 on a per-session basis. This allows the client to override specific CCL fields
861 for searching, etc., to meet the needs of a session or user.
865 Finally, as an extreme case of this, the webservice client can
866 introduce entirely new targets, on the fly, as part of the
867 <link linkend="command-init">init</link> or
868 <link linkend="command-settings">settings</link> command.
869 This is useful if you desire to manage information
870 about your search targets in a separate application such as a database.
871 You do not need any static settings file whatsoever to run Pazpar2 -- as
872 long as the webservice client is prepared to supply the necessary
873 information at the beginning of every session.
878 The following discussion of practical issues related to session
879 and settings management are cast in terms of a user interface based on
880 Ajax/Javascript technology. It would apply equally well to many other
881 kinds of browser-based logic.
886 Typically, a Javascript client is not allowed to directly alter the
887 parameters of a session. There are two reasons for this. One has to do
888 with access to information; typically, information about a user will
889 be stored in a system on the server side, or it will be accessible in
890 some way from the server. However, since the Javascript client cannot
891 be entirely trusted (some hostile agent might in fact 'pretend' to be
892 a regular ws client), it is more robust to control session settings
893 from scripting that you run as part of your webserver. Typically, this
894 can be handled during the session initialization, as follows:
898 Step 1: The Javascript client loads, and asks the webserver for a
899 new Pazpar2 session ID. This can be done using a Javascript call, for
900 instance. Note that it is possible to submit Ajax HTTPXmlRequest calls
901 either to Pazpar2 or to the webserver that Pazpar2 is proxying
902 for. See (XXX Insert link to Pazpar2 protocol).
906 Step 2: Code on the webserver authenticates the user, by database lookup,
907 LDAP access, NCIP, etc. Determines which resources the user has access to,
908 and any user-specific parameters that are to be applied during this session.
912 Step 3: The webserver initializes a new Pazpar2 settings, and sets
913 user-specific parameters as necessary, using the init webservice
914 command. A new session ID is returned.
918 Step 4: The webserver returns this session ID to the Javascript
919 client, which then uses the session ID to submit searches, show
924 Step 5: When the Javascript client ceases to use the session,
925 Pazpar2 destroys any session-specific information.
929 <title>SETTINGS FILE FORMAT</title>
931 Each file contains a root element named <settings>. It may
932 contain one or more <set> elements. The settings and set
933 elements may contain the following attributes. Attributes in the set
934 node overrides those in the setting root element. Each set node must
935 specify (directly, or inherited from the parent node) at least a
936 target, name, and value.
944 This specifies the search target to which this setting should be
945 applied. Targets are identified by their Z39.50 URL, generally
946 including the host, port, and database name, (e.g.
947 <literal>bagel.indexdata.com:210/marc</literal>).
948 Two wildcard forms are accepted:
949 * (asterisk) matches all known targets;
950 <literal>bagel.indexdata.com:210/*</literal> matches all
951 known databases on the given host.
954 A precedence system determines what happens if there are
955 overlapping values for the same setting name for the same
956 target. A setting for a specific target name overrides a
957 setting which specifies target using a wildcard. This makes it
958 easy to set defaults for all targets, and then override them
959 for specific targets or hosts. If there are
960 multiple overlapping settings with the same name and target
961 value, the 'precedence' attribute determines what happens.
964 For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
965 which case, the actual host, port, etc is given by setting
966 <xref linkend="pzurl"/>.
974 The name of the setting. This can be anything you like.
975 However, Pazpar2 reserves a number of setting names for
976 specific purposes, all starting with 'pz:', and it is a good
977 idea to avoid that prefix if you make up your own setting
978 names. See below for a list of reserved variables.
986 The value of the setting. Generally, this can be anything you
987 want -- however, some of the reserved settings may expect
988 specific kinds of values.
993 <term>precedence</term>
996 This should be an integer. If not provided, the default value
997 is 0. If two (or more) settings have the same content for
998 target and name, the precedence value determines the outcome.
999 If both settings have the same precedence value, they are both
1000 applied to the target(s). If one has a higher value, then the
1001 value of that setting is applied, and the other one is ignored.
1008 By setting defaults for target, name, or value in the root
1009 settings node, you can use the settings files in many different
1010 ways. For instance, you can use a single file to set defaults for
1011 many different settings, like search fields, retrieval syntaxes,
1012 etc. You can have one file per server, which groups settings for
1013 that server or target. You could also have one file which associates
1014 a number of targets with a given setting, for instance, to associate
1015 many databases with a given category or class that makes sense
1016 within your application.
1020 The following examples illustrate uses of the settings system to
1021 associate settings with targets to meet different requirements.
1025 The example below associates a set of default values that can be
1026 used across many targets. Note the wildcard for targets.
1027 This associates the given settings with all targets for which no
1028 other information is provided.
1030 <settings target="*">
1032 <!-- This file introduces default settings for pazpar2 -->
1034 <!-- mapping for unqualified search -->
1035 <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
1037 <!-- field-specific mappings -->
1038 <set name="pz:cclmap:ti" value="u=4 s=al"/>
1039 <set name="pz:cclmap:su" value="u=21 s=al"/>
1040 <set name="pz:cclmap:isbn" value="u=7"/>
1041 <set name="pz:cclmap:issn" value="u=8"/>
1042 <set name="pz:cclmap:date" value="u=30 r=r"/>
1044 <set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
1045 <set name="pz:limitmap:date" value="ccl:date"/>
1047 <!-- Retrieval settings -->
1049 <set name="pz:requestsyntax" value="marc21"/>
1050 <set name="pz:elements" value="F"/>
1052 <!-- Query encoding -->
1053 <set name="pz:queryencoding" value="iso-8859-1"/>
1055 <!-- Result normalization settings -->
1057 <set name="pz:nativesyntax" value="iso2709"/>
1058 <set name="pz:xslt" value="../etc/marc21.xsl"/>
1066 The next example shows certain settings overridden for one target,
1067 one which returns XML records containing DublinCore elements, and
1068 which furthermore requires a username/password.
1070 <settings target="funkytarget.com:210/db1">
1071 <set name="pz:requestsyntax" value="xml"/>
1072 <set name="pz:nativesyntax" value="xml"/>
1073 <set name="pz:xslt" value="../etc/dublincore.xsl"/>
1075 <set name="pz:authentication" value="myuser/password"/>
1081 The following example associates a specific name/value combination
1082 with a number of targets. The targets below are access-restricted,
1083 and can only be used by users with special credentials.
1085 <settings name="pz:allow" value="0">
1086 <set target="funkytarget.com:210/*"/>
1087 <set target="commercial.com:2100/expensiveDb"/>
1095 <title>RESERVED SETTING NAMES</title>
1097 The following setting names are reserved by Pazpar2 to control the
1098 behavior of the client function.
1103 <term>pz:cclmap:xxx</term>
1106 This establishes a CCL field definition or other setting, for
1107 the purpose of mapping end-user queries. XXX is the field or
1108 setting name, and the value of the setting provides parameters
1109 (e.g. parameters to send to the server, etc.). Please consult
1110 the YAZ manual for a full overview of the many capabilities of
1111 the powerful and flexible CCL parser.
1114 Note that it is easy to establish a set of default parameters,
1115 and then override them individually for a given target.
1119 <varlistentry id="requestsyntax">
1120 <term>pz:requestsyntax</term>
1123 This specifies the record syntax to use when requesting
1124 records from a given server. The value can be a symbolic name like
1125 marc21 or xml, or it can be a Z39.50-style dot-separated OID.
1130 <term>pz:elements</term>
1133 The element set name to be used when retrieving records from a
1139 <term>pz:piggyback</term>
1142 Piggybacking enables the server to retrieve records from the
1143 server as part of the search response in Z39.50. Almost all
1144 servers support this (or fail it gracefully), but a few
1145 servers will produce undesirable results.
1146 Set to '1' to enable piggybacking, '0' to disable it. Default
1147 is 1 (piggybacking enabled).
1152 <term>pz:nativesyntax</term>
1155 Specifies how Pazpar2 shoule map retrieved records to XML. Currently
1156 supported values are <literal>xml</literal>,
1157 <literal>iso2709</literal> and <literal>txml</literal>.
1160 The value <literal>iso2709</literal> makes Pazpar2 convert retrieved
1161 MARC records to MARCXML. In order to convert to XML, the exact
1162 chacater set of the MARC must be known (if not, the resulting
1163 XML is probably not well-formed). The character set may be
1164 specified by adding:
1165 <literal>;charset=</literal><replaceable>charset</replaceable> to
1166 <literal>iso2709</literal>. If omitted, a charset of
1167 MARC-8 is assumed. This is correct for most MARC21/USMARC records.
1170 The value <literal>txml</literal> is like <literal>iso2709</literal>
1171 except that records are converted to TurboMARC instead of MARCXML.
1174 The value <literal>xml</literal> is used if Pazpar2 retrieves
1175 records that are already XML (no conversion takes place).
1181 <term>pz:queryencoding</term>
1184 The encoding of the search terms that a target accepts. Most
1185 targets do not honor UTF-8 in which case this needs to be specified.
1186 Each term in a query will be converted if this setting is given.
1192 <term>pz:negotiation_charset</term>
1195 Sets character set for Z39.50 negotiation. Most targets do not support
1196 this, and some will even close connection if set (crash on server
1197 side or similar). If set, you probably want to set it to
1198 <literal>UTF-8</literal>.
1204 <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
1207 Is a comma separated list of of stylesheet names that specifies
1208 how to convert incoming records to the internal representation.
1211 For each name, the embedded stylesheets (XSL) that comes with the
1212 service definition are consulted first and takes precedence over
1213 external files; see <xref linkend="servicexslt"/>
1214 of service definition).
1215 If the name does not match an embedded stylesheet it is
1216 considered a filename.
1219 The suffix of each file specifies the kind of tranformation.
1220 Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
1221 "<literal>.mmap</literal>" will use the MMAP transform (described below).
1224 The special value "<literal>auto</literal>" will use a file
1225 which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
1227 <literal>'.xsl'</literal>.
1230 When mapping MARC records, XSLT can be bypassed for increased
1231 performance with the alternate "MARC map" format. Provide the
1232 path of a file with extension ".mmap" containing on each line:
1234 <field> <subfield> <metadata element></programlisting>
1241 To map the field value specify a subfield of '$'. To store a
1242 concatenation of all subfields, specify a subfield of '*'.
1247 <term>pz:authentication</term>
1250 Sets an authentication string for a given server. See the section on
1251 authorization and authentication for discussion.
1256 <term>pz:allow</term>
1259 Allows or denies access to the resources it is applied to. Possible
1260 values are '0' and '1'.
1261 The default is '1' (allow access to this resource).
1262 See the manual section on authorization and authentication for
1263 discussion about how to use this setting.
1268 <term>pz:maxrecs</term>
1271 Controls the maximum number of records to be retrieved from a
1272 server. The default is 100.
1277 <term>pz:extendrecs</term>
1280 If a show command goes to the boundary of a result set for a
1281 database - depends on sorting - and pz:extendrecs is set to a positive
1282 value. then Pazpar2 wait for show to fetch pz:extendrecs more
1283 records. This setting is best used if a
1284 database does native sorting, because the result set otherwise may
1285 be completely re-sorted during extended fetch.
1289 The pz:extendrecs setting appeared in Pazpar2 version 1.6.26.
1290 But the bahavior changed with the release of Pazpar2 1.6.29.
1296 <term>pz:presentchunk</term>
1299 Controls the chunk size in present requests. Pazpar2 will
1300 make (maxrecs / chunk) request(s). The default is 20.
1308 This setting can't be 'set' -- it contains the ID (normally
1309 ZURL) for a given target, and is useful for filtering --
1310 specifically when you want to select one or more specific
1311 targets in the search command.
1316 <term>pz:zproxy</term>
1319 The 'pz:zproxy' setting has the value syntax
1320 'host.internet.adress:port', it is used to tunnel Z39.50
1321 requests through the named Z39.50 proxy.
1327 <term>pz:apdulog</term>
1330 If the 'pz:apdulog' setting is defined and has other value than 0,
1331 then Z39.50 APDUs are written to the log.
1340 This setting enables
1341 <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
1343 It has four possible settings.
1344 'get', enables SRU access through GET requests. 'post' enables SRU/POST
1345 support, less commonly supported, but useful if very large requests are
1346 to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
1350 A value of 'solr' enables Solr client support. This is supported
1351 for Pazpar version 1.5.0 and later.
1357 <term>pz:sru_version</term>
1360 This allows SRU version to be specified. If unset Pazpar2
1361 will the default of YAZ (currently 1.2). Should be set
1362 to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
1368 <term>pz:pqf_prefix</term>
1371 Allows you to specify an arbitrary PQF query language substring.
1372 The provided string is prefixed to the user's query after it has been
1373 normalized to PQF internally in pazpar2.
1374 This allows you to attach complex 'filters' to queries for a given
1375 target, sometimes necessary to select sub-catalogs
1376 in union catalog systems, etc.
1382 <term>pz:pqf_strftime</term>
1385 Allows you to extend a query with dates and operators.
1386 The provided string allows certain substitutions and serves as a
1388 The special two character sequence '%%' gets converted to the
1389 original query. Other characters leading with the percent sign are
1390 conversions supported by strftime.
1391 All other characters are copied verbatim. For example, the string
1392 <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
1393 would search for current year combined with the original PQF (%%).
1396 This setting can also be used as more general alternative to
1397 pz:pqf_prefix -- a way of embedding the submitted query
1398 anywhere in the string rather than appending it to prefix. For
1399 example, if it is desired to omit all records satisfying the
1400 query <literal>@attr 1=pica.bib 0007</literal> then this
1401 subquery can be combined with the submitted query as the second
1402 argument of <literal>@andnot</literal> by using the
1403 pz:pqf_strftime value <literal>@not %% @attr 1=pica.bib
1410 <term>pz:sort</term>
1413 Specifies sort criteria to be applied to the result set.
1414 Only works for targets which support the sort service.
1420 <term>pz:recordfilter</term>
1423 Specifies a filter which allows Pazpar2 to only include
1424 records that meet a certain criteria in a result.
1425 Unmatched records will be ignored.
1426 The filter takes the form name, name~value, or name=value, which
1427 will include only records with metadata element (name) that has the
1428 substring (~value) given, or matches exactly (=value).
1429 If value is omitted all records with the named metadata element
1430 present will be included.
1436 <term>pz:preferred</term>
1439 Specifies that a target is preferred, e.g. possible local, faster
1440 target. Using block=pref on show command will wait for all these
1441 targets to return records before releasing the block.
1442 If no target is preferred, the block=pref will identical to block=1,
1443 which release when one target has returned records.
1448 <term>pz:block_timeout</term>
1451 (Not yet implemented).
1452 Specifies the time for which a block should be released anyway.
1457 <term>pz:termlist_term_count</term>
1460 Specifies number of facet terms to be requested from the target.
1461 The default is unspecified e.g. server-decided. Also see pz:facetmap.
1466 <term>pz:termlist_term_factor</term>
1469 Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
1470 When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
1471 facet with native (target-generated) facets, the later will dominated the dominate the facet list
1472 since they are generated based on the complete result set.
1473 By scaling up the facet count using the ratio between total hit count and the sample size,
1474 the total facet count can be approximated and thus better compared with native facets.
1475 This is not enabled by default.
1481 <term>pz:facetmap:<replaceable>name</replaceable></term>
1484 Specifies that for field <replaceable>name</replaceable>, the target
1485 supports (native) facets. The value is the name of the
1486 field on the target.
1490 At this point only Solr targets have been tested with this
1497 <varlistentry id="limitmap">
1498 <term>pz:limitmap:<replaceable>name</replaceable></term>
1501 Specifies attributes for limiting a search to a field - using
1502 the limit parameter for search. It can be used to filter locally
1503 or remotely (search in a target). In some cases the mapping of
1504 a field to a value is identical to an existing cclmap field; in
1505 other cases the field must be specified in a different way - for
1506 example to match a complete field (rather than parts of a subfield).
1509 The value of limitmap may have one of three forms: referral to
1510 an existing CCL field, a raw PQF string or a local limit. Leading string
1511 determines type; either <literal>ccl:</literal> for CCL field,
1512 <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
1513 for filtering in Pazpar2. The local filtering may be followed
1514 by a field a metadata field (default is to use the name of the
1518 For Pazpar2 version 1.6.23 and later the limitmap may include multiple
1519 specifications, separated by <literal>,</literal> (comma).
1521 <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
1525 The limitmap facility is supported for Pazpar2 version 1.6.0.
1526 Local filtering is supported in Pazpar2 1.6.6.
1532 <varlistentry id="pzurl">
1536 Specifies URL for the target and overrides the target ID.
1540 <literal>pz:url</literal> is only recognized for
1541 Pazpar2 1.6.4 and later.
1547 <varlistentry id="pzsortmap">
1548 <term>pz:sortmap:<replaceable>field</replaceable></term>
1551 Specifies native sorting for a target where
1552 <replaceable>field</replaceable> is a sort criteria (see command
1553 show). The value has to components separated by colon: strategy and
1554 native-field. Strategy is one of <literal>z3950</literal>,
1555 <literal>type7</literal>, <literal>cql</literal>,
1556 <literal>sru11</literal>, or <literal>embed</literal>.
1557 The second component, native-field, is the field that is recognized
1562 Only supported for Pazpar2 1.6.4 and later.
1574 <title>SEE ALSO</title>
1577 <refentrytitle>pazpar2</refentrytitle>
1578 <manvolnum>8</manvolnum>
1581 <refentrytitle>yaz-icu</refentrytitle>
1582 <manvolnum>1</manvolnum>
1585 <refentrytitle>pazpar2_protocol</refentrytitle>
1586 <manvolnum>7</manvolnum>
1591 <!-- Keep this comment at the end of the file
1594 nxml-child-indent: 1