Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 10328 $'
5
#     '$Date: 2017-05-24 16:59:49 -0700 (Wed, 24 May 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.3:
59
------------------------
60
New bugs fixed in this release:
61
* MNodeService.replicate() is failing
62
* MN.publish method fails because of the mismatched checksum
63
* MN.update method doesn't check the checksum
64
* Set file names correctly when reading objects from Metacat
65
* MN.publish method can't generate a new ore document when the metadata is published
66

    
67

    
68
Release Notes for 2.8.2:
69
------------------------
70
New bugs fixed in this release:
71
* The listObjects method fails if there is pid with a white space in the list
72
* 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
73
* The count number is -1 when the expandRightsHolder method lists the subjects
74
* CN V1/V2.archive implementation only allows CN and MN administrators to act
75
* Metacat-index RDF/XML subprocessor not populating prov_hasDerivations field
76

    
77

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

    
94

    
95
Release Notes for 2.8.0:
96
------------------------
97
New features and bugs fixed in this release:
98
* Modify Metacat code according to the change of dataone library migrating from JibX to JAXB
99
* Upgrade Solr to 3.6.2 to fix searching issues
100
* Metacat is not expanding groups in the rightsHolder field during authorization
101
* Improve error message for: User tried to update an access module when they dont have ALL permission!"
102

    
103

    
104
Release Notes for 2.7.2:
105
------------------------
106
New features and bugs fixed in this release:
107
* Legacy Metacat "shortcut" url does not work if revision is omitted
108
* Migrate metacat build to use EML git repo
109
* All links on the registry page should open up in a new tab 
110
* Metadata/data objects which have obsoletedBy field ignore the resource map index
111
* Metacat creates an Invalid Content-Disposition value for some filenames
112
* External links in the registry should open in new tab
113
* Remove the support of Oracle on documentation
114
* Changing a Metacat member node's synchronization value on the d1 admin page doesn't work  
115
* Add the feature to support the noNamespaceSchemaLocation attribute in xml objects
116
* Provide clear messages to clients if the namespaces/formatids of the schemas of xml objects are not registered in Metacat
117
* Disable the feature of downloading external schemas for unregistered namespaces
118
* Metacat-index picks up the changes in log4j.properteis without restarting tomcat
119

    
120
Release Notes for 2.7.1:
121
------------------------
122
* Fixed several bugs on the data registry form
123
* Support the onedcx schema
124
  - Fixed several onedcx stylesheet issues
125

    
126
Relese Notes for 2.7.0:
127
------------------------
128
* Use different format ids to identity variants of the schema with same namespace
129
* Add EML 2.1.1 to Darwin Core supporting for OAI-PMH provider  
130
* Bugs fixed include:
131
  - Series head resolution should use obsoletes field as part of determination(7020)
132
  - The InputStream (parameter) in the CN/MN.create and MN.update method is not closed(7005)
133
  - Use the AutoCloseClientInputStream class in the d1_libclient_java in Metacat replication(7004)
