Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: leinfelder $'
4
# '$Revision: 7518 $'
5
#     '$Date: 2013-03-15 12:24:19 -0700 (Fri, 15 Mar 2013) $'
6
#
7

    
8
Metacat: XML Metadata and Data Management System
9
------------------------------------------------                      
10

    
11
Version: 2.0.6 Release
12

    
13
Send feedback and bugs to: metacat-dev@ecoinformatics.org
14
                           http://bugzilla.ecoinformatics.org
15

    
16
Contributors: Matt Jones (jones@nceas.ucsb.edu)
17
              Chad Berkley (berkley@nceas.ucsb.edu)
18
              Jing Tao (tao@nceas.ucsb.edu)
19
              Jivka Bojilova (bojilova@nceas.ucsb.edu)
20
              Dan Higgins (higgins@nceas.ucsb.edu)
21
              Saurabh Garg (sgarg@nceas.ucsb.edu)
22
              Duane Costa (dcosta@lternet.edu)
23
              Veronique Connolly (connolly@nceas.ucsb.edu)
24
              John Harris (harris@nceas.ucsb.edu)
25
              Callie Bowdish (bowdish@ecoinformatics.org)
26
              Will Tyburczy (tyburczy@ecoinformatics.org)
27
              Matthew Perry (perry@nceas.ucsb.edu)
28
              Chad Burt (underbluewaters@gmail.com)
29
              Ben Leinfelder (leinfelder@nceas.ucsb.edu)
30
              Chris Barteau (barteau@nceas.ucsb.edu)
31
              Shaun Walbridge (walbridge@nceas.ucsb.edu)
32
              Michael Daigle (daigle@nceas.ucsb.edu) 
33

    
34
Patch contributors:
35
              Andrea Chadden (chadden@nceas.ucsb.edu)
36
              Chris Jones (cjones@msi.ucsb.edu)
37
              Johnoel Ancheta (johnoel@hawaii.edu)
38
              Owen Jones (owen.jones@imperial.ac.uk)
