Project

General

Profile

metacat / README @ 3065

1
#
2
#  '$RCSfile$'
3
#   '$Author: sgarg $'
4
# '$Revision: 3025 $'
5
#     '$Date: 2006-07-19 15:40:28 -0700 (Wed, 19 Jul 2006) $'
6
#
7

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

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

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

    
35
Metacat is a flexible database storage system for XML formatted
36
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
storage, retrieval, query, validation, and transformation (using the XSLT
41
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

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

    
50

    
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
* Fixed bug in squery which didnt allow use of not-contains 
70

    
71
New Features:
72
* Added FGDC schema and XSLT so that Metacat can handle FGDC standard
73
* Added support for LSID. This includes modifying the stylesheets to 
74
  display the LSIDs, modifying the build to include a new target 
75
  'install-ldap'.
76
* Added following access control levels to Metacat:
77
    1. Administrators - users who can do the following:
78
       a. Run replication
79
       b. Delete any document
80
       c. Modify any document
81
       d. run indexing for any document
82
       e. check the logs
83
    2. allowedUsers - User who are allowed to submit
84
    3. deniedUsers - Users not allowed to submit
85
* Added a new skin for Ecological Society of America. 
86
* Created an Advanced search servlet which can be used from the web. 
87
* Various connections have been modified to be secure. e.g. connection between 
88
ldaps is made secure now, replication is done over secure channels.  
89

    
90
Performance:
91
* Reduced size of xml_nodes by creating a new table for holding nodes from 
92
  deleted documents and old revisions of the documents. 
93
* Provided a new variable in metacat.properties where more frequently searched 
94
  for paths can be specified. Seperate indexes are created for these paths 
95
  - so that search is faster.
96
* Included log4j for logging and debuging to prevent wasting of time in printing log statements. 
97

    
98
Release Notes for 1.5.0:
99
------------------------
100

    
101
This release comes with performace improvement, user interface enhancements,
102
and bug fixes. Below is the list of bug fixes and performance improvements. 
103

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

    
155

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

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

    
226

    
227
Release Notes for 1.4.0:
228
------------------------
229

    
230
This is a major release, and is the first to introduce many new features to
231
Metacat.  Some of the major new features in this version of Metacat include:
232

    
233
* Added a new 'Harvester' that allows documents to be periodically pulled
234
  from distributed sources into metacat, useful for interfacing with other
235
  system types. See the Metacat Tour for details.
236
* Added new 'skins' capability to allow the GUI for the metacat web interface
237
  to be more easily customized to fit into site needs.  The skin is based on
238
  a flexible mix of XSLT, CSS, and Javascript.
239
* Added a web-based metadata entry form for submitting limited EML documents
240
  as part of a data registry.  The GUI for the registry is customizable and 
241
  is integrated with the 'skins' system for the main metacat interface.  The
242
  registry subsystem is written in Perl, and can simultaneously be used to 
243
  present multiple 'registry' interfaces.
244
* A new 'client API' has been developed and implemented in Java and in Perl 
245
  so that metacat functions can be accessed from any program in those
246
  languages.  The client API supports the major metacat servlet actions,
247
  including login(), logout(), query(), insert(), update(), delete(), and 
248
  upload(). See the Metacat Tour for details.
249
* Added a new 'getlog' action that produces a usage history for all major
250
  events.  So now an XML report can be generated for document reads, inserts,
251
  deletes, etc.  See the new section in the Metacat Tour.
252
* Added a new 'buildindex' action that can rebuild the index entries for any
253
  document in the database.
254
* The configuration file for metacat (metacat.properties) has been moved out
255
  of the jar file and into the WEB-INF directory, allowing far easier changes
256
  to the configuration parameters.
257
* Results in default web interface are sorted by title in the XSLT 
258
  (configurable)
259
* Many bugs were fixed.
260

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

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

    
267
This is a simple interim bug fix. No major functionality changes. Bugs fixed 
268
include:
269
 1) Metacat 1.3.0 doesn't work in Java 1.3 because a subtle API differnce in 
270
    Java 1.3 and Java 1.4. Currently, Metacat 1.3.1 will work in both Java 1.3 
271
    and Java 1.4.
272
 2) Distribution package size was reduced.
273

    
274

    
275
Release Notes for 1.3.0
276
------------------------
277

    
278
In 1.3.0 release, the structure of the xml_access table was changed and a new
279
table, xml_accesssubtree was added. If you try to update a previously 
280
installed Metacat, you should run a script file to updated the table structure 
281
before installation.
282
For Oracle user: At the SQLPLUS prompt type the following -
283
@src/reviseformetacat13.sql
284
For Postgresql user: At install directory prompt type the following -
285
psql exp < src/reviseformetacat13_postgres.sql
286
(where 'exp' is the database name).
287

    
288
After installation, user should run "ant schemasql" command to register EML2
289
schema in xml_catalog table.
290

    
291
If you are a new Metacat user, this step is unneeded.
292

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

    
299
New Features in 1.3.0
300
  1) Partialy support EML2 document. User can store, query, read and write
301
     EML2 documents. However, Metacat only support access control in resource
302
     level. The subtree level access control will be ignored.
303
  2) Support other xml document base on namespace/schema.
304
  3) Support query for attribute value
305
  4) Assign MIME type to data file base on metadata when user try to read it.
306
  5) Owner can assign access rules to a document which does not have access 
307
     document to apply it.
308
  6) Support exporting single file, not only whole package
309
  7) Resupport Microsoft SQL Server.
310

    
311
Fixes in 1.3.0:
312
  1) Couldn't finish delta T replication for large set of documents.
313
  2) Couldn't create access control during delta T replication.
314
  3) Eorr will be written to a seperated log file if some documents
315
     were failed in replication.
316
  4) Decrease the time to create access rules during insert or update 
317
     a package.
318
     
319
Documentation
320
-------------
321
See the docs directory for detailed documentation and installation
322
instructions.
323

    
324
Details of the Metacat architecture can be found on the website for
325
the Knowledge Network for Biocomplexity (KNB):
326

    
327
  http://knb.ecoinformatics.org/software/metacat/
328

    
329
Contributions to this work are welcome.  Please see the above web site
330
for details on how to contribute.
331

    
332
Major Known Bugs or Feature Requests (see http://bugzilla.ecoinformatics.org)
333
-----------------------------------------------------------------------------
334
If you discover a bug please report it, either by email (above) or by using
335
our bug tracking system (http://bugzilla.ecoinformatics.org). There is a
336
list of currently unimplemented features in Bugzilla that we are working on
337
for the next release.
338

    
339
Legalese
340
--------
341
This software is copyrighted by The Regents of the University of California
342
and the National Center for Ecological Analysis and Synthesis
343
and licensed under the GNU GPL; see the 'LICENSE' file for
344
details.
345

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

    
352
This software is partially supported by a grant from the Andrew W. 
353
Mellon Foundation.
354

    
355
This product includes software developed by the Apache Software
356
Foundation (http://www.apache.org/). See the LICENSE file in lib/apache
357
for details.
358

    
359
The source code, object code, and documentation in the com.oreilly.servlet
360
package is copyright and owned by Jason Hunter. See the cos-license.html file
361
for details of the license.  Licensor retains title to and ownership of the
362
Software and all enhancements, modifications, and updates to the Software.
363

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