134

    
135
Release Notes for 2.6.0:
136
------------------------
137
This release supports token-based authentication in the data registry
138
as well as:
139
* MetacatUI 1.11.0
140

    
141
Release Notes for 2.5.1:
142
------------------------
143
This a minor release that improves:
144
* Authentication token handling for the DataONE API
145

    
146
Release Notes for 2.5.0:
147
------------------------
148
This major release adds DataONE V2 API support
149
as well as:
150
* MetacatUI 1.8.1
151
* Data registry bug fixes
152

    
153
Release Notes for 2.4.3:
154
------------------------
155
This release includes:
156
* Support for large file uploads
157
* Recording User-Agent when logging requests
158

    
159
Release Notes for 2.4.2:
160
------------------------
161
This release includes:
162
* Updates to improve character encoding handling
163
* Updated SOLR index and UI to use geohashes for map rendering
164
* Note: this is the last release of Metacat that will support Java 6
165

    
166
Release Notes for 2.4.1:
167
------------------------
168
This is a patch release that addresses the following:
169
* Allows LDAP authentication using aliased referrals
170
* Re-indexes previous document revisions in SOLR when
171
new revisions are added on update
172
* Allows authentication in SANParks skin
173
* Enables OpenLayer.js mapping plug-in over https
174

    
175
Release Notes for 2.4.0:
176
------------------------
177
These release adds a new default file-based authentication mechanism
178
that allows administrators to more easily deploy Metacat without a
179
LDAP server.
180
Other enhancements include:
181
* Correct use of DataONE 'archive' flag
182
* Access policy synchronization with the DataONE Coordinating Node
183
* Indexing support for EML singleDateTime coverage values
184
* Indexing support document read/download events
185
* Improved package download structure and file naming conventions
186

    
187
Release Notes for 2.3.1:
188
------------------------
189
This is a minor patch release to fix an issue that arises when
190
Metacat is operating as a DataONE Coordinating Node.
191
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
192
* Updated MetacatUI with support for spatial query criteria
193
* Updated account/identity management script
194

    
195
Release Notes for 2.3.0:
196
------------------------
197
This release adds solr indexing features to metacat-index 
198
for querying and sorting by authors and taxonomic coverage.
199
Also includes:
200
* Control over the log level from the SOLR libraries using Metacat's
201
log4j file.
202
* access_log DB indexes for better log reporting performance 
203
via the DataONE API
204
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
205

    
206

    
207
Release Notes for 2.2.1:
208
------------------------
209
This is a critical patch release of Metacat that includes addresses
210
a bug in file stream handling. It is recommended for all Metacat deployments.
211

    
212
Release Notes for 2.2.0:
213
------------------------
214
This is a major release of Metacat that includes a new customizable UI and 
215
improved LDAP account management features
216

    
217
Release Notes for 2.1.1:
218
------------------------
219
This is a minor patch release of Metacat that addresses
220
a bug in DOI publishing.
221

    
222
Release Notes for 2.1.0:
223
------------------------
224
This is a major release of Metacat that includes a SOLR-based search feature
225
* Optional SOLR search index
226
* Client certificate delegation (using a service provider like CILogon)
227

    
228
Release Notes for 2.0.8:
229
------------------------
230
This is a patch release for Metacat
231
* Enforce DataONE prohibition on whitespace in identifiers
232
* Use unique filenames for Registry data uploads
233

    
234
Release Notes for 2.0.7:
235
------------------------
236
This is a patch release for Metacat replication
237
* Replication SQL performance enhancement
238
* Comply with DataONE schema for SystemMetadata.submitter
239

    
240
Release Notes for 2.0.6:
241
------------------------
242
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
243
* MN.generateIdentifier() support for UUID and DOI
244
* DOI registration support using EZID service
245
* Pathquery support for specifying multiple document owners
246

    
247

    
248
Release Notes for 2.0.5:
249
------------------------
250
This patch release focuses on Metacat support for Oracle
251
*SystemMetadata table names have been shortened to comply with Oracle limits.
252
*SANParks/SAEON spatial zip file download fixed
253
*Pathquery performance fix
254
*Hazelcast 2.x upgrade
255
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
256

    
257
Release Notes for 2.0.4:
258
------------------------
259
This patch release focuses on Metacat-Metacat replication.
260
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
261
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
262
*Fixes an access control issue that could allow search results to include protected documents
263

    
264
Release Notes for 2.0.3:
265
------------------------
266
This is another critical patch release of Metacat 2.0.
267
*Addresses a bug that prevented Metacat replication from completing (timeout error)
268
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
269

    
270
Release Notes for 2.0.2:
271
------------------------
272
This is a critical patch release of Metacat 2.0.
273
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
274
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
275
*Updates the Foresite ORE library to correctly serialize resource map documents
276

    
277
Release Notes for 2.0.1:
278
------------------------
279
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
280
*Addresses an identifier issue during ORE generation for DataONE services
281
*Increases compatibility with older EML content and the Xalan XSLT processor
282
*Removes XSLT 2.0 support (Saxon)
283

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

    
300

    
301
Release Notes for 1.9.5:
302
------------------------
303
This release fixes those bugs:
304
*Metacat could not download the included schemas in an external schema file during inserting.
305
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
306
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
307
*Document access rules are now preserved when documents are archived during the 'delete' action.
308

    
309
Release Notes for 1.9.4:
310
------------------------
311
This release fixes bugs in the FGDC data package upload and download interface utilized
312
by the SANParks and SAEON skins.
313

    
314
Release Notes for 1.9.3:
315
------------------------
316
This release fixes a harvester bug that prevented the EML harvester from processing
317
harvest lists.
318
The Kepler skin has been updated to support KarXML 2.1.
319
Ecogrid query services now support multiple namespace searches.
320

    
321
Release Notes for 1.9.2:
322
------------------------
323
This release primarily holds the addition of the Threshold of Potential
324
Concern workflow functionality (TPC).  The following issues were addressed:
325

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

    
353
Release Notes for 1.9.1:
354
------------------------
355
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
356
These bugs were primarily replication issues.  There is no difference 
357
in functionality between 1.9.0 and 1.9.1 
358

    
359
Release Notes for 1.9.0:
360
------------------------
361
This release focuses on simplifying the Metacat installation process by 
362
creating a binary (war) installation.  The need to build the application
363
on the server has been removed (although the option is still available).
364
In order to facilitate this method of installation, a few major modifications
365
were made to the code:
366

    
367
  -- Ant token replacement was removed for all non-build variables in the 
