Project

General

Profile

1
#
2
#  '$RCSfile$'
3
#   '$Author: tao $'
4
# '$Revision: 3621 $'
5
#     '$Date: 2007-11-27 17:50:31 -0800 (Tue, 27 Nov 2007) $'
6
#
7

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

    
11
Version: 1.8.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
              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

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

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

    
50
Installation
51
------------
52
See the file "docs/user/metacatinstall.html" for detailed instructions.
53

    
54
Release Notes for 1.8.0:
55
------------------------
56
This release focuses on improving query performance.  Both the selection 
57
and access control queries were rewritten to execute efficiently.
58
To improve search performance, a query caching mechanism was introduced. 
59
Cached queries are currently supported only for public users.
60

    
61
New Features:
62
* Data registries now support uploading of data objects along with data 
63
  packages (Bug 1982)
64
  
65
Bug Fixes:
66
* Metacat Performace: Rewrite the xml_nodes queries (Bug 2155)
67
* Metacat Performace: Rewrite the xml_access part of the query (Bug 2557)
68
* Query cache mechanism (Bug 2905)
69
* Metacat Performance: updates from Morpho of data packages are taking 
70
   longer than five minutes (Bug 2805)
71
* Metacat Performance: Optimize Postgres and Tomcat (Bug 2157)
72
* Metacat Performace: Upgrading hardware setup (Bug 2175)
73
* Metacat Performace: Add/drop indices on key columns (Bug 2153)
74
* Display of metadata documents reorganized, including a new citation format,
75
  obvious download options, and a redesigned data table layout (Bugs 2981, 2832)
76
* I.E. display fixes on default skin (Bug 2579)
77
* Web Address links fixed (Bug 2147)
78
* NCEAS skin redesigned to use IFRAME-less layout, match new website.
79
* Spatial query:  data packages must be fully contained by the selection 
80
  bounding box in order to appear in the search results (Bugs 2972, 2732).
81

    
82
Compatibility Notices:
83
* Tomcat 3 and 4 are no longer tested or supported. Users are 
84
  highly encouraged to upgrade to Tomcat 5.5
85

    
86
Release Notes for 1.7.0:
87
------------------------
88
This release features only a few minor changes to the core Metacat engine. 
89
The major focus of this release is the addition of the spatial functionality.
90
The geographic coverage of metadata documents can now be cached in a GIS-
91
accessible format and published via web mapping services and an online
92
interactive map. 
93

    
94
New Features:
95
* Three new open source libraries have been integrated with Metacat:
96
  - Geoserver:  A standards-compliant web map server to publish
97
                geographic data to the web.
