Project

General

Profile

1 981 tao
#
2 666 jones
#  '$RCSfile$'
3
#   '$Author$'
4
# '$Revision$'
5
#     '$Date$'
6
#
7
8 2479 jones
Metacat: XML Metadata and Data Management System
9
------------------------------------------------
10 666 jones
11 3020 sgarg
Version: 1.6.0 Release
12 666 jones
13 1295 jones
Send feedback and bugs to: metacat-dev@ecoinformatics.org
14
                           http://bugzilla.ecoinformatics.org
15 696 jones
16 666 jones
Contributors: Matt Jones (jones@nceas.ucsb.edu)
17
              Chad Berkley (berkley@nceas.ucsb.edu)
18 981 tao
              Jing Tao (tao@nceas.ucsb.edu)
19 666 jones
              Jivka Bojilova (bojilova@nceas.ucsb.edu)
20
              Dan Higgins (higgins@nceas.ucsb.edu)
21 2313 jones
              Saurabh Garg (sgarg@nceas.ucsb.edu)
22
              Duane Costa (dcosta@lternet.edu)
23 2480 jones
              Veronique Connolly (connolly@nceas.ucsb.edu)
24 2905 harris
              John Harris (harris@nceas.ucsb.edu)
25
              Callie Bowdish (bowdish@ecoinformatics.org)
26
              Will Tyburczy (tyburczy@ecoinformatics.org)
27 3020 sgarg
              Matthew Perry (perry@nceas.ucsb.edu)
28 2480 jones
29
Patch contributors:
30
              Andrea Chadden (chadden@nceas.ucsb.edu)
31 2479 jones
              Chris Jones (cjones@msi.ucsb.edu)
32 2480 jones
              Johnoel Ancheta (johnoel@hawaii.edu)
33
              Owen Jones (owen.jones@imperial.ac.uk)
34 1311 berkley
35 982 berkley
Metacat is a flexible database storage system for XML formatted
36 2313 jones
documents and associated binary files. Metacat models the structure of the
37
XML document, therefore allowing storage of XML documents with arbitrary
38
schemas. Metacat supports several databases on the back-end, including Oracle,
39
PostgreSQL and SQL Server (limited).  The server supports XML document
40 2441 jones
storage, retrieval, query, validation, and transformation (using the XSLT
41 2313 jones
stylesheet language).  In addition, there is a mechanism for replicating the
42
database to other metacat instances for backup and load balancing purposes.
43
Metacat currently uses an LDAP database for authenticating users, but was
44
written to accomodate other authentication services as well.
45 666 jones
46 2321 jones
Installation
47
------------
48
See the file "docs/user/metacatinstall.html" for detailed instructions.
49
50 3020 sgarg
51
Release Notes for 1.6.0:
52
------------------------
53
54
This release comes with more performance improvements, initial support for
55
LSIDs (Life Sciences Identifiers) and FGDC standard, more controls for
56
Metacat administrators and bug fixes. Below is the list of bug fixes and
57
performance improvements.
58
59
Bug Fixes:
60
* Improved the indexing algorithm. Earlier indexing failed for some documents
61
  randomly and used to take a lot of time to complete for others. The
62
  code for indexing was changed to take care of both these problems.
63
* Earlier, xmlns prefix was used to determine the namespace of the document.
64
  Now schemaLocation is used instead xmlns prefix to determine the namespace
65
  of the document as that is a better indicator of document type.
66
* INSTR was used in some SQL statements and it is not supported by Postgres.
67
  So SQL statements were modified so that INSTR is not used.
68
* Replication was changed to include replication of deleted documents also.
69
70
New Features:
71
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
72
* Added support for LSID. This includes modifying the stylesheets to
73
  display the LSIDs, modifying the build to include a new target
74
  'install-ldap'.
75
* Added following access control levels to Metacat:
76
    1. Administrators - users who can do the following:
77
       a. Run replication
78
       b. Delete any document
79
       c. Modify any document
80
       d. run indexing for any document
81
       e. check the logs
82
    2. allowedUsers - User who are allowed to submit
83
    3. deniedUsers - Users not allowed to submit
84
* Added a new skin for Ecological Society of America.
85
86
Performance:
87
* Reduced size of xml_nodes by creating a new table for holding nodes from
88
  deleted documents and old revisions of the documents.
89
* Provided a new variable in metacat.properties where more frequently searched
90
  for paths can be specified. Seperate indexes are created for these paths
91
  - so that search is faster.
