Understanding & customizing Kiosk Pro's error screens
Kiosk Pro displays an error screen when it is unable to successfully load a page. The app will continue to try to load the page in the background while the error screen is shown and, once successful, will automatically clear the error.
In this article
The default error classes and screens are shown below. In paid versions of the app, these error screens can be customized by storing image files for each locally in the Kiosk Pro documents folder in a folder named 'KioskAssets', named using a specific naming convention for each as described below.
Images can be saved in .png or .jpg format; if using .png, transparency is supported. If using an image that does not match the current screen dimensions, Kiosk Pro will resize the image to fill the screen while maintaining its current aspect ratio.
The following error classes are possible:
No Internet Connection
This error screen is shown when a page cannot be loaded because it requires an internet connection and one is not available. If the app is configured with an Alternate Homepage for Offline Use, that will be shown in lieu of this error screen.
The default error screen is shown below:
To customize this screen, the image must be named and stored under 'KioskAssets/connection-problem.png' or 'KioskAssets/connection-problem.jpg'.
File Not Found
This error screen is shown when a file cannot be located at the expected location - for example, the file is missing or there is a typo in the filepath or URL. The default error screen is shown below:
To customize this screen, the image must be named and stored under 'KioskAssets/file-not-found.png' or 'KioskAssets/file-not-found.jpg'.
Timeout Error
This error screen is shown when the Page Loading Time Limit is reached while a file has not completed loading. The default error screen is shown below:
To customize this screen, the image must be named and stored under 'KioskAssets/page-loading.png' or 'KioskAssets/page-loading.jpg'.
Generic Error
This error screen is shown when the app is unable to successfully load a page for an unidentified reason. You can use the Failed Request Log to see additional details about the error. The default error screen is shown below:
To customize this screen, the image must be named and stored under 'KioskAssets/generic-error.png' or 'KioskAssets/generic-error.jpg'.
Mapping Specific Errors to an Error Class
This type of loading error is triggered and returned by the iOS/iPadOS operating system. It's possible to override Kiosk Pro's automatic mapping of a specific error to an error class if necessary using an XML file. A template and instructions for this can be found here.