Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 10412 $'
5
#     '$Date: 2017-09-08 10:58:15 -0700 (Fri, 08 Sep 2017) $'
6
#
7

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

    
11
Version: 2.9.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.8.5:
59
------------------------
60
New bugs fixed in this release:
61
* Some DataONE service packages not being reported
62
* Support for XSL transform of iso19115 metadata format
63

    
64

    
65
Release Notes for 2.8.4:
66
------------------------
67
New bugs fixed in this release:
68
* LDAP-based group authorization is failing
69
* Display the dc:source field from DCX metadata documents in the stylesheet
70
* MN.Delete should continue even though it can't find the local file
71

    
72

    
73
Release Notes for 2.8.3:
74
------------------------
75
New bugs fixed in this release:
76
* MNodeService.replicate() is failing
77
* MN.publish method fails because of the mismatched checksum
78
* MN.update method doesn't check the checksum
79
* Set file names correctly when reading objects from Metacat
80
* MN.publish method can't generate a new ore document when the metadata is published
81

    
82

    
83
Release Notes for 2.8.2:
84
------------------------
85
New bugs fixed in this release:
86
* The listObjects method fails if there is pid with a white space in the list
87
* EML SAX parser will not check if the user has the all permission on data objects (described by the eml object) when the parser is called by DataONE API
88
* The count number is -1 when the expandRightsHolder method lists the subjects
89
* CN V1/V2.archive implementation only allows CN and MN administrators to act
90
* Metacat-index RDF/XML subprocessor not populating prov_hasDerivations field
91

    
92

    
93
Release Notes for 2.8.1:
94
------------------------
95
New features and bugs fixed in this release:
96
* Register schema files for the format id FGDC-STD-100.1-1999
97
* ReIndexing a document lost some prov information in the new generated solr doc
98
* MNodeService.updateSystemMetadata() needs to validate obsolescence chain pids
99
* Metacat DataONE base url always gets 404 not found page
100
* Use the provenance Spring bean file from d1_cn_index_processor in Metacat
101
* Calling cn.synchronize method asynchronously in mn.updatesystemmeta on Metacat
102
* Uploading a resource map with provenance data causes an NPE during indexing
103
* replicationPolicy missing numberReplicas and replicationAllowed attributes
104
* Archive operation not permitted for V1 readonly MNs
105
* Solr index still keeps the obsoletedBy field even though it was removed from the system metadata and reindexed
106
* Private metadata is indexed as isPublic=true
107
* Action reindexall should be asynchronized
108

    
109

    
110
Release Notes for 2.8.0:
111
------------------------
112
New features and bugs fixed in this release:
113
* Modify Metacat code according to the change of dataone library migrating from JibX to JAXB
114
* Upgrade Solr to 3.6.2 to fix searching issues
115
* Metacat is not expanding groups in the rightsHolder field during authorization
116
* Improve error message for: User tried to update an access module when they dont have ‘ALL’ permission!"
117

    
118

    
119
Release Notes for 2.7.2:
120
------------------------
121
New features and bugs fixed in this release:
122
* Legacy Metacat "shortcut" url does not work if revision is omitted
123
* Migrate metacat build to use EML git repo
124
* All links on the registry page should open up in a new tab 
125
* Metadata/data objects which have obsoletedBy field ignore the resource map index
126
* Metacat creates an Invalid Content-Disposition value for some filenames
127
* External links in the registry should open in new tab
128
* Remove the support of Oracle on documentation
129
* Changing a Metacat member node's synchronization value on the d1 admin page doesn't work  
130
* Add the feature to support the noNamespaceSchemaLocation attribute in xml objects
131
* Provide clear messages to clients if the namespaces/formatids of the schemas of xml objects are not registered in Metacat
132
* Disable the feature of downloading external schemas for unregistered namespaces
133
* Metacat-index picks up the changes in log4j.properteis without restarting tomcat
134

    
135
Release Notes for 2.7.1:
136
------------------------
137
* Fixed several bugs on the data registry form
138
* Support the onedcx schema
139
  - Fixed several onedcx stylesheet issues
