PayloadKit

Zappl

com.dare.zappl.preferences

Zappl is a user-focused Application Patching solution, developed by DARE Technology.

macOS

Configuration Keys (4)

KeyTypeDescriptionDefaultRange
string—Default: —Range: —

General

dict—Default: —Range: —

Activation Token

required
stringEnter your unique customer activation token. This is required to activate Zappl.Default: —Range: —
publicKeystring

Public Key

required
stringEnter your unique customer public key. This is required to activate Zappl.Default: —Range: —

Enable Compliance Reporting

booleanWhen enabled, Zappl submits compliance data to the Zappl portal on a recurring interval. Disable this for test devices or environments where portal reporting is not required. Note: To operate in report-only mode (monitor compliance without updating applications), keep this enabled and uncheck "Allow Background Updates" and "Allow Scheduled Update Prompts"Default: trueRange: —

Allow Background Updates

booleanWhen enabled, Zappl attempts to silently update apps in the background on a recurring interval. If an app is not in use when an update is available, it will be updated without any prompts being shown to the user. Leaving this enabled is recommended to ensure updates are applied as quickly as possible with minimal user disruption.Default: trueRange: —

Download Stagger Window

integerSets a stagger window in minutes that spreads update downloads across your devices. Each device will randomly pick a time within this window to check for and download new updates after they are released. Increasing this value is recommended for large sites to reduce network load. The default and minimum value is 60 minutes and the maximum is 360 minutes (6 hours).Default: 60Range: 60 – 360

Allow Scheduled Update Prompts

booleanWhen enabled, Zappl prompts users to temporarily quit and update any apps that could not be updated silently in the background because they were in use at the time. Uncheck this option to disable all scheduled update prompts (not recommended). To configure the behaviour of these prompts, use the options under the "Scheduled Update Prompt Options" section of this profile.Default: trueRange: —
autoUpdateboolean

Automatic Self Updates

booleanDetermines whether Zappl automatically updates itself when new major and point releases are available. Uncheck this option if you prefer to manually update Zappl.Default: trueRange: —

Automatically Install AppBar

booleanWhen enabled, Zappl automatically installs the AppBar menu bar application. Uncheck this option if you do not wish to use AppBar in your environment, or if you prefer to deploy AppBar manually.Default: trueRange: —

Enable Liquid Glass Effect

booleanWhen enabled, Zappl prompts use the Liquid Glass visual style on macOS 26 (Tahoe) and later. Uncheck to use the standard flat appearance on all supported macOS versions.Default: trueRange: —

Allowed Installs

arrayBy default, all apps within the Zappl App catalog are available for installation. If you prefer to specify a list of apps allowed for installation, enter the app identifiers below. You can specify as many unique identifiers as you wish, using the App Catalog unique identifiers for each app. App Catalog: www.zappl.co/app-catalog.Default: —Range: —
string

Allowed Install App Bundle ID

string—Default: —Range: —

Excluded Installs

arrayBy default, all apps within the Zappl App catalog are available for installation. If you wish to allow installations for all apps in the catalog with the exception of some apps, specify the apps you wish to exclude below. You can specify as many unique app identifiers as you wish, using the App Catalog unique identifiers for each app. App Catalog: www.zappl.co/app-catalog.Default: —Range: —
string

Excluded Install App Bundle ID

string—Default: —Range: —

Allowed Updates

arrayBy default, all apps within the Zappl App catalog will be updated if installed. If you prefer to specify a list of apps to allow updates for, enter the app identifiers below. You can specify as many unique identifiers as you wish, using the App Catalog unique identifiers for each app. App Catalog: www.zappl.co/app-catalog.Default: —Range: —
string

Allowed Update App Bundle ID

string—Default: —Range: —

Excluded Updates

arrayBy default, all apps within the Zappl App catalog will be updated if installed. If you wish to allow updates for all apps in the catalog with the exception of some apps, specify the apps you wish to exclude below. You can specify as many unique app identifiers as you wish, using the App Catalog unique identifiers for each app. App Catalog: www.zappl.co/app-catalog.Default: —Range: —
string

