Coding Standards & Examples - Fields

Prefix	Name	Description
__kp	Primary Key	Auto enter serial number unique to each record.
_ks	Secondary Key	Key field used to relate to another key field (either from the same table or from another).
_kf	Foreign Key	Key field used to relate to the primary key from another table.
d	Data	All user data fields.
a	Account	Account or user information.
b	Button	Fields used for displaying button graphics or text.
c	Constant	Fixed data within a calculation, i.e. Admin Link.
e	External Plug-ins	All fields related to plug-in functionality.
f	Filter / Find	Global and calculation fields used for searching and filtering a portal.
h	Help	Fields used as part of the help system.
l	Layout	Information related to the layout, i.e. Tabs
m	Module / Menu	Menu related fields.
n	Navigation	Used for Back / Forward / History functionality.
p	Preferences	Fields that are used across the system.
r	Record	Auto entered data related to the record, i.e. Creation name, etc.
s	Summary	Summary fields.
t	Table	Fields that store table related information, i.e. Current record count
u	Utility	For use with utility fields, i.e. value lists.
v	Variables	Used to store temporary global information.

All spaces should be replaced by underscores.

All key fields, unless otherwise indicated, will be number fields. If a key field is text it must be indicated by adding a "_t" suffix. Key fields should be prefixed with a single underscore and primary keys with a double (this allows the fields to appear at the top of a list alphabetically).

Fields used as flags should have the following suffix added to them: "_Flag" followed by "_n" if it's a number and "_t" if it's text. Moreover all flags should be commented showing a comma-delimited list of possible values and whether a value is auto-entered (square brackets).

Example field names:

__kp_COMPANY
__kp_t_COMPANY
_ks_Company_Type
_kf_Staff
d_Address_1
d_Status_Flag_n
v_Text_9
v_kf_Company

Note: the number after a variable will indicate the number of repetitions that field is set to store.