140

    
141
Relese Notes for 2.7.0:
142
------------------------
143
* Use different format ids to identity variants of the schema with same namespace
144
* Add EML 2.1.1 to Darwin Core supporting for OAI-PMH provider  
145
* Bugs fixed include:
146
  - Series head resolution should use obsoletes field as part of determination(7020)
147
  - The InputStream (parameter) in the CN/MN.create and MN.update method is not closed(7005)
148
  - Use the AutoCloseClientInputStream class in the d1_libclient_java in Metacat replication(7004)
149

    
150
Release Notes for 2.6.0:
151
------------------------
152
This release supports token-based authentication in the data registry
153
as well as:
154
* MetacatUI 1.11.0
155

    
156
Release Notes for 2.5.1:
157
------------------------
158
This a minor release that improves:
159
* Authentication token handling for the DataONE API
160

    
161
Release Notes for 2.5.0:
162
------------------------
163
This major release adds DataONE V2 API support
164
as well as:
165
* MetacatUI 1.8.1
166
* Data registry bug fixes
167

    
168
Release Notes for 2.4.3:
169
------------------------
170
This release includes:
171
* Support for large file uploads
172
* Recording User-Agent when logging requests
173

    
174
Release Notes for 2.4.2:
175
------------------------
176
This release includes:
177
* Updates to improve character encoding handling
178
* Updated SOLR index and UI to use geohashes for map rendering
179
* Note: this is the last release of Metacat that will support Java 6
180

    
181
Release Notes for 2.4.1:
182
------------------------
183
This is a patch release that addresses the following:
184
* Allows LDAP authentication using aliased referrals
185
* Re-indexes previous document revisions in SOLR when
186
new revisions are added on update
187
* Allows authentication in SANParks skin
188
* Enables OpenLayer.js mapping plug-in over https
189

    
190
Release Notes for 2.4.0:
191
------------------------
192
These release adds a new default file-based authentication mechanism
193
that allows administrators to more easily deploy Metacat without a
194
LDAP server.
195
Other enhancements include:
196
* Correct use of DataONE 'archive' flag
197
* Access policy synchronization with the DataONE Coordinating Node
198
* Indexing support for EML singleDateTime coverage values
199
* Indexing support document read/download events
200
* Improved package download structure and file naming conventions
201

    
202
Release Notes for 2.3.1:
203
------------------------
204
This is a minor patch release to fix an issue that arises when
205
Metacat is operating as a DataONE Coordinating Node.
206
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
207
* Updated MetacatUI with support for spatial query criteria
208
* Updated account/identity management script
209

    
210
Release Notes for 2.3.0:
211
------------------------
212
This release adds solr indexing features to metacat-index 
213
for querying and sorting by authors and taxonomic coverage.
214
Also includes:
215
* Control over the log level from the SOLR libraries using Metacat's
216
log4j file.
217
* access_log DB indexes for better log reporting performance 
218
via the DataONE API
219
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
220

    
221

    
222
Release Notes for 2.2.1:
223
------------------------
224
This is a critical patch release of Metacat that includes addresses
225
a bug in file stream handling. It is recommended for all Metacat deployments.
226

    
227
Release Notes for 2.2.0:
228
------------------------
229
This is a major release of Metacat that includes a new customizable UI and 
230
improved LDAP account management features
231

    
232
Release Notes for 2.1.1:
233
------------------------
234
This is a minor patch release of Metacat that addresses
235
a bug in DOI publishing.
236

    
237
Release Notes for 2.1.0:
238
------------------------
239
This is a major release of Metacat that includes a SOLR-based search feature
240
* Optional SOLR search index
241
* Client certificate delegation (using a service provider like CILogon)
242

    
243
Release Notes for 2.0.8:
244
------------------------
245
This is a patch release for Metacat
246
* Enforce DataONE prohibition on whitespace in identifiers
247
* Use unique filenames for Registry data uploads
248

    
249
Release Notes for 2.0.7:
250
------------------------
251
This is a patch release for Metacat replication
252
* Replication SQL performance enhancement
253
* Comply with DataONE schema for SystemMetadata.submitter
254

    
255
Release Notes for 2.0.6:
256
------------------------
257
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
258
* MN.generateIdentifier() support for UUID and DOI
259
* DOI registration support using EZID service
260
* Pathquery support for specifying multiple document owners
261

    
262

    
263
Release Notes for 2.0.5:
264
------------------------
265
This patch release focuses on Metacat support for Oracle
266
*SystemMetadata table names have been shortened to comply with Oracle limits.
267
*SANParks/SAEON spatial zip file download fixed
268
*Pathquery performance fix
269
*Hazelcast 2.x upgrade
270
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
271

    
272
Release Notes for 2.0.4:
273
------------------------
274
This patch release focuses on Metacat-Metacat replication.
275
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
276
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
277
*Fixes an access control issue that could allow search results to include protected documents
278

    
279
Release Notes for 2.0.3:
280
------------------------
281
This is another critical patch release of Metacat 2.0.
282
*Addresses a bug that prevented Metacat replication from completing (timeout error)
283
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
284

    
285
Release Notes for 2.0.2:
286
------------------------
287
This is a critical patch release of Metacat 2.0.
288
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
289
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
290
*Updates the Foresite ORE library to correctly serialize resource map documents
291

    
292
Release Notes for 2.0.1:
293
------------------------
294
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
295
*Addresses an identifier issue during ORE generation for DataONE services
296
*Increases compatibility with older EML content and the Xalan XSLT processor
297
*Removes XSLT 2.0 support (Saxon)
298

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

    
315

    
316
Release Notes for 1.9.5:
317
------------------------
318
This release fixes those bugs:
319
*Metacat could not download the included schemas in an external schema file during inserting.
320
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
321
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
322
*Document access rules are now preserved when documents are archived during the 'delete' action.
323

    
324
Release Notes for 1.9.4:
325
------------------------
326
This release fixes bugs in the FGDC data package upload and download interface utilized
327
by the SANParks and SAEON skins.
328

    
329
Release Notes for 1.9.3:
330
------------------------
331
This release fixes a harvester bug that prevented the EML harvester from processing
332
harvest lists.
333
The Kepler skin has been updated to support KarXML 2.1.
334
Ecogrid query services now support multiple namespace searches.
335

    
336
Release Notes for 1.9.2:
337
------------------------
338
This release primarily holds the addition of the Threshold of Potential
339
Concern workflow functionality (TPC).  The following issues were addressed:
340

    
341
* Create a properties file for use by JUnit Tests (Bug 2994)
342
* security issue with skins (Bug 3368)
343
* reorganize classes into a more functional specific structure (Bug 3510)
344
* Add admin names as dropdown in configuration login (Bug 3729)
345
* KNB metacat replication error log file is empty (Bug 3885)
346
* Create TPC Report web browse/search pages (Bug 4165)
347
* Create archive extraction functionality (Bug 4166)
348
* Create Workflow Scheduler (Bug 4167)
349
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
350
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
351
* Fix cross platform TPC GUI issues (Bug 4556)
352
* TPC Sanparks page content lenth issue (Bug 4557)
353
* Create validate and isAuthorized unit tests (Bug 4558)
354
* Cannot insert replication server via gui (Bug 4594)
355
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
356
* [ESA] Update fails when document rev number is missing (Bug 4627)
357
* fails to catch some insert and update failures (Bug 4637)
358
* must support java 1.6 (Bug 4641)
359
* Convert build to pull eml from svn instead of cvs (Bug 4644)
360
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
361
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
362
* metacat runs out of memory (Bug 4658)
363
* ESA skin links are hard coded to data.esa.org (Bug 4698)
364
* Update release 1.9.2 release notes (Bug 4707)
365
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
366
* Metacat should run against Tomcat 6 (Bug 4716)
367

    
368
Release Notes for 1.9.1:
369
------------------------
370
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
371
These bugs were primarily replication issues.  There is no difference 
372
in functionality between 1.9.0 and 1.9.1 
373

    
374
Release Notes for 1.9.0:
375
------------------------
376
This release focuses on simplifying the Metacat installation process by 
377
creating a binary (war) installation.  The need to build the application
378
on the server has been removed (although the option is still available).
379
In order to facilitate this method of installation, a few major modifications
380
were made to the code:
381

    
382
  -- Ant token replacement was removed for all non-build variables in the 
