Settings Export Options

Export Remote Settings XML in Legacy format or in PLIST format, test these settings files for errors, apply comment management features, and minimize settings file size by removing "newline" and "tab" characters that often give errors for some MDMs.

Editing Settings

Supported in:

After exporting an XML file from the app, open the file in a plain text editor (like TextEdit or Notepad. Do not use a word processor like Microsoft Word, which can add formatting to the text).

Each setting has a key (an identifier) and a value. Keys are unique to each setting, while values can vary depending on the type of setting. Possible value types:

• string - used when the setting needs a user-inputted value, like a URL, text, or whole number
• integer - used for settings with multiple options, each with a number identifier. For example, Show Settings has 3 options with the possible values being 0, 1, or 2.
• real - used for number values with decimals. In our case, that usually means a setting with a range, like brightness level or battery percentage
• boolean - these are either 'true' or 'false' and are used for toggle settings (for example: <true/> or <false/>)

For example, to change the Homepage setting, first you would find the key/value pair in the file:

<key>homePage</key>
<string>kioskgroup.com/kp-start</string>

and change the contents inside the string tags to your URL or filepath. For example: <string>http://website.com</string>.

You can quickly test the basic syntax of your .xml file by using the Test Settings XML for Errors setting.

Ampersands ('&') are a reserved character in XML. If your URL uses one, you will need to instead use the unit code &.

Be very careful not to set the Settings XML File Location to an incorrect value in your XML file. Otherwise, you will lose the ability to remotely update your iPad and will have to visit the kiosk in person to manually correct the error.

Note: If you previously had Allowed Domains set and your new homepage would not be allowed by the previous Allowed Domains list, Kiosk Pro may need to be restarted for the XML settings to successfully take effect.

Test Settings XML for Errors

Supported in:

This feature allows you to test your .xml file for errors. When this setting is selected, Kiosk Pro will check the .xml file set in the Settings XML File Location.

If no errors are found, the Validation Status will say "Valid". You can also test a file from within this setting by tapping "Test File" in the top navigation.

If the .xml file is not valid, the app will stop scanning the file at the point where an error is found and will give you information about the error, usually including which line of the file it is on. Once the error has been corrected, you will need to test the file again to confirm that there are no additional errors later in the file.

If the .xml file is valid but has errors, the Validation Status will say "Valid, but with semantic errors" with a table listing which keys and/or values have errors.

Export Settings in Remote Settings Control Legacy Format

Supported in:

Prior to version 10.4, Kiosk Pro used a slightly different format for .xml files. Both versions are still supported.

For users who need to export settings in the legacy format, you must first turn on this toggle.

XML formats are identified by the first key in the file - this must be set to either "kioskSettings_v2" for the newer format, or "kioskSettings" for the legacy format.

Test MAC Settings File for Errors

Supported in:

Test your current .plist file for errors that might prevent the app from successfully updating through Managed App Configuration.

To test, you will need to upload the file to a web server where Kiosk Pro can access it or move the file over to the Kiosk Pro documents folder (where you would simply enter the filename).

If no errors are found, the message ‘File is valid’ will appear.

Otherwise, the app stops scanning the file when an error is found and will give you information about the error, including which line of the file it is on. Once the error has been corrected, you will need to retest the file to confirm that there are not additional errors later in the file.

Examples of errors

Export Settings as Managed App Configuration PLIST File

Supported in:

Some MDMs require the XML property list for a Managed App Configuration profile to be formatted as a PLIST. This setting enables the user to export app settings in PLIST format and save with .plist file extension.

Include Commented Header Information

Supported in:

Kiosk Pro version 11.2 added the option to automatically include specific PLIST headers because some MDMs require that these be included in the exported PLIST.

Include Commented Settings Names

Supported in:

Kiosk Pro version 11.2 added the option to automatically include specific PLIST settings names since some MDMs require that these be included (or removed) in the exported PLIST.

Minimize File Size

Supported in:

Added in Kiosk Pro version 11.2, this setting removes ALL "newline" and "tab" characters between xml tags, while preserving the validity of the xml. If you then open the minimized file in Chrome, it will format correctly.

Legacy Format

Prior to version 10.4, Kiosk Pro used a slightly different format for .xml files. Both versions are still supported.

For users who need to export settings in the legacy format, you must first turn on the Export Remote Settings XML in Legacy Format toggle located in the Advanced Settings menu.

XML formats are identified by the first key in the file - this must be set to either "kioskSettings_v2" for the newer format, or "kioskSettings" for the legacy format.