Field Reference
Screen-by-screen documentation of all form fields, their types, validation rules, and requirements.
Field Type Legend
| Symbol | Meaning |
|---|---|
| Required | Field must have a value |
| Optional | Field can be left empty |
| Auto | Value is automatically generated |
| FK | Foreign key reference to another table |
| Lookup | Reference to a lookup table (e.g., lookup_program_status) |
Common Field Types
| Type | Description | Frontend Component |
|---|---|---|
| Text | Character string | InputText |
| Email address format | InputText | |
| Number | Numeric value | InputNumber |
| Decimal | Decimal number (e.g., credits, currency) | InputNumber |
| Date | Date value | Calendar |
| DateTime | Date and time | Calendar with showTime |
| Boolean | True/False toggle | Checkbox / InputSwitch |
| Select | Dropdown selection | Dropdown |
| Multi-Select | Multiple value selection | MultiSelect |
| Text Area | Long text content | Textarea |
Lookup Value Types
Common lookup types used throughout the system:
| Type Code | Used For |
|---|---|
| PROGRAM_STATUS | Program statuses (Active, Inactive, Suspended) |
| COURSE_STATUS | Course catalog statuses |
| SECTION_STATUS | Section offering statuses |
| ENROLLMENT_STATUS | Student enrollment statuses |
| STUDENT_STATUS | Student record statuses |
| TERM_TYPE | Academic term types (Fall, Spring, Summer) |
| ADDRESS_TYPE | Address categories |
| PHONE_TYPE | Phone number types |
| EMAIL_TYPE | Email address types |
| NAME_TYPE | Person name types (Legal, Preferred) |
See Lookup Codes for complete list.
Documentation Sections
Academic
- Academic Year - Academic year configuration
- Terms - Academic term settings
- Courses - Course catalog entries
- Sections - Course section offerings
- Degrees - Degree programs
- Majors - Major declarations
- Minors - Minor declarations
- Requirements - Degree requirement blocks
People
- Person - Core person record
- Names - Person name records
- Addresses - Person addresses
- Phones - Phone numbers
- Emails - Email addresses
Roles
Registration
- Enrollment - Course enrollments
- Holds - Student holds
- Planned Courses - Degree planning
Billing
- Billing Methods - Tuition calculation methods
- Fee Types - Fee definitions
- Payment Plans - Payment plan configurations
Organization
- Campus - Campus locations
- Buildings - Building records
- Rooms - Room records
- Departments - Academic departments