Project

General

Profile

metacat / README @ 8556

1
#
2
#  '$RCSfile$'
3
#   '$Author: leinfelder $'
4
# '$Revision: 8555 $'
5
#     '$Date: 2014-02-03 14:56:20 -0800 (Mon, 03 Feb 2014) $'
6
#
7

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

    
11
Version: 2.4.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
Release Notes for 2.4.0:
58
------------------------
59
These release adds a new default file-based authentication mechanism
60
that allows administrators to more easily deploy Metacat without a
61
LDAP server.
62
Other enhancements include:
63
* Access policy synchronization with the DataONE Coordinating Node
64
* Indexing support for EML singleDateTime coverage values
65
* Indexing support document read/download events
66
* Improved package download structure and file naming conventions
67

    
68
Release Notes for 2.3.1:
69
------------------------
70
This is a minor patch release to fix an issue that arises when
71
Metacat is operating as a DataONE Coordinating Node.
72
* See: https://projects.ecoinformatics.org/ecoinfo/issues/6315
73
* Updated MetacatUI with support for spatial query criteria
74
* Updated account/identity management script
75

    
76
Release Notes for 2.3.0:
77
------------------------
78
This release adds solr indexing features to metacat-index 
79
for querying and sorting by authors and taxonomic coverage.
80
Also includes:
81
* Control over the log level from the SOLR libraries using Metacat's
82
log4j file.
83
* access_log DB indexes for better log reporting performance 
84
via the DataONE API
85
* Provide 'reindexall' action instead of 'reindex' without a 'pid' parameter.
86

    
87

    
88
Release Notes for 2.2.1:
89
------------------------
90
This is a critical patch release of Metacat that includes addresses
91
a bug in file stream handling. It is recommended for all Metacat deployments.
92

    
93
Release Notes for 2.2.0:
94
------------------------
95
This is a major release of Metacat that includes a new customizable UI and 
96
improved LDAP account management features
97

    
98
Release Notes for 2.1.1:
99
------------------------
100
This is a minor patch release of Metacat that addresses
101
a bug in DOI publishing.
102

    
103
Release Notes for 2.1.0:
104
------------------------
105
This is a major release of Metacat that includes a SOLR-based search feature
106
* Optional SOLR search index
107
* Client certificate delegation (using a service provider like CILogon)
108

    
109
Release Notes for 2.0.8:
110
------------------------
111
This is a patch release for Metacat
112
* Enforce DataONE prohibition on whitespace in identifiers
113
* Use unique filenames for Registry data uploads
114

    
115
Release Notes for 2.0.7:
116
------------------------
117
This is a patch release for Metacat replication
118
* Replication SQL performance enhancement
119
* Comply with DataONE schema for SystemMetadata.submitter
120

    
121
Release Notes for 2.0.6:
122
------------------------
123
This patch release focuses on Metacat support for DataONE-enabled Morpho clients
124
* MN.generateIdentifier() support for UUID and DOI
125
* DOI registration support using EZID service
126
* Pathquery support for specifying multiple document owners
127

    
128

    
129
Release Notes for 2.0.5:
130
------------------------
131
This patch release focuses on Metacat support for Oracle
132
*SystemMetadata table names have been shortened to comply with Oracle limits.
133
*SANParks/SAEON spatial zip file download fixed
134
*Pathquery performance fix
135
*Hazelcast 2.x upgrade
136
*Correct handling for deleted and archived objects for both Metacat and DataONE APIs
137

    
138
Release Notes for 2.0.4:
139
------------------------
140
This patch release focuses on Metacat-Metacat replication.
141
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
142
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
143
*Fixes an access control issue that could allow search results to include protected documents
144

    
145
Release Notes for 2.0.3:
146
------------------------
147
This is another critical patch release of Metacat 2.0.
148
*Addresses a bug that prevented Metacat replication from completing (timeout error)
149
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
150

    
151
Release Notes for 2.0.2:
152
------------------------
153
This is a critical patch release of Metacat 2.0.
154
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
155
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
156
*Updates the Foresite ORE library to correctly serialize resource map documents
157

    
158
Release Notes for 2.0.1:
159
------------------------
160
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
161
*Addresses an identifier issue during ORE generation for DataONE services
162
*Increases compatibility with older EML content and the Xalan XSLT processor
163
*Removes XSLT 2.0 support (Saxon)
164

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

    
181

    
182
Release Notes for 1.9.5:
183
------------------------
184
This release fixes those bugs:
185
*Metacat could not download the included schemas in an external schema file during inserting.
186
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
187
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
188
*Document access rules are now preserved when documents are archived during the 'delete' action.
189

    
190
Release Notes for 1.9.4:
191
------------------------
192
This release fixes bugs in the FGDC data package upload and download interface utilized
193
by the SANParks and SAEON skins.
194

    
195
Release Notes for 1.9.3:
196
------------------------
197
This release fixes a harvester bug that prevented the EML harvester from processing
198
harvest lists.
199
The Kepler skin has been updated to support KarXML 2.1.
200
Ecogrid query services now support multiple namespace searches.
201

    
202
Release Notes for 1.9.2:
203
------------------------
204
This release primarily holds the addition of the Threshold of Potential
205
Concern workflow functionality (TPC).  The following issues were addressed:
206

    
207
* Create a properties file for use by JUnit Tests (Bug 2994)
208
* security issue with skins (Bug 3368)
209
* reorganize classes into a more functional specific structure (Bug 3510)
210
* Add admin names as dropdown in configuration login (Bug 3729)
211
* KNB metacat replication error log file is empty (Bug 3885)
212
* Create TPC Report web browse/search pages (Bug 4165)
213
* Create archive extraction functionality (Bug 4166)
214
* Create Workflow Scheduler (Bug 4167)
215
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
216
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
217
* Fix cross platform TPC GUI issues (Bug 4556)
218
* TPC Sanparks page content lenth issue (Bug 4557)
219
* Create validate and isAuthorized unit tests (Bug 4558)
220
* Cannot insert replication server via gui (Bug 4594)
221
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
222
* [ESA] Update fails when document rev number is missing (Bug 4627)
223
* fails to catch some insert and update failures (Bug 4637)
224
* must support java 1.6 (Bug 4641)
225
* Convert build to pull eml from svn instead of cvs (Bug 4644)
226
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
227
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
228
* metacat runs out of memory (Bug 4658)
229
* ESA skin links are hard coded to data.esa.org (Bug 4698)
230
* Update release 1.9.2 release notes (Bug 4707)
231
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
232
* Metacat should run against Tomcat 6 (Bug 4716)
233

    
234
Release Notes for 1.9.1:
235
------------------------
236
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
237
These bugs were primarily replication issues.  There is no difference 
238
in functionality between 1.9.0 and 1.9.1 
239

    
240
Release Notes for 1.9.0:
241
------------------------
242
This release focuses on simplifying the Metacat installation process by 
243
creating a binary (war) installation.  The need to build the application
244
on the server has been removed (although the option is still available).
245
In order to facilitate this method of installation, a few major modifications
246
were made to the code:
247

    
248
  -- Ant token replacement was removed for all non-build variables in the 
