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