Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 9980 $'
5
#     '$Date: 2016-09-13 14:53:44 -0700 (Tue, 13 Sep 2016) $'
6
#
7

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

    
11
Version: 2.8.0 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
              Chris Jones (cjones@msi.ucsb.edu)
25
              John Harris (harris@nceas.ucsb.edu)
26
              Callie Bowdish (bowdish@ecoinformatics.org)
27
              Will Tyburczy (tyburczy@ecoinformatics.org)
28
              Matthew Perry (perry@nceas.ucsb.edu)
29
              Chad Burt (underbluewaters@gmail.com)
30
              Ben Leinfelder (leinfelder@nceas.ucsb.edu)
31
              Chris Barteau (barteau@nceas.ucsb.edu)
32
              Shaun Walbridge (walbridge@nceas.ucsb.edu)
33
              Michael Daigle (daigle@nceas.ucsb.edu) 
34
              Lauren Walker (walker@nceas.ucsb.edu) 
35

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

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

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

    
57

    
58
Release Notes for 2.7.2:
59
------------------------
60
Bugs fixed in this release:
61
* Legacy Metacat "shortcut" url does not work if revision is omitted
62
* Migrate metacat build to use EML git repo
63
* All links on the registry page should open up in a new tab 
64
* Metadata/data objects which have obsoletedBy field ignore the resource map index
65
* Metacat creates an Invalid Content-Disposition value for some filenames
66
* External links in the registry should open in new tab
67
* Remove the support of Oracle on documentation
68
* Changing a Metacat member node's synchronization value on the d1 admin page doesn't work  
69
* Add the feature to support the noNamespaceSchemaLocation attribute in xml objects
70
* Provide clear messages to clients if the namespaces/formatids of the schemas of xml objects are not registered in Metacat
71
* Disable the feature of downloading external schemas for unregistered namespaces
72

    
73
Release Notes for 2.7.1:
74
------------------------
75
* Fixed several bugs on the data registry form
76
* Support the onedcx schema
77
  - Fixed several onedcx stylesheet issues
78

    
79
Relese Notes for 2.7.0:
80
------------------------
81
* Use different format ids to identity variants of the schema with same namespace
82
* Add EML 2.1.1 to Darwin Core supporting for OAI-PMH provider  
83
* Bugs fixed include:
84
  - Series head resolution should use obsoletes field as part of determination(7020)
85
  - The InputStream (parameter) in the CN/MN.create and MN.update method is not closed(7005)
86
  - Use the AutoCloseClientInputStream class in the d1_libclient_java in Metacat replication(7004)