39

    
40
Metacat is a flexible database storage system for XML formatted
41
documents and associated binary files. Metacat models the structure of the
42
XML document, therefore allowing storage of XML documents with arbitrary
43
schemas. Metacat supports several databases on the back-end, including Oracle,
44
PostgreSQL and SQL Server (limited).  The server supports XML document
45
storage, retrieval, query, validation, and transformation (using the XSLT
46
stylesheet language).  In addition, there is a mechanism for replicating the
47
database to other metacat instances for backup and load balancing purposes.
48
Metacat currently uses an LDAP database for authenticating users, but was
49
written to accomodate other authentication services as well.
50

    
51
Installation
52
------------
53
See the file "docs/install.html" for detailed instructions
54
for your OS.
55

    
56
Release Notes for 2.0.6:
57
------------------------
58
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
59
* MN.generateIdentifier() support for UUID and DOI
60
* DOI registration support using EZID service
61
* Pathquery support for specifying multiple document owners
62

    
63

    
64
Release Notes for 2.0.5:
65
------------------------
66
This patch release focuses on Metacat support for Oracle
67
*SystemMetadata table names have been shortened to comply with Oracle limits.
68
*SANParks/SAEON spatial zip file download fixed
69
*Pathquery performance fix
70
*Hazelcast 2.x upgrade
71
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
72

    
73
Release Notes for 2.0.4:
74
------------------------
75
This patch release focuses on Metacat-Metacat replication.
76
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
77
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
78
*Fixes an access control issue that could allow search results to include protected documents
79

    
80
Release Notes for 2.0.3:
81
------------------------
82
This is another critical patch release of Metacat 2.0.
83
*Addresses a bug that prevented Metacat replication from completing (timeout error)
84
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
85

    
86
Release Notes for 2.0.2:
87
------------------------
88
This is a critical patch release of Metacat 2.0.
89
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
90
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
91
*Updates the Foresite ORE library to correctly serialize resource map documents
92

    
93
Release Notes for 2.0.1:
94
------------------------
95
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
96
*Addresses an identifier issue during ORE generation for DataONE services
97
*Increases compatibility with older EML content and the Xalan XSLT processor
98
*Removes XSLT 2.0 support (Saxon)
99

    
100
Release Notes for 2.0.0:
101
------------------------
102
This major release includes support for DataONE.
103
*The DataONE v1.0.0 Member Node service APIs are now the preferred method for communicating with Metacat
104
*The existing EcoGrid and Metacat Servlet APIs are deprecated but still available.
105
*EML-embedded access control rules using permOrder="denyFirst" are no longer supported (https://redmine.dataone.org/issues/2614) 
106
*Replication now utilizes client certificates to establish SSL connections between replication source and target servers
107
*Access control rules now apply to objects on a per-revision basis rather than per-docid
108
*Bugs fixed include:
109
-SANParks skin/TPC (5561, 5530, 5533, 5542, 5543, 5544, 5551, 5563, 5566, 5567, 5569, 5353)
110
-Registry (5114, 5244)
111
-Replication (4907, 5537, 5536, 5534, 5520, 5519, 3296)
112
-Spatial cache regeneration can be skipped during reconfiguration/redeployment/upgrade (3811)
113
-Pathquery support for temporal search criteria (2084)
114
-Character encoding of XML now respected (internationalization) (2495, 4083, 3815)
115

    
116

    
117
Release Notes for 1.9.5:
118
------------------------
119
This release fixes those bugs:
120
*Metacat could not download the included schemas in an external schema file during inserting.
121
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
122
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
123
*Document access rules are now preserved when documents are archived during the 'delete' action.
124

    
125
Release Notes for 1.9.4:
126
------------------------
127
This release fixes bugs in the FGDC data package upload and download interface utilized
128
by the SANParks and SAEON skins.
129

    
130
Release Notes for 1.9.3:
131
------------------------
132
This release fixes a harvester bug that prevented the EML harvester from processing
133
harvest lists.
134
The Kepler skin has been updated to support KarXML 2.1.
135
Ecogrid query services now support multiple namespace searches.
136

    
137
Release Notes for 1.9.2:
138
------------------------
139
This release primarily holds the addition of the Threshold of Potential
140
Concern workflow functionality (TPC).  The following issues were addressed:
141

    
142
* Create a properties file for use by JUnit Tests (Bug 2994)
143
* security issue with skins (Bug 3368)
144
* reorganize classes into a more functional specific structure (Bug 3510)
145
* Add admin names as dropdown in configuration login (Bug 3729)
146
* KNB metacat replication error log file is empty (Bug 3885)
147
* Create TPC Report web browse/search pages (Bug 4165)
148
* Create archive extraction functionality (Bug 4166)
149
* Create Workflow Scheduler (Bug 4167)
150
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
151
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
152
* Fix cross platform TPC GUI issues (Bug 4556)
153
* TPC Sanparks page content lenth issue (Bug 4557)
154
* Create validate and isAuthorized unit tests (Bug 4558)
155
* Cannot insert replication server via gui (Bug 4594)
156
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
157
* [ESA] Update fails when document rev number is missing (Bug 4627)
158
* fails to catch some insert and update failures (Bug 4637)
159
* must support java 1.6 (Bug 4641)
160
* Convert build to pull eml from svn instead of cvs (Bug 4644)
161
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
162
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
163
* metacat runs out of memory (Bug 4658)
164
* ESA skin links are hard coded to data.esa.org (Bug 4698)
165
* Update release 1.9.2 release notes (Bug 4707)
166
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
167
* Metacat should run against Tomcat 6 (Bug 4716)
168

    
169
Release Notes for 1.9.1:
170
------------------------
171
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
172
These bugs were primarily replication issues.  There is no difference 
173
in functionality between 1.9.0 and 1.9.1 
174

    
175
Release Notes for 1.9.0:
176
------------------------
177
This release focuses on simplifying the Metacat installation process by 
178
creating a binary (war) installation.  The need to build the application
179
on the server has been removed (although the option is still available).
180
In order to facilitate this method of installation, a few major modifications
181
were made to the code:
182

    
183
  -- Ant token replacement was removed for all non-build variables in the 
184
     application (most of this was already done in 1.8.1).
185

    
186
  -- The Metacat properties confguration was moved into the application
187
     itself.
188

    
189
  -- Database schema version detection and install/upgrade utilities were 
190
     added to the application.
191

    
192
Also, this release includes several enhancements:
193
  -- it supports the new EML 2.1.0 version.  
194

    
195
  -- Documents are now stored on the local filesystem as well as in the 
196
     database in order to preserve document integrity.
197
     
198
  -- Metacat verifies new schemas when they are added.
199

    
200
  -- Additional access is propegated with documents during replication.
201

    
202
High priority bugs were addressed in this release as well.
203

    
204
The enhancements/bugs addressed are:
205

    
206
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
207
* need to set filename for download files (Bug 2566)
208
* add ability for search engines to index metacat documents (Bug 2826)
209
* EML citation section should include both organizationNames and individualNames (Bug 3059)
210
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
211
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
212
* New documents explicitly set as public access don't show up correctly (Bug 3262)
213
* Modify confguration utility in metacat (Bug 3371)
214
* Integrate perl token replacement changes (Bug 3372)
215
* Create skin specific configuration utility (Bug 3373)
216
* Add authentication for configuration utility (Bug 3374)
217
* Create a sorted properties utility (Bug 3375)
218
* Add DB upgrade/install functionality to java code (Bug 3376)
219
* Create ANT install target for developers (Bug 3377)
220
* Create LSID server installation (Bug 3380)
221
* Create unit test code for 1.9 additions (Bug 3381)
222
* create simple turnkey installer for metacat Phase I (Bug 3461)
223
* Maps do not display in Firefox version 3 (Bug 3462)
224
* Replicate access rules in replication (Bug 3464)
225
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
226
* Add full schema checking when metacat register new schema (Bug 3474)
227
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
228
* getprincipals action returns invalid XML document (Bug 3527)
229
* Update knbweb to serve new metacat install (Bug 3545)
230
* Replication should write to disk (Bug 3554)
231
* Update acknowlegements in metacat readme (Bug 3588)
232
* Validate the ldap administrator field. (Bug 3616)
233
* Allow for different authentication services in metacat configuration (Bug 3680)
234
* Tag utilities module and have metacat check out that tag (Bug 3685)
235

    
236
Release Notes for 1.8.1:
237
------------------------
238
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
239
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
240
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
241
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
242
Details please see:
243
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
244
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
245

    
246
Note: after upgrading the Metacat to version 1.8.1, some replication issues may be seen, e.g., the 
247
EML 2.0.1 documents from Metacat 1.8.0 or ealier verions may be rejected since Metacat 1.8.1 uses
248
different EML 2.0.1 schemas (see bug 3239). If this is case, Metacat administrators should notify
249
their counterparts to upgrade previous version Metacats to 1.8.1. 
250

    
251
The fixed bugs include:
252

    
253
*Character set (charset) problem when filling out form (Bug2797)
254
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
255
*Metacat performance issue in Sanparks skin (Bug 3174)
256
*Metacat using illegitimate versions of EML schema (Bug 3239)
257
*Update older invalidated eml201 document in Metacat (Bug 3241)
258
*Verify existing token changes to skins (Bug 3176)
259
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
260
*Expose permission options for registry uploads (Bug 3014)
261
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
262
*Data Catalog Map is slow when selecting (Bug2732)
263
*Only one attribute per element returned with pathquery results(Bug 2999)
264
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
265
*Generalize the reading of skin.configs in DBTransform (Bug3058)
266
*The query example in metacatquery.html document need to be changed (Bug3137)
267
*Add upload method into Metacat tour (Bug 3139)
268
*Query resultset doesn't show component name in kepler skin (Bug 3178)
269
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
270
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
271
*An error message happen during the metacat start up (Bug 3279)
272
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
273
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
274
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
275

    
276
Release Notes for 1.8.0:
277
------------------------
278
This release focuses on improving query performance.  Both the selection 
279
and access control queries were rewritten to execute efficiently.
280
To improve search performance, a query caching mechanism was introduced. 
281
Cached queries are currently supported only for public users.
282

    
283
New Features:
284
* Data registries now support uploading of data objects along with data 
285
  packages (Bug 1982)
286
  
287
Bug Fixes:
288
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
289
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
290
* Query cache mechanism (Bug 2905)
291
* Metacat Performance: updates from Morpho of data packages are taking 
292
   longer than five minutes (Bug 2805)
293
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
294
* Metacat Performace: Upgrading hardware setup (Bug 2175)
295
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
296
* Display of metadata documents reorganized, including a new citation format,
297
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
298
* I.E. display fixes on default skin (Bug 2579)
299
* Web Address links fixed (Bug 2147)
300
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
301
* Spatial query:  data packages must be fully contained by the selection 
302
  bounding box in order to appear in the search results (Bugs 2972, 2732).
303
* FGDC support: upload, delete, update, access control, and download
304
  (Bugs 2807, 2925, 2926, 2929, 2030).
305
Compatibility Notices:
306
* Tomcat 3 and 4 are no longer tested or supported. Users are 
307
  highly encouraged to upgrade to Tomcat 5.5
308

    
309
Release Notes for 1.7.0:
310
------------------------
311
This release features only a few minor changes to the core Metacat engine. 
312
The major focus of this release is the addition of the spatial functionality.
313
The geographic coverage of metadata documents can now be cached in a GIS-
314
accessible format and published via web mapping services and an online
315
interactive map. 
316

    
317
New Features:
318
* Three new open source libraries have been integrated with Metacat:
319
  - Geoserver:  A standards-compliant web map server to publish
320
                geographic data to the web.
321
               (http://docs.codehaus.org/display/GEOS/Home)
322
  - GeoTools:   A java-based GIS toolkit to programatically
323
                manipulate spatial datasets.
324
                (http://geotools.codehaus.org/)
325
  - Mapbuilder: A javascript application to provide an interactive
326
                web map front-end to Geoserver.
327
                (http://docs.codehaus.org/display/MAP/Home)
328
* Spatial Caching/Indexing mechanism; documents with geographic
329
  coverages will be added to the spatial cache.
330
* Spatial Query action in metacat servlet. 
331
* Interactive Web map to visualize and query the spatial 
332
  distribution of metadata documents.
333
* Experimental python, ruby and php client libraries to interface with metacat.
334
* Preliminary process in place for web based configuration of metacat.
335

    
336
Compatibility Notices:
337
* Tomcat 3 and 4 are no longer tested or supported. Users are 
338
  highly encouraged to upgrade to Tomcat 5.5
339

    
340
Bug Fixes:
341
* Metacat administrators are able to modify and delete documents 
342
  created by other users.
343
* Fixed problems with indexing XML attributes, see bug 2469
344

    
345

    
346
Release Notes for 1.6.0:
347
------------------------
348

    
349
This release comes with more performance improvements, initial support for 
350
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
351
Metacat administrators and bug fixes. Below is the list of bug fixes and
352
performance improvements.
353

    
354
Bug Fixes: 
355
* Improved the indexing algorithm. Earlier indexing failed for some documents 
356
  randomly and used to take a lot of time to complete for others. The 
357
  code for indexing was changed to take care of both these problems.
358
* Earlier, xmlns prefix was used to determine the namespace of the document. 
359
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
360
  of the document as that is a better indicator of document type. 
361
* INSTR was used in some SQL statements and it is not supported by Postgres. 
362
  So SQL statements were modified so that INSTR is not used.
363
* Replication was changed to include replication of deleted documents also.
364
* Fixed bug in squery which didnt allow use of not-contains 
365

    
366
New Features:
367
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
368
* Added support for LSID. This includes modifying the stylesheets to 
369
  display the LSIDs, modifying the build to include a new target 
370
  'install-ldap'.
371
* Added following access control levels to Metacat:
372
    1. Administrators - users who can do the following:
373
       a. Run replication
374
       b. Delete any document
375
       c. Modify any document
376
       d. run indexing for any document
377
       e. check the logs
378
    2. allowedUsers - User who are allowed to submit
379
    3. deniedUsers - Users not allowed to submit
380
* Added a new skin for Ecological Society of America. 
381
* Created an Advanced search servlet which can be used from the web. 
382
* Various connections have been modified to be secure. e.g. connection between 
383
ldaps is made secure now, replication is done over secure channels.  
384

    
385
Performance:
386
* Reduced size of xml_nodes by creating a new table for holding nodes from 
387
  deleted documents and old revisions of the documents. 
388
* Provided a new variable in metacat.properties where more frequently searched 
389
  for paths can be specified. Seperate indexes are created for these paths 
390
  - so that search is faster.
391
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
392

    
393
Release Notes for 1.5.0:
394
------------------------
395

    
396
This release comes with performace improvement, user interface enhancements,
397
and bug fixes. Below is the list of bug fixes and performance improvements. 
398

    
399
Bug Fixes:
400
* Modify property values of harvester registration servlets to match the
401
  servlet-mapping URL values in web.xml. The old values used the servlet
402
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
403
  Windows. The new values use the servlet-mapping URL values. This should
404
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
405
* Re-implement logic to prune old log entries from the HARVEST_LOG and
406
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
407
  violations in the database because it tried to delete parent records from
408
  HARVEST_LOG prior to deleting child records from
409
  HARVEST_DETAIL_LOG. (Bug 162)
410
* In data registry, minor bugs fixed like the error page shows the link back
411
  to the form when error page was generated because of a document read
412
  request from search results page,  the successful delete button leading
413
  to a blank screen and the old ACL overwritten by the registry.
414
  (Bugs 1307, 1310, 1322, 1344, 1551)
415
* Changed the code to support insertion of following characters: ', `,
416
  charcters in the Numeric Character Reference format (&#xyz;) and
417
  characters like µ. Characters like µ will be converted to and stored in
418
  Numeric Character Reference format(&#xyz;). They will also be returned
419
  in Numeric Character Reference and it is upto the client to convert them
420
  and display them accordingly in the application. Partial fix provided by
421
  Johnoel Ancheta. (Bug 1538,1711)
422
* Spatial search failed on Oracle because of invalid entries made by
423
  some documents in the nodedata column of xml_nodes for paths involving
424
  'eastBoundingCoordinate', 'westBoundingCoordinate',
425
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
426
  nodedatanumerical was added to xml_nodes table such that all the numerical
427
  nodedata is stored in this column and this column is now used for spatial
428
  search. (Bug 1703, 1718)
429
* In the default skin, clicking on the keywords on the home page did not
430
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
431
* Metacat generated a success message even when a document which didnt
432
  exsist was requested for deletion. This has been fixed. (Bug 1850)
433
* "packagetype" in xml-relation table was entered as eml200 namespace when
434
  an eml201 document was inserted. This is fixed now so that "packagetype"
435
  in xml-relation table points to eml201 namespace. (Bug 1979)
436
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
437
  earlier. Fixed such that it points to the locally installed metacat url. 
438
  (Bug 1986)
439
* Changes to the Query subsystem fix bugs that prevented attributes from 
440
  being expressed solely in the xpath query statement and the returnfield 
441
  values. For instance, a query URL may now include search strings like 
442
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
443
  Previously, the attribute had to be appended to an element: 
444
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
445
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
446
* Search query failed in case of Oracle if number of documents in the result
447
  were more than 1000. This has been fixed. (Bug 2000)
448
* Removed any occurence of enum which is now a keyword in Java 1.5
449

    
450

    
451
Enhancements:
452
* Major improvements done in user interface for the data registeries and
453
  various other skins. Improvements done based on suggestions from Mark
454
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
455
  the default skin and ldap templates. (Bug 1948)
456
* Coded added such that administrator can delete documents irrespective of
457
  who the document belongs to.
458
* Performance impovement done in searching of datasets. A part of the search
459
  time was taken up because of generation of resultset after the search had be
460
  done. So this was the sequence of events in earlier metacat
461
  1) Search for the given text
462
  2) A list of docids generated
463
  3) For each of the docids
464
     3a) Use xml_index and xml_nodes table to generate the string descibing
465
         the document including the returnfields requested in the search
466
  4) Add all the strings from step 3a to send back the resultant
467
     document. Here a decent amount of time was being taken by step 3a. 
468
  The algorithm is now modified by addition of two tables xml_queryresult and
469
  xml_returnfields and a user defined parameter xml_returnfield_count. The
470
  new algorithm works as follows:
471
  1) Search for the given text