368
     application (most of this was already done in 1.8.1).
369

    
370
  -- The Metacat properties confguration was moved into the application
371
     itself.
372

    
373
  -- Database schema version detection and install/upgrade utilities were 
374
     added to the application.
375

    
376
Also, this release includes several enhancements:
377
  -- it supports the new EML 2.1.0 version.  
378

    
379
  -- Documents are now stored on the local filesystem as well as in the 
380
     database in order to preserve document integrity.
381
     
382
  -- Metacat verifies new schemas when they are added.
383

    
384
  -- Additional access is propegated with documents during replication.
385

    
386
High priority bugs were addressed in this release as well.
387

    
388
The enhancements/bugs addressed are:
389

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

    
420
Release Notes for 1.8.1:
421
------------------------
422
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
423
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
424
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
425
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
426
Details please see:
427
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
428
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
429

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

    
435
The fixed bugs include:
436

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

    
460
Release Notes for 1.8.0:
461
------------------------
462
This release focuses on improving query performance.  Both the selection 
463
and access control queries were rewritten to execute efficiently.
464
To improve search performance, a query caching mechanism was introduced. 
465
Cached queries are currently supported only for public users.
466

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

    
493
Release Notes for 1.7.0:
494
------------------------
495
This release features only a few minor changes to the core Metacat engine. 
496
The major focus of this release is the addition of the spatial functionality.
497
The geographic coverage of metadata documents can now be cached in a GIS-
498
accessible format and published via web mapping services and an online
499
interactive map. 
500

    
501
New Features:
502
* Three new open source libraries have been integrated with Metacat:
503
  - Geoserver:  A standards-compliant web map server to publish
504
                geographic data to the web.
