Kioskys

MDM-dokumentaatio

Kioskys tukee hallittua sovellusmääritystä (Managed App Configuration). MDM toimittaa sovellukselle avaimista koostuvan plistin; jokainen asettamasi avain voittaa käyttäjän kirjoittaman, eikä käyttäjä voi muuttaa sitä. Kaikki avaimet ovat valinnaisia.

Mitä tarvitset

Avaimet

AvainTyyppiArvotMitä se tekee
kioskURLmerkkijonoosoiteKioskin verkkosivusto. Ilman skeemaa lisätään https:// (http:// IP-osoitteille ja paikalliselle verkolle).
autoStartSecondskokonaisluku0, tai 3–120Käynnistyksen laskennan sekunnit. 0 = ei asetusnäyttöä, kioski käynnistyy heti. Oletus 10.
settingsPINmerkkijono4–8 numeroaPIN-koodi, joka suojaa asetukset. Käyttäjä ei voi muuttaa tai poistaa sitä. Kirjoita merkkijonona, jotta alkunollat säilyvät.
allowUserConfigurationtotuusarvotrue / falsefalse = asetusnäyttö on vain luku -tilassa. Oletus true.
allowedHostsmerkkijonotaulukkoisäntänimetLisäverkkotunnukset, joille sivu saa siirtyä (esimerkiksi ulkoinen kirjautuminen). Vain isäntänimet, ei skeemaa eikä polkua.
allowCameratotuusarvotrue / falseAntaa määritetyn sivuston sivuille pääsyn kameraan. Oletus true.
allowLocationtotuusarvotrue / falseAntaa pääsyn sijaintiin. Jos false, navigator.geolocation vastaa "denied". Oletus true.
staleReloadMinuteskokonaisluku0–1440Taustalla vietetyt minuutit, joiden jälkeen sivu ladataan uudelleen palattaessa. 0 = ei koskaan. Oletus 0 (pois).
orientationmerkkijonoauto, portrait, landscapeSuuntalukitus (portrait ja landscape sallivat myös 180° käännön). Oletus auto.
energySaverEnabledtotuusarvotrue / falseVirransäästö: asetettujen minuuttien kosketuksettomuuden jälkeen näyttö himmenee 5 %:iin; kosketus palauttaa 100 %. Oletus true.
energySaverMinuteskokonaisluku1–120Kosketuksettomat minuutit ennen himmennystä. Oletus 5.
deviceNamemerkkijono1–80 merkkiäLaitteen nimi, näkyy sivuille muodossa window.Kioskys.deviceName.
openingHourssanakirjamon … sun, dailyAukioloajat. Jokainen päivä on "HH:mm-HH:mm", "24h" tai "closed"; mainitsemattomat päivät ovat suljettuja, ellei daily ole annettu. Tyhjä sanakirja = aina auki. Sulkeminen ennen avaamista = auki keskiyön yli.
closedMessagemerkkijonoenintään 200 merkkiäSuljettu-näytössä näytettävä teksti.
idleResetSecondskokonaisluku0, tai 10–3600Näin monen sekunnin kosketuksettomuuden (tai näppäinpainalluksen) jälkeen kioski palaa ensimmäiselle sivulleen. 0 = pois. Oletus pois.
idleResetClearDatatotuusarvotrue / falseTyhjentää nollauksessa myös evästeet ja verkkosivuston tiedot. Oletus true.
playlistsanakirjataulukkotype, url, seconds, mutedSoittolistatila: sivut, valokuvat ja videot vuorotellen silmukassa (enintään 50). type: page, image tai video; seconds: 3–3600 (0 videolle = loppuun asti); muted: true mykistää videon. Valokuvat ja videot ladataan ja tallennetaan iPadille, joten ne toistuvat viiveettä. Korvaa kioskURL:n. Tyhjä taulukko = perinteinen kioski.
closedBrightnesskokonaisluku0–100Näytön kirkkaus suljettuna (prosenttia). Oletus 5.
closedMediasanakirjatype, urlSuljettuna näytettävä valokuva tai video: {type: image tai video, url}. Se ladataan ja tallennetaan iPadille; video toistuu uudelleen. Tyhjä sanakirja = tavallinen suljettu-näyttö.
bridgeEnabledtotuusarvotrue / falseJavaScript-silta (window.Kioskys.scan, beep). Oletus true.
disablePageZoomtotuusarvotrue / falseEstää sivun zoomauksen: nipistys, kaksoisnapautus ja sivun oma viewport. Oletus true.
scannerCameramerkkijonofront, backKioskys.scan()-funktion käyttämä kamera. Oletus front.
energySaverBrightnesskokonaisluku0–100Näytön kirkkaus (prosentteina), kun virransäästö on himmentänyt näytön. Oletus 5. Nosta sitä, jos käytät näytönsäästäjää.
screensaverEnabledtotuusarvotrue / falseNäytönsäästäjä: kun virransäästö himmentää näytön, kioskin tilalla näkyy kuva tai video; kosketus palauttaa kioskin. Sillä ei ole omaa ajastinta tai kirkkautta. Oletus pois (kytkeytyy itse päälle, jos lähetät screensaverMedian ilman tätä avainta).
screensaverMediasanakirjatype, urlNäytönsäästäjän kuva tai video: {type: image tai video, url}. Se ladataan ja tallennetaan iPadiin; video toistuu ilman ääntä. Tyhjä dictionary = ei sisältöä (näytönsäästäjä ei käynnisty).
customCSSmerkkijono≤ 100 000CSS, joka lisätään kioskisivuston jokaiselle sivulle (ja allowedHosts-verkkotunnusten sivuille), ei kolmansien osapuolten sivuille, joille sivusto ohjaa. Otetaan käyttöön ennen kuin sivu tulee näkyviin.
customJSmerkkijono≤ 100 000JavaScript, joka suoritetaan kioskisivuston jokaisella sivulla (ja allowedHosts-verkkotunnusten sivuilla) sen latauduttua; window.Kioskys on käytettävissä. Virheet menevät sivun konsoliin. customJS:n kanssa MDM päättää, mitä kioskissa suoritetaan: kirjoita se kuin oman sivustosi koodi.

Hyvä tietää

Valmiit tiedostot

Profiileissa on jo Bundle ID app.consulenza.kioskys. Luo niille uudet UUID-tunnisteet (uuidgen) ennen käyttöä. Tiedostojen kommentit ovat englanniksi.

Esimerkkimääritys

<?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>