Project

General

Profile

metacat / README @ 10171

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 10166 $'
5
#     '$Date: 2016-12-28 11:53:32 -0800 (Wed, 28 Dec 2016) $'
6
#
7

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

    
11
Version: 2.8.1 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
Release Notes for 2.8.1:
58
------------------------
59
New features and bugs fixed in this release:
60
* Register schema files for the format id FGDC-STD-100.1-1999
61
* ReIndexing a document lost some prov information in the new generated solr doc
62
* MNodeService.updateSystemMetadata() needs to validate obsolescence chain pids
63
* Metacat DataONE base url always gets 404 not found page
64
* Use the provenance Spring bean file from d1_cn_index_processor in Metacat
65
* Calling cn.synchronize method asynchronously in mn.updatesystemmeta on Metacat
66
* Uploading a resource map with provenance data causes an NPE during indexing
67
* replicationPolicy missing numberReplicas and replicationAllowed attributes
68
* Archive operation not permitted for V1 readonly MNs
69
* Solr index still keeps the obsoletedBy field even though it was removed from the system metadata and reindexed
70
* Private metadata is indexed as isPublic=true
71
* Action reindexall should be asynchronized
72

    
73

    
74
Release Notes for 2.8.0:
75
------------------------
76
New features and bugs fixed in this release:
77
* Modify Metacat code according to the change of dataone library migrating from JibX to JAXB
78
* Upgrade Solr to 3.6.2 to fix searching issues
79
* Metacat is not expanding groups in the rightsHolder field during authorization
80
* Improve error message for: User tried to update an access module when they dont have ‘ALL’ permission!"
81

    
82

    
83
Release Notes for 2.7.2:
84
------------------------
85
New features and bugs fixed in this release:
86
* Legacy Metacat "shortcut" url does not work if revision is omitted
87
* Migrate metacat build to use EML git repo
88
* All links on the registry page should open up in a new tab 
89
* Metadata/data objects which have obsoletedBy field ignore the resource map index
90
* Metacat creates an Invalid Content-Disposition value for some filenames
91
* External links in the registry should open in new tab
92
* Remove the support of Oracle on documentation
93
* Changing a Metacat member node's synchronization value on the d1 admin page doesn't work  
94
* Add the feature to support the noNamespaceSchemaLocation attribute in xml objects
95
* Provide clear messages to clients if the namespaces/formatids of the schemas of xml objects are not registered in Metacat
96
* Disable the feature of downloading external schemas for unregistered namespaces
97
* Metacat-index picks up the changes in log4j.properteis without restarting tomcat
98

    
99
Release Notes for 2.7.1:
100
------------------------
101
* Fixed several bugs on the data registry form
102
* Support the onedcx schema
103
  - Fixed several onedcx stylesheet issues
104

    
105
Relese Notes for 2.7.0:
106
------------------------
107
* Use different format ids to identity variants of the schema with same namespace
108
* Add EML 2.1.1 to Darwin Core supporting for OAI-PMH provider  
109
* Bugs fixed include:
110
  - Series head resolution should use obsoletes field as part of determination(7020)
111
  - The InputStream (parameter) in the CN/MN.create and MN.update method is not closed(7005)
112
  - Use the AutoCloseClientInputStream class in the d1_libclient_java in Metacat replication(7004)