87

    
88
Release Notes for 2.6.0:
89
------------------------
90
This release supports token-based authentication in the data registry
91
as well as:
92
* MetacatUI 1.11.0
93

    
94
Release Notes for 2.5.1:
95
------------------------
96
This a minor release that improves:
97
* Authentication token handling for the DataONE API
98

    
99
Release Notes for 2.5.0:
100
------------------------
101
This major release adds DataONE V2 API support
102
as well as:
103
* MetacatUI 1.8.1
104
* Data registry bug fixes
105

    
106
Release Notes for 2.4.3:
107
------------------------
108
This release includes:
109
* Support for large file uploads
110
* Recording User-Agent when logging requests
111

    
112
Release Notes for 2.4.2:
113
------------------------
114
This release includes:
115
* Updates to improve character encoding handling
116
* Updated SOLR index and UI to use geohashes for map rendering
117
* Note: this is the last release of Metacat that will support Java 6
118

    
119
Release Notes for 2.4.1:
120
------------------------
121
This is a patch release that addresses the following:
122
* Allows LDAP authentication using aliased referrals
123
* Re-indexes previous document revisions in SOLR when
124
new revisions are added on update
125
* Allows authentication in SANParks skin
126
* Enables OpenLayer.js mapping plug-in over https
127

    
128
Release Notes for 2.4.0:
129
------------------------
130
These release adds a new default file-based authentication mechanism
131
that allows administrators to more easily deploy Metacat without a
132
LDAP server.
133
Other enhancements include:
134
* Correct use of DataONE 'archive' flag
135
* Access policy synchronization with the DataONE Coordinating Node
136
* Indexing support for EML singleDateTime coverage values
137
* Indexing support document read/download events
138
* Improved package download structure and file naming conventions
139

    
140
Release Notes for 2.3.1:
141
------------------------
142
This is a minor patch release to fix an issue that arises when
143
Metacat is operating as a DataONE Coordinating Node.
144
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
145
* Updated MetacatUI with support for spatial query criteria
146
* Updated account/identity management script
147

    
148
Release Notes for 2.3.0:
149
------------------------
150
This release adds solr indexing features to metacat-index 
151
for querying and sorting by authors and taxonomic coverage.
152
Also includes:
153
* Control over the log level from the SOLR libraries using Metacat's
154
log4j file.
155
* access_log DB indexes for better log reporting performance 
156
via the DataONE API
157
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
158

    
159

    
160
Release Notes for 2.2.1:
161
------------------------
162
This is a critical patch release of Metacat that includes addresses
163
a bug in file stream handling. It is recommended for all Metacat deployments.
164

    
165
Release Notes for 2.2.0:
166
------------------------
167
This is a major release of Metacat that includes a new customizable UI and 
168
improved LDAP account management features
169

    
170
Release Notes for 2.1.1:
171
------------------------
172
This is a minor patch release of Metacat that addresses
173
a bug in DOI publishing.
174

    
175
Release Notes for 2.1.0:
176
------------------------
177
This is a major release of Metacat that includes a SOLR-based search feature
178
* Optional SOLR search index
179
* Client certificate delegation (using a service provider like CILogon)
180

    
181
Release Notes for 2.0.8:
182
------------------------
183
This is a patch release for Metacat
184
* Enforce DataONE prohibition on whitespace in identifiers
185
* Use unique filenames for Registry data uploads
186

    
187
Release Notes for 2.0.7:
188
------------------------
189
This is a patch release for Metacat replication
190
* Replication SQL performance enhancement
191
* Comply with DataONE schema for SystemMetadata.submitter
192

    
193
Release Notes for 2.0.6:
194
------------------------
195
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
196
* MN.generateIdentifier() support for UUID and DOI
197
* DOI registration support using EZID service
198
* Pathquery support for specifying multiple document owners
199

    
200

    
201
Release Notes for 2.0.5:
202
------------------------
203
This patch release focuses on Metacat support for Oracle
204
*SystemMetadata table names have been shortened to comply with Oracle limits.
205
*SANParks/SAEON spatial zip file download fixed
206
*Pathquery performance fix
207
*Hazelcast 2.x upgrade
208
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
209

    
210
Release Notes for 2.0.4:
211
------------------------
212
This patch release focuses on Metacat-Metacat replication.
213
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
214
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
215
*Fixes an access control issue that could allow search results to include protected documents
216

    
217
Release Notes for 2.0.3:
218
------------------------
219
This is another critical patch release of Metacat 2.0.
220
*Addresses a bug that prevented Metacat replication from completing (timeout error)
221
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
222

    
223
Release Notes for 2.0.2:
224
------------------------
225
This is a critical patch release of Metacat 2.0.
226
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
227
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
228
*Updates the Foresite ORE library to correctly serialize resource map documents
229

    
230
Release Notes for 2.0.1:
231
------------------------
232
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
233
*Addresses an identifier issue during ORE generation for DataONE services
234
*Increases compatibility with older EML content and the Xalan XSLT processor
235
*Removes XSLT 2.0 support (Saxon)
236

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

    
253

    
254
Release Notes for 1.9.5:
255
------------------------
256
This release fixes those bugs:
257
*Metacat could not download the included schemas in an external schema file during inserting.
258
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
259
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
260
*Document access rules are now preserved when documents are archived during the 'delete' action.
261

    
262
Release Notes for 1.9.4:
263
------------------------
264
This release fixes bugs in the FGDC data package upload and download interface utilized
265
by the SANParks and SAEON skins.
266

    
267
Release Notes for 1.9.3:
268
------------------------
269
This release fixes a harvester bug that prevented the EML harvester from processing
270
harvest lists.
271
The Kepler skin has been updated to support KarXML 2.1.
272
Ecogrid query services now support multiple namespace searches.
273

    
274
Release Notes for 1.9.2:
275
------------------------
276
This release primarily holds the addition of the Threshold of Potential
277
Concern workflow functionality (TPC).  The following issues were addressed:
278

    
279
* Create a properties file for use by JUnit Tests (Bug 2994)
280
* security issue with skins (Bug 3368)
281
* reorganize classes into a more functional specific structure (Bug 3510)
282
* Add admin names as dropdown in configuration login (Bug 3729)
283
* KNB metacat replication error log file is empty (Bug 3885)
284
* Create TPC Report web browse/search pages (Bug 4165)
285
* Create archive extraction functionality (Bug 4166)
286
* Create Workflow Scheduler (Bug 4167)
287
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
288
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
289
* Fix cross platform TPC GUI issues (Bug 4556)
290
* TPC Sanparks page content lenth issue (Bug 4557)
291
* Create validate and isAuthorized unit tests (Bug 4558)
292
* Cannot insert replication server via gui (Bug 4594)
293
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
294
* [ESA] Update fails when document rev number is missing (Bug 4627)
295
* fails to catch some insert and update failures (Bug 4637)
296
* must support java 1.6 (Bug 4641)
297
* Convert build to pull eml from svn instead of cvs (Bug 4644)
298
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
299
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
300
* metacat runs out of memory (Bug 4658)
301
* ESA skin links are hard coded to data.esa.org (Bug 4698)
302
* Update release 1.9.2 release notes (Bug 4707)
303
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
304
* Metacat should run against Tomcat 6 (Bug 4716)
305

    
306
Release Notes for 1.9.1:
307
------------------------
308
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
309
These bugs were primarily replication issues.  There is no difference 
310
in functionality between 1.9.0 and 1.9.1 
311

    
312
Release Notes for 1.9.0:
313
------------------------
314
This release focuses on simplifying the Metacat installation process by 
315
creating a binary (war) installation.  The need to build the application
316
on the server has been removed (although the option is still available).
317
In order to facilitate this method of installation, a few major modifications
318
were made to the code:
319

    
320
  -- Ant token replacement was removed for all non-build variables in the 
