MDM-documentatie
Kioskys ondersteunt beheerde app-configuratie (Managed App Configuration). Je MDM levert de app een plist met sleutels; elke sleutel die je instelt wint van wat de gebruiker heeft getypt, en de gebruiker kan hem niet wijzigen. Alle sleutels zijn optioneel.
Wat je nodig hebt
- Een gesuperviseerde iPad die bij je MDM is ingeschreven (nodig voor de modus voor één app).
- Kioskys, in volume gekocht in Apple Business Manager (betaalde app, toegewezen aan je apparaten of gebruikers) en door het MDM geïnstalleerd als beheerde app: de configuratie wordt alleen aan beheerde apps geleverd.
- De Bundle ID van de app: app.consulenza.kioskys (voor iedereen hetzelfde, je hoeft hem niet te wijzigen).
Sleutels
| Sleutel | Type | Waarden | Wat het doet |
|---|---|---|---|
kioskURL | tekenreeks | adres | De kioskwebsite. Zonder schema wordt https:// toegevoegd (http:// voor IP-adressen en het lokale netwerk). |
autoStartSeconds | geheel getal | 0, of 3–120 | Seconden van het aftellen bij het starten. 0 = geen instellingenscherm, de kiosk start meteen. Standaard 10. |
settingsPIN | tekenreeks | 4–8 cijfers | Pincode die de instellingen beveiligt. De gebruiker kan hem niet wijzigen of verwijderen. Schrijf hem als tekenreeks zodat voorloopnullen behouden blijven. |
allowUserConfiguration | boolean | true / false | false = het instellingenscherm is alleen-lezen. Standaard true. |
allowedHosts | array van tekenreeksen | hostnamen | Extra domeinen waarnaar de pagina mag navigeren (bijvoorbeeld een externe login). Alleen hostnamen, geen schema of pad. |
allowCamera | boolean | true / false | Geeft de pagina's van de geconfigureerde site toegang tot de camera. Standaard true. |
allowLocation | boolean | true / false | Geeft toegang tot de locatie. Bij false antwoordt navigator.geolocation met "denied". Standaard true. |
staleReloadMinutes | geheel getal | 0–1440 | Minuten op de achtergrond waarna de pagina bij terugkeer opnieuw wordt geladen. 0 = nooit. Standaard 0 (uit). |
orientation | tekenreeks | auto, portrait, landscape | Oriëntatievergrendeling (portrait en landscape staan ook de draai van 180° toe). Standaard auto. |
energySaverEnabled | boolean | true / false | Energiebesparing: na de ingestelde minuten zonder aanraking dimt het scherm tot 5%; een aanraking herstelt 100%. Standaard true. |
energySaverMinutes | geheel getal | 1–120 | Minuten zonder aanraking voordat het scherm dimt. Standaard 5. |
deviceName | tekenreeks | 1–80 tekens | Apparaatnaam, voor pagina's zichtbaar als window.Kioskys.deviceName. |
openingHours | dictionary | mon … sun, daily | Openingstijden. Elke dag is "HH:mm-HH:mm", "24h" of "closed"; niet vermelde dagen zijn gesloten tenzij daily is opgegeven. Lege dictionary = altijd open. Sluiting vóór opening = open tot na middernacht. |
closedMessage | tekenreeks | tot 200 tekens | Tekst die op het gesloten-scherm wordt getoond. |
idleResetSeconds | geheel getal | 0, of 10–3600 | Na dit aantal seconden zonder aanraking (of toetsaanslag) keert de kiosk terug naar zijn eerste pagina. 0 = uit. Standaard uit. |
idleResetClearData | boolean | true / false | Wist bij het resetten ook cookies en websitegegevens. Standaard true. |
playlist | array van dictionaries | type, url, seconds, muted | Afspeellijstmodus: pagina's, foto's en video's om beurten in een lus (tot 50). type: page, image of video; seconds: 3–3600 (0 bij een video = tot het einde); muted: true dempt een video. Foto's en video's worden gedownload en op de iPad bewaard, dus ze spelen zonder vertraging. Vervangt kioskURL. Lege array = klassieke kiosk. |
closedBrightness | geheel getal | 0–100 | Helderheid van het scherm tijdens gesloten (procent). Standaard 5. |
closedMedia | dictionary | type, url | Een foto of video die tijdens gesloten wordt getoond: {type: image of video, url}. Hij wordt gedownload en op de iPad bewaard; een video wordt herhaald. Lege dictionary = standaard gesloten-scherm. |
bridgeEnabled | boolean | true / false | De JavaScript-bridge (window.Kioskys.scan, beep). Standaard true. |
disablePageZoom | boolean | true / false | Blokkeert paginazoom: knijpen, dubbeltikken en de viewport van de pagina. Standaard true. |
scannerCamera | tekenreeks | front, back | Camera die Kioskys.scan() gebruikt. Standaard front. |
energySaverBrightness | geheel getal | 0–100 | Schermhelderheid (procent) terwijl Energiebesparing het scherm heeft gedimd. Standaard 5. Verhoog dit als je een schermbeveiliging gebruikt. |
screensaverEnabled | boolean | true / false | Schermbeveiliging: terwijl Energiebesparing het scherm dimt, wordt een foto of video getoond in plaats van de kiosk; een aanraking brengt de kiosk terug. Ze heeft geen eigen timer of helderheid. Standaard uit (gaat vanzelf aan als je screensaverMedia stuurt zonder deze sleutel). |
screensaverMedia | dictionary | type, url | Foto of video van de schermbeveiliging: {type: image of video, url}. Wordt gedownload en op de iPad bewaard; een video wordt herhaald, zonder geluid. Leeg dictionary = geen inhoud (de schermbeveiliging start niet). |
customCSS | tekenreeks | ≤ 100 000 | CSS die aan elke pagina van de kioskwebsite wordt toegevoegd (en van de domeinen in allowedHosts), niet aan pagina’s van derden waarnaar de site doorverwijst. Wordt toegepast voordat de pagina verschijnt. |
customJS | tekenreeks | ≤ 100 000 | JavaScript dat op elke pagina van de kioskwebsite (en van de domeinen in allowedHosts) wordt uitgevoerd zodra die is geladen; window.Kioskys is beschikbaar. Fouten komen in de console van de pagina. Met customJS bepaalt je MDM wat er in de kiosk draait: schrijf het zoals de code van je eigen site. |
Goed om te weten
- Getallen en booleans die als tekenreeks worden verstuurd ("10", "true") worden geaccepteerd. Ongeldige waarden worden genegeerd en gemeld, ze laten de app nooit crashen.
- De settingsPIN staat in leesbare tekst in het profiel (beheerders van het MDM kunnen hem zien). De app bewaart hem niet op het apparaat.
- Wijzigingen in het MDM worden toegepast terwijl de app open is; een nieuw adres laadt de pagina opnieuw.
- De app meldt haar status in com.apple.feedback.managed (versie, adres, pagina geladen, status van de camera- en locatietoestemming, configuratieproblemen).
- Kioskys houdt de iPad wakker zolang de app op de voorgrond staat. Om te voorkomen dat iemand de app verlaat, gebruik je de modus voor één app.
- Vijf snelle tikken in de linkerbovenhoek openen de instellingen opnieuw (alleen-lezen als allowUserConfiguration false is; een eventuele settingsPIN wordt eerst gevraagd).
- Dezelfde sleutels werken ook zonder MDM: de pagina QR-configurator zet ze om in een QR-code die de instellingen naar een iPad kopieert. Wat een MDM instelt, wint altijd en de gebruiker kan het niet wijzigen.
Kant-en-klare bestanden
De profielen bevatten al de Bundle ID app.consulenza.kioskys. Genereer vóór gebruik nieuwe UUID's (uuidgen). De opmerkingen in de bestanden zijn in het Engels.
- App-configuratie (alle sleutels)
- Profiel voor de modus voor één app (het MDM vergrendelt de iPad op Kioskys)
- Profiel voor de autonome modus voor één app (de app vergrendelt zichzelf)
Voorbeeldconfiguratie
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<!--
Kioskys - Managed App Configuration
Paste this dictionary into the "App Configuration" field of your MDM, for the app with the Bundle ID
app.consulenza.kioskys. All keys are optional: keep only the ones you need.
A key that is present wins over what the user set by hand, and the user cannot change it.
-->
<plist version="1.0">
<dict>
<!-- Kiosk address. Without a scheme https:// is added (http:// for IPs and local network). -->
<key>kioskURL</key>
<string>https://example.org/kiosk</string>
<!-- Seconds of the start countdown: 0 = no settings screen, the kiosk starts immediately; otherwise 3-120. -->
<key>autoStartSeconds</key>
<integer>0</integer>
<!-- PIN protecting the settings (string of 4-8 digits). The user cannot change or remove it.
Note: it is in clear text inside the profile (MDM administrators can see it). It is not stored on the device. -->
<key>settingsPIN</key>
<string>4821</string>
<!-- false = the settings screen is read-only (no local changes). Default: true. -->
<key>allowUserConfiguration</key>
<true/>
<!-- Extra domains the page may navigate to (e.g. an external login). Host names only, no https:// and no paths. -->
<key>allowedHosts</key>
<array>
<string>login.example.com</string>
</array>
<!-- Camera and location granted to the pages of the configured site. Default: true. -->
<key>allowCamera</key>
<true/>
<key>allowLocation</key>
<true/>
<!-- Minutes in the background after which the page reloads on return (0 = never). Default: 0. -->
<key>staleReloadMinutes</key>
<integer>0</integer>
<!-- Screen orientation lock: auto (free), portrait or landscape.
Portrait and landscape also allow the 180-degree flip. Default: auto. -->
<key>orientation</key>
<string>landscape</string>
<!-- Energy Saver: after energySaverMinutes without touches the brightness drops to energySaverBrightness (default 5%); a touch restores 100%.
Default: on, 5 minutes. Minutes: 1 to 120. Brightness: 0 to 100. -->
<key>energySaverEnabled</key>
<true/>
<key>energySaverMinutes</key>
<integer>5</integer>
<key>energySaverBrightness</key>
<integer>30</integer>
<!-- Device name, visible to pages as window.Kioskys.deviceName (max 80 characters). -->
<key>deviceName</key>
<string>Warehouse iPad 1</string>
<!-- Opening hours: mon..sun (or daily) as "HH:mm-HH:mm", "24h" or "closed". Days not listed are closed unless daily is given.
An empty dictionary means always open. Outside the hours the kiosk shows a closed screen at minimum brightness. -->
<key>openingHours</key>
<dict>
<key>daily</key>
<string>08:00-20:00</string>
<key>sun</key>
<string>closed</string>
</dict>
<key>closedMessage</key>
<string>We are closed. See you tomorrow!</string>
<!-- Closed screen: brightness in percent (default 5) and an optional photo or video that is downloaded and saved on the iPad.
Use <dict/> for the standard closed screen (moon and message). -->
<key>closedBrightness</key>
<integer>40</integer>
<key>closedMedia</key>
<dict>
<key>type</key><string>image</string>
<key>url</key><string>https://example.org/closed.jpg</string>
</dict>
<!-- Inactivity reset: after this many seconds without touches the kiosk returns to its first page (0 = off; 10-3600). -->
<key>idleResetSeconds</key>
<integer>120</integer>
<key>idleResetClearData</key>
<true/>
<!-- Playlist: pages, photos and videos shown in turn, in a loop (up to 50). It replaces kioskURL when present; an empty array = no playlist.
seconds: 3-3600; for a video 0 means "until it ends". -->
<key>playlist</key>
<array>
<dict>
<key>type</key><string>page</string>
<key>url</key><string>https://example.org/menu</string>
<key>seconds</key><integer>30</integer>
</dict>
<dict>
<key>type</key><string>image</string>
<key>url</key><string>https://example.org/offer.jpg</string>
<key>seconds</key><integer>10</integer>
</dict>
<dict>
<key>type</key><string>video</string>
<key>url</key><string>https://example.org/promo.mp4</string>
<key>seconds</key><integer>0</integer>
<key>muted</key><true/>
</dict>
</array>
<!-- JavaScript bridge (window.Kioskys.scan / beep) and the camera used for scanning: front or back. -->
<key>bridgeEnabled</key>
<true/>
<!-- Blocks page zoom: pinch, double-tap and the page's own viewport. Default: true. -->
<key>disablePageZoom</key>
<true/>
<key>scannerCamera</key>
<string>front</string>
<!-- Screensaver: while the Energy Saver has dimmed the screen (energySaverMinutes/energySaverBrightness) this photo or video is shown; a touch brings the kiosk back. It has no timer of its own. -->
<key>screensaverEnabled</key>
<true/>
<key>screensaverMedia</key>
<dict>
<key>type</key><string>video</string>
<key>url</key><string>https://example.org/screensaver.mp4</string>
</dict>
<!-- Custom CSS and JavaScript, applied to the pages of the kiosk site (not to third-party pages). Up to 100000 characters each. -->
<key>customCSS</key>
<string>.cookie-banner { display: none !important; }</string>
<key>customJS</key>
<string>document.documentElement.classList.add('kiosk');</string>
</dict>
</plist>