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.
19 Added a chapter in the manaul about relevance ranking.
23 Rank tweak: follow=number will increase mult by number if two terms
24 occur next to each other; number-1 if they are one term apart , .. 0
25 if they are number a part (all in order). Default is 0 (following
28 Rank tweak: lead=k will divide mult by 1 + log2(1+k*l) where k is
29 value given by lead and l is length from beginning of field where
30 term occurs (l=0 for first term, l=1 for second term, ..). Default
33 Rank tweak: length=strategy. length="linear" if mult is to be divided
34 by length (existing, default behavior), length="log" if mult is to be
35 divided by log2(1+length), length="none" if mult is not to be affected
40 Rank algorithm details may be printed as part of show response in
41 element <relevance_info>.. This is only printed if <rank debug="yes"/>
44 Record as returned by show/record command have a minimal indentation
45 which makes things human-readable.
47 New configuration of default sorting criteria (sort-default) in
48 service definition. If no criteria is defined it will be as before
51 Search command now supports sort parameter just as the show command.
52 If no parameter is give, it will use the service sort-default value.
56 Rank algorithm skips strings that gets normalized to empty string.
57 For example, & and ! could map to the empty string. The weight for
58 those terms is now 0 (as if they were not part of the query).
60 Rank algorithm does not use CCL from limitmap; only from the query
61 parameter (user query).
67 Rank algorithm configurable by 'rank' element inside service. So far
68 only, attribute 'cluster' is recognized. If cluster="yes", multiple
69 records inside a cluster boosts higher than single records. This
70 is default behavior and existing behavior. cluster="no" takes the
71 average score of each record in a cluster.
75 Fix bad re-use of connections (connections with changing proxy should not
80 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
81 resultset and sorting when the sort order is position. However this will be done on
82 every client poll, which will make pazpar2 continuing reset and fetching.
83 It should only be done on FIRST request where the sort order change.
85 Fix an issue on suggestion option: Also disable suggestions on empty string.
87 Clean up in turbo marc stylesheet.
89 Remove the hardcoded size of termlists.
93 New facility: ccldirective may be given in service definition. Allows
94 CCL parsing to be customized a bit, such as defining names of operators
97 New facility: raw record by checksum, rather than offset. The record
98 command optionally takes checksum which identifies certain record from
101 New facility: per field ranking. Rank may be given as M [F N] where
102 M is default rank and N is rank for CCL terms from field F.
104 --- 1.6.14 2012/06/04
106 Fix for IE7/8 in pz.js
108 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
110 Lower log level some places.
112 Remove some invalid test results.
114 --- 1.6.13 2012/05/23
116 Introducing a version=2 parameter for show, termlist and bytarget commands.
117 This enables pazpar2 to return approximation on hit and count count when
118 doing record filtering using the limit parameter on search and a
119 limitmap with a value of "local:"
121 Setting pz:xslt may embed local XSLT as an alternative to referring
123 Value is not CDATA but XML nodes embedded, so escaping is not necessary
124 but a root element *must* be present. For example:
125 <settings target="target="z3950.indexdata.com/marc">
134 Metadata field rank may given by XML internal document (pz:xslt
135 result). If rank is not given, the rank from service description is
138 Metadata field can now configured a default limitmap and facetmap.
139 Setting limitmap to "local:" would work for all kind of targets, but would
140 prob. not be the optimal solution. But at least better than the default behavior
141 of pazpar2 where no filtering is done.
143 A service definition can now also contains <set/> that defines service-wide
144 settings. These will override server-wide sets and will be overridded by
147 New setting, pz:present_chunk, that specifies number of records to fetch
148 at a time. Zero will disable chunkation; will fetch max_records at once.
150 --- 1.6.12 2012/03/14
152 Revert the format change in termlist response, that could break
153 some clients / UIs since they were expecting an (empty) element
154 if no facet values was found.
156 --- 1.6.11 2012/03/07
158 Revert the behavior of returning errors when unable to block
159 on termlist, bytarget and search, when unable to block due to
160 other block. The client will now receive a regular response,
161 but it will be logged in the server. A parameter (report) is
162 added to change behavior to return error response or WARNING
163 status message. Consider this "API" as private, as it is mostly
164 untested and could be changed in future releases.
166 Fix spell error in pz2.js fix in 1.6.10.
168 New Marc2TurboMarc.xsl (contribution from Sven Porst).
169 Can solve the missing marc21.xsl updates in some cases.
171 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
172 substring (contribtion from Sven Porst)
174 marc21.xsl: fix 1-based substring call
176 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
178 Add test_termlist_block to test suite
180 --- 1.6.10 2012/02/23
182 Fix SEGV for invalid PQFs and SRU/SOLR targets
183 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
185 Fix pz2.js: "null object" due to change in in bytarget result XML.
187 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
188 Added this normalization to the other subject-long fields (d6xx),
189 where it was missing.
191 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
192 Still differences around medium and holdings. marc21.xsl is not
193 longer active used by Index Data, and should be considered unsupported.
194 Use tmarc.xsl instead.
198 Fix SEGV that could occur for failed connections.
202 Fix bug for command sort that could return no results for active clients
203 (from previous search). This bug was present in 1.6.6-1.6.7.
205 Fix bug in results that could include results that should have been
206 filtered out. This bug was present in 1.6.6-1.6.7.
210 Fix bug introduced in 1.6.6 where a connection re-use could stall
213 Local filtering may now specify a local metadata field, eg.
214 pz:limitmap:somefield[t]=local:otherfield
218 For search, when limit and or filtering is in place and search
219 is identical to previous search, the result set is re-used and the
220 target is not searched.
222 Limits may work perform local filtering as well, by using "local:"
227 Updated bytarget command to contain a suggestions element with misspelled
228 words and suggestions to these. pz2.js has been updated to deliver this
229 onwards as well. Only target that currently delivers this is the solr
230 client in YAZ 4.2.18.
234 New service definition element, xslt, that allows an embedded stylesheet
235 to be defined. This can be referred to from pz:xslt as an alternative to
238 New pz:sortmap:field setting for specifying hints on how to make
239 a target natively sort on a field. This is used for command=show in
240 conjunction with sort.
242 New pz:url setting for specifying the actual URL for a target. When
243 this is used the target ID is not used as URL anymore and the target ID
244 may be almost any string (not including []).
246 command=termlist without name parameter returns all termlists/facets.
247 Previously if name parameter was omitted, only "subject" was returned.
251 Make termlist sorting stable. Terms with same frequency are now sorted by
252 their display name. This makes a pretty display and improves our
253 regression test because qsort is not a stable sort.
255 New sort parameter value 'position'. The 'position' sorts merged records
256 by their original position from the remote target. This is primarily useful
257 for debugging and may be used for targets that already perform some kind
258 of relevance ranking. Note that sort by default is decreasing; so to get
259 records in their original order sort=position:1 must be used.
263 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
265 Facility to change working directory for pazpar2 daemon. Option -wdir
266 sets working directory to dir. This facility is useful if core dumps
267 must be saved. In this case, the current working directory must be
268 writable by the running user, such as "nobody".
272 New configuration element <icu_chain> for <server>/<service> which
273 allows a named ICU rule (chain) to be defined. The names relevance,
274 sort, mergekey and facet are used for those operations. The definition
275 <icu_chain id="sort" locale="en"> .. </icu_chain>
277 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
278 And so on.. for relevance, mergekey and facet as well. The latter
279 style is deprecated. The facet terms are normalized by the facet
280 rule by default. This may be changed on a metadata field basis by
281 defining the new attribute 'facetrule' for the metadata element.
283 <icu_chain id="myrule" locale="en"> ... </icu_chain>
284 <metadata name="author" termlist="yes" facetrule="myrule"/>
286 Preserve rorder for merged metadata. Fixes issue as reported by Sven
287 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
289 tmarc.xsl: set journal-subpart to 773$ only.
293 Modify the behavior for the limit parameter (first defined in 1.5.7).
294 Mapping of limit searches are now defined by the new configuration item
295 pz:limitmap. Fix a dead-lock problem with the limit parameter.
297 Extend tmarc.xsl to extract 773$g data (OpenURL).
301 ICU default maps remove backquote (`).
303 Command 'search' takes limit parameter (optional). The limit parameter
304 allows a search to be limited one or more facets and the corresponding
305 values. This is for server side filtering.
307 Configure tweak: Use -lm for log(3) if needed
311 Fix a problem with skiparticle sortkey that could be completely
312 ignored (and reduced to "").
314 Fix dependency problem in pazpar2 RPM package (did not require
315 libyaz4 as it should).
319 Fix memory leak that occurred for command=termlist&name=xtargets .
321 Pazpar2 may save HTTP requests. Enabled by option -R.
325 Experimental support for DTIC DADS target. New dads-pz2.xsl.
327 Support for query_syntax (overrides the default for SRU | Z39.50)
329 Support for extraArgs (ZOOM "extraArgs" option) for targets
331 New commands: status-server and status-session
335 Fix for threaded runs: Client now have a copy of the database URL,
336 which can used after the database has been release from the client.
337 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
339 tmarc.xsl: Add journal-title-abbrev and full text.
341 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
343 Fix for cmd=record before search.
345 Session Logging clean up.
347 Fix wrong termlist factor when maxrecs is different from 100.
351 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
352 Term factor is default enabled but can be diseabled by
353 pz:termlist_term_factor=0
357 Add scaling of facet count. Currently always enabled, needs fixing.
358 Allow user-defined info for target suffix. This has no meaning in
359 Pazpar2 except to distinguish targets from each other. The suffix
360 data begins with #. For example z3950.indexdata.com/gils#Mydata
362 Added exact-match recordfilter; format name=value
366 SOLR support. Pazpar2 may operate as web service client for SOLR.
370 Fix for show command and block=1 (dead lock). Bug was introduced in
375 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
376 tested on CentOS 5.5 only.
380 Fix problem with result sets being removed from a client session
381 if the connection for it was resused by another session. Bug #3489.
383 New iphone UI for Pazpar2 (www/iphone).
387 Fixes for threaded operation.
389 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
391 New example services in etc/services in source. In the Debian packages
392 these are located in /etc/pazpar2/services-available
394 Threaded mode operational on Windows. Requires Windows 7 or Windows
397 Default value of setting pz:max_connections is 0 which means that there
398 is no limit on number of connections.
402 Pazpar2 may operate in threaded mode. Enabled by element threads in
403 the configuration. See pazpar2_conf for details.
405 New setting setting: pz:max_connections. Setting pz:max_connections is
406 a limit of number of sockets to a host. When this limit is reached,
407 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
408 The client will be marked Client_Error when it can not be searched
409 (other clients in a session may work). If pz:max_connections is not set
410 for a target, a value of 30 will be used. Note: the pz:max_connections
411 will only work in threaded mode.
413 pz2.js: JSON support for show.
415 Debian package: Enable default service, default.xml, before starting
416 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
420 Debian version depends on on libyaz4. Note that Pazpar2 will still
421 compile from source with YAZ 3.
423 Split services into separate files. The example configuration file
424 pazpar2.cfg.dist now includes a default service default.xml (part of
425 etc). And default.xml includes settings/edu.xml. The default.xml file,
426 not to be confused with settings/defaults.xml, is a template for jsdemo
427 and other services. The Debian package installs /etc/pazpar2/server.xml
428 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
429 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
430 The default.xml (from etc) is installed in /etc/pazpar2/services-available
431 and a symlink to it is created from services-enabled. The default.xml
432 service is unnamed and, thus, will be used by jsdemo and test1.
434 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
435 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
439 Support for additional fields in cf.xsl and pazpar2.conf.dist:
440 publisher, available, due, location (=locallocation), callno
441 (=callnumber), thumburl and score.
443 Describe pz:xslt and the auto setting.
445 Move mergekey definition away from the normalization stylesheets and
446 define a mergekey common for all target types in pazpar2.cfg.
448 Code update: Use the Odr_int type for hit counts. This is part of
449 YAZ 3.0.47 and later and so configure checks for that.
453 Metadata attribute 'skiparticle' also works for ICU based
454 normalization. (was only working for the non-ICU/ASCII before).
456 Command bytarget with argument settings=1 will show settings per
457 target.. This is to be able to verify correct settings and be able to
458 test that they are correct. The database settings array size is now
459 also stored.. Problems with database settings array is that if not
460 careful it will be too small (smaller than dictionary per-service
463 Make record list sorting stable by comparing mergekey for records if
464 relevance/title or other sorting criteria all match. This is merely to
465 ensure that our regressions tests works (reproducible output).
467 Relevance calculation changes: use a different denominator (length) for
468 per-field relevance scoring.. Instead of length of all ranked fields we
469 now use length of individual fields (as if they were individual "free"
470 text fields). This will ensure that documents with a long field with no
471 match (say description) will not "hurt" a title match.
473 Diagnostic member was not set on connection error. Fixed
477 Command search takes two optional parameters, startecs and maxrecs,
478 that specifies the start offset (0, 1, ...) and maximum number of records
479 to fetch for each target.
481 XSLTs + MARC maps are cached within a session so we don't re-parse
482 them over and over again. Even for a session with a single search
483 there's much to be gained because many targets use the same
486 The metadata attribute 'mergekey' now takes one of three values 'no',
487 'required', 'optional' . And the resulting mergekey from metadata
488 is now ordered in the same way as metadata in the service definition.
489 Older Pazpar2 version use the order in which metadata appeared in a
492 The search argument 'filter' now offers a new operator ~ which does a
493 substring match. The = operator works as before: string match for
494 anything but pz:id, or target match for pz:id.
496 New setting pz:recordfilter. The value of this setting takes the
497 form name[~value]. This setting makes Pazpar2 ignore all retrieved
498 records that do not have the metadata element name with value substring
501 Pazpar2 allows YAZ log level to be set (option -v).
505 For WS responses Pazpar2 creates XML header. Exception: raw record.
507 Setting XML files are now stored in etc/settings instead of etc. This
508 reflects the layout with the Debian package layout.
510 Settings may be posted for command=settings. The POSTed settings must
511 have root element 'settings' like regular setting files. In order to be
512 recognized, the POST request must use Content-Type=text/xml.
514 A service may be posted for command=init. This service will be used
515 during the session. The service may have its own target settings,
516 ICU config, timeout, etc. In order to be recognized, the POST request
517 must use Content-Type=text/xml.
519 Timeout values may be given per-service. That's element 'timeout'
520 which takes three attribute values (a subset may be given): 'session',
521 'z3950_operation', 'z3950_session'. Option -T is no longer supported
522 - used to specify session timeout.
524 Option -t tests the Pazpar2 configuration and returns exit code
525 (0=success, non-zero=failure). In previous version of Pazpar2, -t
526 specified local settings.
528 In version 1.2.0 the configuration file - after include processing -
529 was dumped to stdout. Now, the configuration is only dumped to the
530 yaz log file if option -d is given.
534 Configuration may now have multiple server areas. This means that a
535 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
536 yet supported - on a server basis. Configuration may also have multiple
537 services .. That is repeating service elements inside a server. Each
538 has an attribute 'id' which serves as service ID. This ID in turn may
539 be used in a Pazpar2 session, by specifying parameter service=ID for
540 command init. There can be at most one unnamed service inside a server
541 which can be referred to by not specifying an service ID for command
542 init (backwards compatible). In order to partition multiple servers and
543 services a new include directive has been added. This takes an attribute
544 'src' which specifies one or more sub-files. For example to include
545 service files, one might use:
546 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
547 It is the intention that that completely makes the settings directive
550 Fix problem where the record command would wait forever if there were
551 no targets to wait for (activeclients == 0).
555 One result set is created per session (last search) rather than for
556 each connection which happen to be shared (bug #3009).
558 marc21 stylesheets changed for efficiency.
562 Session timeout may be specified on the command-line as option -T.
564 Pazpar2 may now be operated in a no-merged mode for records.. All records
565 will be considered unique. This mode is enabled if no mergekey is
566 generated by the normalization stylesheet (pz:xslt).
568 Pazpar2 caches original records from each target and the 'record' command
569 with offset returns the original record if 'syntax' and 'esn' are NOT
570 specified. This speeds up retrieval of original records but also means
571 that Pazpar2 uses more memory. The cached records will be freed when the
572 session terminates or a new search is executed.
574 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
575 library part of YAZ is used.
577 Added SRU client support.
579 Automatically computes pz:nativesyntax if not provided. Works for XML and
582 --- 1.0.13 2008/11/24
584 Command bytarget returns name of target (if defined).
586 --- 1.0.12 2008/11/04
588 Fixed bug #2021.. location now holds all brief elements.
590 --- 1.0.11 2008/10/15
592 Fixed check for application/x-www-form-urlencoded parameters.
594 --- 1.0.10 2008/10/14
596 Fixes for IE in pz2.js.
598 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
602 Changed the JS library pz2.js to use POST for long URL (+ params).
604 Added installation instructions for Windows. Note: NT services is
605 NOT available until we make a new release of YAZ.
607 Preserve order of repeated metadata fields (they were reversed before).
609 More MARC21 information extracted for metadata.
613 Fixed bug #1162: HTML entities are not escaped properly.
615 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
619 Marc21 stylesheet updated to reflect multiple full text fields
623 Fixed bug in pz2.js WRT DOMElement attributes on IE.
625 Fixed bug 2100: Database wildcards not working
629 Added support for retrieval of records in binary.
631 Fixed bug 1794: Pazpar2 does not return valid XML.
633 Deal with ICU not returning sortkey (resulted in SEGV before).
637 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
638 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
640 Improved diagnostics when Pazpar2 HTTP decoding fails.
642 Pazpar2 requests may be POSTed as using Content-Type
643 application/x-www-form-urlencoded.
645 Pazpar2 honors LF in HTTP headers.
647 Handle targets that handle negative hit counts (should not happen, but it
652 ICU is used for tokenization and normalization of the following: mergekey,
653 sorting, relevance terms.
655 Debian package now enables ICU tokenization and normalization by default.
659 Exposed user setting values (i.e. non-pz: names) to the record systems in two
660 ways: Either as parameters to the normalization stylesheets (which would allow the
661 programmer to postprocess or use the values in any way) or after the normalization
662 step, in which case values are made part of the normalized record (and available for
663 sorting, termlists, display, or other interface-related use.
665 Implemented sorting by year.
667 Option -d dumps records to the current log file instead of stderr.
669 Fixes for compilation on cygwin.
671 Z39.50 client code uses pz:elements. pz:elements was recognized in
672 earlier Pazpar2 versions but it was not used for anything.
674 icu_chain_test is using fgets instead of getline - fixes compilation
677 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
678 query conversions fail (rather than _any_). This means targets that do
679 not support some fields are ignored in a search.
683 Improved handling of socket timeout for Z39.50 connections.
685 Misc documentation updates and spell fixes.
687 Debian package pazpar2 creates log rotate entry.
689 Debian package pazpar2-apache2 reloads Apache2.
691 jsdemo included in distribution. It illustrates the use of the js/pz2.js
696 First public release.