92
93
94 2475 sgarg
Release Notes for 1.5.0:
95
------------------------
96
97 2479 jones
This release comes with performace improvement, user interface enhancements,
98 2475 sgarg
and bug fixes. Below is the list of bug fixes and performance improvements.
99
100
Bug Fixes:
101
* Modify property values of harvester registration servlets to match the
102
  servlet-mapping URL values in web.xml. The old values used the servlet
103
  class names. This worked in Tomcat 4 but seems to break in Tomcat 5 on
104
  Windows. The new values use the servlet-mapping URL values. This should
105
  work in both Tomcat 4 and Tomcat 5. (Bug 162)
106
* Re-implement logic to prune old log entries from the HARVEST_LOG and
107
  HARVEST_DETAIL_LOG tables. The old logic caused integrity constraint
108
  violations in the database because it tried to delete parent records from
109
  HARVEST_LOG prior to deleting child records from
110
  HARVEST_DETAIL_LOG. (Bug 162)
111
* In data registry, minor bugs fixed like the error page shows the link back
112
  to the form when error page was generated because of a document read
113
  request from search results page,  the successful delete button leading
114
  to a blank screen and the old ACL overwritten by the registry.
115
  (Bugs 1307, 1310, 1322, 1344, 1551)
116
* Changed the code to support insertion of following characters: ', `,
117
  charcters in the Numeric Character Reference format (&#xyz;) and
118
  characters like µ. Characters like µ will be converted to and stored in
119
  Numeric Character Reference format(&#xyz;). They will also be returned
120
  in Numeric Character Reference and it is upto the client to convert them
121
  and display them accordingly in the application. Partial fix provided by
122
  Johnoel Ancheta. (Bug 1538,1711)
123
* Spatial search failed on Oracle because of invalid entries made by
124
  some documents in the nodedata column of xml_nodes for paths involving
125
  'eastBoundingCoordinate', 'westBoundingCoordinate',
126
  'northBoundingCoordinate', 'southBoundingCoordinate'. A new column
127
  nodedatanumerical was added to xml_nodes table such that all the numerical
128
  nodedata is stored in this column and this column is now used for spatial
129
  search. (Bug 1703, 1718)
130
* In the default skin, clicking on the keywords on the home page did not
131
  result is a search being done. Fix provided by Owen Jones. (Bug 1768)
132
* Metacat generated a success message even when a document which didnt
133
  exsist was requested for deletion. This has been fixed. (Bug 1850)
134
* "packagetype" in xml-relation table was entered as eml200 namespace when
135
  an eml201 document was inserted. This is fixed now so that "packagetype"
136
  in xml-relation table points to eml201 namespace. (Bug 1979)
137
* System_id in xml_catalog pointed to http://knb.ecoinformatics.org/knb/
138
  earlier. Fixed such that it points to the locally installed metacat url.
139
  (Bug 1986)
140
* Changes to the Query subsystem fix bugs that prevented attributes from
141
  being expressed solely in the xpath query statement and the returnfield
142
  values. For instance, a query URL may now include search strings like
143
  '@packageId=sbclter%25' and return strings like 'returnfield=@packageId'.
144
  Previously, the attribute had to be appended to an element:
145
  '/eml/@packageId=sbclter%25'. These fixes change DBQuery.java,
146
  QuerySpecification.java, and QueryTerm.java (Bug 2052)
147
* Search query failed in case of Oracle if number of documents in the result
148
  were more than 1000. This has been fixed. (Bug 2000)
149
* Removed any occurence of enum which is now a keyword in Java 1.5
150
151
152
Enhancements:
153
* Major improvements done in user interface for the data registeries and
154
  various other skins. Improvements done based on suggestions from Mark
155
  Stromberg, Laura Downey and others. Improvements also done in resultset.xsl,
156
  the default skin and ldap templates. (Bug 1948)
157
* Coded added such that administrator can delete documents irrespective of
158
  who the document belongs to.
159
* Performance impovement done in searching of datasets. A part of the search
160
  time was taken up because of generation of resultset after the search had be
161
  done. So this was the sequence of events in earlier metacat
162
  1) Search for the given text
163
  2) A list of docids generated
164
  3) For each of the docids
165
     3a) Use xml_index and xml_nodes table to generate the string descibing
166
         the document including the returnfields requested in the search
167 2479 jones
  4) Add all the strings from step 3a to send back the resultant
168
     document. Here a decent amount of time was being taken by step 3a.
169
  The algorithm is now modified by addition of two tables xml_queryresult and
170
  xml_returnfields and a user defined parameter xml_returnfield_count. The
171
  new algorithm works as follows:
172 2475 sgarg
  1) Search for the given text
