Add & Configure Preferences
- Add Preferences
- Remove Preferences
- Required Preferences
- Configure Preference Values
- Preference Conditions and Exclusions
To add a preference to a payload, click the '+' button to the left of the preference.
If you switch to the XML view, you will note the added preference key.
To remove an added preference from a payload, click the 'x' button to the left of the preference.
If you switch to the XML view, you will note the removed preference key.
For some payloads, there are a number of preferences that must always be included. These will be listed at the top of the payload.
Each preference has a configured type. The most common are boolean (true/false), integer, and string.
boolean (true/false)
For boolean preference types, click the checkbox to check or uncheck the preference. While it's easy to think of the checked state as 'enabled' and the unchecked state as 'disabled', this is problematic. Think instead in terms of true and false.
For example, a preferences may have a key named Enable<some_preference>, in which case a checked state (true) indicates the preference is enabled. Conversely, a preference with a key named Disable<some_preference> in a checked state (true) indicates the preference is disabled. Checked (true) does not always mean enabled.
| Selection | Value |
|---|---|
| ☑️ | true |
| ⬛ | false |
integer
For integer preference types, enter the desired numeric value or select the desired setting from the available dropdown menu.
In some cases, there may be limitations in terms of the numeric range that can be entered for a preference. This range is indicated to the right of the text field.
string
For string preference types, enter the desired text in the text field or select the desired setting from the available dropdown menu.
In some cases, there may be limitations in terms how the entered string must be formatted. When the text is highlighted in red, the required format is not met. In the example below, the URL must begin with either http:// or https://.
In some cases, preference keys will depend on the inclusion of other preference keys. In the example below, the 'Create mobile account at login' preference was added. Because this depends on the 'Enable ADCreateMobileAccountAtLogin Flag' being present as well, this has been added automatically (Condition). Note that the automatically added preference does not have an adjacent 'x' to allow it to be removed.
However, the added preference lists a message indicating the preference and value that is missing or needed is and is greyed out (Exclusion). If left as is, the added preference will be excluded from both an exported profile or an exported .plist because of this dependency.
This is also reflected in the XML view. Note that the added preference is absent but the associated required preference is present.
By resolving the exclusion rule - in this case, setting the 'Enable ADCreateMobileAccountAtLogin Flag' value to true - the added preference is no longer greyed out ...
... and is listed in the XML view.
