Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 10243 $'
5
#     '$Date: 2017-05-03 14:23:30 -0700 (Wed, 03 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.2:
59
------------------------
60
New bugs fixed in this release:
61
* The listObjects method fails if there is pid with a white space in the list
62
* 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
63
* The count number is -1 when the expandRightsHolder method lists the subjects
64
* CN V1/V2.archive implementation only allows CN and MN administrators to act
65
* Metacat-index RDF/XML subprocessor not populating prov_hasDerivations field
66

    
67

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

    
84

    
85
Release Notes for 2.8.0:
86
------------------------
87
New features and bugs fixed in this release:
88
* Modify Metacat code according to the change of dataone library migrating from JibX to JAXB
89
* Upgrade Solr to 3.6.2 to fix searching issues
90
* Metacat is not expanding groups in the rightsHolder field during authorization
91
* Improve error message for: User tried to update an access module when they dont have ALL permission!"
92

    
93

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

    
110
Release Notes for 2.7.1:
111
------------------------
112
* Fixed several bugs on the data registry form
113
* Support the onedcx schema
114
  - Fixed several onedcx stylesheet issues
115

    
116
Relese Notes for 2.7.0:
117
------------------------
118
* Use different format ids to identity variants of the schema with same namespace
119
* Add EML 2.1.1 to Darwin Core supporting for OAI-PMH provider  
120
* Bugs fixed include:
121
  - Series head resolution should use obsoletes field as part of determination(7020)
122
  - The InputStream (parameter) in the CN/MN.create and MN.update method is not closed(7005)
123
  - Use the AutoCloseClientInputStream class in the d1_libclient_java in Metacat replication(7004)