472
  2) A list of docids is generated
473
  3) For the given set of return fields generate a unique string and check
474
     if that string exists in xml_returnfields
475
     3a) If string does not exist in xml_returnfield, then enter a new
476
         record usage_count as 1 and returnfield_string as the unique string
477
         generated above.
478
     3b) Else if the string exists, increment usage_count
479
  4) Given the docids from step 2 and the id of the returnfield record from
480
     step 3, query for any docids that already exist in xml_queryresult.
481
     For the docids that do exist, get the queryresult_string.
482
  5) For rest of the docids from step2 which were not found in step 4, do
483
     the following for each of the documents:
484
     5a) Use xml_index and xml_nodes table to generate the string descibing
485
         the document including the returnfields requested in the search
486
     5b) If usage_count of the record from step is more than
487
         xml_returnfield_count set in metacat.properties, then store the
488
         string in xml_queryresult as a record which has the returnfield_id
489
         representing the set of returnfields, docid representing the
490
         document and the string as queryresult_string.
491
  6) Add all the strings from step 4 and step 5a to send back the resultant
492
     document
493
  So the results from step 3a in previous algorithm are effectively cached
494
  and hence same computation is not done again and again for each search.
495
  When a document is deleted, all the entries for that document in
496
  xml_queryresult table are also deleted. When a document is updated, all