113

    
114
Release Notes for 2.6.0:
115
------------------------
116
This release supports token-based authentication in the data registry
117
as well as:
118
* MetacatUI 1.11.0
119

    
120
Release Notes for 2.5.1:
121
------------------------
122
This a minor release that improves:
123
* Authentication token handling for the DataONE API
124

    
125
Release Notes for 2.5.0:
126
------------------------
127
This major release adds DataONE V2 API support
128
as well as:
129
* MetacatUI 1.8.1
130
* Data registry bug fixes
131

    
132
Release Notes for 2.4.3:
133
------------------------
134
This release includes:
135
* Support for large file uploads
136
* Recording User-Agent when logging requests
137

    
138
Release Notes for 2.4.2:
139
------------------------
140
This release includes:
141
* Updates to improve character encoding handling
142
* Updated SOLR index and UI to use geohashes for map rendering
143
* Note: this is the last release of Metacat that will support Java 6
144

    
145
Release Notes for 2.4.1:
146
------------------------
147
This is a patch release that addresses the following:
148
* Allows LDAP authentication using aliased referrals
149
* Re-indexes previous document revisions in SOLR when
150
new revisions are added on update
151
* Allows authentication in SANParks skin
152
* Enables OpenLayer.js mapping plug-in over https
153

    
154
Release Notes for 2.4.0:
155
------------------------
156
These release adds a new default file-based authentication mechanism
157
that allows administrators to more easily deploy Metacat without a
158
LDAP server.
159
Other enhancements include:
160
* Correct use of DataONE 'archive' flag
161
* Access policy synchronization with the DataONE Coordinating Node
162
* Indexing support for EML singleDateTime coverage values
163
* Indexing support document read/download events
164
* Improved package download structure and file naming conventions
165

    
166
Release Notes for 2.3.1:
167
------------------------
168
This is a minor patch release to fix an issue that arises when
169
Metacat is operating as a DataONE Coordinating Node.
170
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
171
* Updated MetacatUI with support for spatial query criteria
172
* Updated account/identity management script
173

    
174
Release Notes for 2.3.0:
175
------------------------
176
This release adds solr indexing features to metacat-index 
177
for querying and sorting by authors and taxonomic coverage.
178
Also includes:
179
* Control over the log level from the SOLR libraries using Metacat's
180
log4j file.
181
* access_log DB indexes for better log reporting performance 
182
via the DataONE API
183
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
184

    
185

    
186
Release Notes for 2.2.1:
187
------------------------
188
This is a critical patch release of Metacat that includes addresses
189
a bug in file stream handling. It is recommended for all Metacat deployments.
190

    
191
Release Notes for 2.2.0:
192
------------------------
193
This is a major release of Metacat that includes a new customizable UI and 
194
improved LDAP account management features
195

    
196
Release Notes for 2.1.1:
197
------------------------
198
This is a minor patch release of Metacat that addresses
199
a bug in DOI publishing.
200

    
201
Release Notes for 2.1.0:
202
------------------------
203
This is a major release of Metacat that includes a SOLR-based search feature
204
* Optional SOLR search index
205
* Client certificate delegation (using a service provider like CILogon)
206

    
207
Release Notes for 2.0.8:
208
------------------------
209
This is a patch release for Metacat
210
* Enforce DataONE prohibition on whitespace in identifiers
211
* Use unique filenames for Registry data uploads
212

    
213
Release Notes for 2.0.7:
214
------------------------
215
This is a patch release for Metacat replication
216
* Replication SQL performance enhancement
217
* Comply with DataONE schema for SystemMetadata.submitter
218

    
219
Release Notes for 2.0.6:
220
------------------------
221
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
222
* MN.generateIdentifier() support for UUID and DOI
223
* DOI registration support using EZID service
224
* Pathquery support for specifying multiple document owners
225

    
226

    
227
Release Notes for 2.0.5:
228
------------------------
229
This patch release focuses on Metacat support for Oracle
230
*SystemMetadata table names have been shortened to comply with Oracle limits.
231
*SANParks/SAEON spatial zip file download fixed
232
*Pathquery performance fix
233
*Hazelcast 2.x upgrade
234
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
235

    
236
Release Notes for 2.0.4:
237
------------------------
238
This patch release focuses on Metacat-Metacat replication.
239
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
240
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
241
*Fixes an access control issue that could allow search results to include protected documents
242

    
243
Release Notes for 2.0.3:
244
------------------------
245
This is another critical patch release of Metacat 2.0.
246
*Addresses a bug that prevented Metacat replication from completing (timeout error)
247
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
248

    
249
Release Notes for 2.0.2:
250
------------------------
251
This is a critical patch release of Metacat 2.0.
252
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
253
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
254
*Updates the Foresite ORE library to correctly serialize resource map documents
255

    
256
Release Notes for 2.0.1:
257
------------------------
258
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
259
*Addresses an identifier issue during ORE generation for DataONE services
260
*Increases compatibility with older EML content and the Xalan XSLT processor
261
*Removes XSLT 2.0 support (Saxon)
262

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

    
279

    
280
Release Notes for 1.9.5:
281
------------------------
282
This release fixes those bugs:
283
*Metacat could not download the included schemas in an external schema file during inserting.
284
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
285
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
286
*Document access rules are now preserved when documents are archived during the 'delete' action.
287

    
288
Release Notes for 1.9.4:
289
------------------------
290
This release fixes bugs in the FGDC data package upload and download interface utilized
291
by the SANParks and SAEON skins.
292

    
293
Release Notes for 1.9.3:
294
------------------------
295
This release fixes a harvester bug that prevented the EML harvester from processing
296
harvest lists.
297
The Kepler skin has been updated to support KarXML 2.1.
298
Ecogrid query services now support multiple namespace searches.
299

    
300
Release Notes for 1.9.2:
301
------------------------
302
This release primarily holds the addition of the Threshold of Potential
303
Concern workflow functionality (TPC).  The following issues were addressed:
304

    
305
* Create a properties file for use by JUnit Tests (Bug 2994)
306
* security issue with skins (Bug 3368)
307
* reorganize classes into a more functional specific structure (Bug 3510)
308
* Add admin names as dropdown in configuration login (Bug 3729)
309
* KNB metacat replication error log file is empty (Bug 3885)
310
* Create TPC Report web browse/search pages (Bug 4165)
311
* Create archive extraction functionality (Bug 4166)
312
* Create Workflow Scheduler (Bug 4167)
313
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
314
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
315
* Fix cross platform TPC GUI issues (Bug 4556)
316
* TPC Sanparks page content lenth issue (Bug 4557)
317
* Create validate and isAuthorized unit tests (Bug 4558)
318
* Cannot insert replication server via gui (Bug 4594)
319
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
320
* [ESA] Update fails when document rev number is missing (Bug 4627)
321
* fails to catch some insert and update failures (Bug 4637)
322
* must support java 1.6 (Bug 4641)
323
* Convert build to pull eml from svn instead of cvs (Bug 4644)
324
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
325
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
326
* metacat runs out of memory (Bug 4658)
327
* ESA skin links are hard coded to data.esa.org (Bug 4698)
328
* Update release 1.9.2 release notes (Bug 4707)
329
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
330
* Metacat should run against Tomcat 6 (Bug 4716)
331

    
332
Release Notes for 1.9.1:
333
------------------------
334
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
335
These bugs were primarily replication issues.  There is no difference 
336
in functionality between 1.9.0 and 1.9.1 
337

    
338
Release Notes for 1.9.0:
339
------------------------
340
This release focuses on simplifying the Metacat installation process by 
341
creating a binary (war) installation.  The need to build the application
342
on the server has been removed (although the option is still available).
343
In order to facilitate this method of installation, a few major modifications
344
were made to the code:
345

    
346
  -- Ant token replacement was removed for all non-build variables in the 