124

    
125
Release Notes for 2.6.0:
126
------------------------
127
This release supports token-based authentication in the data registry
128
as well as:
129
* MetacatUI 1.11.0
130

    
131
Release Notes for 2.5.1:
132
------------------------
133
This a minor release that improves:
134
* Authentication token handling for the DataONE API
135

    
136
Release Notes for 2.5.0:
137
------------------------
138
This major release adds DataONE V2 API support
139
as well as:
140
* MetacatUI 1.8.1
141
* Data registry bug fixes
142

    
143
Release Notes for 2.4.3:
144
------------------------
145
This release includes:
146
* Support for large file uploads
147
* Recording User-Agent when logging requests
148

    
149
Release Notes for 2.4.2:
150
------------------------
151
This release includes:
152
* Updates to improve character encoding handling
153
* Updated SOLR index and UI to use geohashes for map rendering
154
* Note: this is the last release of Metacat that will support Java 6
155

    
156
Release Notes for 2.4.1:
157
------------------------
158
This is a patch release that addresses the following:
159
* Allows LDAP authentication using aliased referrals
160
* Re-indexes previous document revisions in SOLR when
161
new revisions are added on update
162
* Allows authentication in SANParks skin
163
* Enables OpenLayer.js mapping plug-in over https
164

    
165
Release Notes for 2.4.0:
166
------------------------
167
These release adds a new default file-based authentication mechanism
168
that allows administrators to more easily deploy Metacat without a
169
LDAP server.
170
Other enhancements include:
171
* Correct use of DataONE 'archive' flag
172
* Access policy synchronization with the DataONE Coordinating Node
173
* Indexing support for EML singleDateTime coverage values
174
* Indexing support document read/download events
175
* Improved package download structure and file naming conventions
176

    
177
Release Notes for 2.3.1:
178
------------------------
179
This is a minor patch release to fix an issue that arises when
180
Metacat is operating as a DataONE Coordinating Node.
181
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
182
* Updated MetacatUI with support for spatial query criteria
183
* Updated account/identity management script
184

    
185
Release Notes for 2.3.0:
186
------------------------
187
This release adds solr indexing features to metacat-index 
188
for querying and sorting by authors and taxonomic coverage.
189
Also includes:
190
* Control over the log level from the SOLR libraries using Metacat's
191
log4j file.
192
* access_log DB indexes for better log reporting performance 
193
via the DataONE API
194
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
195

    
196

    
197
Release Notes for 2.2.1:
198
------------------------
199
This is a critical patch release of Metacat that includes addresses
200
a bug in file stream handling. It is recommended for all Metacat deployments.
201

    
202
Release Notes for 2.2.0:
203
------------------------
204
This is a major release of Metacat that includes a new customizable UI and 
205
improved LDAP account management features
206

    
207
Release Notes for 2.1.1:
208
------------------------
209
This is a minor patch release of Metacat that addresses
210
a bug in DOI publishing.
211

    
212
Release Notes for 2.1.0:
213
------------------------
214
This is a major release of Metacat that includes a SOLR-based search feature
215
* Optional SOLR search index
216
* Client certificate delegation (using a service provider like CILogon)
217

    
218
Release Notes for 2.0.8:
219
------------------------
220
This is a patch release for Metacat
221
* Enforce DataONE prohibition on whitespace in identifiers
222
* Use unique filenames for Registry data uploads
223

    
224
Release Notes for 2.0.7:
225
------------------------
226
This is a patch release for Metacat replication
227
* Replication SQL performance enhancement
228
* Comply with DataONE schema for SystemMetadata.submitter
229

    
230
Release Notes for 2.0.6:
231
------------------------
232
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
233
* MN.generateIdentifier() support for UUID and DOI
234
* DOI registration support using EZID service
235
* Pathquery support for specifying multiple document owners
236

    
237

    
238
Release Notes for 2.0.5:
239
------------------------
240
This patch release focuses on Metacat support for Oracle
241
*SystemMetadata table names have been shortened to comply with Oracle limits.
242
*SANParks/SAEON spatial zip file download fixed
243
*Pathquery performance fix
244
*Hazelcast 2.x upgrade
245
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
246

    
247
Release Notes for 2.0.4:
248
------------------------
249
This patch release focuses on Metacat-Metacat replication.
250
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
251
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
252
*Fixes an access control issue that could allow search results to include protected documents
253

    
254
Release Notes for 2.0.3:
255
------------------------
256
This is another critical patch release of Metacat 2.0.
257
*Addresses a bug that prevented Metacat replication from completing (timeout error)
258
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
259

    
260
Release Notes for 2.0.2:
261
------------------------
262
This is a critical patch release of Metacat 2.0.
263
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
264
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
265
*Updates the Foresite ORE library to correctly serialize resource map documents
266

    
267
Release Notes for 2.0.1:
268
------------------------
269
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
270
*Addresses an identifier issue during ORE generation for DataONE services
271
*Increases compatibility with older EML content and the Xalan XSLT processor
272
*Removes XSLT 2.0 support (Saxon)
273

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

    
290

    
291
Release Notes for 1.9.5:
292
------------------------
293
This release fixes those bugs:
294
*Metacat could not download the included schemas in an external schema file during inserting.
295
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
296
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
297
*Document access rules are now preserved when documents are archived during the 'delete' action.
298

    
299
Release Notes for 1.9.4:
300
------------------------
301
This release fixes bugs in the FGDC data package upload and download interface utilized
302
by the SANParks and SAEON skins.
303

    
304
Release Notes for 1.9.3:
305
------------------------
306
This release fixes a harvester bug that prevented the EML harvester from processing
307
harvest lists.
308
The Kepler skin has been updated to support KarXML 2.1.
309
Ecogrid query services now support multiple namespace searches.
310

    
311
Release Notes for 1.9.2:
312
------------------------
313
This release primarily holds the addition of the Threshold of Potential
314
Concern workflow functionality (TPC).  The following issues were addressed:
315

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

    
343
Release Notes for 1.9.1:
344
------------------------
345
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
346
These bugs were primarily replication issues.  There is no difference 
347
in functionality between 1.9.0 and 1.9.1 
348

    
349
Release Notes for 1.9.0:
350
------------------------
351
This release focuses on simplifying the Metacat installation process by 
352
creating a binary (war) installation.  The need to build the application
353
on the server has been removed (although the option is still available).
354
In order to facilitate this method of installation, a few major modifications
355
were made to the code:
356

    
357
  -- Ant token replacement was removed for all non-build variables in the 
358
     application (most of this was already done in 1.8.1).
359

    
360
  -- The Metacat properties confguration was moved into the application
361
     itself.
362

    
363
  -- Database schema version detection and install/upgrade utilities were 
364
     added to the application.
365

    
366
Also, this release includes several enhancements:
367
  -- it supports the new EML 2.1.0 version.  
368

    
369
  -- Documents are now stored on the local filesystem as well as in the 
370
     database in order to preserve document integrity.
371
     
372
  -- Metacat verifies new schemas when they are added.
373

    
374
  -- Additional access is propegated with documents during replication.
375

    
376
High priority bugs were addressed in this release as well.
377

    
378
The enhancements/bugs addressed are:
379

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

    
410
Release Notes for 1.8.1:
411
------------------------
412
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
413
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
414
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
415
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
416
Details please see:
417
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
418
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
419

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

    
425
The fixed bugs include:
426

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

    
450
Release Notes for 1.8.0:
451
------------------------
452
This release focuses on improving query performance.  Both the selection 
453
and access control queries were rewritten to execute efficiently.
454
To improve search performance, a query caching mechanism was introduced. 
455
Cached queries are currently supported only for public users.
456

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

    
483
Release Notes for 1.7.0:
484
------------------------
485
This release features only a few minor changes to the core Metacat engine. 
486
The major focus of this release is the addition of the spatial functionality.
487
The geographic coverage of metadata documents can now be cached in a GIS-
488
accessible format and published via web mapping services and an online
489
interactive map. 
490

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

    
510
Compatibility Notices:
511
* Tomcat 3 and 4 are no longer tested or supported. Users are 
512
  highly encouraged to upgrade to Tomcat 5.5
