Natural Resources Canada | Earth Science Sector | Geological Survey of Canada

GlobalDB System
Release 3.7


GlobalDB System Site Map | Presentation | Requirements | Software and Scripts | Aliases | Using GShell | Using GQuery | Using Documentor

USING DOCUMENTOR

Documentor is a standalone application designed as an alternative way for users to view table and field definitions, and to change descriptions of the Data tables and fields if absolutely necessary. To use Documentor, the user must have copied over the unzipped system and data folders as described in Software and Scripts, and configured at least one database alias as described in Defining database aliases. When the main form appears, a database can be selected by clicking Select Database button. A small form will appear, showing the aliases of the database(s) available to work with, one of which should be selected by the user. A set of radio buttons on the top panel of the form is used to restrict the type of database tables to display: Data, Lookup, Junction or Service. By default, all tables are visible. If a database has not been selected, clicking on any of the radio buttons will generate an error message.

The next panel displays information about tables: the table name and type, its caption, the WMGDP description, whether the table has been used by the compiler and description of what the table contains. If the table is a detail data table, a check box indicates if the records are ordered or not (using the RANK field). When the current table contains lookup, junction, or service information, the text-box to change description is read-only.

The bottom panel displays information about fields and is similar to the tables panel. The navigation from column to column is restricted to those of the table shown in the upper panel.

The Reset All button closes the database and clears the data fields of the form. The Exit button terminates execution of the program and closes the form.

GlobalDB System Site Map | Presentation | Requirements | Software and Scripts | Aliases | Using GShell | Using GQuery | Using Documentor


Important notices and disclaimers 2014-09-30