98
               (http://docs.codehaus.org/display/GEOS/Home)
99
  - GeoTools:   A java-based GIS toolkit to programatically
100
                manipulate spatial datasets.
101
                (http://geotools.codehaus.org/)
102
  - Mapbuilder: A javascript application to provide an interactive
103
                web map front-end to Geoserver.
104
                (http://docs.codehaus.org/display/MAP/Home)
105
* Spatial Caching/Indexing mechanism; documents with geographic
106
  coverages will be added to the spatial cache.
107
* Spatial Query action in metacat servlet. 
108
* Interactive Web map to visualize and query the spatial 
109
  distribution of metadata documents.
110
* Experimental python, ruby and php client libraries to interface with metacat.
111
* Preliminary process in place for web based configuration of metacat.
112

    
113
Compatibility Notices:
114
* Tomcat 3 and 4 are no longer tested or supported. Users are 
115
  highly encouraged to upgrade to Tomcat 5.5
116

    
117
Bug Fixes:
118
* Metacat administrators are able to modify and delete documents 
119
  created by other users.
120
* Fixed problems with indexing XML attributes, see bug 2469
121

    
122

    
123
Release Notes for 1.6.0:
124
------------------------
125

    
126
This release comes with more performance improvements, initial support for 
127
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
128
Metacat administrators and bug fixes. Below is the list of bug fixes and
129
performance improvements.
130

    
131
Bug Fixes: 
132
* Improved the indexing algorithm. Earlier indexing failed for some documents 
133
  randomly and used to take a lot of time to complete for others. The 
134
  code for indexing was changed to take care of both these problems.
135
* Earlier, xmlns prefix was used to determine the namespace of the document. 
136
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
137
  of the document as that is a better indicator of document type. 
138
* INSTR was used in some SQL statements and it is not supported by Postgres. 
139
  So SQL statements were modified so that INSTR is not used.
140
* Replication was changed to include replication of deleted documents also.
141
* Fixed bug in squery which didnt allow use of not-contains 
142

    
143
New Features:
144
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
145
* Added support for LSID. This includes modifying the stylesheets to 
146
  display the LSIDs, modifying the build to include a new target 
147
  'install-ldap'.
148
* Added following access control levels to Metacat:
149
    1. Administrators - users who can do the following:
150
       a. Run replication
151
       b. Delete any document
152
       c. Modify any document
153
       d. run indexing for any document
154
       e. check the logs
155
    2. allowedUsers - User who are allowed to submit
156
    3. deniedUsers - Users not allowed to submit
157
* Added a new skin for Ecological Society of America. 
158
* Created an Advanced search servlet which can be used from the web. 
159
* Various connections have been modified to be secure. e.g. connection between 
160
ldaps is made secure now, replication is done over secure channels.  
161

    
162
Performance:
163
* Reduced size of xml_nodes by creating a new table for holding nodes from 
164
  deleted documents and old revisions of the documents. 
165
* Provided a new variable in metacat.properties where more frequently searched 
166
  for paths can be specified. Seperate indexes are created for these paths 
167
  - so that search is faster.
168
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
169

    
170
Release Notes for 1.5.0:
171
------------------------
172

    
173
This release comes with performace improvement, user interface enhancements,
174
and bug fixes. Below is the list of bug fixes and performance improvements. 
175

    
176
Bug Fixes:
177
* Modify property values of harvester registration servlets to match the
178
  servlet-mapping URL values in web.xml. The old values used the servlet
179
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
180
  Windows. The new values use the servlet-mapping URL values. This should
181
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
182
* Re-implement logic to prune old log entries from the HARVEST_LOG and
183
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
184
  violations in the database because it tried to delete parent records from
185
  HARVEST_LOG prior to deleting child records from
186
  HARVEST_DETAIL_LOG. (Bug 162)
187
* In data registry, minor bugs fixed like the error page shows the link back
188
  to the form when error page was generated because of a document read
189
  request from search results page,  the successful delete button leading
190
  to a blank screen and the old ACL overwritten by the registry.
191
  (Bugs 1307, 1310, 1322, 1344, 1551)
192
* Changed the code to support insertion of following characters: ', `,
193
  charcters in the Numeric Character Reference format (&#xyz;) and
194
  characters like µ. Characters like µ will be converted to and stored in
195
  Numeric Character Reference format(&#xyz;). They will also be returned
196
  in Numeric Character Reference and it is upto the client to convert them
197
  and display them accordingly in the application. Partial fix provided by
198
  Johnoel Ancheta. (Bug 1538,1711)
199
* Spatial search failed on Oracle because of invalid entries made by
200
  some documents in the nodedata column of xml_nodes for paths involving
201
  'eastBoundingCoordinate', 'westBoundingCoordinate',
202
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
203
  nodedatanumerical was added to xml_nodes table such that all the numerical
204
  nodedata is stored in this column and this column is now used for spatial
205
  search. (Bug 1703, 1718)
206
* In the default skin, clicking on the keywords on the home page did not
207
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
208
* Metacat generated a success message even when a document which didnt
209
  exsist was requested for deletion. This has been fixed. (Bug 1850)
210
* "packagetype" in xml-relation table was entered as eml200 namespace when
211
  an eml201 document was inserted. This is fixed now so that "packagetype"
212
  in xml-relation table points to eml201 namespace. (Bug 1979)
213
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
214
  earlier. Fixed such that it points to the locally installed metacat url. 
215
  (Bug 1986)
216
* Changes to the Query subsystem fix bugs that prevented attributes from 
217
  being expressed solely in the xpath query statement and the returnfield 
218
  values. For instance, a query URL may now include search strings like 
219
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
220
  Previously, the attribute had to be appended to an element: 
221
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java, 
222
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
223
* Search query failed in case of Oracle if number of documents in the result
224
  were more than 1000. This has been fixed. (Bug 2000)
225
* Removed any occurence of enum which is now a keyword in Java 1.5
226

    
227

    
228
Enhancements:
229
* Major improvements done in user interface for the data registeries and
230
  various other skins. Improvements done based on suggestions from Mark
231
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
232
  the default skin and ldap templates. (Bug 1948)
233
* Coded added such that administrator can delete documents irrespective of
234
  who the document belongs to.
235
* Performance impovement done in searching of datasets. A part of the search
236
  time was taken up because of generation of resultset after the search had be
237
  done. So this was the sequence of events in earlier metacat
238
  1) Search for the given text
239
  2) A list of docids generated
240
  3) For each of the docids
241
     3a) Use xml_index and xml_nodes table to generate the string descibing
242
         the document including the returnfields requested in the search
243
  4) Add all the strings from step 3a to send back the resultant