Excluded Update App Bundle ID

string—Default: —Range: —

Allow Background Updates

booleanWhen enabled, Zappl attempts to silently update apps in the background on a recurring interval. If an app is not in use when an update is available, it will be updated without any prompts being shown to the user. Leaving this enabled is recommended to ensure updates are applied as quickly as possible with minimal user disruption.Default: trueRange: —

Background Update Stagger Window

integerSets a stagger window in minutes that spreads background update checks across your devices. Each device will randomly pick a time within this window to check for and download new updates after they are released. Increasing this value is recommended for large sites to reduce network load. The default and minimum value is 60 minutes and the maximum is 360 minutes (6 hours).Default: 60Range: 60 – 360

Scheduled Updates

dict—Default: —Range: —

Run Frequency Options

dict—Default: —Range: —
runTypestring

Run Frequency Option

stringThis defines when to prompt users to install any pending updates. You can either limit user prompts to a specified weekly patch day, or alternatively select a frequency to prompt the users, e.g. once every 2 weeks.Default: "specifyFrequency"Range: Specify Patch Frequency (specifyFrequency), Specify Recurring Patch Day (specifyPatchDay)

Frequency to prompt users

stringA recurring update frequency time window which determines how often users are prompted to install pending updates, e.g. Once every week.Default: "oneWeek"Range: Once every day (oneDay), Once every week (oneWeek), Once every two weeks (twoWeeks), Once every three weeks (threeWeeks), Once every four weeks (fourWeeks)

Frequency Elapsed Behaviour

stringDetermines how frequently users should be prompted if they defer the update once the configured patch frequency time has elapsed. Deferring updates with Single Prompt Mode enabled causes update prompts to be postponed until the patch frequency has elapsed again. Recurring Prompt Mode ensures users are prompted to update on a regular recurring interval after deferring until they update, and the patch frequency will only be reactivated after the updates are installed.Default: "singlePromptMode"Range: Single Prompt Mode (singlePromptMode), Recurring Prompt Mode (recurringPromptMode)

Recurring Prompt Mode Deferral Window (Patch Frequency)

integerWhen using recurring prompt mode, use this setting to define the amount of time in minutes a user can defer the update.Default: 60Range: —
patchDayinteger

Patch Day

integerThe day of the week to prompt users to install cached updates.Default: 3Range: Monday (2), Tuesday (3), Wednesday (4), Thursday (5), Friday (6), Saturday (7), Sunday (1)

Week(s) of Month

dictSelect which week(s) of the month to run the patch day. By default, all weeks are selected (every occurrence of the selected day). Uncheck any weeks you wish to skip.Default: —Range: —
firstWeekboolean

First Week of Month

booleanRun on the first occurrence of the selected day each month.Default: trueRange: —
secondWeekboolean

Second Week of Month

booleanRun on the second occurrence of the selected day each month.Default: trueRange: —
thirdWeekboolean

Third Week of Month

booleanRun on the third occurrence of the selected day each month.Default: trueRange: —
fourthWeekboolean

Fourth Week of Month

booleanRun on the fourth occurrence of the selected day each month.Default: trueRange: —
fifthWeekboolean

Fifth Week of Month (if applicable)

booleanRun on the fifth occurrence of the selected day, when the month has five occurrences.Default: trueRange: —

Patch Day Prompt Frequency

stringDetermines how often users should be prompted to update on the configured patch day if they defer the update. Use the Single Prompt Mode to carry the deferral to the following weekly patch day, or alternatively, use Recurring Prompt Mode to continue to prompt users to update on a recurring interval on the configured patch day if they defer the update.Default: "singlePromptMode"Range: Single Prompt Mode (singlePromptMode), Recurring Prompt Mode (recurringPromptMode)

Recurring Prompt Mode Deferral Window (Patch Day)

integerWhen using recurring prompt mode, use this setting to define the amount of time in minutes a user can defer the update before being prompted again.Default: 60Range: —

Missed Update Prompts