321
     application (most of this was already done in 1.8.1).
322

    
323
  -- The Metacat properties confguration was moved into the application
324
     itself.
325

    
326
  -- Database schema version detection and install/upgrade utilities were 
327
     added to the application.
328

    
329
Also, this release includes several enhancements:
330
  -- it supports the new EML 2.1.0 version.  
331

    
332
  -- Documents are now stored on the local filesystem as well as in the 
333
     database in order to preserve document integrity.
334
     
335
  -- Metacat verifies new schemas when they are added.
336

    
337
  -- Additional access is propegated with documents during replication.
338

    
339
High priority bugs were addressed in this release as well.
340

    
341
The enhancements/bugs addressed are:
342

    
343
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
344
* need to set filename for download files (Bug 2566)
345
* add ability for search engines to index metacat documents (Bug 2826)
346
* EML citation section should include both organizationNames and individualNames (Bug 3059)
347
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
348
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
349
* New documents explicitly set as public access don't show up correctly (Bug 3262)
350
* Modify confguration utility in metacat (Bug 3371)
351
* Integrate perl token replacement changes (Bug 3372)
352
* Create skin specific configuration utility (Bug 3373)
353
* Add authentication for configuration utility (Bug 3374)
354
* Create a sorted properties utility (Bug 3375)
355
* Add DB upgrade/install functionality to java code (Bug 3376)
356
* Create ANT install target for developers (Bug 3377)
357
* Create LSID server installation (Bug 3380)
358
* Create unit test code for 1.9 additions (Bug 3381)
359
* create simple turnkey installer for metacat Phase I (Bug 3461)
360
* Maps do not display in Firefox version 3 (Bug 3462)
361
* Replicate access rules in replication (Bug 3464)
362
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
363
* Add full schema checking when metacat register new schema (Bug 3474)
364
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
365
* getprincipals action returns invalid XML document (Bug 3527)
366
* Update knbweb to serve new metacat install (Bug 3545)
367
* Replication should write to disk (Bug 3554)
368
* Update acknowlegements in metacat readme (Bug 3588)
369
* Validate the ldap administrator field. (Bug 3616)
370
* Allow for different authentication services in metacat configuration (Bug 3680)
371
* Tag utilities module and have metacat check out that tag (Bug 3685)
372

    
373
Release Notes for 1.8.1:
374
------------------------
375
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
376
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
377
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
378
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
379
Details please see:
380
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
381
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
382

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

    
388
The fixed bugs include:
389

    
390
*Character set (charset) problem when filling out form (Bug2797)
391
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
392
*Metacat performance issue in Sanparks skin (Bug 3174)
393
*Metacat using illegitimate versions of EML schema (Bug 3239)
394
*Update older invalidated eml201 document in Metacat (Bug 3241)
395
*Verify existing token changes to skins (Bug 3176)
396
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
397
*Expose permission options for registry uploads (Bug 3014)
398
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
399
*Data Catalog Map is slow when selecting (Bug2732)
400
*Only one attribute per element returned with pathquery results(Bug 2999)
401
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
402
*Generalize the reading of skin.configs in DBTransform (Bug3058)
403
*The query example in metacatquery.html document need to be changed (Bug3137)
404
*Add upload method into Metacat tour (Bug 3139)
405
*Query resultset doesn't show component name in kepler skin (Bug 3178)
406
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
407
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
408
*An error message happen during the metacat start up (Bug 3279)
409
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
410
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
411
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
412

    
413
Release Notes for 1.8.0:
414
------------------------
415
This release focuses on improving query performance.  Both the selection 
416
and access control queries were rewritten to execute efficiently.
417
To improve search performance, a query caching mechanism was introduced. 
418
Cached queries are currently supported only for public users.
419

    
420
New Features:
421
* Data registries now support uploading of data objects along with data 
422
  packages (Bug 1982)