173 2479 jones
  2) A list of docids is generated
174 2475 sgarg
  3) For the given set of return fields generate a unique string and check
175
     if that string exists in xml_returnfields
176
     3a) If string does not exist in xml_returnfield, then enter a new
177
         record usage_count as 1 and returnfield_string as the unique string
178
         generated above.
179
     3b) Else if the string exists, increment usage_count
180
  4) Given the docids from step 2 and the id of the returnfield record from
181
     step 3, query for any docids that already exist in xml_queryresult.
182
     For the docids that do exist, get the queryresult_string.
183
  5) For rest of the docids from step2 which were not found in step 4, do
184
     the following for each of the documents:
185
     5a) Use xml_index and xml_nodes table to generate the string descibing
186
         the document including the returnfields requested in the search
187
     5b) If usage_count of the record from step is more than
188
         xml_returnfield_count set in metacat.properties, then store the
189
         string in xml_queryresult as a record which has the returnfield_id
190
         representing the set of returnfields, docid representing the
191
         document and the string as queryresult_string.
192
  6) Add all the strings from step 4 and step 5a to send back the resultant
193
     document
194
  So the results from step 3a in previous algorithm are effectively cached
195
  and hence same computation is not done again and again for each search.
196
  When a document is deleted, all the entries for that document in
197
  xml_queryresult table are also deleted. When a document is updated, all
198
  the entries for that document in xml_queryresult table are deleted. This
199
  works fine because those entries will be generated and cached again the
200
  next time the document is part of a search is requested.
201
* Performance impovement done for % search.
202
* Following new functions added to metacat client API: a method to set access
203
  on an xml document and a method to get newest version for a given document.
204
* Implement a new HarvesterServlet for running Harvester as a servlet. This
205
  eliminates the need to run Harvester in a terminal window. By default, the
206
  HarvesterServlet is commented out in lib/web.xml.tomcat(3,4,5). The user
207
  documentation will be modified to instruct Harvester administrators to
208
  uncomment the HarvesterServlet entry.
209
* Minor enhancement to support multiple email addresses for harvester
210
  administrator and site contact. Each address is separated by a comma or
211
  semicolon.
212
* Increase number of rows in Harvest List Editor from 300 to 1200.
213
* Changed default maxHarvests value to 0. Added logic to ignore maxHarvests
214
  value when it is set to 0 or a negative number. This allows Harvester to
215
  run indefinitely without shutting down after reaching a maximum number of
216
  harvests. The previous default value of 30 would cause Harvester to
217
  terminate after 30 harvests.
218
219
Details of all changes can be found in the bug database here:
220
http://bugzilla.ecoinformatics.org/buglist.cgi?product=Metacat&target_milestone=1.5
221
222
223 2313 jones
Release Notes for 1.4.0:
224
------------------------
225
226
This is a major release, and is the first to introduce many new features to
227
Metacat.  Some of the major new features in this version of Metacat include:
228
229
* Added a new 'Harvester' that allows documents to be periodically pulled
230
  from distributed sources into metacat, useful for interfacing with other
231
  system types. See the Metacat Tour for details.
232
* Added new 'skins' capability to allow the GUI for the metacat web interface
233
  to be more easily customized to fit into site needs.  The skin is based on
234
  a flexible mix of XSLT, CSS, and Javascript.
235 2321 jones
* Added a web-based metadata entry form for submitting limited EML documents
236 2313 jones
  as part of a data registry.  The GUI for the registry is customizable and
237
  is integrated with the 'skins' system for the main metacat interface.  The
238
  registry subsystem is written in Perl, and can simultaneously be used to
239
  present multiple 'registry' interfaces.
240
* A new 'client API' has been developed and implemented in Java and in Perl
241
  so that metacat functions can be accessed from any program in those
242
  languages.  The client API supports the major metacat servlet actions,
243
  including login(), logout(), query(), insert(), update(), delete(), and
244
  upload(). See the Metacat Tour for details.
245
* Added a new 'getlog' action that produces a usage history for all major
246
  events.  So now an XML report can be generated for document reads, inserts,
247
  deletes, etc.  See the new section in the Metacat Tour.
248
* Added a new 'buildindex' action that can rebuild the index entries for any
249
  document in the database.
250
* The configuration file for metacat (metacat.properties) has been moved out
251
  of the jar file and into the WEB-INF directory, allowing far easier changes
252
  to the configuration parameters.
253 2321 jones
* Results in default web interface are sorted by title in the XSLT
254
  (configurable)