383
     application (most of this was already done in 1.8.1).
384

    
385
  -- The Metacat properties confguration was moved into the application
386
     itself.
387

    
388
  -- Database schema version detection and install/upgrade utilities were 
389
     added to the application.
390

    
391
Also, this release includes several enhancements:
392
  -- it supports the new EML 2.1.0 version.  
393

    
394
  -- Documents are now stored on the local filesystem as well as in the 
395
     database in order to preserve document integrity.
396
     
397
  -- Metacat verifies new schemas when they are added.
398

    
399
  -- Additional access is propegated with documents during replication.
400

    
401
High priority bugs were addressed in this release as well.
402

    
403
The enhancements/bugs addressed are:
404

    
405
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
406
* need to set filename for download files (Bug 2566)
407
* add ability for search engines to index metacat documents (Bug 2826)
408
* EML citation section should include both organizationNames and individualNames (Bug 3059)
409
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
410
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
411
* New documents explicitly set as public access don't show up correctly (Bug 3262)
412
* Modify confguration utility in metacat (Bug 3371)
413
* Integrate perl token replacement changes (Bug 3372)
414
* Create skin specific configuration utility (Bug 3373)
415
* Add authentication for configuration utility (Bug 3374)
416
* Create a sorted properties utility (Bug 3375)
417
* Add DB upgrade/install functionality to java code (Bug 3376)
418
* Create ANT install target for developers (Bug 3377)
419
* Create LSID server installation (Bug 3380)
420
* Create unit test code for 1.9 additions (Bug 3381)
421
* create simple turnkey installer for metacat Phase I (Bug 3461)
422
* Maps do not display in Firefox version 3 (Bug 3462)
423
* Replicate access rules in replication (Bug 3464)
424
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
425
* Add full schema checking when metacat register new schema (Bug 3474)
426
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
427
* getprincipals action returns invalid XML document (Bug 3527)
428
* Update knbweb to serve new metacat install (Bug 3545)
429
* Replication should write to disk (Bug 3554)
430
* Update acknowlegements in metacat readme (Bug 3588)
431
* Validate the ldap administrator field. (Bug 3616)
432
* Allow for different authentication services in metacat configuration (Bug 3680)
433
* Tag utilities module and have metacat check out that tag (Bug 3685)
434

    
435
Release Notes for 1.8.1:
436
------------------------
437
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
438
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
439
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
440
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
441
Details please see:
442
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
443
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
444

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

    
450
The fixed bugs include:
451

    
452
*Character set (charset) problem when filling out form (Bug2797)
453
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
454
*Metacat performance issue in Sanparks skin (Bug 3174)
455
*Metacat using illegitimate versions of EML schema (Bug 3239)
456
*Update older invalidated eml201 document in Metacat (Bug 3241)
457
*Verify existing token changes to skins (Bug 3176)
458
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
459
*Expose permission options for registry uploads (Bug 3014)
460
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
461
*Data Catalog Map is slow when selecting (Bug2732)
462
*Only one attribute per element returned with pathquery results(Bug 2999)
463
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
464
*Generalize the reading of skin.configs in DBTransform (Bug3058)
465
*The query example in metacatquery.html document need to be changed (Bug3137)
466
*Add upload method into Metacat tour (Bug 3139)
467
*Query resultset doesn't show component name in kepler skin (Bug 3178)
468
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
469
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
470
*An error message happen during the metacat start up (Bug 3279)
471
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
472
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
473
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
474

    
475
Release Notes for 1.8.0:
476
------------------------
477
This release focuses on improving query performance.  Both the selection 
478
and access control queries were rewritten to execute efficiently.
479
To improve search performance, a query caching mechanism was introduced. 
480
Cached queries are currently supported only for public users.
481

    
482
New Features:
483
* Data registries now support uploading of data objects along with data 
484
  packages (Bug 1982)