347
     application (most of this was already done in 1.8.1).
348

    
349
  -- The Metacat properties confguration was moved into the application
350
     itself.
351

    
352
  -- Database schema version detection and install/upgrade utilities were 
353
     added to the application.
354

    
355
Also, this release includes several enhancements:
356
  -- it supports the new EML 2.1.0 version.  
357

    
358
  -- Documents are now stored on the local filesystem as well as in the 
359
     database in order to preserve document integrity.
360
     
361
  -- Metacat verifies new schemas when they are added.
362

    
363
  -- Additional access is propegated with documents during replication.
364

    
365
High priority bugs were addressed in this release as well.
366

    
367
The enhancements/bugs addressed are:
368

    
369
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
370
* need to set filename for download files (Bug 2566)
371
* add ability for search engines to index metacat documents (Bug 2826)
372
* EML citation section should include both organizationNames and individualNames (Bug 3059)
373
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
374
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
375
* New documents explicitly set as public access don't show up correctly (Bug 3262)
376
* Modify confguration utility in metacat (Bug 3371)
377
* Integrate perl token replacement changes (Bug 3372)
378
* Create skin specific configuration utility (Bug 3373)
379
* Add authentication for configuration utility (Bug 3374)
380
* Create a sorted properties utility (Bug 3375)
381
* Add DB upgrade/install functionality to java code (Bug 3376)
382
* Create ANT install target for developers (Bug 3377)
383
* Create LSID server installation (Bug 3380)
384
* Create unit test code for 1.9 additions (Bug 3381)
385
* create simple turnkey installer for metacat Phase I (Bug 3461)
386
* Maps do not display in Firefox version 3 (Bug 3462)
387
* Replicate access rules in replication (Bug 3464)
388
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
389
* Add full schema checking when metacat register new schema (Bug 3474)
390
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
391
* getprincipals action returns invalid XML document (Bug 3527)
392
* Update knbweb to serve new metacat install (Bug 3545)
393
* Replication should write to disk (Bug 3554)
394
* Update acknowlegements in metacat readme (Bug 3588)
395
* Validate the ldap administrator field. (Bug 3616)
396
* Allow for different authentication services in metacat configuration (Bug 3680)
397
* Tag utilities module and have metacat check out that tag (Bug 3685)
398

    
399
Release Notes for 1.8.1:
400
------------------------
401
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
402
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
403
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
404
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
405
Details please see:
406
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
407
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
408

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

    
414
The fixed bugs include:
415

    
416
*Character set (charset) problem when filling out form (Bug2797)
417
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
418
*Metacat performance issue in Sanparks skin (Bug 3174)
419
*Metacat using illegitimate versions of EML schema (Bug 3239)
420
*Update older invalidated eml201 document in Metacat (Bug 3241)
421
*Verify existing token changes to skins (Bug 3176)
422
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
423
*Expose permission options for registry uploads (Bug 3014)
424
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
425
*Data Catalog Map is slow when selecting (Bug2732)
426
*Only one attribute per element returned with pathquery results(Bug 2999)
427
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
428
*Generalize the reading of skin.configs in DBTransform (Bug3058)
429
*The query example in metacatquery.html document need to be changed (Bug3137)
430
*Add upload method into Metacat tour (Bug 3139)
431
*Query resultset doesn't show component name in kepler skin (Bug 3178)
432
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
433
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
434
*An error message happen during the metacat start up (Bug 3279)
435
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
436
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
437
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
438

    
439
Release Notes for 1.8.0:
440
------------------------
441
This release focuses on improving query performance.  Both the selection 
442
and access control queries were rewritten to execute efficiently.
443
To improve search performance, a query caching mechanism was introduced. 
444
Cached queries are currently supported only for public users.
445

    
446
New Features:
447
* Data registries now support uploading of data objects along with data 
448
  packages (Bug 1982)
