Project

General

Profile

metacat / README @ 7428

1
#
2
#  '$RCSfile$'
3
#   '$Author: leinfelder $'
4
# '$Revision: 7413 $'
5
#     '$Date: 2012-10-26 11:04:08 -0700 (Fri, 26 Oct 2012) $'
6
#
7

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

    
11
Version: 2.0.5 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
              John Harris (harris@nceas.ucsb.edu)
25
              Callie Bowdish (bowdish@ecoinformatics.org)
26
              Will Tyburczy (tyburczy@ecoinformatics.org)
27
              Matthew Perry (perry@nceas.ucsb.edu)
28
              Chad Burt (underbluewaters@gmail.com)
29
              Ben Leinfelder (leinfelder@nceas.ucsb.edu)
30
              Chris Barteau (barteau@nceas.ucsb.edu)
31
              Shaun Walbridge (walbridge@nceas.ucsb.edu)
32
              Michael Daigle (daigle@nceas.ucsb.edu) 
33

    
34
Patch contributors:
35
              Andrea Chadden (chadden@nceas.ucsb.edu)
36
              Chris Jones (cjones@msi.ucsb.edu)
37
              Johnoel Ancheta (johnoel@hawaii.edu)
38
              Owen Jones (owen.jones@imperial.ac.uk)
