3 New pz:metadata attribute, empty="empty-value" for Pazpar2's
4 internal representation. With this attribute, Pazpar2 treates an empty
5 pz:metadata type as having the value for "empty" - if empty.
7 New setting, pz:extendrecs, which triggers extended fetch of records
8 for a database beyond pz:maxrecs for a show command.
10 Fix warning that was falsely issued for "missing limitmap".
12 Log message for Pazpart start/stop changed. Now using same style as
13 Metaproxy, ie Pazpar2 start SHA1 / Pazpar2 stop .
17 Fix hang of 2nd command=show with esn/syntax given.
21 New merge attribute type: 'first', which takes all metadata fields
22 from first target that returns the particular field.
26 Extend info command with hostname and YAZ SHA1
27 Indent results for both command stat and info.
29 Allow limit on merged content. The new configuration metadata
30 element, limitcluster, configures that a metadata element (name) be used
31 as limit name for search. Applies to the whole service (ie all targets),
32 unlike pz:limitmap which is configured per-target (database).
34 New feature: limitmap local:* matches against all metadata fields.
36 Allow repeated list in limitmap spec . Separated by comma. For
37 example: value="local:title,rpn:@attr 1=4".
39 New element <message> in bytarget response. Holds diagnostic message
40 of code (say 'Unsupported Use Attribute' for Bib-1 114).
42 Improved logging for record ingestion failures.
44 Avoid using struct icu_chain in non-YAZ_HAVE_ICU mode. In the rare case,
45 when YAZ is compiled without ICU support.
49 Requires YAZ-4.2.40 to support native solr support.
51 Fix and improve logic handling whether or not to re-do search on sort
52 order changes. A sort order with change in ascending/descending only
53 whould not trigger a new search, which is required for targets with
54 native sorting capabilities. Each client is now checked if instructions
55 (sortmap) exist for native sorting and only client that does requires
56 it is researched. Other clients is just re-ingesting the records,
57 they already have. The resultset is now cleared if any researching
60 Connection sharing between session has broken since version 1.6.8 with
61 introduction of logic that would minimize searching if pazpar2 could
62 detect this based on same query and limits and partly sort order.
63 This could lead to segementations violations.
65 Added a chapter in the manaul about relevance ranking.
69 Rank tweak: follow=number will increase mult by number if two terms
70 occur next to each other; number-1 if they are one term apart , .. 0
71 if they are number a part (all in order). Default is 0 (following
74 Rank tweak: lead=k will divide mult by 1 + log2(1+k*l) where k is
75 value given by lead and l is length from beginning of field where
76 term occurs (l=0 for first term, l=1 for second term, ..). Default
79 Rank tweak: length=strategy. length="linear" if mult is to be divided
80 by length (existing, default behavior), length="log" if mult is to be
81 divided by log2(1+length), length="none" if mult is not to be affected
86 Rank algorithm details may be printed as part of show response in
87 element <relevance_info>.. This is only printed if <rank debug="yes"/>
90 Record as returned by show/record command have a minimal indentation
91 which makes things human-readable.
93 New configuration of default sorting criteria (sort-default) in
94 service definition. If no criteria is defined it will be as before
97 Search command now supports sort parameter just as the show command.
98 If no parameter is give, it will use the service sort-default value.
100 --- 1.6.19 2012/09/18
102 Rank algorithm skips strings that gets normalized to empty string.
103 For example, & and ! could map to the empty string. The weight for
104 those terms is now 0 (as if they were not part of the query).
106 Rank algorithm does not use CCL from limitmap; only from the query
107 parameter (user query).
111 --- 1.6.18 2012/09/17
113 Rank algorithm configurable by 'rank' element inside service. So far
114 only, attribute 'cluster' is recognized. If cluster="yes", multiple
115 records inside a cluster boosts higher than single records. This
116 is default behavior and existing behavior. cluster="no" takes the
117 average score of each record in a cluster.
119 --- 1.6.17 2012/09/05
121 Fix bad re-use of connections (connections with changing proxy should not
124 --- 1.6.16 2012/08/22
126 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
127 resultset and sorting when the sort order is position. However this will be done on
128 every client poll, which will make pazpar2 continuing reset and fetching.
129 It should only be done on FIRST request where the sort order change.
131 Fix an issue on suggestion option: Also disable suggestions on empty string.
133 Clean up in turbo marc stylesheet.
135 Remove the hardcoded size of termlists.
137 --- 1.6.15 2012/06/27
139 New facility: ccldirective may be given in service definition. Allows
140 CCL parsing to be customized a bit, such as defining names of operators
143 New facility: raw record by checksum, rather than offset. The record
144 command optionally takes checksum which identifies certain record from
147 New facility: per field ranking. Rank may be given as M [F N] where
148 M is default rank and N is rank for CCL terms from field F.
150 --- 1.6.14 2012/06/04
152 Fix for IE7/8 in pz.js
154 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
156 Lower log level some places.
158 Remove some invalid test results.
160 --- 1.6.13 2012/05/23
162 Introducing a version=2 parameter for show, termlist and bytarget commands.
163 This enables pazpar2 to return approximation on hit and count count when
164 doing record filtering using the limit parameter on search and a
165 limitmap with a value of "local:"
167 Setting pz:xslt may embed local XSLT as an alternative to referring
169 Value is not CDATA but XML nodes embedded, so escaping is not necessary
170 but a root element *must* be present. For example:
171 <settings target="target="z3950.indexdata.com/marc">
180 Metadata field rank may given by XML internal document (pz:xslt
181 result). If rank is not given, the rank from service description is
184 Metadata field can now configured a default limitmap and facetmap.
185 Setting limitmap to "local:" would work for all kind of targets, but would
186 prob. not be the optimal solution. But at least better than the default behavior
187 of pazpar2 where no filtering is done.
189 A service definition can now also contains <set/> that defines service-wide
190 settings. These will override server-wide sets and will be overridded by
193 New setting, pz:present_chunk, that specifies number of records to fetch
194 at a time. Zero will disable chunkation; will fetch max_records at once.
196 --- 1.6.12 2012/03/14
198 Revert the format change in termlist response, that could break
199 some clients / UIs since they were expecting an (empty) element
200 if no facet values was found.
202 --- 1.6.11 2012/03/07
204 Revert the behavior of returning errors when unable to block
205 on termlist, bytarget and search, when unable to block due to
206 other block. The client will now receive a regular response,
207 but it will be logged in the server. A parameter (report) is
208 added to change behavior to return error response or WARNING
209 status message. Consider this "API" as private, as it is mostly
210 untested and could be changed in future releases.
212 Fix spell error in pz2.js fix in 1.6.10.
214 New Marc2TurboMarc.xsl (contribution from Sven Porst).
215 Can solve the missing marc21.xsl updates in some cases.
217 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
218 substring (contribtion from Sven Porst)
220 marc21.xsl: fix 1-based substring call
222 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
224 Add test_termlist_block to test suite
226 --- 1.6.10 2012/02/23
228 Fix SEGV for invalid PQFs and SRU/SOLR targets
229 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
231 Fix pz2.js: "null object" due to change in in bytarget result XML.
233 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
234 Added this normalization to the other subject-long fields (d6xx),
235 where it was missing.
237 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
238 Still differences around medium and holdings. marc21.xsl is not
239 longer active used by Index Data, and should be considered unsupported.
240 Use tmarc.xsl instead.
244 Fix SEGV that could occur for failed connections.
248 Fix bug for command sort that could return no results for active clients
249 (from previous search). This bug was present in 1.6.6-1.6.7.
251 Fix bug in results that could include results that should have been
252 filtered out. This bug was present in 1.6.6-1.6.7.
256 Fix bug introduced in 1.6.6 where a connection re-use could stall
259 Local filtering may now specify a local metadata field, eg.
260 pz:limitmap:somefield[t]=local:otherfield
264 For search, when limit and or filtering is in place and search
265 is identical to previous search, the result set is re-used and the
266 target is not searched.
268 Limits may work perform local filtering as well, by using "local:"
273 Updated bytarget command to contain a suggestions element with misspelled
274 words and suggestions to these. pz2.js has been updated to deliver this
275 onwards as well. Only target that currently delivers this is the solr
276 client in YAZ 4.2.18.
280 New service definition element, xslt, that allows an embedded stylesheet
281 to be defined. This can be referred to from pz:xslt as an alternative to
284 New pz:sortmap:field setting for specifying hints on how to make
285 a target natively sort on a field. This is used for command=show in
286 conjunction with sort.
288 New pz:url setting for specifying the actual URL for a target. When
289 this is used the target ID is not used as URL anymore and the target ID
290 may be almost any string (not including []).
292 command=termlist without name parameter returns all termlists/facets.
293 Previously if name parameter was omitted, only "subject" was returned.
297 Make termlist sorting stable. Terms with same frequency are now sorted by
298 their display name. This makes a pretty display and improves our
299 regression test because qsort is not a stable sort.
301 New sort parameter value 'position'. The 'position' sorts merged records
302 by their original position from the remote target. This is primarily useful
303 for debugging and may be used for targets that already perform some kind
304 of relevance ranking. Note that sort by default is decreasing; so to get
305 records in their original order sort=position:1 must be used.
309 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
311 Facility to change working directory for pazpar2 daemon. Option -wdir
312 sets working directory to dir. This facility is useful if core dumps
313 must be saved. In this case, the current working directory must be
314 writable by the running user, such as "nobody".
318 New configuration element <icu_chain> for <server>/<service> which
319 allows a named ICU rule (chain) to be defined. The names relevance,
320 sort, mergekey and facet are used for those operations. The definition
321 <icu_chain id="sort" locale="en"> .. </icu_chain>
323 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
324 And so on.. for relevance, mergekey and facet as well. The latter
325 style is deprecated. The facet terms are normalized by the facet
326 rule by default. This may be changed on a metadata field basis by
327 defining the new attribute 'facetrule' for the metadata element.
329 <icu_chain id="myrule" locale="en"> ... </icu_chain>
330 <metadata name="author" termlist="yes" facetrule="myrule"/>
332 Preserve rorder for merged metadata. Fixes issue as reported by Sven
333 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
335 tmarc.xsl: set journal-subpart to 773$ only.
339 Modify the behavior for the limit parameter (first defined in 1.5.7).
340 Mapping of limit searches are now defined by the new configuration item
341 pz:limitmap. Fix a dead-lock problem with the limit parameter.
343 Extend tmarc.xsl to extract 773$g data (OpenURL).
347 ICU default maps remove backquote (`).
349 Command 'search' takes limit parameter (optional). The limit parameter
350 allows a search to be limited one or more facets and the corresponding
351 values. This is for server side filtering.
353 Configure tweak: Use -lm for log(3) if needed
357 Fix a problem with skiparticle sortkey that could be completely
358 ignored (and reduced to "").
360 Fix dependency problem in pazpar2 RPM package (did not require
361 libyaz4 as it should).
365 Fix memory leak that occurred for command=termlist&name=xtargets .
367 Pazpar2 may save HTTP requests. Enabled by option -R.
371 Experimental support for DTIC DADS target. New dads-pz2.xsl.
373 Support for query_syntax (overrides the default for SRU | Z39.50)
375 Support for extraArgs (ZOOM "extraArgs" option) for targets
377 New commands: status-server and status-session
381 Fix for threaded runs: Client now have a copy of the database URL,
382 which can used after the database has been release from the client.
383 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
385 tmarc.xsl: Add journal-title-abbrev and full text.
387 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
389 Fix for cmd=record before search.
391 Session Logging clean up.
393 Fix wrong termlist factor when maxrecs is different from 100.
397 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
398 Term factor is default enabled but can be diseabled by
399 pz:termlist_term_factor=0
403 Add scaling of facet count. Currently always enabled, needs fixing.
404 Allow user-defined info for target suffix. This has no meaning in
405 Pazpar2 except to distinguish targets from each other. The suffix
406 data begins with #. For example z3950.indexdata.com/gils#Mydata
408 Added exact-match recordfilter; format name=value
412 SOLR support. Pazpar2 may operate as web service client for SOLR.
416 Fix for show command and block=1 (dead lock). Bug was introduced in
421 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
422 tested on CentOS 5.5 only.
426 Fix problem with result sets being removed from a client session
427 if the connection for it was resused by another session. Bug #3489.
429 New iphone UI for Pazpar2 (www/iphone).
433 Fixes for threaded operation.
435 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
437 New example services in etc/services in source. In the Debian packages
438 these are located in /etc/pazpar2/services-available
440 Threaded mode operational on Windows. Requires Windows 7 or Windows
443 Default value of setting pz:max_connections is 0 which means that there
444 is no limit on number of connections.
448 Pazpar2 may operate in threaded mode. Enabled by element threads in
449 the configuration. See pazpar2_conf for details.
451 New setting setting: pz:max_connections. Setting pz:max_connections is
452 a limit of number of sockets to a host. When this limit is reached,
453 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
454 The client will be marked Client_Error when it can not be searched
455 (other clients in a session may work). If pz:max_connections is not set
456 for a target, a value of 30 will be used. Note: the pz:max_connections
457 will only work in threaded mode.
459 pz2.js: JSON support for show.
461 Debian package: Enable default service, default.xml, before starting
462 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
466 Debian version depends on on libyaz4. Note that Pazpar2 will still
467 compile from source with YAZ 3.
469 Split services into separate files. The example configuration file
470 pazpar2.cfg.dist now includes a default service default.xml (part of
471 etc). And default.xml includes settings/edu.xml. The default.xml file,
472 not to be confused with settings/defaults.xml, is a template for jsdemo
473 and other services. The Debian package installs /etc/pazpar2/server.xml
474 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
475 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
476 The default.xml (from etc) is installed in /etc/pazpar2/services-available
477 and a symlink to it is created from services-enabled. The default.xml
478 service is unnamed and, thus, will be used by jsdemo and test1.
480 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
481 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
485 Support for additional fields in cf.xsl and pazpar2.conf.dist:
486 publisher, available, due, location (=locallocation), callno
487 (=callnumber), thumburl and score.
489 Describe pz:xslt and the auto setting.
491 Move mergekey definition away from the normalization stylesheets and
492 define a mergekey common for all target types in pazpar2.cfg.
494 Code update: Use the Odr_int type for hit counts. This is part of
495 YAZ 3.0.47 and later and so configure checks for that.
499 Metadata attribute 'skiparticle' also works for ICU based
500 normalization. (was only working for the non-ICU/ASCII before).
502 Command bytarget with argument settings=1 will show settings per
503 target.. This is to be able to verify correct settings and be able to
504 test that they are correct. The database settings array size is now
505 also stored.. Problems with database settings array is that if not
506 careful it will be too small (smaller than dictionary per-service
509 Make record list sorting stable by comparing mergekey for records if
510 relevance/title or other sorting criteria all match. This is merely to
511 ensure that our regressions tests works (reproducible output).
513 Relevance calculation changes: use a different denominator (length) for
514 per-field relevance scoring.. Instead of length of all ranked fields we
515 now use length of individual fields (as if they were individual "free"
516 text fields). This will ensure that documents with a long field with no
517 match (say description) will not "hurt" a title match.
519 Diagnostic member was not set on connection error. Fixed
523 Command search takes two optional parameters, startecs and maxrecs,
524 that specifies the start offset (0, 1, ...) and maximum number of records
525 to fetch for each target.
527 XSLTs + MARC maps are cached within a session so we don't re-parse
528 them over and over again. Even for a session with a single search
529 there's much to be gained because many targets use the same
532 The metadata attribute 'mergekey' now takes one of three values 'no',
533 'required', 'optional' . And the resulting mergekey from metadata
534 is now ordered in the same way as metadata in the service definition.
535 Older Pazpar2 version use the order in which metadata appeared in a
538 The search argument 'filter' now offers a new operator ~ which does a
539 substring match. The = operator works as before: string match for
540 anything but pz:id, or target match for pz:id.
542 New setting pz:recordfilter. The value of this setting takes the
543 form name[~value]. This setting makes Pazpar2 ignore all retrieved
544 records that do not have the metadata element name with value substring
547 Pazpar2 allows YAZ log level to be set (option -v).
551 For WS responses Pazpar2 creates XML header. Exception: raw record.
553 Setting XML files are now stored in etc/settings instead of etc. This
554 reflects the layout with the Debian package layout.
556 Settings may be posted for command=settings. The POSTed settings must
557 have root element 'settings' like regular setting files. In order to be
558 recognized, the POST request must use Content-Type=text/xml.
560 A service may be posted for command=init. This service will be used
561 during the session. The service may have its own target settings,
562 ICU config, timeout, etc. In order to be recognized, the POST request
563 must use Content-Type=text/xml.
565 Timeout values may be given per-service. That's element 'timeout'
566 which takes three attribute values (a subset may be given): 'session',
567 'z3950_operation', 'z3950_session'. Option -T is no longer supported
568 - used to specify session timeout.
570 Option -t tests the Pazpar2 configuration and returns exit code
571 (0=success, non-zero=failure). In previous version of Pazpar2, -t
572 specified local settings.
574 In version 1.2.0 the configuration file - after include processing -
575 was dumped to stdout. Now, the configuration is only dumped to the
576 yaz log file if option -d is given.
580 Configuration may now have multiple server areas. This means that a
581 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
582 yet supported - on a server basis. Configuration may also have multiple
583 services .. That is repeating service elements inside a server. Each
584 has an attribute 'id' which serves as service ID. This ID in turn may
585 be used in a Pazpar2 session, by specifying parameter service=ID for
586 command init. There can be at most one unnamed service inside a server
587 which can be referred to by not specifying an service ID for command
588 init (backwards compatible). In order to partition multiple servers and
589 services a new include directive has been added. This takes an attribute
590 'src' which specifies one or more sub-files. For example to include
591 service files, one might use:
592 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
593 It is the intention that that completely makes the settings directive
596 Fix problem where the record command would wait forever if there were
597 no targets to wait for (activeclients == 0).
601 One result set is created per session (last search) rather than for
602 each connection which happen to be shared (bug #3009).
604 marc21 stylesheets changed for efficiency.
608 Session timeout may be specified on the command-line as option -T.
610 Pazpar2 may now be operated in a no-merged mode for records.. All records
611 will be considered unique. This mode is enabled if no mergekey is
612 generated by the normalization stylesheet (pz:xslt).
614 Pazpar2 caches original records from each target and the 'record' command
615 with offset returns the original record if 'syntax' and 'esn' are NOT
616 specified. This speeds up retrieval of original records but also means
617 that Pazpar2 uses more memory. The cached records will be freed when the
618 session terminates or a new search is executed.
620 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
621 library part of YAZ is used.
623 Added SRU client support.
625 Automatically computes pz:nativesyntax if not provided. Works for XML and
628 --- 1.0.13 2008/11/24
630 Command bytarget returns name of target (if defined).
632 --- 1.0.12 2008/11/04
634 Fixed bug #2021.. location now holds all brief elements.
636 --- 1.0.11 2008/10/15
638 Fixed check for application/x-www-form-urlencoded parameters.
640 --- 1.0.10 2008/10/14
642 Fixes for IE in pz2.js.
644 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
648 Changed the JS library pz2.js to use POST for long URL (+ params).
650 Added installation instructions for Windows. Note: NT services is
651 NOT available until we make a new release of YAZ.
653 Preserve order of repeated metadata fields (they were reversed before).
655 More MARC21 information extracted for metadata.
659 Fixed bug #1162: HTML entities are not escaped properly.
661 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
665 Marc21 stylesheet updated to reflect multiple full text fields
669 Fixed bug in pz2.js WRT DOMElement attributes on IE.
671 Fixed bug 2100: Database wildcards not working
675 Added support for retrieval of records in binary.
677 Fixed bug 1794: Pazpar2 does not return valid XML.
679 Deal with ICU not returning sortkey (resulted in SEGV before).
683 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
684 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
686 Improved diagnostics when Pazpar2 HTTP decoding fails.
688 Pazpar2 requests may be POSTed as using Content-Type
689 application/x-www-form-urlencoded.
691 Pazpar2 honors LF in HTTP headers.
693 Handle targets that handle negative hit counts (should not happen, but it
698 ICU is used for tokenization and normalization of the following: mergekey,
699 sorting, relevance terms.
701 Debian package now enables ICU tokenization and normalization by default.
705 Exposed user setting values (i.e. non-pz: names) to the record systems in two
706 ways: Either as parameters to the normalization stylesheets (which would allow the
707 programmer to postprocess or use the values in any way) or after the normalization
708 step, in which case values are made part of the normalized record (and available for
709 sorting, termlists, display, or other interface-related use.
711 Implemented sorting by year.
713 Option -d dumps records to the current log file instead of stderr.
715 Fixes for compilation on cygwin.
717 Z39.50 client code uses pz:elements. pz:elements was recognized in
718 earlier Pazpar2 versions but it was not used for anything.
720 icu_chain_test is using fgets instead of getline - fixes compilation
723 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
724 query conversions fail (rather than _any_). This means targets that do
725 not support some fields are ignored in a search.
729 Improved handling of socket timeout for Z39.50 connections.
731 Misc documentation updates and spell fixes.
733 Debian package pazpar2 creates log rotate entry.
735 Debian package pazpar2-apache2 reloads Apache2.
737 jsdemo included in distribution. It illustrates the use of the js/pz2.js
742 First public release.