449
  
450
Bug Fixes:
451
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
452
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
453
* Query cache mechanism (Bug 2905)
454
* Metacat Performance: updates from Morpho of data packages are taking 
455
   longer than five minutes (Bug 2805)
456
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
457
* Metacat Performace: Upgrading hardware setup (Bug 2175)
458
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
459
* Display of metadata documents reorganized, including a new citation format,
460
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
461
* I.E. display fixes on default skin (Bug 2579)
462
* Web Address links fixed (Bug 2147)
463
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
464
* Spatial query:  data packages must be fully contained by the selection 
465
  bounding box in order to appear in the search results (Bugs 2972, 2732).
466
* FGDC support: upload, delete, update, access control, and download
467
  (Bugs 2807, 2925, 2926, 2929, 2030).
468
Compatibility Notices:
469
* Tomcat 3 and 4 are no longer tested or supported. Users are 
470
  highly encouraged to upgrade to Tomcat 5.5
471

    
472
Release Notes for 1.7.0:
473
------------------------
474
This release features only a few minor changes to the core Metacat engine. 
475
The major focus of this release is the addition of the spatial functionality.
476
The geographic coverage of metadata documents can now be cached in a GIS-
477
accessible format and published via web mapping services and an online
478
interactive map. 
479

    
480
New Features:
481
* Three new open source libraries have been integrated with Metacat:
482
  - Geoserver:  A standards-compliant web map server to publish
483
                geographic data to the web.
