BSAdv Tables

BSAdv is a Boy Scout advancement component for the Joomla! 1.6 content management system.

Overview

This documents describes the tables used in the BSAdv database, the fields in each table and the relationships between the fields. A thorough understanding of these components will help the designer define a better user interface.

The structure of the database was directed by the principles of database normalization. This has increased the number of tables in the database, but will improve database integrity, maintainability and portability.

The database structure was developed on MySQL, supplying information to a Joomla! CMS. The BSAdv structure is intended to be generic enough to implement on different database systems and to support different CMS choices. The use of a consistent database structure across different implementations will allow portability of data between the implementations and the development of standard reports to Boy Scout Councils.

In this document, the term BSA refers to the Boy Scouts of America.

License

  Copyright (c)  2008, 2009, 2010, 2011  Kim Eckert.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.2
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled "GNU
  Free Documentation License".

The Database

The database consists of tables that are grouped into eight categories:

CATEGORY	TABLE	DESCRIPTION
Scouts	scouts	Unique information about the Scout
	scoutsphones	Scout telephone numbers
	scoutspatrols	History of patrol membership
	scoutspors	History of Positions of Responsibility
Adults	adults	Unique information about adult leaders and parents
	adultsphones	Adult telephone numbers
	adultstrainings	History of adult training
Events	events	Location and dates of events
Events	deeds	What was accomplished at events
Accounts	accounts	Names of financial accounts
Ranks	ranks	Names and effective dates of BSA ranks
Ranks	ranksreqs	Requirements for each of the ranks
Merit Badges	meritbadges	Names and effective dates of BSA merit badges
Merit Badges	mbreqs	Requirements for each of the merit badges
Awards	awards	List of awards for Scouts and Adults
Control	checkout	Record of tables currently checked out for editing.
Control	dblog	Record of updates made to the database

There are eight tables that implement a many-to-many relationship between the aforementioned tables.

TABLE	DESCRIPTION
scoutsadults	Each row associates one Scout with one adult, normally a parent or guardian relationship
scoutsdeeds	Each row associates one Scout with one deed, which is one or more Scouting accomplishments
scoutsaccounts	Each row records one credit or debit associated with one Scout.
adultsdeeds	Each row associates one adult with one deed, which is one or more Scouting accomplishments
adultsaccounts	Each row records one credit or debit associated with one adult.
mbreqsdeeds	Each row associates one merit badge requirement with one deed
ranksreqsdeeds	Each row associates one rank requirement with one deed
ermbs	Each row defines one merit badge that is required for the Eagle rank
ermbgrps	Identifies alternative merit badges for the Eagle rank
scoutsawards	Each row associates one award with one Scout

Configuration parameters are stored in the params field of the jos_components table, in the row corresponding to BSAdv. They can be modified in the Joomla back end. There are five categories of parameters.

NAME	DESCRIPTION
Unit data
Unit number	Unit number. This is used in official BSA documentation to identify your unit's records.
Unit type	Type of unit, such as Troop, Pack, Cres, Ship. This is used in official BSA documentation to identify your unit's records.
Other unit type	If one of the listed unit types does not match the unit, then enter the type here.
Council name	The name of your BSA Council. This is used in official BSA documentation to identify your unit's records.
Controls how data is displayed
Advancement table width	Number of cells inwidth of the main advancement table. The web site administrator can optimize the width to match the unit Joomla template.
Advancement text	Text that is displayed on the main advancement page. This will be unique to your unit, and can give informantion and instructions to the users.
Include links	Enables the display of links to Reports and Edit pages, from the main advancement page. When the web site administrator has implemented menu links to these two pages, this control can disable the display of the links on the advancement page.
Light color	A color used for certain backgrounds in the BSAdv pages. It should be chosen to contrast with normal text and to coordinate with your template colors. For normal templates, this will be a light color.
Dark color	A color used for certain text in the BSAdv pages. It should be chosen to contrast with normal backgrounds, and to coordinate with your template colors. For normal templates, this will be a dark color.
Controls data storage
Allow Changes	When set, allows updates to the database through the BSAdv web interface. This allows administrators to disable write access, when needed.
Log changes	When set, all database updates are logged in a file. This allows the administrator to investigate who has been making changes to the database. This can help identify users who need additional instructions.
Maximum log entries	The total number of log entries stored. When this number is exceeded, the oldest are deleted, to maintain this total count.
Youth protection. The following parameters enable the use of individual fields in the Scouts table. This allows each unit to completely disable the use (read or write) of Scouts' personal information. This is the ultimate way to keep this information from being hijacked by those who should not have access. Each unit will need to decide whether to limit all or some of the data in this way. Two fields cannot be disabled: id and name_private. These are required for the BSAdv program to work properly.
use_name_public	1=use, 0= do not use.
use_name_family	1=use, 0= do not use.
use_name_given	1=use, 0= do not use.
use_name_middle	1=use, 0= do not use.
use_date_of_birth	1=use, 0= do not use.
use_date_joined_unit	1=use, 0= do not use.
use_address1	1=use, 0= do not use.
use_address2	1=use, 0= do not use.
use_city	1=use, 0= do not use.
use_state	1=use, 0= do not use.
use_zip	1=use, 0= do not use.
user_id	1=use, 0= do not use.
use_email	1=use, 0= do not use.
use_active	1=use, 0= do not use.
use_current_rank	1=use, 0= do not use.
use_is_oa	1=use, 0= do not use.
Permissions (access control). Standard Joomla control interface allows the web site administrator to assign groups of users read and write access to one or more of the six access catagories (actions) defined by BSAdv. For more information see Youth Protection