249
     application (most of this was already done in 1.8.1).
250

    
251
  -- The Metacat properties confguration was moved into the application
252
     itself.
253

    
254
  -- Database schema version detection and install/upgrade utilities were 
255
     added to the application.
256

    
257
Also, this release includes several enhancements:
258
  -- it supports the new EML 2.1.0 version.  
259

    
260
  -- Documents are now stored on the local filesystem as well as in the 
261
     database in order to preserve document integrity.
262
     
263
  -- Metacat verifies new schemas when they are added.
264

    
265
  -- Additional access is propegated with documents during replication.
266

    
267
High priority bugs were addressed in this release as well.
268

    
269
The enhancements/bugs addressed are:
270

    
271
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
272
* need to set filename for download files (Bug 2566)
273
* add ability for search engines to index metacat documents (Bug 2826)
274
* EML citation section should include both organizationNames and individualNames (Bug 3059)
275
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
276
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
277
* New documents explicitly set as public access don't show up correctly (Bug 3262)
278
* Modify confguration utility in metacat (Bug 3371)
279
* Integrate perl token replacement changes (Bug 3372)
280
* Create skin specific configuration utility (Bug 3373)
281
* Add authentication for configuration utility (Bug 3374)
282
* Create a sorted properties utility (Bug 3375)
283
* Add DB upgrade/install functionality to java code (Bug 3376)
284
* Create ANT install target for developers (Bug 3377)
285
* Create LSID server installation (Bug 3380)
286
* Create unit test code for 1.9 additions (Bug 3381)
287
* create simple turnkey installer for metacat Phase I (Bug 3461)
288
* Maps do not display in Firefox version 3 (Bug 3462)
289
* Replicate access rules in replication (Bug 3464)
290
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
291
* Add full schema checking when metacat register new schema (Bug 3474)
292
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
293
* getprincipals action returns invalid XML document (Bug 3527)
294
* Update knbweb to serve new metacat install (Bug 3545)
295
* Replication should write to disk (Bug 3554)
296
* Update acknowlegements in metacat readme (Bug 3588)
297
* Validate the ldap administrator field. (Bug 3616)
298
* Allow for different authentication services in metacat configuration (Bug 3680)
299
* Tag utilities module and have metacat check out that tag (Bug 3685)
300

    
301
Release Notes for 1.8.1:
302
------------------------
303
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
304
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
305
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
306
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
307
Details please see:
308
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
309
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
310

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

    
316
The fixed bugs include:
317

    
318
*Character set (charset) problem when filling out form (Bug2797)
319
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
320
*Metacat performance issue in Sanparks skin (Bug 3174)
321
*Metacat using illegitimate versions of EML schema (Bug 3239)
322
*Update older invalidated eml201 document in Metacat (Bug 3241)
323
*Verify existing token changes to skins (Bug 3176)
324
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
325
*Expose permission options for registry uploads (Bug 3014)
326
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
327
*Data Catalog Map is slow when selecting (Bug2732)
328
*Only one attribute per element returned with pathquery results(Bug 2999)
329
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
330
*Generalize the reading of skin.configs in DBTransform (Bug3058)
331
*The query example in metacatquery.html document need to be changed (Bug3137)
332
*Add upload method into Metacat tour (Bug 3139)
333
*Query resultset doesn't show component name in kepler skin (Bug 3178)
334
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
335
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
336
*An error message happen during the metacat start up (Bug 3279)
337
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
338
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
339
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
340

    
341
Release Notes for 1.8.0:
342
------------------------
343
This release focuses on improving query performance.  Both the selection 
344
and access control queries were rewritten to execute efficiently.
345
To improve search performance, a query caching mechanism was introduced. 
346
Cached queries are currently supported only for public users.
347

    
348
New Features:
349
* Data registries now support uploading of data objects along with data 
350
  packages (Bug 1982)