423
  
424
Bug Fixes:
425
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
426
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
427
* Query cache mechanism (Bug 2905)
428
* Metacat Performance: updates from Morpho of data packages are taking 
429
   longer than five minutes (Bug 2805)
430
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
431
* Metacat Performace: Upgrading hardware setup (Bug 2175)
432
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
433
* Display of metadata documents reorganized, including a new citation format,
434
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
435
* I.E. display fixes on default skin (Bug 2579)
436
* Web Address links fixed (Bug 2147)
437
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
438
* Spatial query:  data packages must be fully contained by the selection 
439
  bounding box in order to appear in the search results (Bugs 2972, 2732).
440
* FGDC support: upload, delete, update, access control, and download
441
  (Bugs 2807, 2925, 2926, 2929, 2030).
442
Compatibility Notices:
443
* Tomcat 3 and 4 are no longer tested or supported. Users are 
444
  highly encouraged to upgrade to Tomcat 5.5
445

    
446
Release Notes for 1.7.0:
447
------------------------
448
This release features only a few minor changes to the core Metacat engine. 
449
The major focus of this release is the addition of the spatial functionality.
450
The geographic coverage of metadata documents can now be cached in a GIS-
451
accessible format and published via web mapping services and an online
452
interactive map. 
453

    
454
New Features:
455
* Three new open source libraries have been integrated with Metacat:
456
  - Geoserver:  A standards-compliant web map server to publish
457
                geographic data to the web.
