Node:dbconfig file, Next:Other config files, Previous:databases file, Up:Management

The dbconfig file

The dbconfig configuration file controls the configuration of a GNATS database. Each database has its own individual copy of this file, which is located in the gnats-adm subdirectory of the database.

The file consists of standard plain text. Whitespace is completely optional and is ignored. Sets of braces @ are used to delimit the different sections, and all non-keyword values must be surrounded with double quotes. The values in dbconfig can be changed at any time; the new values take effect for all subsequent iterations of GNATS tools.

The dbconfig file contains 6 major sections, which must appear in the following order:

• Overall database configuration
• Individual field configuration
• Named query definitions
• Audit-trail and outgoing email formats
• Index file description
• Initial Problem Report input fields

The different sections are described below. While reading the following sections, it will be useful to refer to the sample dbconfig file which is installed when a new database is initialized with the mkdb tool. In fact, the sample file provides a configuration that should be usable for a great range of sites, since it reproduces the behaviour of the older, less customizable 3.x versions of GNATS.

• Overall database configuration: Overall database configuration.
• Individual field configuration: Individual field configuration.
• Field datatypes: Field datatypes.
• Edit controls: Trigger on certain edit actions.
• Named query definitions: Define and name standard queries.
• Audit-trail formats: Specify formatting of the audit-trail.
• Outgoing email formats: Specify contents and formatting of messages sent out by GNATS.
• Index file description: Specify the general format and contents of the database index.
• Initial PR input fields: Which fields should be present on initial PR entry.