497
  the entries for that document in xml_queryresult table are deleted. This
498
  works fine because those entries will be generated and cached again the
499
  next time the document is part of a search is requested.
500
* Performance impovement done for % search.
501
* Following new functions added to metacat client API: a method to set access
502
  on an xml document and a method to get newest version for a given document.
503
* Implement a new HarvesterServlet for running Harvester as a servlet. This
504
  eliminates the need to run Harvester in a terminal window. By default, the
505
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
506
  documentation will be modified to instruct Harvester administrators to
507
  uncomment the HarvesterServlet entry.
508
* Minor enhancement to support multiple email addresses for harvester
509
  administrator and site contact. Each address is separated by a comma or
510
  semicolon.
511
* Increase number of rows in Harvest List Editor from 300 to 1200.
512
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
513
  value when it is set to 0 or a negative number. This allows Harvester to
514
  run indefinitely without shutting down after reaching a maximum number of
515
  harvests. The previous default value of 30 would cause Harvester to
516
  terminate after 30 harvests.
517

    
518
Details of all changes can be found in the bug database here:
519
http://bugzilla.ecoinformatics.org/buglist.cgi?product=Metacat&target_milestone=1.5
520

    
521

    
522
Release Notes for 1.4.0:
523
------------------------
524

    
525
This is a major release, and is the first to introduce many new features to
526
Metacat.  Some of the major new features in this version of Metacat include:
527

    
528
* Added a new 'Harvester' that allows documents to be periodically pulled
529
  from distributed sources into metacat, useful for interfacing with other