351
  
352
Bug Fixes:
353
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
354
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
355
* Query cache mechanism (Bug 2905)
356
* Metacat Performance: updates from Morpho of data packages are taking 
357
   longer than five minutes (Bug 2805)
358
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
359
* Metacat Performace: Upgrading hardware setup (Bug 2175)
360
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
361
* Display of metadata documents reorganized, including a new citation format,
362
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
363
* I.E. display fixes on default skin (Bug 2579)
364
* Web Address links fixed (Bug 2147)
365
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
366
* Spatial query:  data packages must be fully contained by the selection 
367
  bounding box in order to appear in the search results (Bugs 2972, 2732).
368
* FGDC support: upload, delete, update, access control, and download
369
  (Bugs 2807, 2925, 2926, 2929, 2030).
370
Compatibility Notices:
371
* Tomcat 3 and 4 are no longer tested or supported. Users are 
372
  highly encouraged to upgrade to Tomcat 5.5
373

    
374
Release Notes for 1.7.0:
375
------------------------
376
This release features only a few minor changes to the core Metacat engine. 
377
The major focus of this release is the addition of the spatial functionality.
378
The geographic coverage of metadata documents can now be cached in a GIS-
379
accessible format and published via web mapping services and an online
380
interactive map. 
381

    
382
New Features:
383
* Three new open source libraries have been integrated with Metacat:
384
  - Geoserver:  A standards-compliant web map server to publish
385
                geographic data to the web.