485
  
486
Bug Fixes:
487
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
488
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
489
* Query cache mechanism (Bug 2905)
490
* Metacat Performance: updates from Morpho of data packages are taking 
491
   longer than five minutes (Bug 2805)
492
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
493
* Metacat Performace: Upgrading hardware setup (Bug 2175)
494
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
495
* Display of metadata documents reorganized, including a new citation format,
496
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
497
* I.E. display fixes on default skin (Bug 2579)
498
* Web Address links fixed (Bug 2147)
499
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
500
* Spatial query:  data packages must be fully contained by the selection 
501
  bounding box in order to appear in the search results (Bugs 2972, 2732).
502
* FGDC support: upload, delete, update, access control, and download
503
  (Bugs 2807, 2925, 2926, 2929, 2030).
504
Compatibility Notices:
505
* Tomcat 3 and 4 are no longer tested or supported. Users are 
506
  highly encouraged to upgrade to Tomcat 5.5
507

    
508
Release Notes for 1.7.0:
509
------------------------
510
This release features only a few minor changes to the core Metacat engine. 
511
The major focus of this release is the addition of the spatial functionality.
512
The geographic coverage of metadata documents can now be cached in a GIS-
513
accessible format and published via web mapping services and an online
514
interactive map. 
515

    
516
New Features:
517
* Three new open source libraries have been integrated with Metacat:
518
  - Geoserver:  A standards-compliant web map server to publish