505
               (http://docs.codehaus.org/display/GEOS/Home)
506
  - GeoTools:   A java-based GIS toolkit to programatically
507
                manipulate spatial datasets.
508
                (http://geotools.codehaus.org/)
509
  - Mapbuilder: A javascript application to provide an interactive
510
                web map front-end to Geoserver.
511
                (http://docs.codehaus.org/display/MAP/Home)
512
* Spatial Caching/Indexing mechanism; documents with geographic
513
  coverages will be added to the spatial cache.
514
* Spatial Query action in metacat servlet. 
515
* Interactive Web map to visualize and query the spatial 
516
  distribution of metadata documents.
517
* Experimental python, ruby and php client libraries to interface with metacat.
518
* Preliminary process in place for web based configuration of metacat.
519

    
520
Compatibility Notices:
521
* Tomcat 3 and 4 are no longer tested or supported. Users are 
522
  highly encouraged to upgrade to Tomcat 5.5
523

    
524
Bug Fixes:
525
* Metacat administrators are able to modify and delete documents 
526
  created by other users.
527
* Fixed problems with indexing XML attributes, see bug 2469
528

    
529

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

    
533
This release comes with more performance improvements, initial support for 
534
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
535
Metacat administrators and bug fixes. Below is the list of bug fixes and
536
performance improvements.
537

    
538
Bug Fixes: 
539
* Improved the indexing algorithm. Earlier indexing failed for some documents 
540
  randomly and used to take a lot of time to complete for others. The 
541
  code for indexing was changed to take care of both these problems.
542
* Earlier, xmlns prefix was used to determine the namespace of the document. 
543
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
544
  of the document as that is a better indicator of document type. 
545
* INSTR was used in some SQL statements and it is not supported by Postgres. 
546
  So SQL statements were modified so that INSTR is not used.
547
* Replication was changed to include replication of deleted documents also.
548
* Fixed bug in squery which didnt allow use of not-contains 
549

    
550
New Features:
551
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
552
* Added support for LSID. This includes modifying the stylesheets to 
553
  display the LSIDs, modifying the build to include a new target 
554
  'install-ldap'.
555
* Added following access control levels to Metacat:
556
    1. Administrators - users who can do the following:
557
       a. Run replication
558
       b. Delete any document
559
       c. Modify any document
560
       d. run indexing for any document
561
       e. check the logs
562
    2. allowedUsers - User who are allowed to submit
563
    3. deniedUsers - Users not allowed to submit
564
* Added a new skin for Ecological Society of America. 
565
* Created an Advanced search servlet which can be used from the web. 
566
* Various connections have been modified to be secure. e.g. connection between 
567
ldaps is made secure now, replication is done over secure channels.  
568

    
569
Performance:
570
* Reduced size of xml_nodes by creating a new table for holding nodes from 
571
  deleted documents and old revisions of the documents. 
572
* Provided a new variable in metacat.properties where more frequently searched 
573
  for paths can be specified. Seperate indexes are created for these paths 
574
  - so that search is faster.
575
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
576

    
577
Release Notes for 1.5.0:
578
------------------------
579

    
580
This release comes with performace improvement, user interface enhancements,
581
and bug fixes. Below is the list of bug fixes and performance improvements. 
582

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

    
634

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

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

    
705

    
706
Release Notes for 1.4.0:
707
------------------------
708

    
709
This is a major release, and is the first to introduce many new features to
710
Metacat.  Some of the major new features in this version of Metacat include:
711

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

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

    
743
Release Notes for 1.3.1:
744
------------------------
745

    
746
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
747
include:
748
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
749
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
750
    and Java 1.4.
751
 2) Distribution package size was reduced.
752

    
753

    
754
Release Notes for 1.3.0
755
------------------------
756

    
757
In 1.3.0 release, the structure of the xml_access table was changed and a new
758
table, xml_accesssubtree was added. If you try to update a previously 
759
installed Metacat, you should run a script file to updated the table structure 
760
before installation.
761
For Oracle user: At the SQLPLUS prompt type the following -
762
@src/reviseformetacat13.sql
763
For Postgresql user: At install directory prompt type the following -
764
psql exp < src/reviseformetacat13_postgres.sql
765
(where 'exp' is the database name).
766

    
767
After installation, user should run "ant schemasql" command to register EML2
768
schema in xml_catalog table.
769

    
770
If you are a new Metacat user, this step is unneeded.
771

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

    
778
New Features in 1.3.0
779
  1) Partialy support EML2 document. User can store, query, read and write
780
     EML2 documents. However, Metacat only support access control in resource
781
     level. The subtree level access control will be ignored.
782
  2) Support other xml document base on namespace/schema.
783
  3) Support query for attribute value
784
  4) Assign MIME type to data file base on metadata when user try to read it.
785
  5) Owner can assign access rules to a document which does not have access 
786
     document to apply it.
787
  6) Support exporting single file, not only whole package
788
  7) Resupport Microsoft SQL Server.
789

    
790
Fixes in 1.3.0:
791
  1) Couldn't finish delta T replication for large set of documents.
792
  2) Couldn't create access control during delta T replication.
793
  3) Eorr will be written to a seperated log file if some documents
794
     were failed in replication.
795
  4) Decrease the time to create access rules during insert or update 
796
     a package.
797
     
798
Documentation
799
-------------
800
See the docs directory for detailed documentation and installation
801
instructions.
802

    
803
Details of the Metacat architecture can be found on the website for
804
the Knowledge Network for Biocomplexity (KNB):
805

    
806
  http://knb.ecoinformatics.org/software/metacat/
807

    
808
Contributions to this work are welcome.  Please see the above web site
809
for details on how to contribute.
810

    
811
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
812
-----------------------------------------------------------------------------
813
If you discover a bug please report it, either by email (above) or by using
814
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
815
list of currently unimplemented features in Bugzilla that we are working on
816
for the next release.
817

    
818
Legalese
819
--------
820
This software is copyrighted by The Regents of the University of California
821
and the National Center for Ecological Analysis and Synthesis
822
and licensed under the GNU GPL; see the 'LICENSE' file for
823
details.
824

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

    
831
This software is partially supported by a grant from the Andrew W. 
832
Mellon Foundation.
833

    
834
This product includes software developed by the Apache Software
835
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
836
for details.
837

    
838
The source code, object code, and documentation in the com.oreilly.servlet
839
package is copyright and owned by Jason Hunter. See the cos-license.html file
840
for details of the license.  Licensor retains title to and ownership of the
841
Software and all enhancements, modifications, and updates to the Software.
842

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