Project

General

Profile

metacat / README @ 3273

1
#
2
#  '$RCSfile$'
3
#   '$Author: jones $'
4
# '$Revision: 3153 $'
5
#     '$Date: 2007-01-25 10:17:13 -0800 (Thu, 25 Jan 2007) $'
6
#
7

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

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

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

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

    
47
Installation
48
------------
49
See the file "docs/user/metacatinstall.html" for detailed instructions.
50

    
51
Release Notes for 1.7.0:
52
------------------------
53
This release features only a few minor changes to the core Metacat engine. 
54
The major focus of this release is the addition of the spatial functionality.
55
The geographic coverage of metadata documents can now be cached in a GIS-
56
accessible format and published via web mapping services and an online
57
interactive map. 
58

    
59
New Features:
60
* Three new open source libraries have been integrated with Metacat:
61
  - Geoserver:  A standards-compliant web map server to publish
62
                geographic data to the web.
63
                (http://docs.codehaus.org/display/GEOS/Home)
64
  - GeoTools:   A java-based GIS toolkit to programatically
65
                manipulate spatial datasets.
66
                (http://geotools.codehaus.org/)
67
  - Mapbuilder: A javascript application to provide an interactive
68
                web map front-end to Geoserver.
69
                (http://docs.codehaus.org/display/MAP/Home)
70
* Spatial Caching/Indexing mechanism; documents with geographic
71
  coverages will be added to the spatial cache.
72
* Spatial Query action in metacat servlet. 
73
* Interactive Web map to visualize and query the spatial 
74
  distribution of metadata documents.
75
* Experimental python, ruby and php client libraries to interface with metacat.
76
* Preliminary process in place for web based configuration of metacat.
77

    
78
Compatibility Notices:
79
* Tomcat 3 and 4 are no longer tested or supported. Users are 
80
  highly encouraged to upgrade to Tomcat 5.5
81

    
82
Bug Fixes:
83
* Metacat administrators are able to modify and delete documents 
84
  created by other users.
85
* Fixed problems with indexing XML attributes, see bug 2469
86

    
87

    
88
Release Notes for 1.6.0:
89
------------------------
90

    
91
This release comes with more performance improvements, initial support for 
92
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for 
93
Metacat administrators and bug fixes. Below is the list of bug fixes and
94
performance improvements.
95

    
96
Bug Fixes: 
97
* Improved the indexing algorithm. Earlier indexing failed for some documents 
98
  randomly and used to take a lot of time to complete for others. The 
99
  code for indexing was changed to take care of both these problems.
100
* Earlier, xmlns prefix was used to determine the namespace of the document. 
101
  Now schemaLocation is used instead xmlns prefix to determine the namespace 
102
  of the document as that is a better indicator of document type. 
103
* INSTR was used in some SQL statements and it is not supported by Postgres. 
104
  So SQL statements were modified so that INSTR is not used.
105
* Replication was changed to include replication of deleted documents also.
106
* Fixed bug in squery which didnt allow use of not-contains 
107

    
108
New Features:
109
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
110
* Added support for LSID. This includes modifying the stylesheets to 
111
  display the LSIDs, modifying the build to include a new target 
112
  'install-ldap'.
113
* Added following access control levels to Metacat:
114
    1. Administrators - users who can do the following:
115
       a. Run replication
116
       b. Delete any document
117
       c. Modify any document
118
       d. run indexing for any document
119
       e. check the logs
120
    2. allowedUsers - User who are allowed to submit
121
    3. deniedUsers - Users not allowed to submit
122
* Added a new skin for Ecological Society of America. 
123
* Created an Advanced search servlet which can be used from the web. 
124
* Various connections have been modified to be secure. e.g. connection between 
125
ldaps is made secure now, replication is done over secure channels.  
126

    
127
Performance:
128
* Reduced size of xml_nodes by creating a new table for holding nodes from 
129
  deleted documents and old revisions of the documents. 
130
* Provided a new variable in metacat.properties where more frequently searched 
131
  for paths can be specified. Seperate indexes are created for these paths 
132
  - so that search is faster.
133
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
134

    
135
Release Notes for 1.5.0:
136
------------------------
137

    
138
This release comes with performace improvement, user interface enhancements,
139
and bug fixes. Below is the list of bug fixes and performance improvements. 
140

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

    
192

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

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

    
263

    
264
Release Notes for 1.4.0:
265
------------------------
266

    
267
This is a major release, and is the first to introduce many new features to
268
Metacat.  Some of the major new features in this version of Metacat include:
269

    
270
* Added a new 'Harvester' that allows documents to be periodically pulled
271
  from distributed sources into metacat, useful for interfacing with other
272
  system types. See the Metacat Tour for details.
273
* Added new 'skins' capability to allow the GUI for the metacat web interface
274
  to be more easily customized to fit into site needs.  The skin is based on
275
  a flexible mix of XSLT, CSS, and Javascript.
276
* Added a web-based metadata entry form for submitting limited EML documents
277
  as part of a data registry.  The GUI for the registry is customizable and 
278
  is integrated with the 'skins' system for the main metacat interface.  The
279
  registry subsystem is written in Perl, and can simultaneously be used to 
280
  present multiple 'registry' interfaces.
281
* A new 'client API' has been developed and implemented in Java and in Perl 
282
  so that metacat functions can be accessed from any program in those
283
  languages.  The client API supports the major metacat servlet actions,
284
  including login(), logout(), query(), insert(), update(), delete(), and 
285
  upload(). See the Metacat Tour for details.
286
* Added a new 'getlog' action that produces a usage history for all major
287
  events.  So now an XML report can be generated for document reads, inserts,
288
  deletes, etc.  See the new section in the Metacat Tour.
289
* Added a new 'buildindex' action that can rebuild the index entries for any
290
  document in the database.
291
* The configuration file for metacat (metacat.properties) has been moved out
292
  of the jar file and into the WEB-INF directory, allowing far easier changes
293
  to the configuration parameters.
294
* Results in default web interface are sorted by title in the XSLT 
295
  (configurable)
296
* Many bugs were fixed.
297

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

    
301
Release Notes for 1.3.1:
302
------------------------
303

    
304
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
305
include:
306
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
307
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
308
    and Java 1.4.
309
 2) Distribution package size was reduced.
310

    
311

    
312
Release Notes for 1.3.0
313
------------------------
314

    
315
In 1.3.0 release, the structure of the xml_access table was changed and a new
316
table, xml_accesssubtree was added. If you try to update a previously 
317
installed Metacat, you should run a script file to updated the table structure 
318
before installation.
319
For Oracle user: At the SQLPLUS prompt type the following -
320
@src/reviseformetacat13.sql
321
For Postgresql user: At install directory prompt type the following -
322
psql exp < src/reviseformetacat13_postgres.sql
323
(where 'exp' is the database name).
324

    
325
After installation, user should run "ant schemasql" command to register EML2
326
schema in xml_catalog table.
327

    
328
If you are a new Metacat user, this step is unneeded.
329

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

    
336
New Features in 1.3.0
337
  1) Partialy support EML2 document. User can store, query, read and write
338
     EML2 documents. However, Metacat only support access control in resource
339
     level. The subtree level access control will be ignored.
340
  2) Support other xml document base on namespace/schema.