519
                geographic data to the web.
520
               (http://docs.codehaus.org/display/GEOS/Home)
521
  - GeoTools:   A java-based GIS toolkit to programatically
522
                manipulate spatial datasets.
523
                (http://geotools.codehaus.org/)
524
  - Mapbuilder: A javascript application to provide an interactive
525
                web map front-end to Geoserver.
526
                (http://docs.codehaus.org/display/MAP/Home)
527
* Spatial Caching/Indexing mechanism; documents with geographic
528
  coverages will be added to the spatial cache.
529
* Spatial Query action in metacat servlet. 
530
* Interactive Web map to visualize and query the spatial 
531
  distribution of metadata documents.
532
* Experimental python, ruby and php client libraries to interface with metacat.
533
* Preliminary process in place for web based configuration of metacat.
534

    
535
Compatibility Notices:
536
* Tomcat 3 and 4 are no longer tested or supported. Users are 
537
  highly encouraged to upgrade to Tomcat 5.5
538

    
539
Bug Fixes:
540
* Metacat administrators are able to modify and delete documents 
541
  created by other users.
542
* Fixed problems with indexing XML attributes, see bug 2469
543

    
544

    
545
Release Notes for 1.6.0:
546
------------------------
547

    
548
This release comes with more performance improvements, initial support for 
549
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
550
Metacat administrators and bug fixes. Below is the list of bug fixes and
551
performance improvements.
552

    
553
Bug Fixes: 
554
* Improved the indexing algorithm. Earlier indexing failed for some documents 
555
  randomly and used to take a lot of time to complete for others. The 
556
  code for indexing was changed to take care of both these problems.
557
* Earlier, xmlns prefix was used to determine the namespace of the document. 
558
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
559
  of the document as that is a better indicator of document type. 
560
* INSTR was used in some SQL statements and it is not supported by Postgres. 
561
  So SQL statements were modified so that INSTR is not used.
562
* Replication was changed to include replication of deleted documents also.
563
* Fixed bug in squery which didnt allow use of not-contains 
564

    
565
New Features:
566
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
567
* Added support for LSID. This includes modifying the stylesheets to 
568
  display the LSIDs, modifying the build to include a new target 
569
  'install-ldap'.
570
* Added following access control levels to Metacat:
571
    1. Administrators - users who can do the following:
572
       a. Run replication
573
       b. Delete any document
574
       c. Modify any document
575
       d. run indexing for any document
576
       e. check the logs
577
    2. allowedUsers - User who are allowed to submit
578
    3. deniedUsers - Users not allowed to submit
579
* Added a new skin for Ecological Society of America. 
580
* Created an Advanced search servlet which can be used from the web. 
581
* Various connections have been modified to be secure. e.g. connection between 
582
ldaps is made secure now, replication is done over secure channels.  
583

    
584
Performance:
585
* Reduced size of xml_nodes by creating a new table for holding nodes from 
586
  deleted documents and old revisions of the documents. 
587
* Provided a new variable in metacat.properties where more frequently searched 
588
  for paths can be specified. Seperate indexes are created for these paths 
589
  - so that search is faster.
590
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
591

    
592
Release Notes for 1.5.0:
593
------------------------
594

    
595
This release comes with performace improvement, user interface enhancements,
596
and bug fixes. Below is the list of bug fixes and performance improvements. 
597

    
598
Bug Fixes:
599
* Modify property values of harvester registration servlets to match the
600
  servlet-mapping URL values in web.xml. The old values used the servlet
601
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
602
  Windows. The new values use the servlet-mapping URL values. This should
603
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
604
* Re-implement logic to prune old log entries from the HARVEST_LOG and
605
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
606
  violations in the database because it tried to delete parent records from
607
  HARVEST_LOG prior to deleting child records from
608
  HARVEST_DETAIL_LOG. (Bug 162)
609
* In data registry, minor bugs fixed like the error page shows the link back
610
  to the form when error page was generated because of a document read
611
  request from search results page,  the successful delete button leading
612
  to a blank screen and the old ACL overwritten by the registry.
613
  (Bugs 1307, 1310, 1322, 1344, 1551)
614
* Changed the code to support insertion of following characters: ', `,
615
  charcters in the Numeric Character Reference format (&#xyz;) and
616
  characters like µ. Characters like µ will be converted to and stored in
617
  Numeric Character Reference format(&#xyz;). They will also be returned
618
  in Numeric Character Reference and it is upto the client to convert them
619
  and display them accordingly in the application. Partial fix provided by
620
  Johnoel Ancheta. (Bug 1538,1711)
621
* Spatial search failed on Oracle because of invalid entries made by
622
  some documents in the nodedata column of xml_nodes for paths involving
623
  'eastBoundingCoordinate', 'westBoundingCoordinate',
624
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
625
  nodedatanumerical was added to xml_nodes table such that all the numerical
626
  nodedata is stored in this column and this column is now used for spatial
627
  search. (Bug 1703, 1718)
628
* In the default skin, clicking on the keywords on the home page did not
629
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
630
* Metacat generated a success message even when a document which didnt
631
  exsist was requested for deletion. This has been fixed. (Bug 1850)
632
* "packagetype" in xml-relation table was entered as eml200 namespace when
633
  an eml201 document was inserted. This is fixed now so that "packagetype"
634
  in xml-relation table points to eml201 namespace. (Bug 1979)
635
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
636
  earlier. Fixed such that it points to the locally installed metacat url. 
637
  (Bug 1986)
638
* Changes to the Query subsystem fix bugs that prevented attributes from 
639
  being expressed solely in the xpath query statement and the returnfield 
640
  values. For instance, a query URL may now include search strings like 
641
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
642
  Previously, the attribute had to be appended to an element: 
643
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
644
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
645
* Search query failed in case of Oracle if number of documents in the result
646
  were more than 1000. This has been fixed. (Bug 2000)
647
* Removed any occurence of enum which is now a keyword in Java 1.5
648

    
649

    
650
Enhancements:
651
* Major improvements done in user interface for the data registeries and
652
  various other skins. Improvements done based on suggestions from Mark
653
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
654
  the default skin and ldap templates. (Bug 1948)
655
* Coded added such that administrator can delete documents irrespective of
656
  who the document belongs to.
657
* Performance impovement done in searching of datasets. A part of the search
658
  time was taken up because of generation of resultset after the search had be
659
  done. So this was the sequence of events in earlier metacat
660
  1) Search for the given text
661
  2) A list of docids generated
662
  3) For each of the docids
663
     3a) Use xml_index and xml_nodes table to generate the string descibing
664
         the document including the returnfields requested in the search
665
  4) Add all the strings from step 3a to send back the resultant