386
               (http://docs.codehaus.org/display/GEOS/Home)
387
  - GeoTools:   A java-based GIS toolkit to programatically
388
                manipulate spatial datasets.
389
                (http://geotools.codehaus.org/)
390
  - Mapbuilder: A javascript application to provide an interactive
391
                web map front-end to Geoserver.
392
                (http://docs.codehaus.org/display/MAP/Home)
393
* Spatial Caching/Indexing mechanism; documents with geographic
394
  coverages will be added to the spatial cache.
395
* Spatial Query action in metacat servlet. 
396
* Interactive Web map to visualize and query the spatial 
397
  distribution of metadata documents.
398
* Experimental python, ruby and php client libraries to interface with metacat.
399
* Preliminary process in place for web based configuration of metacat.
400

    
401
Compatibility Notices:
402
* Tomcat 3 and 4 are no longer tested or supported. Users are 
403
  highly encouraged to upgrade to Tomcat 5.5
404

    
405
Bug Fixes:
406
* Metacat administrators are able to modify and delete documents 
407
  created by other users.
408
* Fixed problems with indexing XML attributes, see bug 2469
409

    
410

    
411
Release Notes for 1.6.0:
412
------------------------
413

    
414
This release comes with more performance improvements, initial support for 
415
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
416
Metacat administrators and bug fixes. Below is the list of bug fixes and
417
performance improvements.
418

    
419
Bug Fixes: 
420
* Improved the indexing algorithm. Earlier indexing failed for some documents 
421
  randomly and used to take a lot of time to complete for others. The 
422
  code for indexing was changed to take care of both these problems.
423
* Earlier, xmlns prefix was used to determine the namespace of the document. 
424
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
425
  of the document as that is a better indicator of document type. 
426
* INSTR was used in some SQL statements and it is not supported by Postgres. 
427
  So SQL statements were modified so that INSTR is not used.
428
* Replication was changed to include replication of deleted documents also.
429
* Fixed bug in squery which didnt allow use of not-contains 
430

    
431
New Features:
432
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
433
* Added support for LSID. This includes modifying the stylesheets to 
434
  display the LSIDs, modifying the build to include a new target 
435
  'install-ldap'.
436
* Added following access control levels to Metacat:
437
    1. Administrators - users who can do the following:
438
       a. Run replication
439
       b. Delete any document
440
       c. Modify any document
441
       d. run indexing for any document
442
       e. check the logs
443
    2. allowedUsers - User who are allowed to submit
444
    3. deniedUsers - Users not allowed to submit
445
* Added a new skin for Ecological Society of America. 
446
* Created an Advanced search servlet which can be used from the web. 
447
* Various connections have been modified to be secure. e.g. connection between 
448
ldaps is made secure now, replication is done over secure channels.  
449

    
450
Performance:
451
* Reduced size of xml_nodes by creating a new table for holding nodes from 
452
  deleted documents and old revisions of the documents. 
453
* Provided a new variable in metacat.properties where more frequently searched 
454
  for paths can be specified. Seperate indexes are created for these paths 
455
  - so that search is faster.
456
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
457

    
458
Release Notes for 1.5.0:
459
------------------------
460

    
461
This release comes with performace improvement, user interface enhancements,
462
and bug fixes. Below is the list of bug fixes and performance improvements. 
463

    
464
Bug Fixes:
465
* Modify property values of harvester registration servlets to match the
466
  servlet-mapping URL values in web.xml. The old values used the servlet
467
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
468
  Windows. The new values use the servlet-mapping URL values. This should
469
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
470
* Re-implement logic to prune old log entries from the HARVEST_LOG and
471
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
472
  violations in the database because it tried to delete parent records from
473
  HARVEST_LOG prior to deleting child records from
474
  HARVEST_DETAIL_LOG. (Bug 162)
475
* In data registry, minor bugs fixed like the error page shows the link back
476
  to the form when error page was generated because of a document read
477
  request from search results page,  the successful delete button leading
478
  to a blank screen and the old ACL overwritten by the registry.
479
  (Bugs 1307, 1310, 1322, 1344, 1551)
480
* Changed the code to support insertion of following characters: ', `,
481
  charcters in the Numeric Character Reference format (&#xyz;) and
482
  characters like µ. Characters like µ will be converted to and stored in
483
  Numeric Character Reference format(&#xyz;). They will also be returned
484
  in Numeric Character Reference and it is upto the client to convert them
485
  and display them accordingly in the application. Partial fix provided by
486
  Johnoel Ancheta. (Bug 1538,1711)
487
* Spatial search failed on Oracle because of invalid entries made by
488
  some documents in the nodedata column of xml_nodes for paths involving
489
  'eastBoundingCoordinate', 'westBoundingCoordinate',
490
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
491
  nodedatanumerical was added to xml_nodes table such that all the numerical
492
  nodedata is stored in this column and this column is now used for spatial
493
  search. (Bug 1703, 1718)
494
* In the default skin, clicking on the keywords on the home page did not
495
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
496
* Metacat generated a success message even when a document which didnt
497
  exsist was requested for deletion. This has been fixed. (Bug 1850)
498
* "packagetype" in xml-relation table was entered as eml200 namespace when
499
  an eml201 document was inserted. This is fixed now so that "packagetype"
500
  in xml-relation table points to eml201 namespace. (Bug 1979)
501
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
502
  earlier. Fixed such that it points to the locally installed metacat url. 
503
  (Bug 1986)
504
* Changes to the Query subsystem fix bugs that prevented attributes from 
505
  being expressed solely in the xpath query statement and the returnfield 
506
  values. For instance, a query URL may now include search strings like 
507
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
508
  Previously, the attribute had to be appended to an element: 
509
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
510
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
511
* Search query failed in case of Oracle if number of documents in the result
512
  were more than 1000. This has been fixed. (Bug 2000)
513
* Removed any occurence of enum which is now a keyword in Java 1.5
514

    
515

    
516
Enhancements:
517
* Major improvements done in user interface for the data registeries and
518
  various other skins. Improvements done based on suggestions from Mark
519
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
520
  the default skin and ldap templates. (Bug 1948)
521
* Coded added such that administrator can delete documents irrespective of
522
  who the document belongs to.
523
* Performance impovement done in searching of datasets. A part of the search
524
  time was taken up because of generation of resultset after the search had be
525
  done. So this was the sequence of events in earlier metacat
526
  1) Search for the given text
527
  2) A list of docids generated
528
  3) For each of the docids
529
     3a) Use xml_index and xml_nodes table to generate the string descibing
530
         the document including the returnfields requested in the search
531
  4) Add all the strings from step 3a to send back the resultant