The Tables

There are some intricacies in the definition of and the use of the tables and their fields. We will try to capture these here.

Scouts Tables

Data in these tables is related to individual Scouts, except data on their advancement and activities in the unit. All of the Scout contact information is located here.

scouts

Most of this personal information is optional. Youth Protection can be guaranteed by not logging personal information on your Scouts on the web site. The name_public field is necessary for Troop members to identify the Scout. It can be anything your unit chooses, a nickname, initials or a number. It needs to be unique within your unit. If you chose to enter personal information, be sure that your unit webiste is adequately password protected.

The Address fields are a compromise between specific, descriptive fields, such as apartment number, street, etc. and a more general-purpose fields, such as line1, line2, line3, etc. The first two lines are kept generic to allow a variety of uses. The second line is not mormally needed and can be left NULL (blank). Specific fields for city, state and zip are used to allow possible searches or sorts based on those fields.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs. Many tables will refer to this index.
name_public	VARCHAR(255) UNIQUE NOT NULL	Unique and necessary for human identification, but not sufficient to allow strangers to identify the youth
name_family	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Family name.
name_given	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Given name
name_middle	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Middle name or initial
date_of_birth	DATE DEFAULT NULL	(OPTIONAL) Date of birth. Used to keep track of a youth's age
date_joined_unit	DATE DEFAULT NULL	Date joined unit
address1	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Mailing address on the first line below the name
address2	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Additional line for the mailing address. Most addresses do not need this extra line.
city	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Mailing address, city
state	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Mailing address, state
zip	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Mailing address, zip code
user_id	INT UNSIGNED DEFAULT NULL	(OPTIONAL) User id, if the Scout is a registered user of the unit web site.
email	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Email address
active	ENUM('Y','N') DEFAULT NULL	Whether a Scout is currently active. A Scout may be inactive at some time during his Scouting career or when he turns 18 years old. This field allows the data to stay in the database, but not be listed in most queries.
current_rank	INT UNSIGNED DEFAULT NULL	This is a duplicate of advancement data stored elsewhere in this database. It is useful enough to keep as a duplicate, but care must be taken to ensure it is updated when the supporting data is updated. It may not be necessary to use this field if the rank calculations can be done efficiently.
is_oa	ENUM('Y','N') DEFAULT 'N'	This denotes that the Scout has completed his Order of the Arrow ordeal. That data is stored elsewhere in this database, but it is useful to capture it here also. As with the current_rank, care must be taken to keep this updated.

Three tables contain additional Scout data that cannot be contained in the scouts table. These are not a part of the scouts table because they may have multiple entries for each Scout.

scoutsphones

Scouts may have multiple phone numbers.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs. This field may not be absolutely necessary because the combination of scouts_id and number should be unique. It is consistent with other tables in this database to have an id field.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table. Identifies the Scout that this number belongs to.
number	VARCHAR(255) DEFAULT NULL	The telephone number. Use a consistent format for all numbers, such as nnn-nnn-nnnn.
description	VARCHAR(255) DEFAULT NULL	Differentiates between multiple numbers, such as 'home', 'cell', 'weeknights before 10:00', 'weekend with dad'.

scoutspatrols

