3 Requires YAZ-4.2.40 to support native solr support.
5 Fix and improve logic handling whether or not to re-do search on sort
6 order changes. A sort order with change in ascending/descending only
7 whould not trigger a new search, which is required for targets with
8 native sorting capabilities. Each client is now checked if instructions
9 (sortmap) exist for native sorting and only client that does requires
10 it is researched. Other clients is just re-ingesting the records,
11 they already have. The resultset is now cleared if any researching
14 Connection sharing between session has broken since version 1.6.8 with
15 introduction of logic that would minimize searching if pazpar2 could
16 detect this based on same query and limits and partly sort order.
17 This could lead to segementations violations.
21 Rank tweak: follow=number will increase mult by number if two terms
22 occur next to each other; number-1 if they are one term apart , .. 0
23 if they are number a part (all in order). Default is 0 (following
26 Rank tweak: lead=k will divide mult by 1 + log2(1+k*l) where k is
27 value given by lead and l is length from beginning of field where
28 term occurs (l=0 for first term, l=1 for second term, ..). Default
31 Rank tweak: length=strategy. length="linear" if mult is to be divided
32 by length (existing, default behavior), length="log" if mult is to be
33 divided by log2(1+length), length="none" if mult is not to be affected
38 Rank algorithm details may be printed as part of show response in
39 element <relevance_info>.. This is only printed if <rank debug="yes"/>
42 Record as returned by show/record command have a minimal indentation
43 which makes things human-readable.
45 New configuration of default sorting criteria (sort-default) in
46 service definition. If no criteria is defined it will be as before
49 Search command now supports sort parameter just as the show command.
50 If no parameter is give, it will use the service sort-default value.
54 Rank algorithm skips strings that gets normalized to empty string.
55 For example, & and ! could map to the empty string. The weight for
56 those terms is now 0 (as if they were not part of the query).
58 Rank algorithm does not use CCL from limitmap; only from the query
59 parameter (user query).
65 Rank algorithm configurable by 'rank' element inside service. So far
66 only, attribute 'cluster' is recognized. If cluster="yes", multiple
67 records inside a cluster boosts higher than single records. This
68 is default behavior and existing behavior. cluster="no" takes the
69 average score of each record in a cluster.
73 Fix bad re-use of connections (connections with changing proxy should not
78 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
79 resultset and sorting when the sort order is position. However this will be done on
80 every client poll, which will make pazpar2 continuing reset and fetching.
81 It should only be done on FIRST request where the sort order change.
83 Fix an issue on suggestion option: Also disable suggestions on empty string.
85 Clean up in turbo marc stylesheet.
87 Remove the hardcoded size of termlists.
91 New facility: ccldirective may be given in service definition. Allows
92 CCL parsing to be customized a bit, such as defining names of operators
95 New facility: raw record by checksum, rather than offset. The record
96 command optionally takes checksum which identifies certain record from
99 New facility: per field ranking. Rank may be given as M [F N] where
100 M is default rank and N is rank for CCL terms from field F.
102 --- 1.6.14 2012/06/04
104 Fix for IE7/8 in pz.js
106 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
108 Lower log level some places.
110 Remove some invalid test results.
112 --- 1.6.13 2012/05/23
114 Introducing a version=2 parameter for show, termlist and bytarget commands.
115 This enables pazpar2 to return approximation on hit and count count when
116 doing record filtering using the limit parameter on search and a
117 limitmap with a value of "local:"
119 Setting pz:xslt may embed local XSLT as an alternative to referring
121 Value is not CDATA but XML nodes embedded, so escaping is not necessary
122 but a root element *must* be present. For example:
123 <settings target="target="z3950.indexdata.com/marc">
132 Metadata field rank may given by XML internal document (pz:xslt
133 result). If rank is not given, the rank from service description is
136 Metadata field can now configured a default limitmap and facetmap.
137 Setting limitmap to "local:" would work for all kind of targets, but would
138 prob. not be the optimal solution. But at least better than the default behavior
139 of pazpar2 where no filtering is done.
141 A service definition can now also contains <set/> that defines service-wide
142 settings. These will override server-wide sets and will be overridded by
145 New setting, pz:present_chunk, that specifies number of records to fetch
146 at a time. Zero will disable chunkation; will fetch max_records at once.
148 --- 1.6.12 2012/03/14
150 Revert the format change in termlist response, that could break
151 some clients / UIs since they were expecting an (empty) element
152 if no facet values was found.
154 --- 1.6.11 2012/03/07
156 Revert the behavior of returning errors when unable to block
157 on termlist, bytarget and search, when unable to block due to
158 other block. The client will now receive a regular response,
159 but it will be logged in the server. A parameter (report) is
160 added to change behavior to return error response or WARNING
161 status message. Consider this "API" as private, as it is mostly
162 untested and could be changed in future releases.
164 Fix spell error in pz2.js fix in 1.6.10.
166 New Marc2TurboMarc.xsl (contribution from Sven Porst).
167 Can solve the missing marc21.xsl updates in some cases.
169 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
170 substring (contribtion from Sven Porst)
172 marc21.xsl: fix 1-based substring call
174 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
176 Add test_termlist_block to test suite
178 --- 1.6.10 2012/02/23
180 Fix SEGV for invalid PQFs and SRU/SOLR targets
181 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
183 Fix pz2.js: "null object" due to change in in bytarget result XML.
185 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
186 Added this normalization to the other subject-long fields (d6xx),
187 where it was missing.
189 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
190 Still differences around medium and holdings. marc21.xsl is not
191 longer active used by Index Data, and should be considered unsupported.
192 Use tmarc.xsl instead.
196 Fix SEGV that could occur for failed connections.
200 Fix bug for command sort that could return no results for active clients
201 (from previous search). This bug was present in 1.6.6-1.6.7.
203 Fix bug in results that could include results that should have been
204 filtered out. This bug was present in 1.6.6-1.6.7.
208 Fix bug introduced in 1.6.6 where a connection re-use could stall
211 Local filtering may now specify a local metadata field, eg.
212 pz:limitmap:somefield[t]=local:otherfield
216 For search, when limit and or filtering is in place and search
217 is identical to previous search, the result set is re-used and the
218 target is not searched.
220 Limits may work perform local filtering as well, by using "local:"
225 Updated bytarget command to contain a suggestions element with misspelled
226 words and suggestions to these. pz2.js has been updated to deliver this
227 onwards as well. Only target that currently delivers this is the solr
228 client in YAZ 4.2.18.
232 New service definition element, xslt, that allows an embedded stylesheet
233 to be defined. This can be referred to from pz:xslt as an alternative to
236 New pz:sortmap:field setting for specifying hints on how to make
237 a target natively sort on a field. This is used for command=show in
238 conjunction with sort.
240 New pz:url setting for specifying the actual URL for a target. When
241 this is used the target ID is not used as URL anymore and the target ID
242 may be almost any string (not including []).
244 command=termlist without name parameter returns all termlists/facets.
245 Previously if name parameter was omitted, only "subject" was returned.
249 Make termlist sorting stable. Terms with same frequency are now sorted by
250 their display name. This makes a pretty display and improves our
251 regression test because qsort is not a stable sort.
253 New sort parameter value 'position'. The 'position' sorts merged records
254 by their original position from the remote target. This is primarily useful
255 for debugging and may be used for targets that already perform some kind
256 of relevance ranking. Note that sort by default is decreasing; so to get
257 records in their original order sort=position:1 must be used.
261 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
263 Facility to change working directory for pazpar2 daemon. Option -wdir
264 sets working directory to dir. This facility is useful if core dumps
265 must be saved. In this case, the current working directory must be
266 writable by the running user, such as "nobody".
270 New configuration element <icu_chain> for <server>/<service> which
271 allows a named ICU rule (chain) to be defined. The names relevance,
272 sort, mergekey and facet are used for those operations. The definition
273 <icu_chain id="sort" locale="en"> .. </icu_chain>
275 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
276 And so on.. for relevance, mergekey and facet as well. The latter
277 style is deprecated. The facet terms are normalized by the facet
278 rule by default. This may be changed on a metadata field basis by
279 defining the new attribute 'facetrule' for the metadata element.
281 <icu_chain id="myrule" locale="en"> ... </icu_chain>
282 <metadata name="author" termlist="yes" facetrule="myrule"/>
284 Preserve rorder for merged metadata. Fixes issue as reported by Sven
285 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
287 tmarc.xsl: set journal-subpart to 773$ only.
291 Modify the behavior for the limit parameter (first defined in 1.5.7).
292 Mapping of limit searches are now defined by the new configuration item
293 pz:limitmap. Fix a dead-lock problem with the limit parameter.
295 Extend tmarc.xsl to extract 773$g data (OpenURL).
299 ICU default maps remove backquote (`).
301 Command 'search' takes limit parameter (optional). The limit parameter
302 allows a search to be limited one or more facets and the corresponding
303 values. This is for server side filtering.
305 Configure tweak: Use -lm for log(3) if needed
309 Fix a problem with skiparticle sortkey that could be completely
310 ignored (and reduced to "").
312 Fix dependency problem in pazpar2 RPM package (did not require
313 libyaz4 as it should).
317 Fix memory leak that occurred for command=termlist&name=xtargets .
319 Pazpar2 may save HTTP requests. Enabled by option -R.
323 Experimental support for DTIC DADS target. New dads-pz2.xsl.
325 Support for query_syntax (overrides the default for SRU | Z39.50)
327 Support for extraArgs (ZOOM "extraArgs" option) for targets
329 New commands: status-server and status-session
333 Fix for threaded runs: Client now have a copy of the database URL,
334 which can used after the database has been release from the client.
335 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
337 tmarc.xsl: Add journal-title-abbrev and full text.
339 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
341 Fix for cmd=record before search.
343 Session Logging clean up.
345 Fix wrong termlist factor when maxrecs is different from 100.
349 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
350 Term factor is default enabled but can be diseabled by
351 pz:termlist_term_factor=0
355 Add scaling of facet count. Currently always enabled, needs fixing.
356 Allow user-defined info for target suffix. This has no meaning in
357 Pazpar2 except to distinguish targets from each other. The suffix
358 data begins with #. For example z3950.indexdata.com/gils#Mydata
360 Added exact-match recordfilter; format name=value
364 SOLR support. Pazpar2 may operate as web service client for SOLR.
368 Fix for show command and block=1 (dead lock). Bug was introduced in
373 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
374 tested on CentOS 5.5 only.
378 Fix problem with result sets being removed from a client session
379 if the connection for it was resused by another session. Bug #3489.
381 New iphone UI for Pazpar2 (www/iphone).
385 Fixes for threaded operation.
387 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
389 New example services in etc/services in source. In the Debian packages
390 these are located in /etc/pazpar2/services-available
392 Threaded mode operational on Windows. Requires Windows 7 or Windows
395 Default value of setting pz:max_connections is 0 which means that there
396 is no limit on number of connections.
400 Pazpar2 may operate in threaded mode. Enabled by element threads in
401 the configuration. See pazpar2_conf for details.
403 New setting setting: pz:max_connections. Setting pz:max_connections is
404 a limit of number of sockets to a host. When this limit is reached,
405 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
406 The client will be marked Client_Error when it can not be searched
407 (other clients in a session may work). If pz:max_connections is not set
408 for a target, a value of 30 will be used. Note: the pz:max_connections
409 will only work in threaded mode.
411 pz2.js: JSON support for show.
413 Debian package: Enable default service, default.xml, before starting
414 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
418 Debian version depends on on libyaz4. Note that Pazpar2 will still
419 compile from source with YAZ 3.
421 Split services into separate files. The example configuration file
422 pazpar2.cfg.dist now includes a default service default.xml (part of
423 etc). And default.xml includes settings/edu.xml. The default.xml file,
424 not to be confused with settings/defaults.xml, is a template for jsdemo
425 and other services. The Debian package installs /etc/pazpar2/server.xml
426 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
427 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
428 The default.xml (from etc) is installed in /etc/pazpar2/services-available
429 and a symlink to it is created from services-enabled. The default.xml
430 service is unnamed and, thus, will be used by jsdemo and test1.
432 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
433 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
437 Support for additional fields in cf.xsl and pazpar2.conf.dist:
438 publisher, available, due, location (=locallocation), callno
439 (=callnumber), thumburl and score.
441 Describe pz:xslt and the auto setting.
443 Move mergekey definition away from the normalization stylesheets and
444 define a mergekey common for all target types in pazpar2.cfg.
446 Code update: Use the Odr_int type for hit counts. This is part of
447 YAZ 3.0.47 and later and so configure checks for that.
451 Metadata attribute 'skiparticle' also works for ICU based
452 normalization. (was only working for the non-ICU/ASCII before).
454 Command bytarget with argument settings=1 will show settings per
455 target.. This is to be able to verify correct settings and be able to
456 test that they are correct. The database settings array size is now
457 also stored.. Problems with database settings array is that if not
458 careful it will be too small (smaller than dictionary per-service
461 Make record list sorting stable by comparing mergekey for records if
462 relevance/title or other sorting criteria all match. This is merely to
463 ensure that our regressions tests works (reproducible output).
465 Relevance calculation changes: use a different denominator (length) for
466 per-field relevance scoring.. Instead of length of all ranked fields we
467 now use length of individual fields (as if they were individual "free"
468 text fields). This will ensure that documents with a long field with no
469 match (say description) will not "hurt" a title match.
471 Diagnostic member was not set on connection error. Fixed
475 Command search takes two optional parameters, startecs and maxrecs,
476 that specifies the start offset (0, 1, ...) and maximum number of records
477 to fetch for each target.
479 XSLTs + MARC maps are cached within a session so we don't re-parse
480 them over and over again. Even for a session with a single search
481 there's much to be gained because many targets use the same
484 The metadata attribute 'mergekey' now takes one of three values 'no',
485 'required', 'optional' . And the resulting mergekey from metadata
486 is now ordered in the same way as metadata in the service definition.
487 Older Pazpar2 version use the order in which metadata appeared in a
490 The search argument 'filter' now offers a new operator ~ which does a
491 substring match. The = operator works as before: string match for
492 anything but pz:id, or target match for pz:id.
494 New setting pz:recordfilter. The value of this setting takes the
495 form name[~value]. This setting makes Pazpar2 ignore all retrieved
496 records that do not have the metadata element name with value substring
499 Pazpar2 allows YAZ log level to be set (option -v).
503 For WS responses Pazpar2 creates XML header. Exception: raw record.
505 Setting XML files are now stored in etc/settings instead of etc. This
506 reflects the layout with the Debian package layout.
508 Settings may be posted for command=settings. The POSTed settings must
509 have root element 'settings' like regular setting files. In order to be
510 recognized, the POST request must use Content-Type=text/xml.
512 A service may be posted for command=init. This service will be used
513 during the session. The service may have its own target settings,
514 ICU config, timeout, etc. In order to be recognized, the POST request
515 must use Content-Type=text/xml.
517 Timeout values may be given per-service. That's element 'timeout'
518 which takes three attribute values (a subset may be given): 'session',
519 'z3950_operation', 'z3950_session'. Option -T is no longer supported
520 - used to specify session timeout.
522 Option -t tests the Pazpar2 configuration and returns exit code
523 (0=success, non-zero=failure). In previous version of Pazpar2, -t
524 specified local settings.
526 In version 1.2.0 the configuration file - after include processing -
527 was dumped to stdout. Now, the configuration is only dumped to the
528 yaz log file if option -d is given.
532 Configuration may now have multiple server areas. This means that a
533 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
534 yet supported - on a server basis. Configuration may also have multiple
535 services .. That is repeating service elements inside a server. Each
536 has an attribute 'id' which serves as service ID. This ID in turn may
537 be used in a Pazpar2 session, by specifying parameter service=ID for
538 command init. There can be at most one unnamed service inside a server
539 which can be referred to by not specifying an service ID for command
540 init (backwards compatible). In order to partition multiple servers and
541 services a new include directive has been added. This takes an attribute
542 'src' which specifies one or more sub-files. For example to include
543 service files, one might use:
544 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
545 It is the intention that that completely makes the settings directive
548 Fix problem where the record command would wait forever if there were
549 no targets to wait for (activeclients == 0).
553 One result set is created per session (last search) rather than for
554 each connection which happen to be shared (bug #3009).
556 marc21 stylesheets changed for efficiency.
560 Session timeout may be specified on the command-line as option -T.
562 Pazpar2 may now be operated in a no-merged mode for records.. All records
563 will be considered unique. This mode is enabled if no mergekey is
564 generated by the normalization stylesheet (pz:xslt).
566 Pazpar2 caches original records from each target and the 'record' command
567 with offset returns the original record if 'syntax' and 'esn' are NOT
568 specified. This speeds up retrieval of original records but also means
569 that Pazpar2 uses more memory. The cached records will be freed when the
570 session terminates or a new search is executed.
572 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
573 library part of YAZ is used.
575 Added SRU client support.
577 Automatically computes pz:nativesyntax if not provided. Works for XML and
580 --- 1.0.13 2008/11/24
582 Command bytarget returns name of target (if defined).
584 --- 1.0.12 2008/11/04
586 Fixed bug #2021.. location now holds all brief elements.
588 --- 1.0.11 2008/10/15
590 Fixed check for application/x-www-form-urlencoded parameters.
592 --- 1.0.10 2008/10/14
594 Fixes for IE in pz2.js.
596 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
600 Changed the JS library pz2.js to use POST for long URL (+ params).
602 Added installation instructions for Windows. Note: NT services is
603 NOT available until we make a new release of YAZ.
605 Preserve order of repeated metadata fields (they were reversed before).
607 More MARC21 information extracted for metadata.
611 Fixed bug #1162: HTML entities are not escaped properly.
613 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
617 Marc21 stylesheet updated to reflect multiple full text fields
621 Fixed bug in pz2.js WRT DOMElement attributes on IE.
623 Fixed bug 2100: Database wildcards not working
627 Added support for retrieval of records in binary.
629 Fixed bug 1794: Pazpar2 does not return valid XML.
631 Deal with ICU not returning sortkey (resulted in SEGV before).
635 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
636 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
638 Improved diagnostics when Pazpar2 HTTP decoding fails.
640 Pazpar2 requests may be POSTed as using Content-Type
641 application/x-www-form-urlencoded.
643 Pazpar2 honors LF in HTTP headers.
645 Handle targets that handle negative hit counts (should not happen, but it
650 ICU is used for tokenization and normalization of the following: mergekey,
651 sorting, relevance terms.
653 Debian package now enables ICU tokenization and normalization by default.
657 Exposed user setting values (i.e. non-pz: names) to the record systems in two
658 ways: Either as parameters to the normalization stylesheets (which would allow the
659 programmer to postprocess or use the values in any way) or after the normalization
660 step, in which case values are made part of the normalized record (and available for
661 sorting, termlists, display, or other interface-related use.
663 Implemented sorting by year.
665 Option -d dumps records to the current log file instead of stderr.
667 Fixes for compilation on cygwin.
669 Z39.50 client code uses pz:elements. pz:elements was recognized in
670 earlier Pazpar2 versions but it was not used for anything.
672 icu_chain_test is using fgets instead of getline - fixes compilation
675 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
676 query conversions fail (rather than _any_). This means targets that do
677 not support some fields are ignored in a search.
681 Improved handling of socket timeout for Z39.50 connections.
683 Misc documentation updates and spell fixes.
685 Debian package pazpar2 creates log rotate entry.
687 Debian package pazpar2-apache2 reloads Apache2.
689 jsdemo included in distribution. It illustrates the use of the js/pz2.js
694 First public release.