666
     document. Here a decent amount of time was being taken by step 3a. 
667
  The algorithm is now modified by addition of two tables xml_queryresult and
668
  xml_returnfields and a user defined parameter xml_returnfield_count. The
669
  new algorithm works as follows:
670
  1) Search for the given text
671
  2) A list of docids is generated
672
  3) For the given set of return fields generate a unique string and check
673
     if that string exists in xml_returnfields
674
     3a) If string does not exist in xml_returnfield, then enter a new
675
         record usage_count as 1 and returnfield_string as the unique string
676
         generated above.
677
     3b) Else if the string exists, increment usage_count
678
  4) Given the docids from step 2 and the id of the returnfield record from
679
     step 3, query for any docids that already exist in xml_queryresult.
680
     For the docids that do exist, get the queryresult_string.
681
  5) For rest of the docids from step2 which were not found in step 4, do
682
     the following for each of the documents:
683
     5a) Use xml_index and xml_nodes table to generate the string descibing
684
         the document including the returnfields requested in the search
685
     5b) If usage_count of the record from step is more than
686
         xml_returnfield_count set in metacat.properties, then store the
687
         string in xml_queryresult as a record which has the returnfield_id
688
         representing the set of returnfields, docid representing the
689
         document and the string as queryresult_string.
690
  6) Add all the strings from step 4 and step 5a to send back the resultant