458
               (http://docs.codehaus.org/display/GEOS/Home)
459
  - GeoTools:   A java-based GIS toolkit to programatically
460
                manipulate spatial datasets.
461
                (http://geotools.codehaus.org/)
462
  - Mapbuilder: A javascript application to provide an interactive
463
                web map front-end to Geoserver.
464
                (http://docs.codehaus.org/display/MAP/Home)
465
* Spatial Caching/Indexing mechanism; documents with geographic
466
  coverages will be added to the spatial cache.
467
* Spatial Query action in metacat servlet. 
468
* Interactive Web map to visualize and query the spatial 
469
  distribution of metadata documents.
470
* Experimental python, ruby and php client libraries to interface with metacat.
471
* Preliminary process in place for web based configuration of metacat.
472

    
473
Compatibility Notices:
474
* Tomcat 3 and 4 are no longer tested or supported. Users are 
475
  highly encouraged to upgrade to Tomcat 5.5
476

    
477
Bug Fixes:
478
* Metacat administrators are able to modify and delete documents 
479
  created by other users.
480
* Fixed problems with indexing XML attributes, see bug 2469
481

    
482

    
483
Release Notes for 1.6.0:
484
------------------------
485

    
486
This release comes with more performance improvements, initial support for 
487
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
488
Metacat administrators and bug fixes. Below is the list of bug fixes and
489
performance improvements.
490

    
491
Bug Fixes: 
492
* Improved the indexing algorithm. Earlier indexing failed for some documents 
493
  randomly and used to take a lot of time to complete for others. The 
494
  code for indexing was changed to take care of both these problems.
495
* Earlier, xmlns prefix was used to determine the namespace of the document. 
496
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
497
  of the document as that is a better indicator of document type. 
498
* INSTR was used in some SQL statements and it is not supported by Postgres. 
499
  So SQL statements were modified so that INSTR is not used.
500
* Replication was changed to include replication of deleted documents also.
501
* Fixed bug in squery which didnt allow use of not-contains 
502

    
503
New Features:
504
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
505
* Added support for LSID. This includes modifying the stylesheets to 
506
  display the LSIDs, modifying the build to include a new target 
507
  'install-ldap'.
508
* Added following access control levels to Metacat:
509
    1. Administrators - users who can do the following:
510
       a. Run replication
511
       b. Delete any document
512
       c. Modify any document
513
       d. run indexing for any document
514
       e. check the logs
515
    2. allowedUsers - User who are allowed to submit
516
    3. deniedUsers - Users not allowed to submit
517
* Added a new skin for Ecological Society of America. 
518
* Created an Advanced search servlet which can be used from the web. 
519
* Various connections have been modified to be secure. e.g. connection between 
520
ldaps is made secure now, replication is done over secure channels.  
521

    
522
Performance:
523
* Reduced size of xml_nodes by creating a new table for holding nodes from 
524
  deleted documents and old revisions of the documents. 
525
* Provided a new variable in metacat.properties where more frequently searched 
526
  for paths can be specified. Seperate indexes are created for these paths 
527
  - so that search is faster.
528
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
529

    
530
Release Notes for 1.5.0:
531
------------------------
532

    
533
This release comes with performace improvement, user interface enhancements,
534
and bug fixes. Below is the list of bug fixes and performance improvements. 
535

    
536
Bug Fixes:
537
* Modify property values of harvester registration servlets to match the
538
  servlet-mapping URL values in web.xml. The old values used the servlet
539
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
540
  Windows. The new values use the servlet-mapping URL values. This should
541
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
542
* Re-implement logic to prune old log entries from the HARVEST_LOG and
543
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
544
  violations in the database because it tried to delete parent records from
545
  HARVEST_LOG prior to deleting child records from
546
  HARVEST_DETAIL_LOG. (Bug 162)
547
* In data registry, minor bugs fixed like the error page shows the link back
548
  to the form when error page was generated because of a document read
549
  request from search results page,  the successful delete button leading
550
  to a blank screen and the old ACL overwritten by the registry.
551
  (Bugs 1307, 1310, 1322, 1344, 1551)
552
* Changed the code to support insertion of following characters: ', `,
553
  charcters in the Numeric Character Reference format (&#xyz;) and
554
  characters like µ. Characters like µ will be converted to and stored in
555
  Numeric Character Reference format(&#xyz;). They will also be returned
556
  in Numeric Character Reference and it is upto the client to convert them
557
  and display them accordingly in the application. Partial fix provided by
558
  Johnoel Ancheta. (Bug 1538,1711)
559
* Spatial search failed on Oracle because of invalid entries made by
560
  some documents in the nodedata column of xml_nodes for paths involving
561
  'eastBoundingCoordinate', 'westBoundingCoordinate',
562
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
563
  nodedatanumerical was added to xml_nodes table such that all the numerical
564
  nodedata is stored in this column and this column is now used for spatial
565
  search. (Bug 1703, 1718)
566
* In the default skin, clicking on the keywords on the home page did not
567
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
568
* Metacat generated a success message even when a document which didnt
569
  exsist was requested for deletion. This has been fixed. (Bug 1850)
570
* "packagetype" in xml-relation table was entered as eml200 namespace when
571
  an eml201 document was inserted. This is fixed now so that "packagetype"
572
  in xml-relation table points to eml201 namespace. (Bug 1979)
573
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
574
  earlier. Fixed such that it points to the locally installed metacat url. 
575
  (Bug 1986)
576
* Changes to the Query subsystem fix bugs that prevented attributes from 
577
  being expressed solely in the xpath query statement and the returnfield 
578
  values. For instance, a query URL may now include search strings like 
579
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
580
  Previously, the attribute had to be appended to an element: 
581
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
582
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
583
* Search query failed in case of Oracle if number of documents in the result
584
  were more than 1000. This has been fixed. (Bug 2000)
585
* Removed any occurence of enum which is now a keyword in Java 1.5
586

    
587

    
588
Enhancements:
589
* Major improvements done in user interface for the data registeries and
590
  various other skins. Improvements done based on suggestions from Mark
591
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
592
  the default skin and ldap templates. (Bug 1948)
593
* Coded added such that administrator can delete documents irrespective of
594
  who the document belongs to.
595
* Performance impovement done in searching of datasets. A part of the search
596
  time was taken up because of generation of resultset after the search had be
597
  done. So this was the sequence of events in earlier metacat
598
  1) Search for the given text
599
  2) A list of docids generated
600
  3) For each of the docids
601
     3a) Use xml_index and xml_nodes table to generate the string descibing
602
         the document including the returnfields requested in the search
603
  4) Add all the strings from step 3a to send back the resultant