513

    
514
Bug Fixes:
515
* Metacat administrators are able to modify and delete documents 
516
  created by other users.
517
* Fixed problems with indexing XML attributes, see bug 2469
518

    
519

    
520
Release Notes for 1.6.0:
521
------------------------
522

    
523
This release comes with more performance improvements, initial support for 
524
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
525
Metacat administrators and bug fixes. Below is the list of bug fixes and
526
performance improvements.
527

    
528
Bug Fixes: 
529
* Improved the indexing algorithm. Earlier indexing failed for some documents 
530
  randomly and used to take a lot of time to complete for others. The 
531
  code for indexing was changed to take care of both these problems.
532
* Earlier, xmlns prefix was used to determine the namespace of the document. 
533
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
534
  of the document as that is a better indicator of document type. 
535
* INSTR was used in some SQL statements and it is not supported by Postgres. 
536
  So SQL statements were modified so that INSTR is not used.
537
* Replication was changed to include replication of deleted documents also.
538
* Fixed bug in squery which didnt allow use of not-contains 
539

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

    
559
Performance:
560
* Reduced size of xml_nodes by creating a new table for holding nodes from 
561
  deleted documents and old revisions of the documents. 
562
* Provided a new variable in metacat.properties where more frequently searched 
563
  for paths can be specified. Seperate indexes are created for these paths 
564
  - so that search is faster.
565
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
566

    
567
Release Notes for 1.5.0:
568
------------------------
569

    
570
This release comes with performace improvement, user interface enhancements,
571
and bug fixes. Below is the list of bug fixes and performance improvements. 
572

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

    
624

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

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

    
695

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

    
699
This is a major release, and is the first to introduce many new features to
700
Metacat.  Some of the major new features in this version of Metacat include:
701

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

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

    
733
Release Notes for 1.3.1:
734
------------------------
735

    
736
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
737
include:
738
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
739
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
740
    and Java 1.4.
741
 2) Distribution package size was reduced.
742

    
743

    
744
Release Notes for 1.3.0
745
------------------------
746

    
747
In 1.3.0 release, the structure of the xml_access table was changed and a new
748
table, xml_accesssubtree was added. If you try to update a previously 
749
installed Metacat, you should run a script file to updated the table structure 
750
before installation.
751
For Oracle user: At the SQLPLUS prompt type the following -
752
@src/reviseformetacat13.sql
753
For Postgresql user: At install directory prompt type the following -
754
psql exp < src/reviseformetacat13_postgres.sql
755
(where 'exp' is the database name).
756

    
757
After installation, user should run "ant schemasql" command to register EML2
758
schema in xml_catalog table.
759

    
760
If you are a new Metacat user, this step is unneeded.
761

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

    
768
New Features in 1.3.0
769
  1) Partialy support EML2 document. User can store, query, read and write
770
     EML2 documents. However, Metacat only support access control in resource
771
     level. The subtree level access control will be ignored.
772
  2) Support other xml document base on namespace/schema.
773
  3) Support query for attribute value
774
  4) Assign MIME type to data file base on metadata when user try to read it.
775
  5) Owner can assign access rules to a document which does not have access 
776
     document to apply it.
777
  6) Support exporting single file, not only whole package
778
  7) Resupport Microsoft SQL Server.
779

    
780
Fixes in 1.3.0:
781
  1) Couldn't finish delta T replication for large set of documents.
782
  2) Couldn't create access control during delta T replication.
783
  3) Eorr will be written to a seperated log file if some documents
784
     were failed in replication.
785
  4) Decrease the time to create access rules during insert or update 
786
     a package.
787
     
788
Documentation
789
-------------
790
See the docs directory for detailed documentation and installation
791
instructions.
792

    
793
Details of the Metacat architecture can be found on the website for
794
the Knowledge Network for Biocomplexity (KNB):
795

    
796
  http://knb.ecoinformatics.org/software/metacat/
797

    
798
Contributions to this work are welcome.  Please see the above web site
799
for details on how to contribute.
800

    
801
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
802
-----------------------------------------------------------------------------
803
If you discover a bug please report it, either by email (above) or by using
804
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
805
list of currently unimplemented features in Bugzilla that we are working on
806
for the next release.
807

    
808
Legalese
809
--------
810
This software is copyrighted by The Regents of the University of California
811
and the National Center for Ecological Analysis and Synthesis
812
and licensed under the GNU GPL; see the 'LICENSE' file for
813
details.
814

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

    
821
This software is partially supported by a grant from the Andrew W. 
822
Mellon Foundation.
823

    
824
This product includes software developed by the Apache Software
825
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
826
for details.
827

    
828
The source code, object code, and documentation in the com.oreilly.servlet
829
package is copyright and owned by Jason Hunter. See the cos-license.html file
830
for details of the license.  Licensor retains title to and ownership of the
831
Software and all enhancements, modifications, and updates to the Software.
832

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