Andon Configuration
Andon screens are large shopfloor displays that show live KPI data from your boards without requiring user authentication. Inspired by the Toyota Production System, they provide at-a-glance visual management for operational teams.
Overview
Each Andon screen is powered by an embed token stored in the embed_tokens table with entityType: "andon". The token grants read-only access to KPI data (definitions, values, targets, and sparklines) but never exposes board items, comments, or user information.
Andon displays run in a browser on a wall-mounted monitor, TV, or kiosk device. No login is required -- the URL contains the embed token for authentication.
Getting Started
- Navigate to Settings > Andon.
- Click Create Andon Screen.
- Select the board from a list of all boards in your organization.
- Enter a descriptive label (1-200 characters, e.g., "Building A - Line 3").
- Choose a layout and theme.
- Configure refresh interval and cycle duration.
- Optionally set an expiration date for the token.
- Click Create. Copy the generated Andon URL for the display device.
The system verifies that the selected board belongs to your organization before creating the token.
How It Works
Layout Options
| Layout | Value | Description |
|---|---|---|
| SQCDP | sqcdp | Safety, Quality, Cost, Delivery, People -- the classic lean layout |
| Grid | grid | KPIs arranged in a responsive grid |
| Focus | focus | Single KPI in large format (requires focusKpiId) |
| Alerts | alerts | Only KPIs that are out of threshold are shown |
When multiple layouts are configured via the layouts array, the screen cycles between them at the configured interval.
Theme Options
| Theme | Value | Use Case |
|---|---|---|
| Dark | dark | Best for dimly lit shopfloors and factories |
| Light | light | Best for bright office environments |
| High Contrast | high-contrast | Maximised readability for distant viewing |
The theme is stored as the andonTheme key in the token config to support the extended high-contrast option beyond the base embed token theme types.
Data Refresh
The Andon display polls the getData public endpoint at the configured refresh interval (15 seconds to 60 minutes). Each poll fetches the latest KPI values, targets, thresholds, and the last 7 data points for sparklines. The getData endpoint validates the embed token but requires no user session.
Configuration
| Setting | Type | Validation | Description |
|---|---|---|---|
| Board | String | Required, must exist | The board providing KPI data |
| Label | String | 1-200 characters | Human-readable name for the Andon screen |
| Layout | Enum | Default: sqcdp | Display layout (sqcdp, grid, focus, or alerts) |
| Layouts | Array | Optional | Multiple layouts for cycling |
| Cycle Duration | Integer | 10-3600, default 60 | Seconds between layout transitions |
| Theme | Enum | Default: dark | Visual theme (dark, light, or high-contrast) |
| Refresh Interval | Integer | 15-3600, default 30 | Seconds between data refreshes |
| Focus KPI ID | String | Required for focus | The specific KPI to display in focus layout |
| Alert Audio | Boolean | Default: false | Enable an audible alert when a KPI breaches its threshold |
| Expires At | DateTime | Optional (ISO 8601) | Expiration date for the token |
Router Operations
| Operation | Auth Required | Description |
|---|---|---|
| listBoards | Yes | List all boards available for Andon creation |
| createToken | Yes | Create a new Andon embed token for a board |
| listTokens | Yes | List all Andon tokens for the organization |
| revokeToken | Yes | Delete an Andon token (immediate invalidation) |
| getData | No (public) | Fetch KPI data using the embed token |
Permissions
- Organization Admins and Owners can create, list, and revoke Andon tokens via
orgProcedure. - The Andon display URL is a public endpoint -- anyone with the URL can view the KPI data.
- Revoking a token immediately invalidates its URL.
- Token creation and revocation are recorded in the Audit Log.
The Andon URL grants unauthenticated access to KPI data. Treat it like a password -- do not share it outside your organization or post it publicly.
Tips & Best Practices
Set an expiration date on Andon tokens used for temporary events (e.g., a kaizen week). This ensures the token auto-expires and does not remain active indefinitely.
- Place Andon screens near the work area they monitor for maximum impact.
- Use the SQCDP layout for daily stand-up meetings and gemba walks.
- The Alerts layout is ideal for exception-based management -- nothing shows unless something is wrong.
- Configure a short refresh interval (15-30 seconds) for real-time shopfloor metrics.
- Use the High Contrast theme when the display is viewed from more than 5 metres away.
- For multi-layout cycling, keep the cycle duration between 30-60 seconds so operators can absorb each view.
Network Considerations
Since Andon screens typically run on dedicated kiosk devices on the shopfloor network:
- Ensure the display device can reach the ProBeya server on HTTPS (port 443).
- If using IP allowlisting (Enterprise), add the kiosk device's IP to the allowlist.
- The
getDataendpoint is lightweight (JSON payload of KPI values only) and suitable for low-bandwidth connections. - Consider using a browser kiosk mode (e.g., Chrome
--kioskflag) to prevent accidental navigation away from the Andon display.
Token Expiration
When an Andon token expires, the display shows an error message indicating the token is no longer valid. The admin must create a new token and update the URL on the display device. Tokens without an expiration date remain valid indefinitely until manually revoked.
Related Features
- Integrations -- Connect KPI data sources to boards.
- Workspace Management -- Organise boards that feed Andon displays.
- Security Settings -- Control network-level access to Andon endpoints.
- API Keys -- Programmatic access to the same KPI data via authenticated API.