341
  3) Support query for attribute value
342
  4) Assign MIME type to data file base on metadata when user try to read it.
343
  5) Owner can assign access rules to a document which does not have access 
344
     document to apply it.
345
  6) Support exporting single file, not only whole package
346
  7) Resupport Microsoft SQL Server.
347

    
348
Fixes in 1.3.0:
349
  1) Couldn't finish delta T replication for large set of documents.
350
  2) Couldn't create access control during delta T replication.
351
  3) Eorr will be written to a seperated log file if some documents
352
     were failed in replication.
353
  4) Decrease the time to create access rules during insert or update 
354
     a package.
355
     
356
Documentation
357
-------------
358
See the docs directory for detailed documentation and installation
359
instructions.
360

    
361
Details of the Metacat architecture can be found on the website for
362
the Knowledge Network for Biocomplexity (KNB):
363

    
364
  http://knb.ecoinformatics.org/software/metacat/
365

    
366
Contributions to this work are welcome.  Please see the above web site
367
for details on how to contribute.
368

    
369
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
370
-----------------------------------------------------------------------------
371
If you discover a bug please report it, either by email (above) or by using
372
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
373
list of currently unimplemented features in Bugzilla that we are working on
374
for the next release.
375

    
376
Legalese
377
--------
378
This software is copyrighted by The Regents of the University of California
379
and the National Center for Ecological Analysis and Synthesis
380
and licensed under the GNU GPL; see the 'LICENSE' file for
381
details.
382

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

    
389
This software is partially supported by a grant from the Andrew W. 
390
Mellon Foundation.
391

    
392
This product includes software developed by the Apache Software
393
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
394
for details.
395

    
396
The source code, object code, and documentation in the com.oreilly.servlet
397
package is copyright and owned by Jason Hunter. See the cos-license.html file
398
for details of the license.  Licensor retains title to and ownership of the
399
Software and all enhancements, modifications, and updates to the Software.
400

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