691
     document
692
  So the results from step 3a in previous algorithm are effectively cached
693
  and hence same computation is not done again and again for each search.
694
  When a document is deleted, all the entries for that document in
695
  xml_queryresult table are also deleted. When a document is updated, all
696
  the entries for that document in xml_queryresult table are deleted. This
697
  works fine because those entries will be generated and cached again the
698
  next time the document is part of a search is requested.
699
* Performance impovement done for % search.
700
* Following new functions added to metacat client API: a method to set access
701
  on an xml document and a method to get newest version for a given document.
702
* Implement a new HarvesterServlet for running Harvester as a servlet. This
703
  eliminates the need to run Harvester in a terminal window. By default, the
704
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
705
  documentation will be modified to instruct Harvester administrators to
706
  uncomment the HarvesterServlet entry.
707
* Minor enhancement to support multiple email addresses for harvester
708
  administrator and site contact. Each address is separated by a comma or
709
  semicolon.
710
* Increase number of rows in Harvest List Editor from 300 to 1200.
711
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
712
  value when it is set to 0 or a negative number. This allows Harvester to
713
  run indefinitely without shutting down after reaching a maximum number of
714
  harvests. The previous default value of 30 would cause Harvester to
715
  terminate after 30 harvests.
716

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

    
720

    
721
Release Notes for 1.4.0:
722
------------------------
723

    
724
This is a major release, and is the first to introduce many new features to
725
Metacat.  Some of the major new features in this version of Metacat include:
726

    
727
* Added a new 'Harvester' that allows documents to be periodically pulled
728
  from distributed sources into metacat, useful for interfacing with other
729
  system types. See the Metacat Tour for details.
730
* Added new 'skins' capability to allow the GUI for the metacat web interface
731
  to be more easily customized to fit into site needs.  The skin is based on
732
  a flexible mix of XSLT, CSS, and Javascript.
733
* Added a web-based metadata entry form for submitting limited EML documents
734
  as part of a data registry.  The GUI for the registry is customizable and 
735
  is integrated with the 'skins' system for the main metacat interface.  The
736
  registry subsystem is written in Perl, and can simultaneously be used to 
737
  present multiple 'registry' interfaces.