39

    
40
Metacat is a flexible database storage system for XML formatted
41
documents and associated binary files. Metacat models the structure of the
42
XML document, therefore allowing storage of XML documents with arbitrary
43
schemas. Metacat supports several databases on the back-end, including Oracle,
44
PostgreSQL and SQL Server (limited).  The server supports XML document
45
storage, retrieval, query, validation, and transformation (using the XSLT
46
stylesheet language).  In addition, there is a mechanism for replicating the
47
database to other metacat instances for backup and load balancing purposes.
48
Metacat currently uses an LDAP database for authenticating users, but was
49
written to accomodate other authentication services as well.
50

    
51
Installation
52
------------
53
See the file "docs/install.html" for detailed instructions
54
for your OS.
55

    
56
Release Notes for 2.0.5:
57
------------------------
58
This patch release focuses on Metacat support for Oracle
59
*SystemMetadata table names have been shortened to comply with Oracle limits.
60
*SANParks/SAEON spatial zip file download fixed
61
*Pathquery performance fix
62

    
63
Release Notes for 2.0.4:
64
------------------------
65
This patch release focuses on Metacat-Metacat replication.
66
*Allows Metacat to stream replication update information between servers to avoid connection timeout issues
67
*Allows Metacat replication when source host does not provide SystemMetadata (DataONE)
68
*Fixes an access control issue that could allow search results to include protected documents
69

    
70
Release Notes for 2.0.3:
71
------------------------
72
This is another critical patch release of Metacat 2.0.
73
*Addresses a bug that prevented Metacat replication from completing (timeout error)
74
*Uses more efficient SystemMetadata synchronization using shared Hazelcast map
75

    
76
Release Notes for 2.0.2:
77
------------------------
78
This is a critical patch release of Metacat 2.0.
79
*Addresses a bug that prevented updates to DataONE identified datapackages (e.g., using DOIs)
80
*Addresses a bug that prevented the use of the Metacat API 'getaccesscontrol' action
81
*Updates the Foresite ORE library to correctly serialize resource map documents
82

    
83
Release Notes for 2.0.1:
84
------------------------
85
This is a minor patch release of Metacat 2.0. Please see the previous release notes for complete information.
86
*Addresses an identifier issue during ORE generation for DataONE services
87
*Increases compatibility with older EML content and the Xalan XSLT processor
88
*Removes XSLT 2.0 support (Saxon)
89

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

    
106

    
107
Release Notes for 1.9.5:
108
------------------------
109
This release fixes those bugs:
110
*Metacat could not download the included schemas in an external schema file during inserting.
111
*Workflow scheduler could not work since the metadata standard of kepler kar file was changed. 
112
*Earthgrid could not transform the Earthgrid query with concept "/" to the Metacat path query correctly.
113
*Document access rules are now preserved when documents are archived during the 'delete' action.
114

    
115
Release Notes for 1.9.4:
116
------------------------
117
This release fixes bugs in the FGDC data package upload and download interface utilized
118
by the SANParks and SAEON skins.
119

    
120
Release Notes for 1.9.3:
121
------------------------
122
This release fixes a harvester bug that prevented the EML harvester from processing
123
harvest lists.
124
The Kepler skin has been updated to support KarXML 2.1.
125
Ecogrid query services now support multiple namespace searches.
126

    
127
Release Notes for 1.9.2:
128
------------------------
129
This release primarily holds the addition of the Threshold of Potential
130
Concern workflow functionality (TPC).  The following issues were addressed:
131

    
132
* Create a properties file for use by JUnit Tests (Bug 2994)
133
* security issue with skins (Bug 3368)
134
* reorganize classes into a more functional specific structure (Bug 3510)
135
* Add admin names as dropdown in configuration login (Bug 3729)
136
* KNB metacat replication error log file is empty (Bug 3885)
137
* Create TPC Report web browse/search pages (Bug 4165)
138
* Create archive extraction functionality (Bug 4166)
139
* Create Workflow Scheduler (Bug 4167)
140
* metacat didn't update xml_path_index table while a document was updated (Bug 4367)
141
* Enforce permissions for tpc workflow viewing and scheduling (Bug 4420)
142
* Fix cross platform TPC GUI issues (Bug 4556)
143
* TPC Sanparks page content lenth issue (Bug 4557)
144
* Create validate and isAuthorized unit tests (Bug 4558)
145
* Cannot insert replication server via gui (Bug 4594)
146
* Timed Replication takes many hours and drives the load up on KNB (Bug 4616)
147
* [ESA] Update fails when document rev number is missing (Bug 4627)
148
* fails to catch some insert and update failures (Bug 4637)
149
* must support java 1.6 (Bug 4641)
150
* Convert build to pull eml from svn instead of cvs (Bug 4644)
151
* handleGetRevisionAndDocTypeAction should search both xml_documents and xml_revisions table (Bug 4645)
152
* Metacat couldn't update a document from client, which previous versions only stay in xml_revisions table (Bug 4649)
153
* metacat runs out of memory (Bug 4658)
154
* ESA skin links are hard coded to data.esa.org (Bug 4698)
155
* Update release 1.9.2 release notes (Bug 4707)
156
* Handle writing a text node > 4000 characters to the db. (Bug 4708)
157
* Metacat should run against Tomcat 6 (Bug 4716)
158

    
159
Release Notes for 1.9.1:
160
------------------------
161
The 1.9.1 release holds the bug fixes found after releasing 1.9.0 beta.  
162
These bugs were primarily replication issues.  There is no difference 
163
in functionality between 1.9.0 and 1.9.1 
164

    
165
Release Notes for 1.9.0:
166
------------------------
167
This release focuses on simplifying the Metacat installation process by 
168
creating a binary (war) installation.  The need to build the application
169
on the server has been removed (although the option is still available).
170
In order to facilitate this method of installation, a few major modifications
171
were made to the code:
172

    
173
  -- Ant token replacement was removed for all non-build variables in the 
174
     application (most of this was already done in 1.8.1).
175

    
176
  -- The Metacat properties confguration was moved into the application
177
     itself.
178

    
179
  -- Database schema version detection and install/upgrade utilities were 
180
     added to the application.
181

    
182
Also, this release includes several enhancements:
183
  -- it supports the new EML 2.1.0 version.  
184

    
185
  -- Documents are now stored on the local filesystem as well as in the 
186
     database in order to preserve document integrity.
187
     
188
  -- Metacat verifies new schemas when they are added.
189

    
190
  -- Additional access is propegated with documents during replication.