Records the history of Patrol membership for Scouts.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	identification field for programs.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table. Identifies the Scout that this data belongs to.
patrol_name	VARCHAR(255) DEFAULT NULL	Patrol Name
start_date	DATE DEFAULT NULL	Date that the Scout joined the Patrol
end_date	DATE DEFAULT NULL	Date that the Scout left the Patrol. This is NULL for a Scout's current patrol membership.

scoutspors

Positions of Responsibilities

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	identification field for programs.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table. Identifies the Scout that this data belongs to.
position_name	VARCHAR(255) DEFAULT NULL	Name of the Position
start_date	DATE DEFAULT NULL	Date the Scout started in this position
end_date	DATE DEFAULT NULL	Date the Scout stopped serving this position. This is NULL for a Scout's current position.

Adults Tables

Information for adult leaders, parents and guardians are combined in the adults tables. Data for adult leaders and for parents/guardians ended up very similar. Since most adult leaders are also a parent of a Scout, we combined the tables.

adults

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
is_leader	ENUM('Y','N') DEFAULT 'N'	Indicates if the adult registered with the BSA.
name_family	VARCHAR(255) DEFAULT NULL	Family (last) name
name_given	VARCHAR(255) DEFAULT NULL	Given (first) name
name_middle	VARCHAR(255) DEFAULT NULL	Middle name
address1	VARCHAR(255) DEFAULT NULL	Mailing address on the first line below the name
address2	VARCHAR(255) DEFAULT NULL	(OPTIONAL) Additional line for the mailing address. Most addresses do not need this extra line.
city	VARCHAR(255) DEFAULT NULL	Mailing address, city
state	VARCHAR(255) DEFAULT NULL	Mailing address, state
zip	VARCHAR(255) DEFAULT NULL	Mailing address, zip code
email	VARCHAR(255) DEFAULT NULL	Email address
user_id	INT UNSIGNED DEFAULT NULL	Index into the ID field of the website user table.
is_oa	ENUM('Y','N') DEFAULT 'N'	Indicates if this adult is a member of the Order of the Arrow.

adultsphones

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
adults_id	INT UNSIGNED NOT NULL	Index into the adults table.
number	VARCHAR(255) DEFAULT NULL	The telephone number. Use a consistent format for all numbers, such as nnn-nnn-nnnn.
description	VARCHAR(255) DEFAULT NULL	Description that differentiates between multiple numbers.

adultstrainings

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
adults_id	INT UNSIGNED NOT NULL	Index into the adults table.
description	VARCHAR(255) DEFAULT NULL	Description of the training.
date_valid	DATE DEFAULT NULL	Date the training became valid.
date_expired	DATE DEFAULT NULL	Date the training expires. If the training does not expire, enter NULL.

scoutsadults

This associates a Scout with an adult, either a parent or guardian.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table.
adults_id	INT UNSIGNED NOT NULL	Index into the adults table.
relation	VARCHAR(255) DEFAULT NULL	Description of the adult relation to the Scout, such as father, mother or stepfather

Events

Scouting events are stored in two tables: events and deeds. This eliminates duplication of data, but can be confusing. Take some time to understand these tables and their interaction with other tables.

events

This is simply the description and dates of the event. Accomplishments are captured in the deeds table and in other tables associated with rank advancement and merit badge requirements.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
description	VARCHAR(255) DEFAULT NUL	Description of the event.
date	DATEDEFAULT NULL	Date the event occurred, or the starting date of a multi-day event.
end_date	DATE DEFAULT NULL	Ending date of a multi-day event. NULL for single-day events.

deeds

This is where most accomplishments are recorded. One row in this table captures a combination of accomplishments that either one Scout or multiple Scouts completed at an event. Associated tables allow multiple Scouts to be assigned to this deed, multiple merit badge requirements to be logged and multiple rank advancement to be logged. The deed table is the main place for recording Scouts' accomplishments.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
events_id	INT UNSIGNED NOT NULL	Index into the events table.
description	VARCHAR(255) DEFAULT NULL	Short description, used mostly to better identify the deeds during data entry and editing.
date	DATE	Date of the deed. On multi-day events, this indicates the actual date that advancement should be registered.
nights_camped	INT UNSIGNED DEFAULT NULL	Number of nights camped.
miles_hiked	FLOAT DEFAULT NULL	Number of miles hiked. Fractional values are allowed.
hours_service	FLOAT DEFAULT NULL	Number of hours of service. Fractional values are allowed.
is_activity	ENUM('Y','N') DEFAULT 'N'	Denotes that this deed qualifies as a Troop and/or Patrol activity as required for rank advancement.
verified_by	INT UNSIGNED DEFAULT NULL	The adult that verified the data, normally the advancement chairman. Index into the adults table.
verified_date	DATE DEFAULT NULL	Date that the advancement chairman verified the deed.

