Settings Export Options

Editing Remote Settings Control Settings XML

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 Remote Settings Control 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.

Examples of errors

Export Remote Settings Control Settings in Legacy Format

Supported in:

In version 10.4, the XML format used for Remote Settings Control settings files was updated to be easier to read and edit. Both versions are still supported and can be used in current versions of the app.

By default, the app creates exports using the new format. Users with devices still on versions of the app prior to 10.4, which are unable to process the new format, can use this toggle setting to export settings in the legacy format.

XML formats are identified by the first key in the file - this shows as "kioskSettings_v2" for the newer format, or "kioskSettings" for the legacy format.

Test Managed App Configuration 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. 

See Examples of Errors above for possible errors.

Export Settings as Managed App Configuration PLIST File

Supported in:

By default, Kiosk Pro exports the Managed App Configuration settings in XML format as this is the most commonly used format. 

However, some MDM systems including Microsoft Intune and SimpleMDM require a settings file to be in PLIST format. Enabling this option will add the necessary PLIST headers to the exported file and save it with a .plist file extension.

Include Commented Header Information

Supported in:

By default, settings files exported from the app include commented header information detailing which version of the app the settings where exported from, version number, export date and timestamp, and general comments about how to work with the file.

Some MDMs (notably, Microsoft Intune) have issues processing a MAC file if it contains comments. In other circumstances, like when working with limited bandwidth, it might be preferable to omit this header to minimize file size.

Include Commented Settings Names

Supported in:

By default, settings files exported from the app include commented labels that connect each exported settings key to the app settings name that it controls.

As noted above, some MDMs (notably, Microsoft Intune) have issues processing a MAC file if it contains comments. In other circumstances, like when working with limited bandwidth, it might be preferable to omit comments to minimize file size.

Minimize File Size

Supported in:

Remove all line breaks and whitespace from the exported file to make it as compact as possible. This can help if your MDM has a size limit for configuration files or if you are working with limited bandwidth. Note that the minimized file will be harder to read, but will still be a valid XML or PLIST.