191

    
192
High priority bugs were addressed in this release as well.
193

    
194
The enhancements/bugs addressed are:
195

    
196
* escaped "less than" in inlinedata causes invalid eml output (Bug 2564)
197
* need to set filename for download files (Bug 2566)
198
* add ability for search engines to index metacat documents (Bug 2826)
199
* EML citation section should include both organizationNames and individualNames (Bug 3059)
200
* refactor skins to get organization list from metacat getOrganizations() function (Bug 3114)
201
* Update dataknp.sanparks.org packageId attributes to match Metacat Ids (Bug 3258)
202
* New documents explicitly set as public access don't show up correctly (Bug 3262)
203
* Modify confguration utility in metacat (Bug 3371)
204
* Integrate perl token replacement changes (Bug 3372)
205
* Create skin specific configuration utility (Bug 3373)
206
* Add authentication for configuration utility (Bug 3374)
207
* Create a sorted properties utility (Bug 3375)
208
* Add DB upgrade/install functionality to java code (Bug 3376)
209
* Create ANT install target for developers (Bug 3377)
210
* Create LSID server installation (Bug 3380)
211
* Create unit test code for 1.9 additions (Bug 3381)
212
* create simple turnkey installer for metacat Phase I (Bug 3461)
213
* Maps do not display in Firefox version 3 (Bug 3462)
214
* Replicate access rules in replication (Bug 3464)
215
* Metacat casesensitive="true" option in pathquery expressions is broken (Bug 3472)
216
* Add full schema checking when metacat register new schema (Bug 3474)
217
* Incorporate EML 2.1.0 access changes in metacat (Bug 3495)
218
* getprincipals action returns invalid XML document (Bug 3527)
219
* Update knbweb to serve new metacat install (Bug 3545)
220
* Replication should write to disk (Bug 3554)
221
* Update acknowlegements in metacat readme (Bug 3588)
222
* Validate the ldap administrator field. (Bug 3616)
223
* Allow for different authentication services in metacat configuration (Bug 3680)
224
* Tag utilities module and have metacat check out that tag (Bug 3685)
225

    
226
Release Notes for 1.8.1:
227
------------------------
228
This release focuses on bug fixes. In this release, the problem that Metacat 1.8.0 and previous 
229
versions use illegitimate EML 2.0.1 schemas is addressed: first, Metacat 1.8.1 comes with
230
legitimate EML 2.0.1 schemas; second, existing invalid EML 2.0.1 documents will be 
231
automatically fixed while maintaining their package ID during the Metacat 1.8.1 upgrading process. 
232
Details please see:
233
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3239
234
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=3241
235

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

    
241
The fixed bugs include:
242

    
243
*Character set (charset) problem when filling out form (Bug2797)
244
*Charset bug: > "less than" symbol does not display correctly (Bug2517)
245
*Metacat performance issue in Sanparks skin (Bug 3174)
246
*Metacat using illegitimate versions of EML schema (Bug 3239)
247
*Update older invalidated eml201 document in Metacat (Bug 3241)
248
*Verify existing token changes to skins (Bug 3176)
249
*The edit feature in the NCEAS Data Repoistory does not work (Bug 2644)
250
*Expose permission options for registry uploads (Bug 3014)
251
*ESA registry doesn't have LTER in login dropdown menu (Bug 2647)
252
*Data Catalog Map is slow when selecting (Bug2732)
253
*Only one attribute per element returned with pathquery results(Bug 2999)
254
*The field "skinconfigs" in the MetacatUtil class is public (Bug 3057)
255
*Generalize the reading of skin.configs in DBTransform (Bug3058)
256
*The query example in metacatquery.html document need to be changed (Bug3137)
257
*Add upload method into Metacat tour (Bug 3139)
258
*Query resultset doesn't show component name in kepler skin (Bug 3178)
259
*Add fields used in Morpho search to the default indexPaths property (Bug 3259)
260
*Private data cannot be downloaded from metadata display page (xsl) (Bug 3263)
261
*An error message happen during the metacat start up (Bug 3279)
262
*Replication: Timed replication failures occur twice instead of once (Bug 3304)
263
*Inline Data does not work correctly without the <pre> tag (Bug 3088)
264
*Include FGDC metadata in KNB and NCEAS skin search results (Bug 3146)
265

    
266
Release Notes for 1.8.0:
267
------------------------
268
This release focuses on improving query performance.  Both the selection 
269
and access control queries were rewritten to execute efficiently.
270
To improve search performance, a query caching mechanism was introduced. 
271
Cached queries are currently supported only for public users.
272

    
273
New Features:
274
* Data registries now support uploading of data objects along with data 
275
  packages (Bug 1982)
