Configuring Custom Preferences

The below plist key reference is to be used for guidance when configuring custom Zappl preferences. If you are using Jamf Pro, use the Configuring Custom Preferences guide.

The plist structure consists of three main preference dictionaries; the General Options, the Scheduled Update options and the Forced Update options.

All preferences reside under the com.dare.zappl.preferences preference domain.

We recommend referring to the included Adding the Preferences Profile plist to get a full understanding of the structure required when configuring the preferences, then use this guide to gain an understanding of the functionality each preference offers.

Click Open on any of the keys below to view a detailed explanation of the functionality each preference offers.

</aside>

General Options

Dictionary: GeneralOptions
Description: This is the key label for the General Options preference dictionary. The below keys are available to configure within this dictionary.

Untitled

Scheduled Update | Main Dictionary

Dictionary: ScheduledUpdates
Description: This is the key label for the Scheduled Updates preference dictionary. The below keys are available to configure within this dictionary.

Forced Update | Main Dictionary

Dictionary: ForcedUpdates
Description: This is the key label for the Forced Updates preference dictionary. There are fewer preferences available to configure in the Forced Update dictionary than in the Scheduled Updates dictionary. This is partly because deferral and grace period options for forced updates are configured when utilising Forced Updates, and partly because less functionality is required for forced updates.

Untitled

`Scheduled Updates` | Run Frequency Sub-Dictionary

Dictionary: runFrequency
Description: This is a nested dictionary within the main ScheduledUpdates dictionary. Although the scheduled cached update check is run on a frequent basis every day, the preferences in the Run Frequency Options dictionary ensure that users are only prompted to install updates on a specified frequency, e.g., once every week.

Untitled

`Scheduled Updates` & `Forced Updates`| Run Limitation Sub-Dictionary

Dictionary: runLimitations
Description: This is a nested dictionary within the main ScheduledUpdates and ForcedUpdate dictionaries. This allows you to add run exclusions to the run frequency options you previously configured, allowing you to define any days or times you do not want users to be prompted to update.

Untitled

`Scheduled Updates` | Deferral Configuration Sub-Dictionary

Dictionary: deferralConfiguration
Description: This is a nested dictionary within the main ScheduledUpdates dictionary. Use this preference dictionary to configure your desired deferral behaviour for Scheduled Updates.

Untitled

`Scheduled Updates` & `ForcedUpdates`| Custom Prompt Size Sub-Dictionaries

When customising prompt sizes with vertical list mode set as the App List value, Zappl automatically adds the required height for the App list to the custom height you define. When setting your custom prompt size, first set the App List key to Horizontal, configure the prompt to fit the prompt message, then switch back to vertical list mode.

</aside>

Dictionary: customInitialPromptSize
Description: This is a nested dictionary within the main ScheduledUpdates and ForcedUpdates dictionaries. This is an optional preference which allows you to customise the size of the prompts displayed to users when updates are pending and deferrals are configured and available. You should only modify the prompt size if you have customised the update message and need to increase or decrease the prompt size to align with the new message. If you are using the default update messages, the correct prompt size is pre-configured, so this preference can be ignored.
Dictionary: customGracePromptSize
Description: This is a nested dictionary within the main ScheduledUpdates and ForcedUpdate dictionaries. This is an optional preference which allows you to customise the size of the prompt displayed to users when updates are pending and deferrals are either not configured or not available. You should only modify the prompt size if you have customised the update message and need to increase or decrease the prompt size to align with the new message. If you are using the default update messages, the correct prompt size is pre-configured, so this preference can be ignored.
Dictionary: customSelfServicePromptSize
Description: This is a nested dictionary within the main ScheduledUpdates dictionary. This is an optional preference which allows you to customise the size of the prompt displayed to users when they initiate the Self Service Application Updates policy. You should only modify the prompt size if you have customised the update message and need to increase or decrease the prompt size to align with the new message. If you are using the default update messages, the correct prompt size is pre-configured, so this preference can be ignored.