3 Fix hang of 2nd command=show with esn/syntax given.
7 New merge attribute type: 'first', which takes all metadata fields
8 from first target that returns the particular field.
12 Extend info command with hostname and YAZ SHA1
13 Indent results for both command stat and info.
15 Allow limit on merged content. The new configuration metadata
16 element, limitcluster, configures that a metadata element (name) be used
17 as limit name for search. Applies to the whole service (ie all targets),
18 unlike pz:limitmap which is configured per-target (database).
20 New feature: limitmap local:* matches against all metadata fields.
22 Allow repeated list in limitmap spec . Separated by comma. For
23 example: value="local:title,rpn:@attr 1=4".
25 New element <message> in bytarget response. Holds diagnostic message
26 of code (say 'Unsupported Use Attribute' for Bib-1 114).
28 Improved logging for record ingestion failures.
30 Avoid using struct icu_chain in non-YAZ_HAVE_ICU mode. In the rare case,
31 when YAZ is compiled without ICU support.
35 Requires YAZ-4.2.40 to support native solr support.
37 Fix and improve logic handling whether or not to re-do search on sort
38 order changes. A sort order with change in ascending/descending only
39 whould not trigger a new search, which is required for targets with
40 native sorting capabilities. Each client is now checked if instructions
41 (sortmap) exist for native sorting and only client that does requires
42 it is researched. Other clients is just re-ingesting the records,
43 they already have. The resultset is now cleared if any researching
46 Connection sharing between session has broken since version 1.6.8 with
47 introduction of logic that would minimize searching if pazpar2 could
48 detect this based on same query and limits and partly sort order.
49 This could lead to segementations violations.
51 Added a chapter in the manaul about relevance ranking.
55 Rank tweak: follow=number will increase mult by number if two terms
56 occur next to each other; number-1 if they are one term apart , .. 0
57 if they are number a part (all in order). Default is 0 (following
60 Rank tweak: lead=k will divide mult by 1 + log2(1+k*l) where k is
61 value given by lead and l is length from beginning of field where
62 term occurs (l=0 for first term, l=1 for second term, ..). Default
65 Rank tweak: length=strategy. length="linear" if mult is to be divided
66 by length (existing, default behavior), length="log" if mult is to be
67 divided by log2(1+length), length="none" if mult is not to be affected
72 Rank algorithm details may be printed as part of show response in
73 element <relevance_info>.. This is only printed if <rank debug="yes"/>
76 Record as returned by show/record command have a minimal indentation
77 which makes things human-readable.
79 New configuration of default sorting criteria (sort-default) in
80 service definition. If no criteria is defined it will be as before
83 Search command now supports sort parameter just as the show command.
84 If no parameter is give, it will use the service sort-default value.
88 Rank algorithm skips strings that gets normalized to empty string.
89 For example, & and ! could map to the empty string. The weight for
90 those terms is now 0 (as if they were not part of the query).
92 Rank algorithm does not use CCL from limitmap; only from the query
93 parameter (user query).
99 Rank algorithm configurable by 'rank' element inside service. So far
100 only, attribute 'cluster' is recognized. If cluster="yes", multiple
101 records inside a cluster boosts higher than single records. This
102 is default behavior and existing behavior. cluster="no" takes the
103 average score of each record in a cluster.
105 --- 1.6.17 2012/09/05
107 Fix bad re-use of connections (connections with changing proxy should not
110 --- 1.6.16 2012/08/22
112 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
113 resultset and sorting when the sort order is position. However this will be done on
114 every client poll, which will make pazpar2 continuing reset and fetching.
115 It should only be done on FIRST request where the sort order change.
117 Fix an issue on suggestion option: Also disable suggestions on empty string.
119 Clean up in turbo marc stylesheet.
121 Remove the hardcoded size of termlists.
123 --- 1.6.15 2012/06/27
125 New facility: ccldirective may be given in service definition. Allows
126 CCL parsing to be customized a bit, such as defining names of operators
129 New facility: raw record by checksum, rather than offset. The record
130 command optionally takes checksum which identifies certain record from
133 New facility: per field ranking. Rank may be given as M [F N] where
134 M is default rank and N is rank for CCL terms from field F.
136 --- 1.6.14 2012/06/04
138 Fix for IE7/8 in pz.js
140 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
142 Lower log level some places.
144 Remove some invalid test results.
146 --- 1.6.13 2012/05/23
148 Introducing a version=2 parameter for show, termlist and bytarget commands.
149 This enables pazpar2 to return approximation on hit and count count when
150 doing record filtering using the limit parameter on search and a
151 limitmap with a value of "local:"
153 Setting pz:xslt may embed local XSLT as an alternative to referring
155 Value is not CDATA but XML nodes embedded, so escaping is not necessary
156 but a root element *must* be present. For example:
157 <settings target="target="z3950.indexdata.com/marc">
166 Metadata field rank may given by XML internal document (pz:xslt
167 result). If rank is not given, the rank from service description is
170 Metadata field can now configured a default limitmap and facetmap.
171 Setting limitmap to "local:" would work for all kind of targets, but would
172 prob. not be the optimal solution. But at least better than the default behavior
173 of pazpar2 where no filtering is done.
175 A service definition can now also contains <set/> that defines service-wide
176 settings. These will override server-wide sets and will be overridded by
179 New setting, pz:present_chunk, that specifies number of records to fetch
180 at a time. Zero will disable chunkation; will fetch max_records at once.
182 --- 1.6.12 2012/03/14
184 Revert the format change in termlist response, that could break
185 some clients / UIs since they were expecting an (empty) element
186 if no facet values was found.
188 --- 1.6.11 2012/03/07
190 Revert the behavior of returning errors when unable to block
191 on termlist, bytarget and search, when unable to block due to
192 other block. The client will now receive a regular response,
193 but it will be logged in the server. A parameter (report) is
194 added to change behavior to return error response or WARNING
195 status message. Consider this "API" as private, as it is mostly
196 untested and could be changed in future releases.
198 Fix spell error in pz2.js fix in 1.6.10.
200 New Marc2TurboMarc.xsl (contribution from Sven Porst).
201 Can solve the missing marc21.xsl updates in some cases.
203 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
204 substring (contribtion from Sven Porst)
206 marc21.xsl: fix 1-based substring call
208 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
210 Add test_termlist_block to test suite
212 --- 1.6.10 2012/02/23
214 Fix SEGV for invalid PQFs and SRU/SOLR targets
215 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
217 Fix pz2.js: "null object" due to change in in bytarget result XML.
219 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
220 Added this normalization to the other subject-long fields (d6xx),
221 where it was missing.
223 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
224 Still differences around medium and holdings. marc21.xsl is not
225 longer active used by Index Data, and should be considered unsupported.
226 Use tmarc.xsl instead.
230 Fix SEGV that could occur for failed connections.
234 Fix bug for command sort that could return no results for active clients
235 (from previous search). This bug was present in 1.6.6-1.6.7.
237 Fix bug in results that could include results that should have been
238 filtered out. This bug was present in 1.6.6-1.6.7.
242 Fix bug introduced in 1.6.6 where a connection re-use could stall
245 Local filtering may now specify a local metadata field, eg.
246 pz:limitmap:somefield[t]=local:otherfield
250 For search, when limit and or filtering is in place and search
251 is identical to previous search, the result set is re-used and the
252 target is not searched.
254 Limits may work perform local filtering as well, by using "local:"
259 Updated bytarget command to contain a suggestions element with misspelled
260 words and suggestions to these. pz2.js has been updated to deliver this
261 onwards as well. Only target that currently delivers this is the solr
262 client in YAZ 4.2.18.
266 New service definition element, xslt, that allows an embedded stylesheet
267 to be defined. This can be referred to from pz:xslt as an alternative to
270 New pz:sortmap:field setting for specifying hints on how to make
271 a target natively sort on a field. This is used for command=show in
272 conjunction with sort.
274 New pz:url setting for specifying the actual URL for a target. When
275 this is used the target ID is not used as URL anymore and the target ID
276 may be almost any string (not including []).
278 command=termlist without name parameter returns all termlists/facets.
279 Previously if name parameter was omitted, only "subject" was returned.
283 Make termlist sorting stable. Terms with same frequency are now sorted by
284 their display name. This makes a pretty display and improves our
285 regression test because qsort is not a stable sort.
287 New sort parameter value 'position'. The 'position' sorts merged records
288 by their original position from the remote target. This is primarily useful
289 for debugging and may be used for targets that already perform some kind
290 of relevance ranking. Note that sort by default is decreasing; so to get
291 records in their original order sort=position:1 must be used.
295 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
297 Facility to change working directory for pazpar2 daemon. Option -wdir
298 sets working directory to dir. This facility is useful if core dumps
299 must be saved. In this case, the current working directory must be
300 writable by the running user, such as "nobody".
304 New configuration element <icu_chain> for <server>/<service> which
305 allows a named ICU rule (chain) to be defined. The names relevance,
306 sort, mergekey and facet are used for those operations. The definition
307 <icu_chain id="sort" locale="en"> .. </icu_chain>
309 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
310 And so on.. for relevance, mergekey and facet as well. The latter
311 style is deprecated. The facet terms are normalized by the facet
312 rule by default. This may be changed on a metadata field basis by
313 defining the new attribute 'facetrule' for the metadata element.
315 <icu_chain id="myrule" locale="en"> ... </icu_chain>
316 <metadata name="author" termlist="yes" facetrule="myrule"/>
318 Preserve rorder for merged metadata. Fixes issue as reported by Sven
319 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
321 tmarc.xsl: set journal-subpart to 773$ only.
325 Modify the behavior for the limit parameter (first defined in 1.5.7).
326 Mapping of limit searches are now defined by the new configuration item
327 pz:limitmap. Fix a dead-lock problem with the limit parameter.
329 Extend tmarc.xsl to extract 773$g data (OpenURL).
333 ICU default maps remove backquote (`).
335 Command 'search' takes limit parameter (optional). The limit parameter
336 allows a search to be limited one or more facets and the corresponding
337 values. This is for server side filtering.
339 Configure tweak: Use -lm for log(3) if needed
343 Fix a problem with skiparticle sortkey that could be completely
344 ignored (and reduced to "").
346 Fix dependency problem in pazpar2 RPM package (did not require
347 libyaz4 as it should).
351 Fix memory leak that occurred for command=termlist&name=xtargets .
353 Pazpar2 may save HTTP requests. Enabled by option -R.
357 Experimental support for DTIC DADS target. New dads-pz2.xsl.
359 Support for query_syntax (overrides the default for SRU | Z39.50)
361 Support for extraArgs (ZOOM "extraArgs" option) for targets
363 New commands: status-server and status-session
367 Fix for threaded runs: Client now have a copy of the database URL,
368 which can used after the database has been release from the client.
369 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
371 tmarc.xsl: Add journal-title-abbrev and full text.
373 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
375 Fix for cmd=record before search.
377 Session Logging clean up.
379 Fix wrong termlist factor when maxrecs is different from 100.
383 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
384 Term factor is default enabled but can be diseabled by
385 pz:termlist_term_factor=0
389 Add scaling of facet count. Currently always enabled, needs fixing.
390 Allow user-defined info for target suffix. This has no meaning in
391 Pazpar2 except to distinguish targets from each other. The suffix
392 data begins with #. For example z3950.indexdata.com/gils#Mydata
394 Added exact-match recordfilter; format name=value
398 SOLR support. Pazpar2 may operate as web service client for SOLR.
402 Fix for show command and block=1 (dead lock). Bug was introduced in
407 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
408 tested on CentOS 5.5 only.
412 Fix problem with result sets being removed from a client session
413 if the connection for it was resused by another session. Bug #3489.
415 New iphone UI for Pazpar2 (www/iphone).
419 Fixes for threaded operation.
421 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
423 New example services in etc/services in source. In the Debian packages
424 these are located in /etc/pazpar2/services-available
426 Threaded mode operational on Windows. Requires Windows 7 or Windows
429 Default value of setting pz:max_connections is 0 which means that there
430 is no limit on number of connections.
434 Pazpar2 may operate in threaded mode. Enabled by element threads in
435 the configuration. See pazpar2_conf for details.
437 New setting setting: pz:max_connections. Setting pz:max_connections is
438 a limit of number of sockets to a host. When this limit is reached,
439 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
440 The client will be marked Client_Error when it can not be searched
441 (other clients in a session may work). If pz:max_connections is not set
442 for a target, a value of 30 will be used. Note: the pz:max_connections
443 will only work in threaded mode.
445 pz2.js: JSON support for show.
447 Debian package: Enable default service, default.xml, before starting
448 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
452 Debian version depends on on libyaz4. Note that Pazpar2 will still
453 compile from source with YAZ 3.
455 Split services into separate files. The example configuration file
456 pazpar2.cfg.dist now includes a default service default.xml (part of
457 etc). And default.xml includes settings/edu.xml. The default.xml file,
458 not to be confused with settings/defaults.xml, is a template for jsdemo
459 and other services. The Debian package installs /etc/pazpar2/server.xml
460 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
461 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
462 The default.xml (from etc) is installed in /etc/pazpar2/services-available
463 and a symlink to it is created from services-enabled. The default.xml
464 service is unnamed and, thus, will be used by jsdemo and test1.
466 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
467 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
471 Support for additional fields in cf.xsl and pazpar2.conf.dist:
472 publisher, available, due, location (=locallocation), callno
473 (=callnumber), thumburl and score.
475 Describe pz:xslt and the auto setting.
477 Move mergekey definition away from the normalization stylesheets and
478 define a mergekey common for all target types in pazpar2.cfg.
480 Code update: Use the Odr_int type for hit counts. This is part of
481 YAZ 3.0.47 and later and so configure checks for that.
485 Metadata attribute 'skiparticle' also works for ICU based
486 normalization. (was only working for the non-ICU/ASCII before).
488 Command bytarget with argument settings=1 will show settings per
489 target.. This is to be able to verify correct settings and be able to
490 test that they are correct. The database settings array size is now
491 also stored.. Problems with database settings array is that if not
492 careful it will be too small (smaller than dictionary per-service
495 Make record list sorting stable by comparing mergekey for records if
496 relevance/title or other sorting criteria all match. This is merely to
497 ensure that our regressions tests works (reproducible output).
499 Relevance calculation changes: use a different denominator (length) for
500 per-field relevance scoring.. Instead of length of all ranked fields we
501 now use length of individual fields (as if they were individual "free"
502 text fields). This will ensure that documents with a long field with no
503 match (say description) will not "hurt" a title match.
505 Diagnostic member was not set on connection error. Fixed
509 Command search takes two optional parameters, startecs and maxrecs,
510 that specifies the start offset (0, 1, ...) and maximum number of records
511 to fetch for each target.
513 XSLTs + MARC maps are cached within a session so we don't re-parse
514 them over and over again. Even for a session with a single search
515 there's much to be gained because many targets use the same
518 The metadata attribute 'mergekey' now takes one of three values 'no',
519 'required', 'optional' . And the resulting mergekey from metadata
520 is now ordered in the same way as metadata in the service definition.
521 Older Pazpar2 version use the order in which metadata appeared in a
524 The search argument 'filter' now offers a new operator ~ which does a
525 substring match. The = operator works as before: string match for
526 anything but pz:id, or target match for pz:id.
528 New setting pz:recordfilter. The value of this setting takes the
529 form name[~value]. This setting makes Pazpar2 ignore all retrieved
530 records that do not have the metadata element name with value substring
533 Pazpar2 allows YAZ log level to be set (option -v).
537 For WS responses Pazpar2 creates XML header. Exception: raw record.
539 Setting XML files are now stored in etc/settings instead of etc. This
540 reflects the layout with the Debian package layout.
542 Settings may be posted for command=settings. The POSTed settings must
543 have root element 'settings' like regular setting files. In order to be
544 recognized, the POST request must use Content-Type=text/xml.
546 A service may be posted for command=init. This service will be used
547 during the session. The service may have its own target settings,
548 ICU config, timeout, etc. In order to be recognized, the POST request
549 must use Content-Type=text/xml.
551 Timeout values may be given per-service. That's element 'timeout'
552 which takes three attribute values (a subset may be given): 'session',
553 'z3950_operation', 'z3950_session'. Option -T is no longer supported
554 - used to specify session timeout.
556 Option -t tests the Pazpar2 configuration and returns exit code
557 (0=success, non-zero=failure). In previous version of Pazpar2, -t
558 specified local settings.
560 In version 1.2.0 the configuration file - after include processing -
561 was dumped to stdout. Now, the configuration is only dumped to the
562 yaz log file if option -d is given.
566 Configuration may now have multiple server areas. This means that a
567 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
568 yet supported - on a server basis. Configuration may also have multiple
569 services .. That is repeating service elements inside a server. Each
570 has an attribute 'id' which serves as service ID. This ID in turn may
571 be used in a Pazpar2 session, by specifying parameter service=ID for
572 command init. There can be at most one unnamed service inside a server
573 which can be referred to by not specifying an service ID for command
574 init (backwards compatible). In order to partition multiple servers and
575 services a new include directive has been added. This takes an attribute
576 'src' which specifies one or more sub-files. For example to include
577 service files, one might use:
578 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
579 It is the intention that that completely makes the settings directive
582 Fix problem where the record command would wait forever if there were
583 no targets to wait for (activeclients == 0).
587 One result set is created per session (last search) rather than for
588 each connection which happen to be shared (bug #3009).
590 marc21 stylesheets changed for efficiency.
594 Session timeout may be specified on the command-line as option -T.
596 Pazpar2 may now be operated in a no-merged mode for records.. All records
597 will be considered unique. This mode is enabled if no mergekey is
598 generated by the normalization stylesheet (pz:xslt).
600 Pazpar2 caches original records from each target and the 'record' command
601 with offset returns the original record if 'syntax' and 'esn' are NOT
602 specified. This speeds up retrieval of original records but also means
603 that Pazpar2 uses more memory. The cached records will be freed when the
604 session terminates or a new search is executed.
606 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
607 library part of YAZ is used.
609 Added SRU client support.
611 Automatically computes pz:nativesyntax if not provided. Works for XML and
614 --- 1.0.13 2008/11/24
616 Command bytarget returns name of target (if defined).
618 --- 1.0.12 2008/11/04
620 Fixed bug #2021.. location now holds all brief elements.
622 --- 1.0.11 2008/10/15
624 Fixed check for application/x-www-form-urlencoded parameters.
626 --- 1.0.10 2008/10/14
628 Fixes for IE in pz2.js.
630 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
634 Changed the JS library pz2.js to use POST for long URL (+ params).
636 Added installation instructions for Windows. Note: NT services is
637 NOT available until we make a new release of YAZ.
639 Preserve order of repeated metadata fields (they were reversed before).
641 More MARC21 information extracted for metadata.
645 Fixed bug #1162: HTML entities are not escaped properly.
647 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
651 Marc21 stylesheet updated to reflect multiple full text fields
655 Fixed bug in pz2.js WRT DOMElement attributes on IE.
657 Fixed bug 2100: Database wildcards not working
661 Added support for retrieval of records in binary.
663 Fixed bug 1794: Pazpar2 does not return valid XML.
665 Deal with ICU not returning sortkey (resulted in SEGV before).
669 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
670 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
672 Improved diagnostics when Pazpar2 HTTP decoding fails.
674 Pazpar2 requests may be POSTed as using Content-Type
675 application/x-www-form-urlencoded.
677 Pazpar2 honors LF in HTTP headers.
679 Handle targets that handle negative hit counts (should not happen, but it
684 ICU is used for tokenization and normalization of the following: mergekey,
685 sorting, relevance terms.
687 Debian package now enables ICU tokenization and normalization by default.
691 Exposed user setting values (i.e. non-pz: names) to the record systems in two
692 ways: Either as parameters to the normalization stylesheets (which would allow the
693 programmer to postprocess or use the values in any way) or after the normalization
694 step, in which case values are made part of the normalized record (and available for
695 sorting, termlists, display, or other interface-related use.
697 Implemented sorting by year.
699 Option -d dumps records to the current log file instead of stderr.
701 Fixes for compilation on cygwin.
703 Z39.50 client code uses pz:elements. pz:elements was recognized in
704 earlier Pazpar2 versions but it was not used for anything.
706 icu_chain_test is using fgets instead of getline - fixes compilation
709 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
710 query conversions fail (rather than _any_). This means targets that do
711 not support some fields are ignored in a search.
715 Improved handling of socket timeout for Z39.50 connections.
717 Misc documentation updates and spell fixes.
719 Debian package pazpar2 creates log rotate entry.
721 Debian package pazpar2-apache2 reloads Apache2.
723 jsdemo included in distribution. It illustrates the use of the js/pz2.js
728 First public release.