532
     document. Here a decent amount of time was being taken by step 3a. 
533
  The algorithm is now modified by addition of two tables xml_queryresult and
534
  xml_returnfields and a user defined parameter xml_returnfield_count. The
535
  new algorithm works as follows:
536
  1) Search for the given text
537
  2) A list of docids is generated
538
  3) For the given set of return fields generate a unique string and check
539
     if that string exists in xml_returnfields
540
     3a) If string does not exist in xml_returnfield, then enter a new
541
         record usage_count as 1 and returnfield_string as the unique string
542
         generated above.
543
     3b) Else if the string exists, increment usage_count
544
  4) Given the docids from step 2 and the id of the returnfield record from
545
     step 3, query for any docids that already exist in xml_queryresult.
546
     For the docids that do exist, get the queryresult_string.
547
  5) For rest of the docids from step2 which were not found in step 4, do
548
     the following for each of the documents:
549
     5a) Use xml_index and xml_nodes table to generate the string descibing
550
         the document including the returnfields requested in the search
551
     5b) If usage_count of the record from step is more than
552
         xml_returnfield_count set in metacat.properties, then store the
553
         string in xml_queryresult as a record which has the returnfield_id
554
         representing the set of returnfields, docid representing the
555
         document and the string as queryresult_string.
556
  6) Add all the strings from step 4 and step 5a to send back the resultant
557
     document
558
  So the results from step 3a in previous algorithm are effectively cached
559
  and hence same computation is not done again and again for each search.
560
  When a document is deleted, all the entries for that document in
561
  xml_queryresult table are also deleted. When a document is updated, all
562
  the entries for that document in xml_queryresult table are deleted. This
563
  works fine because those entries will be generated and cached again the
564
  next time the document is part of a search is requested.
565
* Performance impovement done for % search.
566
* Following new functions added to metacat client API: a method to set access
567
  on an xml document and a method to get newest version for a given document.
568
* Implement a new HarvesterServlet for running Harvester as a servlet. This
569
  eliminates the need to run Harvester in a terminal window. By default, the
570
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
571
  documentation will be modified to instruct Harvester administrators to
572
  uncomment the HarvesterServlet entry.
573
* Minor enhancement to support multiple email addresses for harvester
574
  administrator and site contact. Each address is separated by a comma or
575
  semicolon.
576
* Increase number of rows in Harvest List Editor from 300 to 1200.
577
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
578
  value when it is set to 0 or a negative number. This allows Harvester to
579
  run indefinitely without shutting down after reaching a maximum number of
580
  harvests. The previous default value of 30 would cause Harvester to
581
  terminate after 30 harvests.
582

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

    
586

    
587
Release Notes for 1.4.0:
588
------------------------
589

    
590
This is a major release, and is the first to introduce many new features to
591
Metacat.  Some of the major new features in this version of Metacat include:
592

    
593
* Added a new 'Harvester' that allows documents to be periodically pulled
594
  from distributed sources into metacat, useful for interfacing with other
595
  system types. See the Metacat Tour for details.
596
* Added new 'skins' capability to allow the GUI for the metacat web interface
597
  to be more easily customized to fit into site needs.  The skin is based on
