Documentation


Install

If you have not already installed Java, you will need to download and install any J2SE JRE from Sun. Next, go to the Self-Contained Bug Database download page, and download the software. Unzip it to the directory of your choice. From a command line, go to the directory containing the bug database software. Type "java SCBugDB", being sure to use the full path identifying the directory in which you have installed Java. The software should now be running. If you encounter any trouble, please contact support.

Use

Once the software is running, open a web browser on any machine with network access to the server machine. Type the name of the server machine into the URL line. You should now see the main page of the Self-Contained Bug Database program. From here, you may submit new bugs or search for existing ones. To search for a bug, go to the search page and enter the appropriate criteria. From the listing of matching bugs, select a bug to view. If you choose, you may now edit and update the bug.

Customize

The following shows a sample "schema.txt" file.
users=Dave,Lisa,Bill,None
Summary=text
Comments=area
Status=Open,To Be Tested,Closed
Priority=High,Medium,Low
Owner=user
The first line of the file lists all of your bug database's users. The remaining lines list the fields currently used in your bug database. Note that the "Bug #" and "Submit Date" fields are not described in the schema. These fields automatically appear as the first two fields in the user interface. The additional fields you define will appear in the user interface in the same order as they are listed in the schema file. You may define four kinds of fields: "text" (a one-line text value), "area" (a multi-line text value), a choice field (for choosing among a few values separated by commas, where the first value is the default), and "user" (a choice field for choosing among your list of users). In order for your schema changes to take effect, you will need to restart the bug database software.

Customizing Choices and Users

You may safely re-order the possible values for a choice field (or the list of users) by editing the schema file. To set a default value (or user), make sure it appears first in the list of choices. You may safely add new values (or users). When you remove a value (or user), any bugs still using that value will continue to show the old value in reports. (You may choose to update these bugs one at a time.) Finally, be advised that when you attempt to rename a value (or user), you will actually be removing one value and adding a new one.

Customizing Fields

You may safely re-order the list of fields. When you add a new field, existing bugs will show a "null" value in reports. (You may choose to update these bugs one at a time.) You may safely remove fields you no longer wish to use. Finally, be advised that when you attempt to rename a field, you will actually be removing one field and adding a new one.
Home
Download
Documentation
People
Contact Us
SourceForge Logo