276
  
277
Bug Fixes:
278
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
279
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
280
* Query cache mechanism (Bug 2905)
281
* Metacat Performance: updates from Morpho of data packages are taking 
282
   longer than five minutes (Bug 2805)
283
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
284
* Metacat Performace: Upgrading hardware setup (Bug 2175)
285
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
286
* Display of metadata documents reorganized, including a new citation format,
287
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
288
* I.E. display fixes on default skin (Bug 2579)
289
* Web Address links fixed (Bug 2147)
290
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
291
* Spatial query:  data packages must be fully contained by the selection 
292
  bounding box in order to appear in the search results (Bugs 2972, 2732).
293
* FGDC support: upload, delete, update, access control, and download
294
  (Bugs 2807, 2925, 2926, 2929, 2030).
295
Compatibility Notices:
296
* Tomcat 3 and 4 are no longer tested or supported. Users are 
297
  highly encouraged to upgrade to Tomcat 5.5
298

    
299
Release Notes for 1.7.0:
300
------------------------
301
This release features only a few minor changes to the core Metacat engine. 
302
The major focus of this release is the addition of the spatial functionality.
303
The geographic coverage of metadata documents can now be cached in a GIS-
304
accessible format and published via web mapping services and an online
305
interactive map. 
306

    
307
New Features:
308
* Three new open source libraries have been integrated with Metacat:
309
  - Geoserver:  A standards-compliant web map server to publish
310
                geographic data to the web.