530
  system types. See the Metacat Tour for details.
531
* Added new 'skins' capability to allow the GUI for the metacat web interface
532
  to be more easily customized to fit into site needs.  The skin is based on
533
  a flexible mix of XSLT, CSS, and Javascript.
534
* Added a web-based metadata entry form for submitting limited EML documents
535
  as part of a data registry.  The GUI for the registry is customizable and 
536
  is integrated with the 'skins' system for the main metacat interface.  The
537
  registry subsystem is written in Perl, and can simultaneously be used to 
538
  present multiple 'registry' interfaces.
539
* A new 'client API' has been developed and implemented in Java and in Perl 
540
  so that metacat functions can be accessed from any program in those
541
  languages.  The client API supports the major metacat servlet actions,
542
  including login(), logout(), query(), insert(), update(), delete(), and 
543
  upload(). See the Metacat Tour for details.
544
* Added a new 'getlog' action that produces a usage history for all major
545
  events.  So now an XML report can be generated for document reads, inserts,
546
  deletes, etc.  See the new section in the Metacat Tour.
547
* Added a new 'buildindex' action that can rebuild the index entries for any
548
  document in the database.
549
* The configuration file for metacat (metacat.properties) has been moved out
550
  of the jar file and into the WEB-INF directory, allowing far easier changes
