Contact Us Sign In

Reference · Updated Mar 27, 2026

Field Reference — Display Screen Form

1 min read 1,044 views

Field Reference — Display Screen Form

This reference covers every field in the Create Display Screen and Edit Display Screen forms.

UI Label	Backend Variable	Type	Required	Validation	Notes
Name	`name`	string	Yes	max:100	Used to generate URL slug
Campus	`campus_id`	ULID	Yes	exists:campuses	Which campus this display is for
Assigned Offices	`assigned_office_ids`	JSON array	—	—	Which offices to show on this screen
Theme	`theme`	string	—	in: dark, light	Default: dark
Audio Enabled	`audio_enabled`	bool	—	—	Alert sound plays on ticket call
TTS Enabled	`tts_enabled`	bool	—	—	Text-to-speech announces ticket number
TTS Language	`tts_language`	string	—	Any IETF language tag	e.g., "en-US", "fil-PH", "tl-PH"
Show Announcements	`show_announcements`	bool	—	—	Enables the scrolling announcements panel
Active	`is_active`	bool	—	—	Inactive screens are rejected at token authentication

Auto-Generated Fields (Read-Only)

Field	Notes
Access Token	64-character random token; stored as SHA-256 hash; used in display URL
Display URL	`{school}.schoolaide-q.com/display/{token}`
Last Heartbeat	Updated every Livewire render; used for Online/Offline status

Was this article helpful?

Let us know so we can improve our documentation.

Related articles

Workflow — Complete Queue Journey (Walk-Up) Workflow — Appointment to Ticket Frequently Asked Questions — SchoolAide Queue SchoolAide Queue — Module Overview Workflow — Multi-Stage Service