738
* A new 'client API' has been developed and implemented in Java and in Perl 
739
  so that metacat functions can be accessed from any program in those
740
  languages.  The client API supports the major metacat servlet actions,
741
  including login(), logout(), query(), insert(), update(), delete(), and 
742
  upload(). See the Metacat Tour for details.
743
* Added a new 'getlog' action that produces a usage history for all major
744
  events.  So now an XML report can be generated for document reads, inserts,
745
  deletes, etc.  See the new section in the Metacat Tour.
746
* Added a new 'buildindex' action that can rebuild the index entries for any
747
  document in the database.
748
* The configuration file for metacat (metacat.properties) has been moved out
749
  of the jar file and into the WEB-INF directory, allowing far easier changes
750
  to the configuration parameters.
751
* Results in default web interface are sorted by title in the XSLT 
752
  (configurable)
753
* Many bugs were fixed.
754

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

    
758
Release Notes for 1.3.1:
759
------------------------
760

    
761
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
762
include:
763
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
764
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
765
    and Java 1.4.
766
 2) Distribution package size was reduced.
767

    
768

    
769
Release Notes for 1.3.0
770
------------------------
771

    
772
In 1.3.0 release, the structure of the xml_access table was changed and a new
773
table, xml_accesssubtree was added. If you try to update a previously 
774
installed Metacat, you should run a script file to updated the table structure 
775
before installation.
776
For Oracle user: At the SQLPLUS prompt type the following -
777
@src/reviseformetacat13.sql
778
For Postgresql user: At install directory prompt type the following -
779
psql exp < src/reviseformetacat13_postgres.sql
780
(where 'exp' is the database name).
781

    
782
After installation, user should run "ant schemasql" command to register EML2
783
schema in xml_catalog table.
784

    
785
If you are a new Metacat user, this step is unneeded.
786

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

    
793
New Features in 1.3.0
794
  1) Partialy support EML2 document. User can store, query, read and write
795
     EML2 documents. However, Metacat only support access control in resource
796
     level. The subtree level access control will be ignored.
797
  2) Support other xml document base on namespace/schema.
798
  3) Support query for attribute value
799
  4) Assign MIME type to data file base on metadata when user try to read it.
800
  5) Owner can assign access rules to a document which does not have access 
801
     document to apply it.
802
  6) Support exporting single file, not only whole package
803
  7) Resupport Microsoft SQL Server.
804

    
805
Fixes in 1.3.0:
806
  1) Couldn't finish delta T replication for large set of documents.
807
  2) Couldn't create access control during delta T replication.
808
  3) Eorr will be written to a seperated log file if some documents
809
     were failed in replication.
810
  4) Decrease the time to create access rules during insert or update 
811
     a package.
812
     
813
Documentation
814
-------------
815
See the docs directory for detailed documentation and installation
816
instructions.
817

    
818
Details of the Metacat architecture can be found on the website for
819
the Knowledge Network for Biocomplexity (KNB):
820

    
821
  http://knb.ecoinformatics.org/software/metacat/
822

    
823
Contributions to this work are welcome.  Please see the above web site
824
for details on how to contribute.
825

    
826
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
827
-----------------------------------------------------------------------------
828
If you discover a bug please report it, either by email (above) or by using
829
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
830
list of currently unimplemented features in Bugzilla that we are working on
831
for the next release.
832

    
833
Legalese
834
--------
835
This software is copyrighted by The Regents of the University of California
836
and the National Center for Ecological Analysis and Synthesis
837
and licensed under the GNU GPL; see the 'LICENSE' file for
838
details.
839

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

    
846
This software is partially supported by a grant from the Andrew W. 
847
Mellon Foundation.
848

    
849
This product includes software developed by the Apache Software
850
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
851
for details.
852

    
853
The source code, object code, and documentation in the com.oreilly.servlet
854
package is copyright and owned by Jason Hunter. See the cos-license.html file
855
for details of the license.  Licensor retains title to and ownership of the
856
Software and all enhancements, modifications, and updates to the Software.
857

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