booleanWhen enabled, Zappl will prompt the user to update whenever the device comes back online if it was offline on the defined patch day, or if the user deferred all update prompts when using Recurring Prompt Mode. Alternatively, leave this unchecked to wait until the next patch day to prompt the user if their device was offline on the previous patch day.Default: trueRange: —

Run Limitation Options

dict—Default: —Range: —
mondayboolean

Monday

booleanIf selected, update prompts will be allowed on Mondays.Default: trueRange: —

Monday Start Time

stringIf you allowed updates on Mondays, use to define the time on a Monday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Monday End Time

stringIf you allowed updates on Mondays, use to define the time on a Monday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
tuesdayboolean

Tuesday

booleanIf selected, update prompts will be allowed on Tuesdays.Default: trueRange: —

Tuesday Start Time

stringIf you allowed updates on Tuesdays, use to define the time on a Tuesday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Tuesday End Time

stringIf you allowed updates on Tuesdays, use to define the time on a Tuesday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
wednesdayboolean

Wednesday

booleanIf selected, update prompts will be allowed on Wednesdays.Default: trueRange: —

Wednesday Start Time

stringIf you allowed updates on Wednesdays, use to define the time on a Wednesday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Wednesday End Time

stringIf you allowed updates on Wednesdays, use to define the time on a Wednesday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
thursdayboolean

Thursday

booleanIf selected, update prompts will be allowed on Thursdays.Default: trueRange: —

Thursday Start Time

stringIf you allowed updates on Thursdays, use to define the time on a Thursday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Thursday End Time

stringIf you allowed updates on Thursdays, use to define the time on a Thursday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
fridayboolean

Friday

booleanIf selected, update prompts will be allowed on Fridays.Default: trueRange: —

Friday Start Time

stringIf you allowed updates on Fridays, use to define the time on a Friday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Friday End Time

stringIf you allowed updates on Fridays, use to define the time on a Friday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
saturdayboolean

Saturday

booleanIf selected, update prompts will be allowed on Saturdays.Default: trueRange: —

Saturday Start Time

stringIf you allowed updates on Saturdays, use to define the time on a Saturday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Saturday End Time

stringIf you allowed updates on Saturdays, use to define the time on a Saturday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
sundayboolean

Sunday

booleanIf selected, update prompts will be allowed on Sundays.Default: trueRange: —

Sunday Start Time

stringIf you allowed updates on Sundays, use to define the time on a Sunday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Sunday End Time

stringIf you allowed updates on Sundays, use to define the time on a Sunday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —

Deferral Options

dict—Default: —Range: —

Select a Deferral Option

stringUse to define behaviour around update deferrals. To allow the user to continue deferring with no limit and force the update on-demand, select Disable Deferral Limit. To set a limit on the amount of allowed deferrals, select Specify Deferral Limit. Alternatively, you can disable deferrals completely by selecting Disable Deferrals, which will only allow a grace period for updates.Default: "specifyDeferralLimit"Range: Disable Deferral Limit (disableDeferralLimit), Specify Deferral Limit (specifyDeferralLimit), Disable Deferrals (disableDeferrals)

Deferral Limit

integerSpecify a custom deferral limit. The default deferral limit if not specified is 2.Default: 2Range: —

Grace Period in Minutes

integerThe amount of time a user is given to save work before updates are installed automatically when there are no remaining deferrals. Default is 15 minutes.Default: 15Range: —

Icon

stringA custom icon to be displayed on the user prompts. The default is the Self Service icon.Default: —Range: —

Initial Prompt Icon Overlay

stringAn icon overlay on the initial update prompts. The overlay is displayed on the bottom right of the main icon. Possible values are paths to a valid .png, .jpg or .icns file, or use the 'selfService' variable for the Jamf Self Service icon.Default: —Range: —

Single App Prompt Title

stringA custom title to be displayed on the user prompts when there is 1 pending App update.Default: —Range: —

Multiple Apps Prompt Title

stringA custom title to be displayed on the user prompts when there is more than 1 pending App update.Default: —Range: —

Defer Button Label

stringA custom Defer button label displayed on prompts where deferrals are allowed.Default: —Range: —

Update Button Label