255
* Many bugs were fixed.
256 2313 jones
257
Details of all changes can be found in the bug database here:
258
http://bugzilla.ecoinformatics.org/buglist.cgi?product=Metacat&target_milestone=1.4
259
260 1775 tao
Release Notes for 1.3.1:
261 2313 jones
------------------------
262 1308 tao
263 1775 tao
This is a simple interim bug fix. No major functionality changes. Bugs fixed
264
include:
265 1776 tao
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in
266
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3
267
    and Java 1.4.
268 1775 tao
 2) Distribution package size was reduced.
269
270
271
Release Notes for 1.3.0
272 2313 jones
------------------------
273 1775 tao
274
In 1.3.0 release, the structure of the xml_access table was changed and a new
275 1628 tao
table, xml_accesssubtree was added. If you try to update a previously
276
installed Metacat, you should run a script file to updated the table structure
277
before installation.
278
For Oracle user: At the SQLPLUS prompt type the following -
279
@src/reviseformetacat13.sql
280
For Postgresql user: At install directory prompt type the following -
281
psql exp < src/reviseformetacat13_postgres.sql
282
(where 'exp' is the database name).
283 1334 tao
284 1628 tao
After installation, user should run "ant schemasql" command to register EML2
285
schema in xml_catalog table.
286
287
If you are a new Metacat user, this step is unneeded.
288
289 1769 tao
Note: 1) We recommend to use Tomcat 4 and JAVA 1.4 to run Metacat. Otherwise,
290
         it will cause potential replication issues.
291
      2) Delete the xercesImpl.jar and xmlParserAPIs.jar files
292
         which are in $CATALINA_HOME/common/endorsed. They are old version and
293
         don't support XML schema validation.
294
295 1628 tao
New Features in 1.3.0
296
  1) Partialy support EML2 document. User can store, query, read and write
297
     EML2 documents. However, Metacat only support access control in resource
298
     level. The subtree level access control will be ignored.
299
  2) Support other xml document base on namespace/schema.
300
  3) Support query for attribute value
301
  4) Assign MIME type to data file base on metadata when user try to read it.
302
  5) Owner can assign access rules to a document which does not have access
303
     document to apply it.
304
  6) Support exporting single file, not only whole package
305 1769 tao
  7) Resupport Microsoft SQL Server.
306 1628 tao
307
Fixes in 1.3.0:
308
  1) Couldn't finish delta T replication for large set of documents.
309
  2) Couldn't create access control during delta T replication.
310
  3) Eorr will be written to a seperated log file if some documents
311
     were failed in replication.
312
  4) Decrease the time to create access rules during insert or update
313
     a package.
314
315 861 jones
Documentation
316
-------------
317 1311 berkley
See the docs directory for detailed documentation and installation
318 666 jones
instructions.
319
320 1311 berkley
Details of the Metacat architecture can be found on the website for
321 666 jones
the Knowledge Network for Biocomplexity (KNB):
322
323 805 jones
  http://knb.ecoinformatics.org/software/metacat/
324 666 jones
325
Contributions to this work are welcome.  Please see the above web site
326
for details on how to contribute.
327
328 848 jones
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
329
-----------------------------------------------------------------------------
330 2313 jones
If you discover a bug please report it, either by email (above) or by using
331
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
332
list of currently unimplemented features in Bugzilla that we are working on
333
for the next release.
334 805 jones
335
Legalese
336
--------
337 666 jones
This software is copyrighted by The Regents of the University of California
338
and the National Center for Ecological Analysis and Synthesis
339
and licensed under the GNU GPL; see the 'LICENSE' file for
340
details.
341
342 1311 berkley
This material is based upon work supported by the
343 2313 jones
National Science Foundation under Grant No. DEB99-80154, DBI99-04777, and
344 2975 jones
0225676 for SEEK.  Any opinions, findings and conclusions or recomendations
345
expressed in this material are those of the author(s) and do not necessarily
346
reflect the views of the National Science Foundation (NSF).
347 1307 jones
348 2505 sgarg
This software is partially supported by a grant from the Andrew W.
349
Mellon Foundation.
350
351 1311 berkley
This product includes software developed by the Apache Software
352 1307 jones
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
353
for details.
354
355 1311 berkley
The source code, object code, and documentation in the com.oreilly.servlet
356 1307 jones
package is copyright and owned by Jason Hunter. See the cos-license.html file
357 1311 berkley
for details of the license.  Licensor retains title to and ownership of the
358 1307 jones
Software and all enhancements, modifications, and updates to the Software.
359 2441 jones
360 2599 jones
This software includes the JDBC driver for PostgreSQL.  See the
361
postgresql-license.txt file for details.