604
     document. Here a decent amount of time was being taken by step 3a. 
605
  The algorithm is now modified by addition of two tables xml_queryresult and
606
  xml_returnfields and a user defined parameter xml_returnfield_count. The
607
  new algorithm works as follows:
608
  1) Search for the given text
609
  2) A list of docids is generated
610
  3) For the given set of return fields generate a unique string and check
611
     if that string exists in xml_returnfields
612
     3a) If string does not exist in xml_returnfield, then enter a new
613
         record usage_count as 1 and returnfield_string as the unique string
614
         generated above.
615
     3b) Else if the string exists, increment usage_count
616
  4) Given the docids from step 2 and the id of the returnfield record from
617
     step 3, query for any docids that already exist in xml_queryresult.
618
     For the docids that do exist, get the queryresult_string.
619
  5) For rest of the docids from step2 which were not found in step 4, do
620
     the following for each of the documents:
621
     5a) Use xml_index and xml_nodes table to generate the string descibing
622
         the document including the returnfields requested in the search
623
     5b) If usage_count of the record from step is more than
624
         xml_returnfield_count set in metacat.properties, then store the
625
         string in xml_queryresult as a record which has the returnfield_id
626
         representing the set of returnfields, docid representing the
627
         document and the string as queryresult_string.
628
  6) Add all the strings from step 4 and step 5a to send back the resultant
629
     document
630
  So the results from step 3a in previous algorithm are effectively cached
631
  and hence same computation is not done again and again for each search.
632
  When a document is deleted, all the entries for that document in
633
  xml_queryresult table are also deleted. When a document is updated, all
634
  the entries for that document in xml_queryresult table are deleted. This
635
  works fine because those entries will be generated and cached again the
636
  next time the document is part of a search is requested.
637
* Performance impovement done for % search.
638
* Following new functions added to metacat client API: a method to set access
639
  on an xml document and a method to get newest version for a given document.
640
* Implement a new HarvesterServlet for running Harvester as a servlet. This
641
  eliminates the need to run Harvester in a terminal window. By default, the
642
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
643
  documentation will be modified to instruct Harvester administrators to
644
  uncomment the HarvesterServlet entry.
645
* Minor enhancement to support multiple email addresses for harvester
646
  administrator and site contact. Each address is separated by a comma or
647
  semicolon.
648
* Increase number of rows in Harvest List Editor from 300 to 1200.
649
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
650
  value when it is set to 0 or a negative number. This allows Harvester to
651
  run indefinitely without shutting down after reaching a maximum number of
652
  harvests. The previous default value of 30 would cause Harvester to
653
  terminate after 30 harvests.
654

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

    
658

    
659
Release Notes for 1.4.0:
660
------------------------
661

    
662
This is a major release, and is the first to introduce many new features to
663
Metacat.  Some of the major new features in this version of Metacat include:
664

    
665
* Added a new 'Harvester' that allows documents to be periodically pulled
666
  from distributed sources into metacat, useful for interfacing with other
667
  system types. See the Metacat Tour for details.
668
* Added new 'skins' capability to allow the GUI for the metacat web interface
669
  to be more easily customized to fit into site needs.  The skin is based on
670
  a flexible mix of XSLT, CSS, and Javascript.
671
* Added a web-based metadata entry form for submitting limited EML documents
672
  as part of a data registry.  The GUI for the registry is customizable and 