stringA custom Update button label displayed on the update prompts.Default: —Range: —

Show Info Button

booleanWhen enabled, an info button is displayed on update prompts that users can tap to view additional context about the update. Disable to hide the button and show prompts without it.Default: trueRange: —

Initial Prompt Info Popover Text

stringCustom text displayed in the info popover on the initial update prompt. Use ## to create headings and ** ** to bold text. Newlines can be inserted using \n.Default: —Range: —

Grace Period Prompt Info Popover Text

stringCustom text displayed in the info popover on the grace period prompt. Use ## to create headings and ** ** to bold text. Newlines can be inserted using \n.Default: —Range: —

App List Type

stringDetermines how to display the list of Apps on the update prompts. Apps can either be displayed in a vertical scrollable list beneath the prompt message, or displayed horizontally as part of the prompt message. When using the horizontal list option, the list of Apps is stored in the appList variable.Default: —Range: Vertical List (vertical), Horizontal List (horizontal)

Prompt Refresh Interval

integerThe amount of time in seconds the user prompts refresh. The prompts require a refresh to pull focus if the user swipes away to ignore the prompt and ensures they either select defer or update. The default value is 60 seconds. The minimum allowed value is 30 seconds.Default: 60Range: 30 – —

Do Not Disturb Applications

arrayApplication Bundle IDs specified here will prevent Zappl from prompting users to update if the App(s) are identified as being active in the foreground (You can specify one or more Bundle IDs). To get Bundle IDs, enter the following in terminal (replacing Safari with the relevant App): defaults read /Applications/Safari.app/Contents/Info.plist CFBundleIdentifier.Default: —Range: —
string
string—Default: —Range: —

Do Not Disturb Application Assertions

arrayApplication names specified here will prevent Zappl from prompting users to update if the App(s) are identified as using assertions (You can specify one or more Application names). To get the required Application name format, run \"/usr/bin/pmset -g assertions\" in terminal while the application is running and using assertions.Default: —Range: —
string
string—Default: —Range: —

Respect Do Not Disturb Mode

booleanSetting as True will prevent Zappl from prompting users if Do Not Disturb mode is detected.Default: falseRange: —

Do Not Disturb Camera Usage

booleanSetting as True will prevent Zappl from prompting users if the camera is in use. Note: Apple Silicon Macs running macOS 12 (Monterey) do not accurately report camera usage, therefore this setting will be ignored. Upgrading to macOS 13 (Ventura) will resolve this issue for Apple Silicon Macs.Default: falseRange: —

Do Not Disturb Screen Sharing

booleanSetting as True will prevent Zappl from prompting users if Screen Sharing is in use.Default: falseRange: —

Show Update Progress Prompt

booleanWhen enabled, a small progress prompt is displayed in the corner of the screen while updates are being installed. Disable to run updates silently without any progress indicator.Default: trueRange: —

Update Progress Prompt Position

stringThe position on the screen of the prompt which displays the progress of an update. The default position is top right.Default: "topright"Range: Top Right (topright), Right (right), Bottom Right (bottomright), Top Left (topleft), Left (left), Bottom Left (bottomleft), Top Centre (top), Centre (center/centre), Bottom Centre (bottom)

Update Progress Prompt Overlay Icon

stringAn icon overlay on the prompt shown during the App updates. The overlay is displayed on the bottom right of the main icon, which on this prompt is the App icon. Possible values are paths to a valid .png, .jpg or .icns file, or use the 'selfService' variable for the Jamf Self Service icon.Default: —Range: —

Automatically Relaunch Apps

booleanDetermines whether Zappl automatically relaunches apps that were running prior to updating once the update completes.Default: trueRange: —

Send Completion Notification

booleanWhen enabled, a macOS notification is sent to the user once all updates are complete.Default: trueRange: —

Initial Prompt Size

dictUse to customise the size of the initial prompt displayed to users when they can either defer or update. Note: Only configure this setting if defining custom prompt messages. If you are using the default prompt messages, customising prompt size is not recommended as the default prompt size is pre-configured to correctly match the size of the default message displayed.Default: —Range: —

