X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=4e820224690b97d677e9b2dc9cac81ccb4cea552;hb=f3f81f2a91aa590cf5ab931bb23f25048b413b7c;hp=1ad24a2a5bd3a081aa5abcf7153eeede47cf43f2;hpb=319d591dd9d6c3b38775cb4fdfbbd0a92d822f4b;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 1ad24a2..4e82022 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -15,24 +15,24 @@
&version;Index Data
-
+
Pazpar2 conf5File formats and conventions
-
+
pazpar2_confPazpar2 Configuration
-
+
pazpar2.conf
-
+
DESCRIPTION
@@ -41,7 +41,7 @@
extraction of data elements from incoming result records, for the
purposes of merging, sorting, facet analysis, and display.
-
+
The file is specified using the option -f on the Pazpar2 command line.
There is not presently a way to reload the configuration file without
@@ -49,19 +49,19 @@
in the future.
-
+
FORMAT
The configuration file is XML-structured. It must be well-formed XML. All
elements specific to Pazpar2 should belong to the namespace
- http://www.indexdata.com/pazpar2/1.0
+ http://www.indexdata.com/pazpar2/1.0
(this is assumed in the
following examples). The root element is named "pazpar2".
Under the root element are a number of elements which group categories of
information. The categories are described below.
-
+
threads
@@ -73,6 +73,16 @@
in main thread).
+
+ file
+
+ This configuration takes one attribute path which
+ specifies a path to search for local files, such as XSLTs and settings.
+ The path is a colon separated list of directories. Its default value
+ is "." which is equivalent to the location of the
+ main configuration file (where indeed the file element is given).
+
+ server
@@ -101,7 +111,7 @@
-
+
proxy
@@ -137,7 +147,7 @@
-
+
relevance / sort / mergekey / facet
@@ -146,7 +156,7 @@
-
+
settings
@@ -156,14 +166,14 @@
The settings element requires one attribute 'src' which specifies
a settings file or a directory . If a directory is given all
files with suffix .xml is read from this
- directory. Refer to
+ directory. Refer to
for more information.
-
+
- service
+ service
This nested element controls the behavior of Pazpar2 with
@@ -195,7 +205,7 @@
ranking, merging, and display of data elements. It supports
the following attributes:
-
+
name
@@ -203,19 +213,19 @@
This is the name of the data element. It is matched
against the 'type' attribute of the
- 'metadata' element
+ 'metadata' element
in the normalized record. A warning is produced if
metadata elements with an unknown name are
- found in the
+ found in the
normalized record. This name is also used to
- represent
+ represent
data elements in the records returned by the
webservice API, and to name sort lists and browse
facets.
-
+
type
@@ -229,7 +239,7 @@
-
+
brief
@@ -241,7 +251,7 @@
-
+
sortkey
@@ -254,21 +264,21 @@
-
+
- rank
+ rank
Specifies that this element is to be used to
- help rank
+ help rank
records against the user's query (when ranking is
- requested).
- The valus is of the form
+ requested).
+ The valus is of the form
M [F N]
where M is an integer, used as a
- multiplier against the basic TF*IDF score. A value of
+ weight against the basic TF*IDF score. A value of
1 is the base, higher values give additional weight to
elements of this type. The default is '0', which
excludes this element from the rank calculation.
@@ -283,15 +293,17 @@
For Pazpar2 1.6.13 and later, the rank may also defined
- "per-document", by the normalization stylesheet.
+ "per-document", by the normalization stylesheet.
The per field rank was introduced in Pazpar2 1.6.15. Earlier
releases only allowed a rank value M (simple integer).
+ See for more
+ about ranking.
-
+
termlist
@@ -300,13 +312,13 @@
termlist, or browse facet. Values are tabulated from
incoming records, and a highscore of values (with
their associated frequency) is made available to the
- client through the webservice API.
+ client through the webservice API.
The possible values
are 'yes' and 'no' (default).
-
+
merge
@@ -320,9 +332,14 @@
all elements), or 'no' (don't merge; this is the
default);
+
+ Pazpar 1.6.24 also offers a new value for merge, 'first', which
+ is like 'all' but only takes all from first database that returns
+ the particular metadata field.
+
-
+
mergekey
@@ -357,29 +374,47 @@
-
+
+
+ limitcluster
+
+
+ Allow a limit on merged metadata. The value of this attribute
+ is the name of actual metadata content to be used for matching
+ (most often same name as metadata name).
+
+
+
+ Requires Pazpar2 1.6.23 or later.
+
+
+
+
+
limitmap
- Specifies a default limitmap for this field. This is to avoid mass
- configuring of targets. However it is important to review/do this on a per
- target since it is usually target-specific. See limitmap for format.
+ Specifies a default limitmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do
+ this on a per target since it is usually target-specific.
+ See limitmap for format.
-
+
facetmap
- Specifies a default facetmap for this field. This is to avoid mass
- configuring of targets. However it is important to review/do this on a per
- target since it is usually target-specific. See facetmap for format.
+ Specifies a default facetmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do
+ this on a per target since it is usually target-specific.
+ See facetmap for format.
-
+
setting
@@ -389,7 +424,7 @@
are allowed. 'no' is the default and doesn't do anything.
'postproc' copies the value of a setting with the same name
into the output of the normalization stylesheet(s). 'parameter'
- makes the value of a setting with the same name available
+ makes the value of a setting with the same name available
as a parameter to the normalization stylesheet, so you
can further process the value inside of the stylesheet, or use
the value to decide how to deal with other data values.
@@ -404,9 +439,9 @@
-
+
-
+
@@ -433,7 +468,7 @@
rule set.
Pazpar2 uses the particular rule sets for particular purposes.
Rule set 'relevance' is used to normalize
- terms for relevance ranking. Rule set 'sort' is used to
+ terms for relevance ranking. Rule set 'sort' is used to
normalize terms for sorting. Rule set 'mergekey' is used to
normalize terms for making a mergekey and, finally. Rule set 'facet'
is normally used to normalize facet terms, unless
@@ -447,7 +482,7 @@
in any order, except the 'index' element which logically
belongs to the end of the list. The stated tokenization,
transformation and charmapping instructions are performed
- in order from top to bottom.
+ in order from top to bottom.
@@ -456,7 +491,7 @@
The attribute 'rule' defines the direction of the
per-character casemapping, allowed values are "l"
- (lower), "u" (upper), "t" (title).
+ (lower), "u" (upper), "t" (title).
@@ -467,10 +502,10 @@
Normalization and transformation of tokens follows
the rules defined in the 'rule' attribute. For
possible values we refer to the extensive ICU
- documentation found at the
+ documentation found at the
ICU
transformation home page. Set filtering
- principles are explained at the
+ principles are explained at the
ICU set and
filtering page.
@@ -485,7 +520,7 @@
'rule' attribute may have the following values:
"s" (sentence), "l" (line-break), "w" (word), and
"c" (character), the later probably not being
- very useful in a pruning Pazpar2 installation.
+ very useful in a pruning Pazpar2 installation.
@@ -497,7 +532,7 @@
-
+
relevance
@@ -513,7 +548,7 @@
-
+
sort
@@ -529,13 +564,13 @@
-
+
mergekey
Specifies ICU tokenization and transformation rules
- for tokens that are used in Pazpar2's mergekey.
+ for tokens that are used in Pazpar2's mergekey.
The child element of 'mergekey' must be 'icu_chain' and the
'id' attribute of the icu_chain is ignored. This
definition is obsolete and should be replaced by the equivalent
@@ -573,7 +608,7 @@
The name and value of the CCL directive is gigen by attributes
'name' and 'value' respectively. Refer to possible list of names
in the
-
YAZ manual
.
@@ -581,18 +616,85 @@
-
+ rank
- Customizes the ranking (relevance) algorithm.
- Attribute 'cluster' is a boolean
- that controls whether Pazpar2 should boost ranking for merged
- records. Is 'yes' by default. A value of 'no' will make
- Pazpar2 avergage ranking of each record in a cluster.
+ Customizes the ranking (relevance) algorithm. Also known as
+ rank tweaks. The rank element
+ accepts the following attributes - all being optional:
+
+
+
+ cluster
+
+
+ Attribute 'cluster' is a boolean
+ that controls whether Pazpar2 should boost ranking for merged
+ records. Is 'yes' by default. A value of 'no' will make
+ Pazpar2 average ranking of each record in a cluster.
+
+
+
+
+ debug
+
+
+ Attribute 'debug' is a boolean
+ that controls whether Pazpar2 should include details
+ about ranking for each document in the show command's
+ response. Enable by using value "yes", disable by using
+ value "no" (default).
+
+
+
+
+ follow
+
+
+ Attribute 'follow' is a a floating point number greater than
+ or equal to 0. A positive number will boost weight for terms
+ that occur close to each other (proximity, distance).
+ A value of 1, will double the weight if two terms are in
+ proximity distance of 1 (next to each other). The default
+ value of 'follow' is 0 (order will not affect weight).
+
+
+
+
+ lead
+
+
+ Attribute 'lead' is a floating point number.
+ It controls if term weight should be reduced by position
+ from start in a metadata field. A positive value of 'lead'
+ will reduce weight as it apperas further away from the lead
+ of the field. Default value is 0 (no reduction of weight by
+ position).
+
+
+
+
+ length
+
+
+ Attribute 'length' determines how/if term weight should be
+ divided by lenght of metadata field. A value of "linear"
+ divide by length. A value of "log" will divide by log2(length).
+ A value of "none" will leave term weight as is (no division).
+ Default value is "linear".
+
+
+
+
+
+ Refer to to see how
+ these tweaks are used in computation of score.
- This configuration was added in pazpar2 1.6.18.
+ Customization of ranking algorithm was introduced with
+ Pazpar2 1.6.18. The semantics of some of the fields changed
+ in versions up to 1.6.22.
@@ -602,10 +704,10 @@
Specifies the default sort criteria (default 'relevance'),
- which previous was hard-coded as default criteria in search.
- This is a fix/work-around to avoid re-searching when using
- target-based sorting. In order for this to work efficient,
- the search must also have the sort critera parameter; otherwise
+ which previous was hard-coded as default criteria in search.
+ This is a fix/work-around to avoid re-searching when using
+ target-based sorting. In order for this to work efficient,
+ the search must also have the sort critera parameter; otherwise
pazpar2 will do re-searching on search criteria changes, if
changed between search and show command.
@@ -615,7 +717,7 @@
-
+-->
settings
@@ -644,7 +746,7 @@
Specifies timeout parameters for this service.
The timeout
- element supports the following attributes:
+ element supports the following attributes:
session, z3950_operation,
z3950_session which specifies
'session timeout', 'Z39.50 operation timeout',
@@ -682,6 +784,7 @@
+
@@ -704,14 +807,14 @@
]]>
-
+
INCLUDE FACILITY
The XML configuration may be partitioned into multiple files by using
the include element which takes a single attribute,
- src. The of the src attribute is
+ src. The src attribute is
regular Shell like glob-pattern. For example,
@@ -729,8 +832,8 @@
kinds of attributes, or settings with search targets. This can be done
through XML files which are read at startup; each file can associate
one or more settings with one or more targets. The file format is generic
- in nature, designed to support a wide range of application requirements. The
- settings can be purely technical things, like, how to perform a title
+ in nature, designed to support a wide range of application requirements.
+ The settings can be purely technical things, like, how to perform a title
search against a given target, or it can associate arbitrary name=value
pairs with groups of targets -- for instance, if you would like to
place all commercial full-text bases in one group for selection
@@ -739,13 +842,13 @@
to drive sorting, facet/termlist generation, or end-user interface display
logic.
-
+
During startup, Pazpar2 will recursively read a specified directory
(can be identified in the pazpar2.cfg file or on the command line), and
process any settings files found therein.
-
+
Clients of the Pazpar2 webservice interface can selectively override
settings for individual targets within the scope of one session. This
@@ -759,16 +862,17 @@
some search targets in different ways. This, again, can be managed
using an external database or other lookup mechanism. Setting overrides
can be performed either using the
- init or the
+ init or the
settings webservice
command.
-
+
In fact, every setting that applies to a database (except pz:id, which
can only be used for filtering targets to use for a search) can be overridden
- on a per-session basis. This allows the client to override specific CCL fields
- for searching, etc., to meet the needs of a session or user.
+ on a per-session basis.
+ This allows the client to override specific CCL fields for
+ searching, etc., to meet the needs of a session or user.
@@ -846,7 +950,7 @@
target, name, and value.
-
+ target
@@ -950,7 +1054,7 @@
-
+
@@ -1007,173 +1111,190 @@
The following setting names are reserved by Pazpar2 to control the
behavior of the client function.
-
+
+
- pz:cclmap:xxx
+ pz:allow
- This establishes a CCL field definition or other setting, for
- the purpose of mapping end-user queries. XXX is the field or
- setting name, and the value of the setting provides parameters
- (e.g. parameters to send to the server, etc.). Please consult
- the YAZ manual for a full overview of the many capabilities of
- the powerful and flexible CCL parser.
-
-
- Note that it is easy to establish a set of default parameters,
- and then override them individually for a given target.
+ Allows or denies access to the resources it is applied to. Possible
+ values are '0' and '1'.
+ The default is '1' (allow access to this resource).
-
- pz:requestsyntax
+
+
+ pz:apdulog
- This specifies the record syntax to use when requesting
- records from a given server. The value can be a symbolic name like
- marc21 or xml, or it can be a Z39.50-style dot-separated OID.
+ If the 'pz:apdulog' setting is defined and has other value than 0,
+ then Z39.50 APDUs are written to the log.
+
- pz:elements
+ pz:authentication
- The element set name to be used when retrieving records from a
- server.
+ Sets an authentication string for a given database. For Z39.50,
+ this is carried as part of the Initialize Request. In order to carry
+ the information in the "open" elements, separate
+ username and password with a slash (In Z39.50 it is a VisibleString).
+ In order to carry the information in the idPass elements, separate
+ username term, password term and, optionally, a group term with a
+ single blank.
+ If three terms are given, the order is
+ user, group, password.
+ If only two terms are given, the order is
+ user, password.
+
+
+ For HTTP based procotols, such as SRU and Solr, the authentication
+ string includes a username term and, optionally, a password term.
+ Each term is separated by a single blank. The
+ authentication information is passed either by HTTP basic
+ authentication or via URL parameters. The mode is operation is
+ determined by pz:authentication_mode setting.
+
- pz:piggyback
+ pz:authentication_mode
- Piggybacking enables the server to retrieve records from the
- server as part of the search response in Z39.50. Almost all
- servers support this (or fail it gracefully), but a few
- servers will produce undesirable results.
- Set to '1' to enable piggybacking, '0' to disable it. Default
- is 1 (piggybacking enabled).
+ Determines how authentication is carried in HTTP based protocols.
+ Value may be "basic" or "url".
+
- pz:nativesyntax
+ pz:block_timeout
- Specifies how Pazpar2 shoule map retrieved records to XML. Currently
- supported values are xml,
- iso2709 and txml.
-
-
- The value iso2709 makes Pazpar2 convert retrieved
- MARC records to MARCXML. In order to convert to XML, the exact
- chacater set of the MARC must be known (if not, the resulting
- XML is probably not well-formed). The character set may be
- specified by adding:
- ;charset=charset to
- iso2709. If omitted, a charset of
- MARC-8 is assumed. This is correct for most MARC21/USMARC records.
+ (Not yet implemented).
+ Specifies the time for which a block should be released anyway.
+
+
+
+
+ pz:cclmap:xxx
+
- The value txml is like iso2709
- except that records are converted to TurboMARC instead of MARCXML.
+ This establishes a CCL field definition or other setting, for
+ the purpose of mapping end-user queries. XXX is the field or
+ setting name, and the value of the setting provides parameters
+ (e.g. parameters to send to the server, etc.). Please consult
+ the YAZ manual for a full overview of the many capabilities of
+ the powerful and flexible CCL parser.
- The value xml is used if Pazpar2 retrieves
- records that are already XML (no conversion takes place).
+ Note that it is easy to establish a set of default parameters,
+ and then override them individually for a given target.
- pz:queryencoding
+ pz:elements
- The encoding of the search terms that a target accepts. Most
- targets do not honor UTF-8 in which case this needs to be specified.
- Each term in a query will be converted if this setting is given.
+ The element set name to be used when retrieving records from a
+ server.
- pz:negotiation_charset
+ pz:extendrecs
- Sets character set for Z39.50 negotiation. Most targets do not support
- this, and some will even close connection if set (crash on server
- side or similar). If set, you probably want to set it to
- UTF-8.
+ If a show command goes to the boundary of a result set for a
+ database - depends on sorting - and pz:extendrecs is set to a positive
+ value. then Pazpar2 wait for show to fetch pz:extendrecs more
+ records. This setting is best used if a database does native
+ sorting, because the result set otherwise may be completely
+ re-sorted during extended fetch.
+ The default value of pz:extendrecs is 0 (no extended fetch).
+
+
+ The pz:extendrecs setting appeared in Pazpar2 version 1.6.26.
+ But the bahavior changed with the release of Pazpar2 1.6.29.
+
+
- pz:xslt
+ pz:facetmap:name
- Is a comma separated list of of stylesheet names that specifies
- how to convert incoming records to the internal representation.
-
-
- For each name, the embedded stylesheets (XSL) that comes with the
- service definition are consulted first and takes precedence over
- external files; see
- of service definition).
- If the name does not match an embedded stylesheet it is
- considered a filename.
-
-
- The suffix of each file specifies the kind of tranformation.
- Suffix ".xsl" makes an XSL transform. Suffix
- ".mmap" will use the MMAP transform (described below).
-
-
- The special value "auto" will use a file
- which is the pz:requestsyntax's
- value followed by
- '.xsl'.
-
-
- When mapping MARC records, XSLT can be bypassed for increased
- performance with the alternate "MARC map" format. Provide the
- path of a file with extension ".mmap" containing on each line:
-
- <field> <subfield> <metadata element>
- For example:
-
- 245 a title
- 500 $ description
- 773 * citation
-
- To map the field value specify a subfield of '$'. To store a
- concatenation of all subfields, specify a subfield of '*'.
+ Specifies that for field name, the target
+ supports (native) facets. The value is the name of the
+ field on the target.
+
+
+ At this point only Solr targets have been tested with this
+ facility.
+
+
+
- pz:authentication
+ pz:id
- Sets an authentication string for a given server. See the section on
- authorization and authentication for discussion.
+ This setting can't be 'set' -- it contains the ID (normally
+ ZURL) for a given target, and is useful for filtering --
+ specifically when you want to select one or more specific
+ targets in the search command.
-
- pz:allow
+
+
+ pz:limitmap:name
- Allows or denies access to the resources it is applied to. Possible
- values are '0' and '1'.
- The default is '1' (allow access to this resource).
- See the manual section on authorization and authentication for
- discussion about how to use this setting.
+ Specifies attributes for limiting a search to a field - using
+ the limit parameter for search. It can be used to filter locally
+ or remotely (search in a target). In some cases the mapping of
+ a field to a value is identical to an existing cclmap field; in
+ other cases the field must be specified in a different way - for
+ example to match a complete field (rather than parts of a subfield).
+
+ The value of limitmap may have one of three forms: referral to
+ an existing CCL field, a raw PQF string or a local limit. Leading string
+ determines type; either ccl: for CCL field,
+ rpn: for PQF/RPN, or local:
+ for filtering in Pazpar2. The local filtering may be followed
+ by a field a metadata field (default is to use the name of the
+ limitmap itself).
+
+
+ For Pazpar2 version 1.6.23 and later the limitmap may include multiple
+ specifications, separated by , (comma).
+ For example:
+ ccl:title,local:ltitle,rpn:@attr 1=4.
+
+
+
+ The limitmap facility is supported for Pazpar2 version 1.6.0.
+ Local filtering is supported in Pazpar2 1.6.6.
+
+
+
pz:maxrecs
@@ -1183,78 +1304,97 @@
+
- pz:presentchunk
+ pz:memcached
- Controls the chunk size in present requests. Pazpar2 will
- make (maxrecs / chunk) request(s). The default is 20.
+ If set and non-empty,
+ libMemcached will
+ configured and enabled for the target.
+ The value of this setting is same as the ZOOM option
+ memcached, which in turn is the configuration
+ string passed to the memcached function
+ of libMemcached.
-
-
-
- pz:id
-
- This setting can't be 'set' -- it contains the ID (normally
- ZURL) for a given target, and is useful for filtering --
- specifically when you want to select one or more specific
- targets in the search command.
+ This setting is honored in Pazpar2 1.6.39 or later. Pazpar2 must
+ be using YAZ version 5.0.13 or later.
+
- pz:zproxy
+ pz:redis
- The 'pz:zproxy' setting has the value syntax
- 'host.internet.adress:port', it is used to tunnel Z39.50
- requests through the named Z39.50 proxy.
+ If set and non-empty,
+ redis will
+ configured and enabled for the target.
+ The value of this setting is exactly as the redis option for
+ ZOOM C of YAZ.
+
+
+ This setting is honored in Pazpar2 1.6.43 or later. Pazpar2 must
+ be using YAZ version 5.2.0 or later.
-
+
- pz:apdulog
+ pz:nativesyntax
- If the 'pz:apdulog' setting is defined and has other value than 0,
- then Z39.50 APDUs are written to the log.
+ Specifies how Pazpar2 shoule map retrieved records to XML. Currently
+ supported values are xml,
+ iso2709 and txml.
+
+
+ The value iso2709 makes Pazpar2 convert retrieved
+ MARC records to MARCXML. In order to convert to XML, the exact
+ chacater set of the MARC must be known (if not, the resulting
+ XML is probably not well-formed). The character set may be
+ specified by adding:
+ ;charset to
+ iso2709. If omitted, a charset of
+ MARC-8 is assumed. This is correct for most MARC21/USMARC records.
+
+
+ The value txml is like iso2709
+ except that records are converted to TurboMARC instead of MARCXML.
+
+
+ The value xml is used if Pazpar2 retrieves
+ records that are already XML (no conversion takes place).
-
+
- pz:sru
+ pz:negotiation_charset
- This setting enables
- SRU/Solr
- support.
- It has four possible settings.
- 'get', enables SRU access through GET requests. 'post' enables SRU/POST
- support, less commonly supported, but useful if very large requests are
- to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
- the protocol.
-
-
- A value of 'solr' enables Solr client support. This is supported
- for Pazpar version 1.5.0 and later.
+ Sets character set for Z39.50 negotiation. Most targets do not support
+ this, and some will even close connection if set (crash on server
+ side or similar). If set, you probably want to set it to
+ UTF-8.
-
+
- pz:sru_version
+ pz:piggyback
- This allows SRU version to be specified. If unset Pazpar2
- will the default of YAZ (currently 1.2). Should be set
- to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
+ Piggybacking enables the server to retrieve records from the
+ server as part of the search response in Z39.50. Almost all
+ servers support this (or fail it gracefully), but a few
+ servers will produce undesirable results.
+ Set to '1' to enable piggybacking, '0' to disable it. Default
+ is 1 (piggybacking enabled).
-
pz:pqf_prefix
@@ -1268,7 +1408,7 @@
-
+
pz:pqf_strftime
@@ -1296,13 +1436,37 @@
-
+
- pz:sort
+ pz:preferred
- Specifies sort criteria to be applied to the result set.
- Only works for targets which support the sort service.
+ Specifies that a target is preferred, e.g. possible local, faster
+ target. Using block=pref on show command will wait for all these
+ targets to return records before releasing the block.
+ If no target is preferred, the block=pref will identical to block=1,
+ which release when one target has returned records.
+
+
+
+
+
+ pz:presentchunk
+
+
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+
+
+
+
+
+ pz:queryencoding
+
+
+ The encoding of the search terms that a target accepts. Most
+ targets do not honor UTF-8 in which case this needs to be specified.
+ Each term in a query will be converted if this setting is given.
@@ -1322,95 +1486,106 @@
-
-
- pz:preferred
+
+
+ pz:requestsyntax
- Specifies that a target is preferred, e.g. possible local, faster
- target. Using block=pref on show command will wait for all these
- targets to return records before releasing the block.
- If no target is preferred, the block=pref will identical to block=1,
- which release when one target has returned records.
+ This specifies the record syntax to use when requesting
+ records from a given server. The value can be a symbolic name like
+ marc21 or xml, or it can be a Z39.50-style dot-separated OID.
+
- pz:block_timeout
+ pz:sort
- (Not yet implemented).
- Specifies the time for which a block should be released anyway.
+ Specifies sort criteria to be applied to the result set.
+ Only works for targets which support the sort service.
-
- pz:termlist_term_count
+
+
+ pz:sortmap:field
- Specifies number of facet terms to be requested from the target.
- The default is unspecified e.g. server-decided. Also see pz:facetmap.
+ Specifies native sorting for a target where
+ field is a sort criterion (see command
+ show). The value has two components separated by a colon: strategy and
+ native-field. Strategy is one of z3950,
+ type7, cql,
+ sru11, or embed.
+ The second component, native-field, is the field that is recognized
+ by the target.
+
+
+ Only supported for Pazpar2 1.6.4 and later.
+
+
+
- pz:termlist_term_factor
+ pz:sru
- Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
- When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
- facet with native (target-generated) facets, the later will dominated the dominate the facet list
- since they are generated based on the complete result set.
- By scaling up the facet count using the ratio between total hit count and the sample size,
- the total facet count can be approximated and thus better compared with native facets.
- This is not enabled by default.
+ This setting enables
+ SRU/Solr
+ support.
+ It has four possible settings.
+ 'get', enables SRU access through GET requests. 'post' enables SRU/POST
+ support, less commonly supported, but useful if very large requests are
+ to be submitted. 'soap' enables the SRW (SRU over SOAP) variation of
+ the protocol.
+
+
+ A value of 'solr' enables Solr client support. This is supported
+ for Pazpar version 1.5.0 and later.
- pz:facetmap:name
+ pz:sru_version
- Specifies that for field name, the target
- supports (native) facets. The value is the name of the
- field on the target.
+ This allows SRU version to be specified. If unset Pazpar2
+ will the default of YAZ (currently 1.2). Should be set
+ to 1.1 or 1.2. For Solr, the current supported/tested version
+ is 1.4 and 3.x.
-
-
- At this point only Solr targets have been tested with this
- facility.
-
-
-
- pz:limitmap:name
+
+ pz:termlist_term_count
- Specifies attributes for limiting a search to a field - using
- the limit parameter for search. It can be used to filter locally
- or remotely (search in a target). In some cases the mapping of
- a field to a value is identical to an existing cclmap field; in
- other cases the field must be specified in a different way - for
- example to match a complete field (rather than parts of a subfield).
+ Specifies number of facet terms to be requested from the target.
+ The default is unspecified e.g. server-decided. Also see pz:facetmap.
+
+
+
+
+ pz:termlist_term_factor
+
- The value of limitmap may have one of three forms: referral to
- an existing CCL field, a raw PQF string or a local limit. Leading string
- determines type; either ccl: for CCL field,
- rpn: for PQF/RPN, or local:
- for filtering in Pazpar2. The local filtering may be followed
- by a field a metadata field (default is to use the name of the
- limitmap itself).
+ Specifies whether to use a factor for pazpar2 generated facets (1)
+ or not (0).
+ When mixing locally generated (by the downloaded (pz:maxrecs) samples)
+ facet with native (target-generated) facets, the later will
+ dominated the dominate the facet list since they are generated
+ based on the complete result set.
+ By scaling up the facet count using the ratio between total hit
+ count and the sample size,
+ the total facet count can be approximated and thus better compared
+ with native facets. This is not enabled by default.
-
-
- The limitmap facility is supported for Pazpar2 version 1.6.0.
- Local filtering is supported in Pazpar2 1.6.6.
-
-
@@ -1429,29 +1604,62 @@
-
- pz:sortmap:field
+
+ pz:xslt
- Specifies native sorting for a target where
- field is a sort criteria (see command
- show). The value has to components separated by colon: strategy and
- native-field. Strategy is one of z3950,
- type7, cql,
- sru11, or embed.
- The second component, native-field, is the field that is recognized
- by the target.
+ Is a comma separated list of of stylesheet names that specifies
+ how to convert incoming records to the internal representation.
+
+
+ For each name, the embedded stylesheets (XSL) that comes with the
+ service definition are consulted first and takes precedence over
+ external files; see
+ of service definition).
+ If the name does not match an embedded stylesheet it is
+ considered a filename.
+
+
+ The suffix of each file specifies the kind of tranformation.
+ Suffix ".xsl" makes an XSL transform. Suffix
+ ".mmap" will use the MMAP transform (described below).
+
+
+ The special value "auto" will use a file
+ which is the pz:requestsyntax's
+ value followed by
+ '.xsl'.
+
+
+ When mapping MARC records, XSLT can be bypassed for increased
+ performance with the alternate "MARC map" format. Provide the
+ path of a file with extension ".mmap" containing on each line:
+
+ <field> <subfield> <metadata element>
+ For example:
+
+ 245 a title
+ 500 $ description
+ 773 * citation
+
+ To map the field value specify a subfield of '$'. To store a
+ concatenation of all subfields, specify a subfield of '*'.
-
-
- Only supported for Pazpar2 1.6.4 and later.
-
-
-
+
+
+ pz:zproxy
+
+
+ The 'pz:zproxy' setting has the value syntax
+ 'host.internet.adress:port', it is used to tunnel Z39.50
+ requests through the named Z39.50 proxy.
+
+
+
+
-