484
               (http://docs.codehaus.org/display/GEOS/Home)
485
  - GeoTools:   A java-based GIS toolkit to programatically
486
                manipulate spatial datasets.
487
                (http://geotools.codehaus.org/)
488
  - Mapbuilder: A javascript application to provide an interactive
489
                web map front-end to Geoserver.
490
                (http://docs.codehaus.org/display/MAP/Home)
491
* Spatial Caching/Indexing mechanism; documents with geographic
492
  coverages will be added to the spatial cache.
493
* Spatial Query action in metacat servlet. 
494
* Interactive Web map to visualize and query the spatial 
495
  distribution of metadata documents.
496
* Experimental python, ruby and php client libraries to interface with metacat.
497
* Preliminary process in place for web based configuration of metacat.
498

    
499
Compatibility Notices:
500
* Tomcat 3 and 4 are no longer tested or supported. Users are 
501
  highly encouraged to upgrade to Tomcat 5.5
502

    
503
Bug Fixes:
504
* Metacat administrators are able to modify and delete documents 
505
  created by other users.
506
* Fixed problems with indexing XML attributes, see bug 2469
507

    
508

    
509
Release Notes for 1.6.0:
510
------------------------
511

    
512
This release comes with more performance improvements, initial support for 
513
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
514
Metacat administrators and bug fixes. Below is the list of bug fixes and
515
performance improvements.
516

    
517
Bug Fixes: 
518
* Improved the indexing algorithm. Earlier indexing failed for some documents 
519
  randomly and used to take a lot of time to complete for others. The 
520
  code for indexing was changed to take care of both these problems.
521
* Earlier, xmlns prefix was used to determine the namespace of the document. 
522
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
523
  of the document as that is a better indicator of document type. 
524
* INSTR was used in some SQL statements and it is not supported by Postgres. 
525
  So SQL statements were modified so that INSTR is not used.
526
* Replication was changed to include replication of deleted documents also.
527
* Fixed bug in squery which didnt allow use of not-contains 
528

    
529
New Features:
530
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
531
* Added support for LSID. This includes modifying the stylesheets to 
532
  display the LSIDs, modifying the build to include a new target 
533
  'install-ldap'.
534
* Added following access control levels to Metacat:
535
    1. Administrators - users who can do the following:
536
       a. Run replication
537
       b. Delete any document
538
       c. Modify any document
539
       d. run indexing for any document
540
       e. check the logs
541
    2. allowedUsers - User who are allowed to submit
542
    3. deniedUsers - Users not allowed to submit
543
* Added a new skin for Ecological Society of America. 
544
* Created an Advanced search servlet which can be used from the web. 
545
* Various connections have been modified to be secure. e.g. connection between 
546
ldaps is made secure now, replication is done over secure channels.  
547

    
548
Performance:
549
* Reduced size of xml_nodes by creating a new table for holding nodes from 
550
  deleted documents and old revisions of the documents. 
551
* Provided a new variable in metacat.properties where more frequently searched 
552
  for paths can be specified. Seperate indexes are created for these paths 
553
  - so that search is faster.
554
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
555

    
556
Release Notes for 1.5.0:
557
------------------------
558

    
559
This release comes with performace improvement, user interface enhancements,
560
and bug fixes. Below is the list of bug fixes and performance improvements. 
561

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

    
613

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

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

    
684

    
685
Release Notes for 1.4.0:
686
------------------------
687

    
688
This is a major release, and is the first to introduce many new features to
689
Metacat.  Some of the major new features in this version of Metacat include:
690

    
691
* Added a new 'Harvester' that allows documents to be periodically pulled
692
  from distributed sources into metacat, useful for interfacing with other
693
  system types. See the Metacat Tour for details.
694
* Added new 'skins' capability to allow the GUI for the metacat web interface
695
  to be more easily customized to fit into site needs.  The skin is based on
696
  a flexible mix of XSLT, CSS, and Javascript.
697
* Added a web-based metadata entry form for submitting limited EML documents
698
  as part of a data registry.  The GUI for the registry is customizable and 
699
  is integrated with the 'skins' system for the main metacat interface.  The
700
  registry subsystem is written in Perl, and can simultaneously be used to 
701
  present multiple 'registry' interfaces.
702
* A new 'client API' has been developed and implemented in Java and in Perl 
703
  so that metacat functions can be accessed from any program in those
704
  languages.  The client API supports the major metacat servlet actions,
705
  including login(), logout(), query(), insert(), update(), delete(), and 
706
  upload(). See the Metacat Tour for details.
707
* Added a new 'getlog' action that produces a usage history for all major
708
  events.  So now an XML report can be generated for document reads, inserts,
709
  deletes, etc.  See the new section in the Metacat Tour.
710
* Added a new 'buildindex' action that can rebuild the index entries for any
711
  document in the database.
712
* The configuration file for metacat (metacat.properties) has been moved out
713
  of the jar file and into the WEB-INF directory, allowing far easier changes
714
  to the configuration parameters.
715
* Results in default web interface are sorted by title in the XSLT 
716
  (configurable)
717
* Many bugs were fixed.
718

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

    
722
Release Notes for 1.3.1:
723
------------------------
724

    
725
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
726
include:
727
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
728
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
729
    and Java 1.4.
730
 2) Distribution package size was reduced.
731

    
732

    
733
Release Notes for 1.3.0
734
------------------------
735

    
736
In 1.3.0 release, the structure of the xml_access table was changed and a new
737
table, xml_accesssubtree was added. If you try to update a previously 
738
installed Metacat, you should run a script file to updated the table structure 
739
before installation.
740
For Oracle user: At the SQLPLUS prompt type the following -
741
@src/reviseformetacat13.sql
742
For Postgresql user: At install directory prompt type the following -
743
psql exp < src/reviseformetacat13_postgres.sql
744
(where 'exp' is the database name).
745

    
746
After installation, user should run "ant schemasql" command to register EML2
747
schema in xml_catalog table.
748

    
749
If you are a new Metacat user, this step is unneeded.
750

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

    
757
New Features in 1.3.0
758
  1) Partialy support EML2 document. User can store, query, read and write
759
     EML2 documents. However, Metacat only support access control in resource
760
     level. The subtree level access control will be ignored.
761
  2) Support other xml document base on namespace/schema.