Custom Initial Prompt (Height)

integerUse to customise the height of the initial prompt displayed to users when they can either defer or update. Only use to define a custom height in points for the prompts shown to users, e.g. 330.Default: 330Range: —

Custom Initial Prompt (Width)

integerUse to customise the width of the initial prompt displayed to users when they can either defer or update. Only use to define a custom width in points for the prompts shown to users, e.g. 640.Default: 640Range: —

Custom Grace Prompt Size

dictUse to customise the size of the grace period timer prompt shown when users have no remaining deferrals. Note: Only configure this setting if defining custom prompt messages. If you are using the default prompt messages, customising prompt size is not recommended as the default prompt size is pre-configured to correctly match the size of the default message displayed.Default: —Range: —

Custom Grace Prompt (Height)

integerUse to customise the height of the grace period timer prompt displayed to users when they have no remaining deferrals. Only use to define a custom height in points for the prompts shown to users, e.g. 330.Default: 330Range: —

Custom Grace Prompt (Width)

integerUse to customise the width of the grace period timer prompt displayed to users when they have no remaining deferrals. Only use to define a custom width in points for the prompts shown to users, e.g. 640.Default: 640Range: —

Self Service Prompt Size

dictUse to customise the size of the prompt displayed to users when they initiate a Self Service update. Note: Only configure this setting if defining custom prompt messages. If you are using the default prompt messages, customising prompt size is not recommended as the default prompt size is pre-configured to correctly match the size of the default message displayed.Default: —Range: —

Self Service Prompt (Height)

integerUse to customise the height of the prompt displayed to users when they initiate a Self Service update. Only use to define a custom height in points for the prompts shown to users, e.g. 330.Default: 330Range: —

Self Service Prompt (Width)

integerUse to customise the width of the prompt displayed to users when they initiate a Self Service update. Only use to define a custom width in points for the prompts shown to users, e.g. 640.Default: 640Range: —

Single App Initial Prompt Message

stringA custom message displayed on the initial \"App needs to quit\" prompt shown when there is 1 pending App update.Default: —Range: —

Multiple Apps Initial Prompt Message

stringA custom message displayed on the initial \"Apps need to quit\" prompt shown when there are multiple pending App updates.Default: —Range: —

Single App Self Service Prompt Message

stringA custom message displayed on the initial \"App needs to quit\" prompt shown when a user manually initiates an update check and there is 1 pending update.Default: —Range: —

Multiple App Self Service Prompt Message

stringA custom message displayed on the initial \"Apps need to quit\" prompt shown when a user manually initiates an update check and there are multiple pending App updates.Default: —Range: —

Single App Grace Period Prompt Message

stringA custom message displayed on the \"App needs to quit\" grace period prompt shown when there is 1 pending update. This prompt shows a grace period timer and is displayed when no deferrals are remaining or configured.Default: —Range: —

Multiple App Grace Period Prompt Message

stringA custom message displayed on the \"Apps need to quit\" grace period prompt shown when there are multiple pending updates. This prompt shows a grace period timer and is displayed when no deferrals are remaining or configured.Default: —Range: —

Self Service Skip Button Label

stringA custom Skip button label displayed on the Self Service update prompts that allows users to back out of installing updates without affecting deferrals.Default: —Range: —

Forced Updates

dictDefine days and time windows during which forced updates are allowed to run.Default: —Range: —

Run Limitation Options

dictUse this preference to limit which weekdays and times Zappl is allowed to prompt users to install forced updates. Check the boxes next to any days you wish to allow Zappl to prompt users, and uncheck any days you want update prompts to be skipped. If you allow Zappl to run on a particular day, you can then limit runs to a specific time window using the start and end time fields. Note: If you have specified a weekly patch day and that day is not checked below, the patch day setting will override this setting.Default: —Range: —
mondayboolean

Monday

booleanIf selected, update prompts will be allowed on Mondays.Default: trueRange: —

Monday Start Time

stringIf you allowed updates on Mondays, use to define the time on a Monday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Monday End Time

stringIf you allowed updates on Mondays, use to define the time on a Monday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
tuesdayboolean