551
  to the configuration parameters.
552
* Results in default web interface are sorted by title in the XSLT 
553
  (configurable)
554
* Many bugs were fixed.
555

    
556
Details of all changes can be found in the bug database here:
557
http://bugzilla.ecoinformatics.org/buglist.cgi?product=Metacat&target_milestone=1.4
558

    
559
Release Notes for 1.3.1:
560
------------------------
561

    
562
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
563
include:
564
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
565
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
566
    and Java 1.4.
567
 2) Distribution package size was reduced.
568

    
569

    
570
Release Notes for 1.3.0
571
------------------------
572

    
573
In 1.3.0 release, the structure of the xml_access table was changed and a new
574
table, xml_accesssubtree was added. If you try to update a previously 
575
installed Metacat, you should run a script file to updated the table structure 
576
before installation.
577
For Oracle user: At the SQLPLUS prompt type the following -
578
@src/reviseformetacat13.sql
579
For Postgresql user: At install directory prompt type the following -
580
psql exp < src/reviseformetacat13_postgres.sql
581
(where 'exp' is the database name).
582

    
583
After installation, user should run "ant schemasql" command to register EML2
584
schema in xml_catalog table.
585

    
586
If you are a new Metacat user, this step is unneeded.
587

    
588
Note: 1) We recommend to use Tomcat 4 and JAVA 1.4 to run Metacat. Otherwise, 
589
         it will cause potential replication issues.