scoutsdeeds

Each row of this table associates a Scout with a deed.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
deeds_id	INT UNSIGNED NOT NULL	Index into the deeds table.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table.

adultsdeeds

Each row of this table associates an adult with a deed.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
deeds_id	INT UNSIGNED NOT NULL	Index into the deeds table.
adults_id	INT UNSIGNED NOT NULL	Index into the adults table.

Accounts

accounts

These are the names of the accounts, such as 'general' or 'Summer Camp'.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
events_id	INT UNSIGNED DEFAULT NULL	Index into the events table, linking the account to an event. NULL if the account is not related to an event.
name	VARCHAR(255) DEFAULT NULL	Name of the account, such as general or summer camp

scoutsaccounts

Individual credits and debits to a Scout's account.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
accounts_id	INT UNSIGNED NOT NULL	Index into the accounts table.
scouts_id	INT UNSIGNED NOT NULL	Index into the scouts table.
description	VARCHAR(255) DEFAULT NULL	Description of the actual credit or debit, such as first deposit
date	DATE DEFAULT NULL	Effective date that the credit or debit.
amount	FLOAT DEFAULT NULL	Amount credited (positive) or debited (negative) to this account for this Scout.

adultsaccounts

Individual credits and debits to an adult's account.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
accounts_id	INT UNSIGNED NOT NULL	Index into the accounts table.
adults_id	INT UNSIGNED NOT NULL	Index into the adults table.
description	VARCHAR(255) DEFAULT NULL	Description of the actual credit or debit, such as first deposit
date	DATE DEFAULT NULL	Effective date that the credit or debit.
amount	FLOAT DEFAULT NULL	Amount credited (positive) or debited (negative) to this account for this Scout.

Meritbadges

BSA updates merit badges regularly. Scouts often have the option of completing the older requirements if they have started work on them before the new requirements are issued. Because of this, the database must be able to store multiple versions of merit badges with the same name. They are distinguished by the fields date_created and date_obsoleted and of course the field id.

To track merit badge completions, it is necessary to capture the numbers and letters of merit badge requirements. It is useful to also have the text for each requirement, so those are stored here also. The mbreqsgrp table is used to document exclusive requirements, such as 'One of the following'.

meritbadges

Each version of merit badges has a separate entry in this table. The data for this table comes from the BSA merit badge list. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
name	VARCHAR(255) DEFAULT NULL	Name of the Merit Badge.
date_created	DATE DEFAULT NULL	Date that the Merit Badge became effective.
date_obsoleted	DATE DEFAULT NULL	Date that the Merit Badge became obsolete. NULL for current Merit Badges. Many Merit Badges can be completed after the obsolete date if a Scout has started it before that date.

mbreqs

The actual requirements for the merit badges are listed here. The data for this table comes from the BSA merit badge requirement lists. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
meritbadges_id	INT UNSIGNED NOT NULL	Index into the meritbadges table.
designation	VARCHAR(255) DEFAULT NULL	The combination of number(s) and/or letter(s) that the BSA uses to designate a merit badge requirement, such as 1, 2, 4a.

mbreqsdeeds

Documents which merit badge requirements were completed at each event/deed. This is the only table in this category that has data specific to a unit.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
deeds_id	INT UNSIGNED NOT NULL	Index into the deeds table.
mbreqs_id	INT UNSIGNED NOT NULL	Index into the mbreqs table.

Ranks

ranks

Each version of rank advancement has a separate entry in this table. The data for this table comes from the BSA Scout handbook. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
name	VARCHAR(255) DEFAULT NULL	Name of the rank, as the BSA defines it, such as Tenderfoot or Eagle.
date_created	DATE DEFAULT NULL	Date that the Rank requirements became effective.
date_obsoleted	DATE DEFAULT NULL	Date that the Rank requirements became obsolete. NULL for current ranks. Some ranks can be completed after the obsolete date if a Scout has started it before that date. See the BSA documentation for the new rank.

ranksreqs

The actual requirements for rank advancement are listed here. The data for this table comes from the BSA Scout Handbook. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
ranks_id	INT UNSIGNED NOT NULL	Index into the ranks table.
designation	VARCHAR(255) DEFAULT NULL	The combination of number(s) and/or letter(s) that the BSA uses to designate a rank requirement, such as 1, 2, 4a.

ermbs