673
  is integrated with the 'skins' system for the main metacat interface.  The
674
  registry subsystem is written in Perl, and can simultaneously be used to 
675
  present multiple 'registry' interfaces.
676
* A new 'client API' has been developed and implemented in Java and in Perl 
677
  so that metacat functions can be accessed from any program in those
678
  languages.  The client API supports the major metacat servlet actions,
679
  including login(), logout(), query(), insert(), update(), delete(), and 
680
  upload(). See the Metacat Tour for details.
681
* Added a new 'getlog' action that produces a usage history for all major
682
  events.  So now an XML report can be generated for document reads, inserts,
683
  deletes, etc.  See the new section in the Metacat Tour.
684
* Added a new 'buildindex' action that can rebuild the index entries for any
685
  document in the database.
686
* The configuration file for metacat (metacat.properties) has been moved out
687
  of the jar file and into the WEB-INF directory, allowing far easier changes
688
  to the configuration parameters.
689
* Results in default web interface are sorted by title in the XSLT 
690
  (configurable)
691
* Many bugs were fixed.
692

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

    
696
Release Notes for 1.3.1:
697
------------------------
698

    
699
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
700
include:
701
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
702
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
703
    and Java 1.4.
704
 2) Distribution package size was reduced.
705

    
706

    
707
Release Notes for 1.3.0
708
------------------------
709

    
710
In 1.3.0 release, the structure of the xml_access table was changed and a new
711
table, xml_accesssubtree was added. If you try to update a previously 
712
installed Metacat, you should run a script file to updated the table structure 
713
before installation.
714
For Oracle user: At the SQLPLUS prompt type the following -
715
@src/reviseformetacat13.sql
716
For Postgresql user: At install directory prompt type the following -
717
psql exp < src/reviseformetacat13_postgres.sql
718
(where 'exp' is the database name).
719

    
720
After installation, user should run "ant schemasql" command to register EML2
721
schema in xml_catalog table.
722

    
723
If you are a new Metacat user, this step is unneeded.
724

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

    
731
New Features in 1.3.0
732
  1) Partialy support EML2 document. User can store, query, read and write
733
     EML2 documents. However, Metacat only support access control in resource
734
     level. The subtree level access control will be ignored.
735
  2) Support other xml document base on namespace/schema.
736
  3) Support query for attribute value
737
  4) Assign MIME type to data file base on metadata when user try to read it.
738
  5) Owner can assign access rules to a document which does not have access 
739
     document to apply it.
740
  6) Support exporting single file, not only whole package
741
  7) Resupport Microsoft SQL Server.
742

    
743
Fixes in 1.3.0:
744
  1) Couldn't finish delta T replication for large set of documents.
745
  2) Couldn't create access control during delta T replication.
746
  3) Eorr will be written to a seperated log file if some documents
747
     were failed in replication.
748
  4) Decrease the time to create access rules during insert or update 
749
     a package.
750
     
751
Documentation
752
-------------
753
See the docs directory for detailed documentation and installation
754
instructions.
755

    
756
Details of the Metacat architecture can be found on the website for
757
the Knowledge Network for Biocomplexity (KNB):
758

    
759
  http://knb.ecoinformatics.org/software/metacat/
760

    
761
Contributions to this work are welcome.  Please see the above web site
762
for details on how to contribute.
763

    
764
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
765
-----------------------------------------------------------------------------
766
If you discover a bug please report it, either by email (above) or by using
767
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
768
list of currently unimplemented features in Bugzilla that we are working on
769
for the next release.
770

    
771
Legalese
772
--------
773
This software is copyrighted by The Regents of the University of California
774
and the National Center for Ecological Analysis and Synthesis
775
and licensed under the GNU GPL; see the 'LICENSE' file for
776
details.
777

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

    
784
This software is partially supported by a grant from the Andrew W. 
785
Mellon Foundation.
786

    
787
This product includes software developed by the Apache Software
788
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
789
for details.
790

    
791
The source code, object code, and documentation in the com.oreilly.servlet
792
package is copyright and owned by Jason Hunter. See the cos-license.html file
793
for details of the license.  Licensor retains title to and ownership of the
794
Software and all enhancements, modifications, and updates to the Software.
795

    
796
This software includes the JDBC driver for PostgreSQL.  See the 
797
postgresql-license.txt file for details.
(2-2/7)