244
     document. Here a decent amount of time was being taken by step 3a. 
245
  The algorithm is now modified by addition of two tables xml_queryresult and
246
  xml_returnfields and a user defined parameter xml_returnfield_count. The
247
  new algorithm works as follows:
248
  1) Search for the given text
249
  2) A list of docids is generated
250
  3) For the given set of return fields generate a unique string and check
251
     if that string exists in xml_returnfields
252
     3a) If string does not exist in xml_returnfield, then enter a new
253
         record usage_count as 1 and returnfield_string as the unique string
254
         generated above.
255
     3b) Else if the string exists, increment usage_count
256
  4) Given the docids from step 2 and the id of the returnfield record from
257
     step 3, query for any docids that already exist in xml_queryresult.
258
     For the docids that do exist, get the queryresult_string.
259
  5) For rest of the docids from step2 which were not found in step 4, do
260
     the following for each of the documents:
261
     5a) Use xml_index and xml_nodes table to generate the string descibing
262
         the document including the returnfields requested in the search
263
     5b) If usage_count of the record from step is more than
264
         xml_returnfield_count set in metacat.properties, then store the
265
         string in xml_queryresult as a record which has the returnfield_id
266
         representing the set of returnfields, docid representing the
267
         document and the string as queryresult_string.
268
  6) Add all the strings from step 4 and step 5a to send back the resultant
269
     document
270
  So the results from step 3a in previous algorithm are effectively cached
271
  and hence same computation is not done again and again for each search.
272
  When a document is deleted, all the entries for that document in
273
  xml_queryresult table are also deleted. When a document is updated, all
274
  the entries for that document in xml_queryresult table are deleted. This
275
  works fine because those entries will be generated and cached again the
276
  next time the document is part of a search is requested.
277
* Performance impovement done for % search.
278
* Following new functions added to metacat client API: a method to set access
279
  on an xml document and a method to get newest version for a given document.
280
* Implement a new HarvesterServlet for running Harvester as a servlet. This
281
  eliminates the need to run Harvester in a terminal window. By default, the
282
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
283
  documentation will be modified to instruct Harvester administrators to
284
  uncomment the HarvesterServlet entry.
285
* Minor enhancement to support multiple email addresses for harvester
286
  administrator and site contact. Each address is separated by a comma or
287
  semicolon.
288
* Increase number of rows in Harvest List Editor from 300 to 1200.
289
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
290
  value when it is set to 0 or a negative number. This allows Harvester to
291
  run indefinitely without shutting down after reaching a maximum number of
292
  harvests. The previous default value of 30 would cause Harvester to
293
  terminate after 30 harvests.
294

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

    
298

    
299
Release Notes for 1.4.0:
300
------------------------
301

    
302
This is a major release, and is the first to introduce many new features to
303
Metacat.  Some of the major new features in this version of Metacat include:
304

    
305
* Added a new 'Harvester' that allows documents to be periodically pulled
306
  from distributed sources into metacat, useful for interfacing with other
307
  system types. See the Metacat Tour for details.
308
* Added new 'skins' capability to allow the GUI for the metacat web interface
309
  to be more easily customized to fit into site needs.  The skin is based on
310
  a flexible mix of XSLT, CSS, and Javascript.
311
* Added a web-based metadata entry form for submitting limited EML documents
312
  as part of a data registry.  The GUI for the registry is customizable and 
313
  is integrated with the 'skins' system for the main metacat interface.  The