Tuesday

booleanIf selected, update prompts will be allowed on Tuesdays.Default: trueRange: —

Tuesday Start Time

stringIf you allowed updates on Tuesdays, use to define the time on a Tuesday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Tuesday End Time

stringIf you allowed updates on Tuesdays, use to define the time on a Tuesday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
wednesdayboolean

Wednesday

booleanIf selected, update prompts will be allowed on Wednesdays.Default: trueRange: —

Wednesday Start Time

stringIf you allowed updates on Wednesdays, use to define the time on a Wednesday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Wednesday End Time

stringIf you allowed updates on Wednesdays, use to define the time on a Wednesday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
thursdayboolean

Thursday

booleanIf selected, update prompts will be allowed on Thursdays.Default: trueRange: —

Thursday Start Time

stringIf you allowed updates on Thursdays, use to define the time on a Thursday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Thursday End Time

stringIf you allowed updates on Thursdays, use to define the time on a Thursday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
fridayboolean

Friday

booleanIf selected, update prompts will be allowed on Fridays.Default: trueRange: —

Friday Start Time

stringIf you allowed updates on Fridays, use to define the time on a Friday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Friday End Time

stringIf you allowed updates on Fridays, use to define the time on a Friday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
saturdayboolean

Saturday

booleanIf selected, update prompts will be allowed on Saturdays.Default: trueRange: —

Saturday Start Time

stringIf you allowed updates on Saturdays, use to define the time on a Saturday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Saturday End Time

stringIf you allowed updates on Saturdays, use to define the time on a Saturday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —
sundayboolean

Sunday

booleanIf selected, update prompts will be allowed on Sundays.Default: trueRange: —

Sunday Start Time

stringIf you allowed updates on Sundays, use to define the time on a Sunday Zappl is permitted to start prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "00:00"Range: —

Sunday End Time

stringIf you allowed updates on Sundays, use to define the time on a Sunday Zappl should stop prompting users to install pending updates. This should be in 24 hour format, e.g., 09:00 for 9am, or 21:00 for 9pm.Default: "23:59"Range: —

Icon

stringA custom icon to be displayed on the user prompts. The default when not specified is the icon of the App being forced to update.Default: —Range: —

Initial Prompt Overlay Icon

stringAn icon overlay on the initial or grace period update prompts. The overlay is displayed on the bottom right of the main icon, which on this prompt is the App icon. Possible values are paths to a valid .png, .jpg or .icns file, or use the 'selfService' variable for the Jamf Self Service icon.Default: —Range: —

Title

stringA custom title to be displayed on the initial force update prompts which are shown prior to the updates running, e.g the defer/update prompt (if configured) or the grace period prompt.Default: —Range: —

Defer Button Label

stringA custom Defer button displayed on prompts where deferrals are allowed.Default: —Range: —

Update Button Label

stringA custom Update button label displayed on the update prompts.Default: —Range: —

Show Info Button

booleanWhen enabled, an info button is displayed on update prompts that users can tap to view additional context about the update. Disable to hide the button and show prompts without it.Default: trueRange: —

Initial Prompt Info Popover Text

stringCustom text displayed in the info popover on the initial forced update prompt. Use ## to create headings and ** ** to bold text. Newlines can be inserted using \n.Default: —Range: —

Grace Period Prompt Info Popover Text

stringCustom text displayed in the info popover on the grace period forced update prompt. Use ## to create headings and ** ** to bold text. Newlines can be inserted using \n.Default: —Range: —

Prompt Refresh Interval

integerThe amount of time in seconds the user prompts refresh when deferrals have been configured for forced updates. The prompts require a refresh to pull focus if the user swipes away to ignore the prompt and ensures they either select defer or update. The default value is 60 seconds. The minimum allowed value is 30 seconds.Default: 60Range: 30 – —

Do Not Disturb Applications

arrayApplication Bundle IDs specified here will prevent Zappl from prompting users to update if the App(s) are identified as being active in the foreground (You can specify one or more Bundle IDs). To get Bundle IDs, enter the following in terminal (replacing Safari with the relevant App): defaults read /Applications/Safari.app/Contents/Info.plist CFBundleIdentifier.Default: —Range: —
string
string—Default: —Range: —

