Keystone Documentation                                             ESCHEMA
--------------------------------------------------------------------------
$Id: eschema.txt,v 1.2 1999/07/13 21:23:20 roberts Exp $
==========================================================================

Keystone provides a mechanism that allows users to 'extend' the structure
of tables within the system.  This allows local customizations that do
not involve altering the basic table structure that Keystone is 
distributed with.  An administrator can add columns to forms, and still
be compatible with the Keystone distribution.

Note you must be an Administrator in Keystone to modify extended table
schema.  See 'groups.txt' for information on how to do this.

To add columns to a table, go into the 'Maint' functions under the 'Other'
menu, and click on 'Eschema'.  This brings up the Extended Schema table
editor.  All schema changes happen through this screen.  The columns are:

	_rowid	An column used internally by Keystone to track rows.

	etable	The name of the table to be affected.   As of Keystone
		0.22.00, only 'slips' and 'followups' are supported here.

	element	The name of the new column.  This must be under 8 
		characters, and should not conflict with an existing
		column name from the table being added to.  

	etype	A type identifier.  "I" for Integer, "C" for Character

	eflags	Flags to Keystone describing special functionality.
		See below for details.

	esequence	The order to display the extended schema
		columns.

	elength	How 'wide' a column should be.  For Integer columns,
		this is the number of digits.  (ala, to store the
		numbers 0-999, this value would be '3'.

	elabel	A text field describing the column.  This will be the 
		text shown on the form when data is requested.  It
		is free form.


FLAGS
	The 'eflags' column has special meaning depending on which table
is being extended.  To flag a column in 'eschema', enter in the identifier
from the table below.

	Tablename:	'followups'

	Flag	Function
	-------	------------------------------------------------------
	V	Visible.  This column will display in the followup 
		summary when a slip's followups are expanded in the 
		browse screen.  If this flag is not specified, the 
		followup will not be shown, but will be on the form
		when followups are added.  
 
        O       The row is part of an option menu.  All parts of an
                option menu must have the same value in the element
                column and should have sequential esequence values.  If
                they do not have sequential esequence values, you will
                end up with multiple option menus with the same label
                which will result in an unpredictable value.

		

