Client Devices
This article covers how to set up client devices for Supra, enable Supra mode per-applet, and manage connected clients.
Prerequisites
| Condition | Detail |
|---|---|
| Feature entitlement | The organization must have the Supra On-Premise feature entitlement enabled. |
| Supra Server running | A Supra Server must be installed and running in the same Location. See Supra Server. |
| Same Location | The client device must be assigned to the same Location as the Supra Server. |
| Supported platform | The client device must be a supported platform. |
Location Setup
All devices in a Supra deployment must be in the same Location:
- Create or select a Location in Box.
- Assign the Supra Server device to the Location.
- Assign all client devices to the same Location.
- (Optional) Add
[SUPRA_SECURE]to the Location description to enable TLS for Android and Emulator clients. See TLS Setup.
Enabling Supra Mode
When the Supra On-Premise feature entitlement is active, an additional Supra column appears in the Applets table on the device detail page. This column is visible on all devices in the organization.
Each timing row shows a toggle switch:
- On — sets
supra: enabledin the timing configuration. The client device connects to the Supra Server and displays remotely rendered content instead of running the applet locally. - Off — removes the
suprakey, returning the applet to normal local rendering.
After toggling Supra mode, the affected client device may need to restart its applet for the change to take effect. You can trigger a manual restart using the App Restart Power action.
What Happens When Supra Mode Is Enabled
- The timing configuration is updated with
supra: enabled. - On the next applet lifecycle event (or after a manual refresh), the client device detects the Supra flag.
- The device connects to the Supra Server in the same Location.
- The Supra Server begins rendering the original applet in a headless Chromium browser and delivers the output to the client device.
What Happens When Supra Mode Is Disabled
- The
suprakey is removed from the timing configuration. - On the next applet lifecycle event, the client device detects the configuration change.
- The device stops receiving rendered content from the Supra Server and reverts to running the originally assigned applet locally.
Platform-Specific Setup
For the full compatibility table, see Supported Platforms.
Android
Android devices require a few additional steps:
- Install the latest WebView — Ensure the latest Android System WebView package is installed (e.g., version 114 or newer). See Common Issues for details.
- Switch to ExoPlayer — Android devices must use ExoPlayer for video playback. See Common Issues for step-by-step instructions.
- Enable TLS (recommended) — See TLS Setup.
Monitoring Client Status
From the Supra Server
Navigate to the Supra Server's device detail page → Supra tab → Connected Clients table. Each client row shows the applet, version, Supra status, and a Refresh button. See Supra Server — Connected Clients.
From the Client Device
On the client device's detail page → Applets tab, the Supra column indicates whether Supra mode is enabled for each timing.
Managing Multiple Client Devices
- Supra mode is per-applet, not per-device — A single device can have some applets running via Supra and others rendering locally.
- Use the Supra Server's Clients table — The Connected Clients table provides a centralized view of all client devices and their Supra status.
- Client count — The Supra Server's Client Count card shows enabled vs. total clients for a quick deployment overview.
Refreshing Client Devices
If a client device does not pick up a Supra mode change automatically:
- From the client device: Use the App Restart Power action to restart the applet.
Related Topics
- Supra Overview — General introduction to Supra
- Supra Server — Installing and managing the Supra Server
- Supported Platforms — Compatible server and client platforms
- Common Issues — Troubleshooting platform-specific problems