Do Not Disturb Application Assertions

arrayApplication names specified here will prevent Zappl from prompting users to update if the App(s) are identified as using assertions (You can specify one or more Application names). To get the required Application name format, run \"/usr/bin/pmset -g assertions\" in terminal while the application is running and using assertions.Default: —Range: —
string
string—Default: —Range: —

Respect Do Not Disturb Mode

booleanSetting as True will prevent Zappl from prompting users if Do Not Disturb mode is detected.Default: falseRange: —

Do Not Disturb Camera Usage

booleanSetting as True will prevent Zappl from prompting users if the camera is in use. Note: Apple Silicon Macs running macOS 12 (Monterey) do not accurately report camera usage, therefore this setting will be ignored. Upgrading to macOS 13 (Ventura) will resolve this issue for Apple Silicon Macs.Default: falseRange: —

Do Not Disturb Screen Sharing

booleanSetting as True will prevent Zappl from prompting users if Screen Sharing is in use.Default: falseRange: —

Show Update Progress Prompt

booleanWhen enabled, a small progress prompt is displayed in the corner of the screen while updates are being installed. Disable to run updates silently without any progress indicator.Default: trueRange: —

Update Progress Prompt Position

stringThe position on the screen of the prompt which displays the progress of an update. The default position is top right.Default: "topright"Range: Top Right (topright), Right (right), Bottom Right (bottomright), Top Left (topleft), Left (left), Bottom Left (bottomleft), Top Centre (top), Centre (center/centre), Bottom Centre (bottom)

Update Progress Prompt Overlay Icon

stringAn icon overlay on the prompt shown during the App updates. The overlay is displayed on the bottom right of the main icon, which on this prompt is the App icon. Possible values are paths to a valid .png, .jpg or .icns file, or use the 'selfService' variable for the Jamf Self Service icon.Default: —Range: —

Automatically Relaunch Apps

booleanDetermines whether Zappl automatically relaunches apps that were running prior to updating once the update completes.Default: trueRange: —

Send Completion Notification

booleanWhen enabled, a macOS notification is sent to the user once all updates are complete.Default: trueRange: —

Initial Prompt Size

dictUse to customise the size of the initial prompt displayed to users when they can either defer or update. Note: Only configure this setting if defining custom prompt messages. If you are using the default prompt messages, customising prompt size is not recommended as the default prompt size is pre-configured to correctly match the size of the default message displayed.Default: —Range: —

Custom Initial Prompt (Height)

integerUse to customise the height of the initial prompt displayed to users when they can either defer or update. Only use to define a custom height in points for the prompts shown to users, e.g. 330.Default: 330Range: —

Custom Initial Prompt (Width)

integerUse to customise the width of the initial prompt displayed to users when they can either defer or update. Only use to define a custom width in points for the prompts shown to users, e.g. 640.Default: 640Range: —

Custom Grace Prompt Size

dictUse to customise the size of the grace period timer prompt shown when users have no remaining deferrals. Note: Only configure this setting if defining custom prompt messages. If you are using the default prompt messages, customising prompt size is not recommended as the default prompt size is pre-configured to correctly match the size of the default message displayed.Default: —Range: —

Custom Grace Prompt (Height)

integerUse to customise the height of the grace period timer prompt displayed to users when they have no remaining deferrals. Only use to define a custom height in points for the prompts shown to users, e.g. 330.Default: 330Range: —

Custom Grace Prompt (Width)

integerUse to customise the width of the grace period timer prompt displayed to users when they have no remaining deferrals. Only use to define a custom width in points for the prompts shown to users, e.g. 640.Default: 640Range: —

Custom Title

stringA custom message displayed on the initial \"App needs to quit\" forced update prompt.Default: —Range: —

Grace Period Quit Prompt Message

stringA custom message displayed on the grace period \"App needs to quit\" prompt. This prompt shows a grace period timer and is displayed when no deferrals are remaining or configured.Default: —Range: —