Onsite Modules

​

Overview

​

Core Module

​

OnsiteCore

• Admin Title: “Onsite Reg Core Module”
• Link Title: “onsite”
• Module Type: “onsite”
• Seq: -1000 (displayed first)
• Choosable: Yes

• Central hub for all onsite operations
• Quick access to all enabled onsite modules
• Different interface for admin vs. onsite-only staff
• Links to most-used onsite tools

• main - Main onsite landing page

​

Check-in Modules

​

OnSiteCheckinModule

• Admin Title: “On-Site User Check-In”
• Link Title: “Check-in (check students off for payments and forms)”
• Module Type: “onsite”
• Seq: 1
• Choosable: Yes

• Barcode scanning for rapid check-in
• Manual student search and lookup
• Payment verification and marking
• Medical/liability form verification
• Attendance recording
• Student information display
• Schedule viewing
• Onsite profile editing

• checkin - Main check-in interface
• barcode_checkin - Barcode-based check-in
• student_status - View individual student status
• mark_paid - Mark student as paid
• mark_attended - Mark student as checked in

1. Scan barcode or search for student
2. View student information and schedule
3. Verify payment status
4. Verify medical/liability forms
5. Mark as checked in (attended)
6. Print materials if needed

• attended: Student has checked in
• paid: Payment received
• Med: Medical form submitted
• Liab: Liability form submitted

​

OnSiteCheckoutModule

• Admin Title: “On-Site User Check-Out”
• Link Title: “Check-out”
• Module Type: “onsite”
• Seq: 2
• Choosable: Yes

• Mark students as checked out
• Verify student departure
• Track who is still on premises

​

TeacherCheckinModule

• Admin Title: “Teacher Check-In”
• Link Title: “Check in teachers”
• Module Type: “onsite”
• Seq: 10
• Choosable: Yes

• Barcode or manual check-in
• View teacher’s schedule
• See which classes they’re teaching
• Mark teachers as present
• Room assignment information

• teachercheckin - Main teacher check-in interface
• barcode_checkin - Barcode-based teacher check-in

​

Registration and Class Management

​

OnSiteRegister

• Admin Title: “Onsite New Registration”
• Link Title: “New Student Registration”
• Module Type: “onsite”
• Seq: 30
• Choosable: Yes

• Create new student accounts on-site
• Minimal information required:
  • First and last name
  • Email
  • Grade
  • School
  • Payment status
  • Medical/liability status
• Automatically mark as attended and checked in
• Generate temporary password
• Redirect to class selection

• onsite_create - Registration form for new students

1. Student arrives without pre-registration
2. Staff enters basic information
3. System creates account
4. Student can immediately select classes
5. Password reset email sent

​

OnSiteClassList

• Admin Title: “Show Open Classes at Onsite Registration”
• Link Title: “List of Open Classes”
• Module Type: “onsite”
• Seq: 32
• Choosable: Yes

• View all classes with open spots
• Filter by time, category, grade
• See current enrollment vs. capacity
• Real-time updates
• Print class lists

• classlist - Main class list view
• classlist_by_time - Classes organized by timeslot

• Class title and code
• Teacher name
• Time and room
• Current enrollment
• Available spots
• Grade range

​

OnsiteClassSchedule

• Admin Title: “Onsite Class Schedule Display”
• Link Title: “Class Schedule”
• Module Type: “onsite”
• Seq: 20
• Choosable: Yes

• Grid view of all classes by time
• Filter by category, room, teacher
• Printable format
• Large display mode for posting

​

Attendance and Tracking

​

OnSiteAttendance

• Admin Title: “On-Site Student Attendance”
• Link Title: “Check Student Attendance”
• Module Type: “onsite”
• Seq: 1
• Choosable: Yes

• Mark attendance for individual classes
• View attendance reports
• Track no-shows
• Statistics on class attendance
• Export attendance data

• attendance - Main attendance interface
• class_attendance - Attendance for a specific class
• attendance_reports - Summary reports

• Teachers mark attendance at start of class
• Track which students attended which classes
• Identify students not attending registered classes
• Generate attendance certificates

​

Payment Modules

​

OnsitePaidItemsModule

• Admin Title: “Onsite Paid Items”
• Link Title: “Sell Items”
• Module Type: “onsite”
• Seq: 15
• Choosable: Yes

• Record onsite purchases (t-shirts, meals, etc.)
• Accept payments
• Update student accounts
• Print receipts

​

Printing Modules

​

OnsitePrintSchedules