311
               (http://docs.codehaus.org/display/GEOS/Home)
312
  - GeoTools:   A java-based GIS toolkit to programatically
313
                manipulate spatial datasets.
314
                (http://geotools.codehaus.org/)
315
  - Mapbuilder: A javascript application to provide an interactive
316
                web map front-end to Geoserver.
317
                (http://docs.codehaus.org/display/MAP/Home)
318
* Spatial Caching/Indexing mechanism; documents with geographic
319
  coverages will be added to the spatial cache.
320
* Spatial Query action in metacat servlet. 
321
* Interactive Web map to visualize and query the spatial 
322
  distribution of metadata documents.
323
* Experimental python, ruby and php client libraries to interface with metacat.
324
* Preliminary process in place for web based configuration of metacat.
325

    
326
Compatibility Notices:
327
* Tomcat 3 and 4 are no longer tested or supported. Users are 
328
  highly encouraged to upgrade to Tomcat 5.5
329

    
330
Bug Fixes:
331
* Metacat administrators are able to modify and delete documents 
332
  created by other users.
333
* Fixed problems with indexing XML attributes, see bug 2469
334

    
335

    
336
Release Notes for 1.6.0:
337
------------------------
338

    
339
This release comes with more performance improvements, initial support for 
340
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
341
Metacat administrators and bug fixes. Below is the list of bug fixes and
342
performance improvements.
343

    
344
Bug Fixes: 
345
* Improved the indexing algorithm. Earlier indexing failed for some documents 
346
  randomly and used to take a lot of time to complete for others. The 
347
  code for indexing was changed to take care of both these problems.
348
* Earlier, xmlns prefix was used to determine the namespace of the document. 
349
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
350
  of the document as that is a better indicator of document type. 
351
* INSTR was used in some SQL statements and it is not supported by Postgres. 
352
  So SQL statements were modified so that INSTR is not used.
353
* Replication was changed to include replication of deleted documents also.
354
* Fixed bug in squery which didnt allow use of not-contains 
355

    
356
New Features:
357
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
358
* Added support for LSID. This includes modifying the stylesheets to 
359
  display the LSIDs, modifying the build to include a new target 
360
  'install-ldap'.
361
* Added following access control levels to Metacat:
362
    1. Administrators - users who can do the following:
363
       a. Run replication
364
       b. Delete any document
365
       c. Modify any document
366
       d. run indexing for any document
367
       e. check the logs
368
    2. allowedUsers - User who are allowed to submit
369
    3. deniedUsers - Users not allowed to submit
370
* Added a new skin for Ecological Society of America. 
371
* Created an Advanced search servlet which can be used from the web. 
372
* Various connections have been modified to be secure. e.g. connection between 
373
ldaps is made secure now, replication is done over secure channels.  
374

    
375
Performance:
376
* Reduced size of xml_nodes by creating a new table for holding nodes from 
377
  deleted documents and old revisions of the documents. 
378
* Provided a new variable in metacat.properties where more frequently searched 
379
  for paths can be specified. Seperate indexes are created for these paths 
380
  - so that search is faster.
381
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
382

    
383
Release Notes for 1.5.0:
384
------------------------
385

    
386
This release comes with performace improvement, user interface enhancements,
387
and bug fixes. Below is the list of bug fixes and performance improvements. 
388

    
389
Bug Fixes:
390
* Modify property values of harvester registration servlets to match the
391
  servlet-mapping URL values in web.xml. The old values used the servlet
392
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
393
  Windows. The new values use the servlet-mapping URL values. This should
394
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
395
* Re-implement logic to prune old log entries from the HARVEST_LOG and
396
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
397
  violations in the database because it tried to delete parent records from
398
  HARVEST_LOG prior to deleting child records from
399
  HARVEST_DETAIL_LOG. (Bug 162)
400
* In data registry, minor bugs fixed like the error page shows the link back
401
  to the form when error page was generated because of a document read
402
  request from search results page,  the successful delete button leading
403
  to a blank screen and the old ACL overwritten by the registry.
404
  (Bugs 1307, 1310, 1322, 1344, 1551)
405
* Changed the code to support insertion of following characters: ', `,
406
  charcters in the Numeric Character Reference format (&#xyz;) and
407
  characters like µ. Characters like µ will be converted to and stored in
408
  Numeric Character Reference format(&#xyz;). They will also be returned
409
  in Numeric Character Reference and it is upto the client to convert them
410
  and display them accordingly in the application. Partial fix provided by
411
  Johnoel Ancheta. (Bug 1538,1711)
412
* Spatial search failed on Oracle because of invalid entries made by
413
  some documents in the nodedata column of xml_nodes for paths involving
414
  'eastBoundingCoordinate', 'westBoundingCoordinate',
415
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
416
  nodedatanumerical was added to xml_nodes table such that all the numerical
417
  nodedata is stored in this column and this column is now used for spatial
418
  search. (Bug 1703, 1718)
419
* In the default skin, clicking on the keywords on the home page did not
420
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
421
* Metacat generated a success message even when a document which didnt
422
  exsist was requested for deletion. This has been fixed. (Bug 1850)
423
* "packagetype" in xml-relation table was entered as eml200 namespace when
424
  an eml201 document was inserted. This is fixed now so that "packagetype"
425
  in xml-relation table points to eml201 namespace. (Bug 1979)
426
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
427
  earlier. Fixed such that it points to the locally installed metacat url. 
428
  (Bug 1986)
429
* Changes to the Query subsystem fix bugs that prevented attributes from 
430
  being expressed solely in the xpath query statement and the returnfield 
431
  values. For instance, a query URL may now include search strings like 
432
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
433
  Previously, the attribute had to be appended to an element: 
434
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
435
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
436
* Search query failed in case of Oracle if number of documents in the result
437
  were more than 1000. This has been fixed. (Bug 2000)
438
* Removed any occurence of enum which is now a keyword in Java 1.5
439

    
440

    
441
Enhancements:
442
* Major improvements done in user interface for the data registeries and
443
  various other skins. Improvements done based on suggestions from Mark
444
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
445
  the default skin and ldap templates. (Bug 1948)
446
* Coded added such that administrator can delete documents irrespective of
447
  who the document belongs to.
448
* Performance impovement done in searching of datasets. A part of the search
449
  time was taken up because of generation of resultset after the search had be
450
  done. So this was the sequence of events in earlier metacat
451
  1) Search for the given text
452
  2) A list of docids generated
453
  3) For each of the docids
454
     3a) Use xml_index and xml_nodes table to generate the string descibing
455
         the document including the returnfields requested in the search
456
  4) Add all the strings from step 3a to send back the resultant
