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