• Admin Title: “Onsite Schedule Printing”
• Link Title: “Print Schedules”
• Module Type: “onsite”
• Seq: 25
• Choosable: Yes

• Search for student
• Print their schedule immediately
• Batch printing for multiple students
• Various schedule formats

​

Display and Information

​

BigBoardModule

• Current classes in progress
• Next timeslot preview
• Room assignments
• Auto-refresh for projector display

​

Admin-Accessible Onsite Tools

​

From Admin Modules:

• CommModule: Send announcements to participants
• AdminClass: Make class changes on the fly
• ResourceModule: Reassign rooms
• AJAXSchedulingModule: Fix scheduling conflicts
• ProgramPrintables: Print rosters, schedules, etc.

​

Student/Teacher Onsite Modules

​

StudentOnsite

​

TeacherOnsite

​

Common Onsite Workflows

​

Student Arrival Workflow

1. Check-in (OnSiteCheckinModule):
   • Scan barcode or search by name
   • Verify identity
   • Check payment status
   • Verify forms
   • Mark as attended
2. Class Selection (if needed):
   • View open classes (OnSiteClassList)
   • Help student add classes
   • Print schedule (OnsitePrintSchedules)
3. Ongoing:
   • Take attendance in classes (OnSiteAttendance)
   • Handle schedule changes
   • Track student location

​

Walk-in Student Workflow

1. Registration (OnSiteRegister):
   • Create new account
   • Collect payment
   • Verify forms
2. Class Selection:
   • View open classes
   • Register for classes
   • Print schedule
3. Automatic Check-in:
   • Already marked as attended during registration

​

Teacher Arrival Workflow

1. Check-in (TeacherCheckinModule):
   • Verify identity
   • Show schedule and room assignments
   • Mark as present
2. Support:
   • Answer questions about schedule
   • Provide room keys/materials
   • Handle last-minute changes

​

Development Notes

​

Creating a Custom Onsite Module

from esp.program.modules.base import ProgramModuleObj, needs_onsite, main_call
from esp.utils.web import render_to_response

class MyOnsiteModule(ProgramModuleObj):
    doc = """Description of onsite functionality."""
    
    @classmethod
    def module_properties(cls):
        return {
            "admin_title": "My Onsite Tool",
            "link_title": "My Tool",
            "module_type": "onsite",
            "seq": 50,
            "choosable": 1,
        }
    
    @main_call
    @needs_onsite
    def mytool(self, request, tl, one, two, module, extra, prog):
        context = {'program': prog}
        return render_to_response(self.baseDir() + 'main.html', request, context)

​

Onsite Module Best Practices

1. Speed is Critical: Onsite tools must be fast and responsive
2. Minimize Clicks: Design for efficiency with many users
3. Clear Feedback: Provide immediate visual/audio confirmation
4. Error Handling: Gracefully handle barcode scanning errors
5. Offline Capability: Consider what happens if internet is slow
6. Print-Friendly: Many onsite outputs need to be printable
7. Large Touch Targets: May be used on tablets/touchscreens
8. Barcode Support: Implement barcode scanning where possible

​

Permission Decorators for Onsite

@needs_onsite  # Requires onsite staff or admin
@needs_onsite_no_switchback  # Stricter onsite requirement

​

Common Onsite Patterns

​

Student Lookup

from esp.users.views import search_for_user

user, found = search_for_user(request, 
    ESPUser.objects.filter(program_students=prog))
if not found:
    return user  # Returns the search form
# Use user object

​

Barcode Scanning

def barcode_checkin(self, request, tl, one, two, module, extra, prog):
    if request.method == 'POST':
        barcode = request.POST.get('barcode')
        try:
            user = ESPUser.objects.get(id=barcode)
            # Process check-in
        except ESPUser.DoesNotExist:
            # Handle error

​

Record Management

from esp.users.models import Record, RecordType

# Create a record
rt = RecordType.objects.get(name="attended")
rec = Record.objects.create(
    user=student,
    event=rt,
    program=prog
)

# Check if record exists
has_attended = Record.objects.filter(
    user=student,
    event__name="attended",
    program=prog
).exists()

​

Hardware Recommendations

1. Barcode Scanners: USB or Bluetooth scanners for check-in
2. Tablets: For mobile check-in stations
3. Receipt Printers: For printing schedules and receipts
4. Large Displays: For class schedules and announcements
5. Backup Internet: Mobile hotspot in case of WiFi issues

​

See Also

• Program Modules Overview
• Student Modules
• Teacher Modules
• Admin Modules