Certain merit badges are required for the Eagle rank. The list of merit badges changes occasionally and is associated with a particular version of the Eagle rank requirements. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
ranks_id	INT UNSIGNED NOT NULL	Index into the ranks table.
meritbadges_id	INT UNSIGNED NOT NULL	Index into the meritbadges table.
ermbgrp_id	INT UNSIGNED DEFAULT NULL	Index into the ermbgrps table. All rows in this table that have the same ermbgrp_id value are mutually exclusive merit badges. Not all of them are required to be completed.

ermbgrps

The Eagle rank requirements allow alternatives to some merit badges, such as Emergency Preparedness OR Lifesaving. Those alternatives are captured here. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
countrequired	INT UNSIGNED NOT NULL	The number of mutually exclusive merit badges that are required to be completed.
comment	VARCHAR(255) DEFAULT NULL	The text that describes the alternatives, such as Earn one of the following merit badges: . If this field is null, the program should display Earn of the following merit badges: . If desired, the software can ignore this field and create the exact wording as defined by the BSA.

ranksreqsdeeds

Rows in this table associate a rank requirement with an event/deed where it was completed. This is the only table in this category that has data specific to a unit.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
deeds_id	INT UNSIGNED NOT NULL	Index into the deeds table.
ranksreqs_id	INT UNSIGNED NOT NULL	Index into the ranksreqs table.

Awards

awards

This table contains a list of awards that can be earned by Scouts and adult leaders. All units will have identical data in this table.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
name	VARCHAR(255) DEFAULT NULL	Name of the award.

scoutsawards

Each row in this table associates an award earned with the Scout who earned it. This table keeps track of the dates the award was earned, purchased and awarded to the Scout. There are fields for general awards, rank advancement and merit badges. Each row can have only one of these three awards. Additional awards require additional rows.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
awards_id	INT UNSIGNED DEFAULT NULL	Index into the awards table. NULL if the award is one that is not listed in the table.
ranks_id	INT UNSIGNED DEFAULT NULL	Index into the ranks table. NULL if the award is one that is not listed in the table.
meritbadges_id	INT UNSIGNED DEFAULT NULL	Index into the meritbadges table. NULL if the award is one that is not listed in the table.
scouts_id	INT UNSIGNED DEFAULT NULL	Index into the scouts table. Identifies the Scout who has earned the award.
date_earned	DATE DEFAULT NULL	Date the award was earned.
date_purchased	DATE DEFAULT NULL	Date the award was purchased.
date_awarded	DATE DEFAULT NULL	Date the award was presented to the Scout.

Control

checkout

This table keeps a list of tables currently being edited. This is used to avoid having multiple users edit the same tables, maybe for the same reason. BSAdv does not keep multiple users from editing the database, it just warns them of the potential conflict. There may be good reasons for a single person to have multiple simultaneous active edit sessions. BSAdv editing algorithms use techniques to maintain the correct state of the final database. This allows multiple users to modify the same tables, without conflicts. Changes to the config, checkout and dblog tables are not logged.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
user_id	INT UNSIGNED NOT NULL	Who is making the edit(s).
item	VARCHAR(255) NOT NULL	The name of the table(s) being edited.
reason	VARCHAR(255) NOT NULL	Why the user is editing data.
datetime	DATETIME NOT NULL	When the user started editing.

dblog

This table holds a record of changes made to the database, and who made them. This is occasionally useful to identify someone that may need additional training in the use of BSAdv. The total number of entries is set by a value in the config table. Each unit can set this to a value they are comfortable with. There is a dblog controller to view these table entries, and optionally delete them.

FIELD	TYPE	DESCRIPTION
id	INT UNSIGNED NOT NULL AUTO_INCREMENT	Identification field for programs.
thistime	DATETIME NOT NULL	Date and time that the update was made.
username	VARCHAR(255) DEFAULT NULL	Name of the user making the change(s). This is the human-readable name, not the user id.
cmd	VARCHAR(2048) DEFAULT NULL	The actual SQL command(s) submitted to MySQL. Multiple commands are simply concatenated, separated by semicolons, and submitted to MySQL in one string.
error	VARCHAR(255) DEFAULT NULL	Error message, or null if there was no error.

GNU Free Documentation License

Version 1.2, November 2002

  Copyright (C) 2000,2001,2002  Free Software Foundation, Inc.
  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements."

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (c)  YEAR  YOUR NAME.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.2
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled "GNU
  Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this:

  with the Invariant Sections being LIST THEIR TITLES, with the
  Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

END OF FILE