598
  a flexible mix of XSLT, CSS, and Javascript.
599
* Added a web-based metadata entry form for submitting limited EML documents
600
  as part of a data registry.  The GUI for the registry is customizable and 
601
  is integrated with the 'skins' system for the main metacat interface.  The
602
  registry subsystem is written in Perl, and can simultaneously be used to 
603
  present multiple 'registry' interfaces.
604
* A new 'client API' has been developed and implemented in Java and in Perl 
605
  so that metacat functions can be accessed from any program in those
606
  languages.  The client API supports the major metacat servlet actions,
607
  including login(), logout(), query(), insert(), update(), delete(), and 
608
  upload(). See the Metacat Tour for details.
609
* Added a new 'getlog' action that produces a usage history for all major
610
  events.  So now an XML report can be generated for document reads, inserts,
611
  deletes, etc.  See the new section in the Metacat Tour.
612
* Added a new 'buildindex' action that can rebuild the index entries for any
613
  document in the database.
614
* The configuration file for metacat (metacat.properties) has been moved out
615
  of the jar file and into the WEB-INF directory, allowing far easier changes
616
  to the configuration parameters.
617
* Results in default web interface are sorted by title in the XSLT 
618
  (configurable)
619
* Many bugs were fixed.
620

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

    
624
Release Notes for 1.3.1:
625
------------------------
626

    
627
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
628
include:
629
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
630
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
631
    and Java 1.4.
632
 2) Distribution package size was reduced.
633

    
634

    
635
Release Notes for 1.3.0
636
------------------------
637

    
638
In 1.3.0 release, the structure of the xml_access table was changed and a new
639
table, xml_accesssubtree was added. If you try to update a previously 
640
installed Metacat, you should run a script file to updated the table structure 
641
before installation.
642
For Oracle user: At the SQLPLUS prompt type the following -
643
@src/reviseformetacat13.sql
644
For Postgresql user: At install directory prompt type the following -
645
psql exp < src/reviseformetacat13_postgres.sql
646
(where 'exp' is the database name).
647

    
648
After installation, user should run "ant schemasql" command to register EML2
649
schema in xml_catalog table.
650

    
651
If you are a new Metacat user, this step is unneeded.
652

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

    
659
New Features in 1.3.0
660
  1) Partialy support EML2 document. User can store, query, read and write
661
     EML2 documents. However, Metacat only support access control in resource
662
     level. The subtree level access control will be ignored.
663
  2) Support other xml document base on namespace/schema.
664
  3) Support query for attribute value
665
  4) Assign MIME type to data file base on metadata when user try to read it.
666
  5) Owner can assign access rules to a document which does not have access 
667
     document to apply it.
668
  6) Support exporting single file, not only whole package
669
  7) Resupport Microsoft SQL Server.
670

    
671
Fixes in 1.3.0:
672
  1) Couldn't finish delta T replication for large set of documents.
673
  2) Couldn't create access control during delta T replication.
674
  3) Eorr will be written to a seperated log file if some documents
675
     were failed in replication.
676
  4) Decrease the time to create access rules during insert or update 
677
     a package.
678
     
679
Documentation
680
-------------
681
See the docs directory for detailed documentation and installation
682
instructions.
683

    
684
Details of the Metacat architecture can be found on the website for
685
the Knowledge Network for Biocomplexity (KNB):
686

    
687
  http://knb.ecoinformatics.org/software/metacat/
688

    
689
Contributions to this work are welcome.  Please see the above web site
690
for details on how to contribute.
691

    
692
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
693
-----------------------------------------------------------------------------
694
If you discover a bug please report it, either by email (above) or by using
695
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
696
list of currently unimplemented features in Bugzilla that we are working on
697
for the next release.
698

    
699
Legalese
700
--------
701
This software is copyrighted by The Regents of the University of California
702
and the National Center for Ecological Analysis and Synthesis
703
and licensed under the GNU GPL; see the 'LICENSE' file for
704
details.
705

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

    
712
This software is partially supported by a grant from the Andrew W. 
713
Mellon Foundation.
714

    
715
This product includes software developed by the Apache Software
716
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
717
for details.
718

    
719
The source code, object code, and documentation in the com.oreilly.servlet
720
package is copyright and owned by Jason Hunter. See the cos-license.html file
721
for details of the license.  Licensor retains title to and ownership of the
722
Software and all enhancements, modifications, and updates to the Software.
723

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