590
      2) Delete the xercesImpl.jar and xmlParserAPIs.jar files 
591
         which are in $CATALINA_HOME/common/endorsed. They are old version and
592
         don't support XML schema validation.
593

    
594
New Features in 1.3.0
595
  1) Partialy support EML2 document. User can store, query, read and write
596
     EML2 documents. However, Metacat only support access control in resource
597
     level. The subtree level access control will be ignored.
598
  2) Support other xml document base on namespace/schema.
599
  3) Support query for attribute value
600
  4) Assign MIME type to data file base on metadata when user try to read it.
601
  5) Owner can assign access rules to a document which does not have access 
602
     document to apply it.
603
  6) Support exporting single file, not only whole package
604
  7) Resupport Microsoft SQL Server.
605

    
606
Fixes in 1.3.0:
607
  1) Couldn't finish delta T replication for large set of documents.
608
  2) Couldn't create access control during delta T replication.
609
  3) Eorr will be written to a seperated log file if some documents
610
     were failed in replication.
611
  4) Decrease the time to create access rules during insert or update 
612
     a package.
613
     
614
Documentation
615
-------------
616
See the docs directory for detailed documentation and installation
617
instructions.
618

    
619
Details of the Metacat architecture can be found on the website for
620
the Knowledge Network for Biocomplexity (KNB):
621

    
622
  http://knb.ecoinformatics.org/software/metacat/
623

    
624
Contributions to this work are welcome.  Please see the above web site
625
for details on how to contribute.
626

    
627
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
628
-----------------------------------------------------------------------------
629
If you discover a bug please report it, either by email (above) or by using
630
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
631
list of currently unimplemented features in Bugzilla that we are working on
632
for the next release.
633

    
634
Legalese
635
--------
636
This software is copyrighted by The Regents of the University of California
637
and the National Center for Ecological Analysis and Synthesis
638
and licensed under the GNU GPL; see the 'LICENSE' file for
639
details.
640

    
641
This material is based upon work supported by the
642
National Science Foundation under Grant No. DEB99-80154, DBI99-04777, and
643
0225676 for SEEK.  Any opinions, findings and conclusions or recomendations 
644
expressed in this material are those of the author(s) and do not necessarily 
645
reflect the views of the National Science Foundation (NSF).
646

    
647
This software is partially supported by a grant from the Andrew W. 
648
Mellon Foundation.
649

    
650
This product includes software developed by the Apache Software
651
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
652
for details.
653

    
654
The source code, object code, and documentation in the com.oreilly.servlet
655
package is copyright and owned by Jason Hunter. See the cos-license.html file
656
for details of the license.  Licensor retains title to and ownership of the
657
Software and all enhancements, modifications, and updates to the Software.
658

    
659
This software includes the JDBC driver for PostgreSQL.  See the 
660
postgresql-license.txt file for details.
(2-2/6)