762
  3) Support query for attribute value
763
  4) Assign MIME type to data file base on metadata when user try to read it.
764
  5) Owner can assign access rules to a document which does not have access 
765
     document to apply it.
766
  6) Support exporting single file, not only whole package
767
  7) Resupport Microsoft SQL Server.
768

    
769
Fixes in 1.3.0:
770
  1) Couldn't finish delta T replication for large set of documents.
771
  2) Couldn't create access control during delta T replication.
772
  3) Eorr will be written to a seperated log file if some documents
773
     were failed in replication.
774
  4) Decrease the time to create access rules during insert or update 
775
     a package.
776
     
777
Documentation
778
-------------
779
See the docs directory for detailed documentation and installation
780
instructions.
781

    
782
Details of the Metacat architecture can be found on the website for
783
the Knowledge Network for Biocomplexity (KNB):
784

    
785
  http://knb.ecoinformatics.org/software/metacat/
786

    
787
Contributions to this work are welcome.  Please see the above web site
788
for details on how to contribute.
789

    
790
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
791
-----------------------------------------------------------------------------
792
If you discover a bug please report it, either by email (above) or by using
793
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
794
list of currently unimplemented features in Bugzilla that we are working on
795
for the next release.
796

    
797
Legalese
798
--------
799
This software is copyrighted by The Regents of the University of California
800
and the National Center for Ecological Analysis and Synthesis
801
and licensed under the GNU GPL; see the 'LICENSE' file for
802
details.
803

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

    
810
This software is partially supported by a grant from the Andrew W. 
811
Mellon Foundation.
812

    
813
This product includes software developed by the Apache Software
814
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
815
for details.
816

    
817
The source code, object code, and documentation in the com.oreilly.servlet
818
package is copyright and owned by Jason Hunter. See the cos-license.html file
819
for details of the license.  Licensor retains title to and ownership of the
820
Software and all enhancements, modifications, and updates to the Software.
821

    
822
This software includes the JDBC driver for PostgreSQL.  See the 
823
postgresql-license.txt file for details.