314
  registry subsystem is written in Perl, and can simultaneously be used to 
315
  present multiple 'registry' interfaces.
316
* A new 'client API' has been developed and implemented in Java and in Perl 
317
  so that metacat functions can be accessed from any program in those
318
  languages.  The client API supports the major metacat servlet actions,
319
  including login(), logout(), query(), insert(), update(), delete(), and 
320
  upload(). See the Metacat Tour for details.
321
* Added a new 'getlog' action that produces a usage history for all major
322
  events.  So now an XML report can be generated for document reads, inserts,
323
  deletes, etc.  See the new section in the Metacat Tour.
324
* Added a new 'buildindex' action that can rebuild the index entries for any
325
  document in the database.
326
* The configuration file for metacat (metacat.properties) has been moved out
327
  of the jar file and into the WEB-INF directory, allowing far easier changes
328
  to the configuration parameters.
329
* Results in default web interface are sorted by title in the XSLT 
330
  (configurable)
331
* Many bugs were fixed.
332

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

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

    
339
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
340
include:
341
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
342
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
343
    and Java 1.4.
344
 2) Distribution package size was reduced.
345

    
346

    
347
Release Notes for 1.3.0
348
------------------------
349

    
350
In 1.3.0 release, the structure of the xml_access table was changed and a new
351
table, xml_accesssubtree was added. If you try to update a previously 
352
installed Metacat, you should run a script file to updated the table structure 
353
before installation.
354
For Oracle user: At the SQLPLUS prompt type the following -
355
@src/reviseformetacat13.sql
356
For Postgresql user: At install directory prompt type the following -
357
psql exp < src/reviseformetacat13_postgres.sql
358
(where 'exp' is the database name).
359

    
360
After installation, user should run "ant schemasql" command to register EML2
361
schema in xml_catalog table.
362

    
363
If you are a new Metacat user, this step is unneeded.
364

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

    
371
New Features in 1.3.0
372
  1) Partialy support EML2 document. User can store, query, read and write
373
     EML2 documents. However, Metacat only support access control in resource
374
     level. The subtree level access control will be ignored.
375
  2) Support other xml document base on namespace/schema.
376
  3) Support query for attribute value
377
  4) Assign MIME type to data file base on metadata when user try to read it.
378
  5) Owner can assign access rules to a document which does not have access 
379
     document to apply it.
380
  6) Support exporting single file, not only whole package
381
  7) Resupport Microsoft SQL Server.
382

    
383
Fixes in 1.3.0:
384
  1) Couldn't finish delta T replication for large set of documents.
385
  2) Couldn't create access control during delta T replication.
386
  3) Eorr will be written to a seperated log file if some documents
387
     were failed in replication.
388
  4) Decrease the time to create access rules during insert or update 
389
     a package.
390
     
391
Documentation
392
-------------
393
See the docs directory for detailed documentation and installation
394
instructions.
395

    
396
Details of the Metacat architecture can be found on the website for
397
the Knowledge Network for Biocomplexity (KNB):
398

    
399
  http://knb.ecoinformatics.org/software/metacat/
400

    
401
Contributions to this work are welcome.  Please see the above web site
402
for details on how to contribute.
403

    
404
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
405
-----------------------------------------------------------------------------
406
If you discover a bug please report it, either by email (above) or by using
407
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
408
list of currently unimplemented features in Bugzilla that we are working on
409
for the next release.
410

    
411
Legalese
412
--------
413
This software is copyrighted by The Regents of the University of California
414
and the National Center for Ecological Analysis and Synthesis
415
and licensed under the GNU GPL; see the 'LICENSE' file for
416
details.
417

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

    
424
This software is partially supported by a grant from the Andrew W. 
425
Mellon Foundation.
426

    
427
This product includes software developed by the Apache Software
428
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
429
for details.
430

    
431
The source code, object code, and documentation in the com.oreilly.servlet
432
package is copyright and owned by Jason Hunter. See the cos-license.html file
433
for details of the license.  Licensor retains title to and ownership of the
434
Software and all enhancements, modifications, and updates to the Software.
435

    
436
This software includes the JDBC driver for PostgreSQL.  See the 
437
postgresql-license.txt file for details.
(2-2/5)