DiversityModelDocumenter (release 2.6, January 2004)

This utility is designed to run under Microsoft Access 2000 or Access XP (which must already be installed on your computer). It will produce an HTML document, documenting the attributes, data types, and attribute descriptions of entities defined in a Jet 4.0 (*.mdb) database file. Many options are available, e.g. to include relations (only as text, not graphical!), validation rules, etc. It has only been tested with "*.mdb" database files containing the tables directly (there is only limited support for linked tables, for which certain attributes may not be available). In addition to the HTML document basic SQL DDL statements to generate tables and xml schema definitions are generated.

There is no further documentation available beyond this text. Please look at the output - try it out. Some information is available in statusbar messages and tool tips that appear when the mouse pointer hovers for 3 seconds over a control. Please contact me if anything is especially unclear; I will then add it to this document. To see examples of output of the model documenter go to the Diversity Workbench area of DiversityCampus and follow the links to the information models.

You can redistribute or modify this application under the terms of the GNU General Public License ver. 2, as published by the Free Software Foundation. It is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License (www.gnu.org/copyleft/gpl.html) for more details. If this file is missing, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

Download software

Download the DiversityModelDocumenter as self-extracting archive, save to disk and double-click to extract.

Version history

The first version 1.0 was release on 9. Nov. 2000 and produced only a html document. Subsequent versions added support for xml schema (xsd and xdr) and sql-DDL code. Development of the 1.x versions was continued up to version 1.7, released 31. May 2001. This was the last version that did not change the database to be documented. It can still be downloaded here.

Starting with version 2.0 a fundamental change was introduced. The model documenter now writes the information it collects into permanent special tables in the database that is being documented. The advantage of this behaviour is that the information in the table can be used by other applications, e.g. a web interface, to provide attribute descriptions, etc. and to add application specific validation code for data types and data ranges. The format used in these tables is not strictly documented, and therefore future versions of the documenter may modify the logic of this table as required.

Version 2.3 currently fixed bugs in the xml schema output. The key/keyref mechanism is now valid, although the xpath statements are still partly wrong and need to be fixed manually. A future version of the documenter will hopefully fix that as well.

Version 2.4, 2.5, and 2.6 all improved the layout of the html formatted reports. No significant other functionality was introduced, but many minor glitches were dealt with.

(c) Copyright Gregor Hagedorn 2000-2004
Federal Biological Research Center for Agriculture and
Forestry, K├Ânigin-Luise-Str. 19,14195 Berlin, Germany

First published 2000-11-09, last update: 2005-03-30.
Diversity Campus Copyright & Impressum

This work is licensed under a Creative Commons License Valid XHTML 1.0! Valid CSS1!