457
     document. Here a decent amount of time was being taken by step 3a. 
458
  The algorithm is now modified by addition of two tables xml_queryresult and
459
  xml_returnfields and a user defined parameter xml_returnfield_count. The
460
  new algorithm works as follows:
461
  1) Search for the given text
462
  2) A list of docids is generated
463
  3) For the given set of return fields generate a unique string and check
464
     if that string exists in xml_returnfields
465
     3a) If string does not exist in xml_returnfield, then enter a new
466
         record usage_count as 1 and returnfield_string as the unique string
467
         generated above.
468
     3b) Else if the string exists, increment usage_count
469
  4) Given the docids from step 2 and the id of the returnfield record from
470
     step 3, query for any docids that already exist in xml_queryresult.
471
     For the docids that do exist, get the queryresult_string.
472
  5) For rest of the docids from step2 which were not found in step 4, do
473
     the following for each of the documents:
474
     5a) Use xml_index and xml_nodes table to generate the string descibing
475
         the document including the returnfields requested in the search
476
     5b) If usage_count of the record from step is more than
477
         xml_returnfield_count set in metacat.properties, then store the
478
         string in xml_queryresult as a record which has the returnfield_id
479
         representing the set of returnfields, docid representing the
480
         document and the string as queryresult_string.
481
  6) Add all the strings from step 4 and step 5a to send back the resultant
482
     document
483
  So the results from step 3a in previous algorithm are effectively cached
484
  and hence same computation is not done again and again for each search.
485
  When a document is deleted, all the entries for that document in
486
  xml_queryresult table are also deleted. When a document is updated, all
487
  the entries for that document in xml_queryresult table are deleted. This
488
  works fine because those entries will be generated and cached again the
489
  next time the document is part of a search is requested.
490
* Performance impovement done for % search.
491
* Following new functions added to metacat client API: a method to set access
492
  on an xml document and a method to get newest version for a given document.
493
* Implement a new HarvesterServlet for running Harvester as a servlet. This
494
  eliminates the need to run Harvester in a terminal window. By default, the
495
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
496
  documentation will be modified to instruct Harvester administrators to
497
  uncomment the HarvesterServlet entry.
498
* Minor enhancement to support multiple email addresses for harvester
499
  administrator and site contact. Each address is separated by a comma or
500
  semicolon.
501
* Increase number of rows in Harvest List Editor from 300 to 1200.
502
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
503
  value when it is set to 0 or a negative number. This allows Harvester to
504
  run indefinitely without shutting down after reaching a maximum number of
505
  harvests. The previous default value of 30 would cause Harvester to
506
  terminate after 30 harvests.
507

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

    
511

    
512
Release Notes for 1.4.0:
513
------------------------
514

    
515
This is a major release, and is the first to introduce many new features to
516
Metacat.  Some of the major new features in this version of Metacat include:
517

    
518
* Added a new 'Harvester' that allows documents to be periodically pulled
519
  from distributed sources into metacat, useful for interfacing with other
520
  system types. See the Metacat Tour for details.
521
* Added new 'skins' capability to allow the GUI for the metacat web interface
522
  to be more easily customized to fit into site needs.  The skin is based on
523
  a flexible mix of XSLT, CSS, and Javascript.
524
* Added a web-based metadata entry form for submitting limited EML documents
525
  as part of a data registry.  The GUI for the registry is customizable and 
526
  is integrated with the 'skins' system for the main metacat interface.  The
527
  registry subsystem is written in Perl, and can simultaneously be used to 
528
  present multiple 'registry' interfaces.
