Configures the webservice -- this controls how you can connect to Pazpar2 from your browser or server-side code. The attributes 'host' and 'port' control the binding of the server. The 'host' attribute can be used to bind the server to a secondary IP address of your system, enabling you to run Pazpar2 on port 80 alongside a conventional web server. You can override this setting on the command line using the option -h.

If this item is given, Pazpar2 will forward all incoming HTTP requests that do not contain the filename 'search.pz2' to the host and port specified using the 'host' and 'port' attributes. The 'myurl' attribute is required, and should provide the base URL of the server. Generally, the HTTP URL for the host specified in the 'listen' parameter. This functionality is crucial if you wish to use Pazpar2 in conjunction with browser-based code (JS, Flash, applets, etc.) which operates in a security sandbox. Such code can only connect to the same server from which the enclosing HTML page originated. Pazpar2's proxy functionality enables you to host all of the main pages (plus images, CSS, etc.) of your application on a conventional webserver, while efficiently processing webservice requests for metasearch status, results, etc.

Specifies character set normalization for relevancy / sorting / mergekey and facets - for the server. These definitions serve as default for services that don't have these given. For the meaning of these settings refer to the icu_chain element inside service.

Obsolete. Use element icu_chain instead.

Specifies target settings for the server. These settings serve as default for all services which don't have these given. 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 are read from this directory. Refer to the section called “TARGET SETTINGS” for more information.

This nested element controls the behavior of Pazpar2 with respect to your data model. In Pazpar2, incoming records are normalized, using XSLT, into an internal representation. The 'service' section controls the further processing and extraction of data from the internal representation, primarily through the 'metadata' sub-element.

Pazpar2 version 1.2 and later allows multiple service elements. Multiple services must be given a unique ID by specifying attribute id. A single service may be unnamed (service ID omitted). The service ID is referred to in the init webservice command's service parameter.

This specifies the search target to which this setting should be applied. Targets are identified by their Z39.50 URL, generally including the host, port, and database name, (e.g. z3950.indexdata.com:210/marc). Two wildcard forms are accepted: * (asterisk) matches all known targets; z3950.indexdata.com:210/* matches all known databases on the given host.

A precedence system determines what happens if there are overlapping values for the same setting name for the same target. A setting for a specific target name overrides a setting which specifies target using a wildcard. This makes it easy to set defaults for all targets, and then override them for specific targets or hosts. If there are multiple overlapping settings with the same name and target value, the 'precedence' attribute determines what happens.

For Pazpar2 1.6.4 or later, the target ID may be user-defined, in which case, the actual host, port, etc., is given by the setting pz:url.

The name of the setting. This can be anything you like. However, Pazpar2 reserves a number of setting names for specific purposes, all starting with 'pz:', and it is a good idea to avoid that prefix if you make up your own setting names. See below for a list of reserved variables.

The value of the setting. Generally, this can be anything you want -- however, some of the reserved settings may expect specific kinds of values.

This should be an integer. If not provided, the default value is 0. If two (or more) settings have the same content for target and name, the precedence value determines the outcome. If both settings have the same precedence value, they are both applied to the target(s). If one has a higher value, then the value of that setting is applied, and the other one is ignored.

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).

If the 'pz:apdulog' setting is defined and has other value than 0, then Z39.50 APDUs are written to the log.

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 protocols, such as SRU and Apache 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 of operation is determined by pz:authentication_mode setting.

Determines how authentication is carried in HTTP based protocols. Value may be "basic" or "url".

(Not yet implemented). Specifies the time for which a block should be released anyway.

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.

The element set name to be used when retrieving records from a server.

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).

Specifies that for field name, the target supports (native) facets. The value is the name of the field on the target.

Like pz:facetmap, but makes Pazpar2 inspect the term value consisting of two items separated by colon. First item is the raw ID to be sent to database if limitmap on the field name is used. The second item is the display term.

This facility was added in Pazpar2 version 1.11.0.

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.

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.

Controls the maximum number of records to be retrieved from a server. The default is 100.

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.

This setting is honored in Pazpar2 1.6.39 or later. Pazpar2 must be using YAZ version 5.0.13 or later.

If set and non-empty, redis will be configured and enabled for the target. The value of this setting is exactly as the redis option for ZOOM C of YAZ. Refer to the YAZ manual.

This setting is honored in Pazpar2 1.6.43 or later. Pazpar2 must be using YAZ version 5.2.0 or later.

Specifies how Pazpar2 should 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 character 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).

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.

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).

Allows you to specify an arbitrary PQF query language substring. The provided string is prefixed to the user's query after it has been normalized to PQF internally in pazpar2. This allows you to attach complex 'filters' to queries for a given target, sometimes necessary to select sub-catalogs in union catalog systems, etc.

Allows you to extend a query with dates and operators. The provided string allows certain substitutions and serves as a format string. The special two character sequence '%%' gets converted to the original query. Other characters leading with the percent sign are conversions supported by strftime. All other characters are copied verbatim. For example, the string @and @attr 1=30 @attr 2=3 %Y %% would search for current year combined with the original PQF (%%).

This setting can also be used as more general alternative to pz:pqf_prefix -- a way of embedding the submitted query anywhere in the string rather than appending it to prefix. For example, if it is desired to omit all records satisfying the query @attr 1=pica.bib 0007 then this subquery can be combined with the submitted query as the second argument of @andnot by using the pz:pqf_strftime value @not %% @attr 1=pica.bib 0007

Specifies that a target is preferred, e.g. possible local, faster target. Using block=preferred on show command will wait for all these targets to return records before releasing the block. If no target is preferred, the block=preferred will be identical to block=1, which release when one target has returned records.

Controls the chunk size in present requests. Pazpar2 will make (maxrecs / chunk) request(s). The default is 20.

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.

Specifies a filter which allows Pazpar2 to only include records that meet a certain criteria in a result. Unmatched records will be ignored. The filter takes the form name, name~value, or name=value, which will include only records with metadata element (name) that has the substring (~value) given, or matches exactly (=value). If value is omitted all records with the named metadata element present will be included.

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.

Specifies sort criteria to be applied to the result set. Only works for targets which support the sort service.

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.

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.

This allows SRU version to be specified. If unset Pazpar2 will use 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.

Specifies number of facet terms to be requested from the target. The default is unspecified e.g. server-decided. Also see pz:facetmap.

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 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.

Specifies timeout for operation (e.g. search, and fetch) for a database. This overrides the z3650_operation timeout that is given for a service. See timeout.

Specifies URL for the target and overrides the target ID.

A comma-separated list 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 take precedence over external files; see xslt 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 '*'.

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.