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