529
* A new 'client API' has been developed and implemented in Java and in Perl 
530
  so that metacat functions can be accessed from any program in those
531
  languages.  The client API supports the major metacat servlet actions,
532
  including login(), logout(), query(), insert(), update(), delete(), and 
533
  upload(). See the Metacat Tour for details.
534
* Added a new 'getlog' action that produces a usage history for all major
535
  events.  So now an XML report can be generated for document reads, inserts,
536
  deletes, etc.  See the new section in the Metacat Tour.
537
* Added a new 'buildindex' action that can rebuild the index entries for any
538
  document in the database.
539
* The configuration file for metacat (metacat.properties) has been moved out
540
  of the jar file and into the WEB-INF directory, allowing far easier changes
541
  to the configuration parameters.
542
* Results in default web interface are sorted by title in the XSLT 
543
  (configurable)
544
* Many bugs were fixed.
545

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

    
549
Release Notes for 1.3.1:
550
------------------------
551

    
552
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
553
include:
554
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
555
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
556
    and Java 1.4.
557
 2) Distribution package size was reduced.
558

    
559

    
560
Release Notes for 1.3.0
561
------------------------
562

    
563
In 1.3.0 release, the structure of the xml_access table was changed and a new
564
table, xml_accesssubtree was added. If you try to update a previously 
565
installed Metacat, you should run a script file to updated the table structure 
566
before installation.
567
For Oracle user: At the SQLPLUS prompt type the following -
568
@src/reviseformetacat13.sql
569
For Postgresql user: At install directory prompt type the following -
570
psql exp < src/reviseformetacat13_postgres.sql
571
(where 'exp' is the database name).
572

    
573
After installation, user should run "ant schemasql" command to register EML2
574
schema in xml_catalog table.
575

    
576
If you are a new Metacat user, this step is unneeded.
577

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

    
584
New Features in 1.3.0
585
  1) Partialy support EML2 document. User can store, query, read and write
586
     EML2 documents. However, Metacat only support access control in resource
587
     level. The subtree level access control will be ignored.
588
  2) Support other xml document base on namespace/schema.
589
  3) Support query for attribute value
590
  4) Assign MIME type to data file base on metadata when user try to read it.
591
  5) Owner can assign access rules to a document which does not have access 
592
     document to apply it.
593
  6) Support exporting single file, not only whole package
594
  7) Resupport Microsoft SQL Server.
595

    
596
Fixes in 1.3.0:
597
  1) Couldn't finish delta T replication for large set of documents.
598
  2) Couldn't create access control during delta T replication.
599
  3) Eorr will be written to a seperated log file if some documents
600
     were failed in replication.
601
  4) Decrease the time to create access rules during insert or update 
602
     a package.
603
     
604
Documentation
605
-------------
606
See the docs directory for detailed documentation and installation
607
instructions.
608

    
609
Details of the Metacat architecture can be found on the website for
610
the Knowledge Network for Biocomplexity (KNB):
611

    
612
  http://knb.ecoinformatics.org/software/metacat/
613

    
614
Contributions to this work are welcome.  Please see the above web site
615
for details on how to contribute.
616

    
617
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
618
-----------------------------------------------------------------------------
619
If you discover a bug please report it, either by email (above) or by using
620
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
621
list of currently unimplemented features in Bugzilla that we are working on
622
for the next release.
623

    
624
Legalese
625
--------
626
This software is copyrighted by The Regents of the University of California
627
and the National Center for Ecological Analysis and Synthesis
628
and licensed under the GNU GPL; see the 'LICENSE' file for
629
details.
630

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

    
637
This software is partially supported by a grant from the Andrew W. 
638
Mellon Foundation.
639

    
640
This product includes software developed by the Apache Software
641
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
642
for details.
643

    
644
The source code, object code, and documentation in the com.oreilly.servlet
645
package is copyright and owned by Jason Hunter. See the cos-license.html file
646
for details of the license.  Licensor retains title to and ownership of the
647
Software and all enhancements, modifications, and updates to the Software.
648

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