PayloadKit

App Auto-Patch

xyz.techitout.appAutoPatch

This will configure the settings for the App Auto-Patch tool

macOS

Configuration Keys (52)

KeyTypeTitle
PFC_SegmentedControl_0required
string
DaysUntilReset

The number of days after the patching cadence start date (Zero Date) that the patching complete status will reset from TRUE to FALSE

stringDays Until Reset
PatchWeekStartDay

The day of the week to force the patching cadence start date (Zero Date) to go back to in order to have the patch cadence start the same day of the week for all users

Range: Monday - 1 (1), Tuesday - 2 (2), Wednesday - 3 (3), Thursday - 4 (4), Friday - 5 (5), Saturday - 6 (6), Sunday - 7 (7)

integerPatch Week Start Day
DeadlineCountFocus

The maximum number of automatic deferrals allowed if the system is in user-enabled Focus/Do Not Disturb or when a process has requested that the display not go to sleep

stringFocus Count Deadline
DeadlineCountHard

The maximum number of user selected deferrals allowed before App Auto-Patch will no longer allow deferrals and will automatically patch when the timer expires

stringHard Count Deadline
DeadlineDaysFocus

The maximum number of days that automatic deferrals are allowed if the system is in user-enabled Focus/Do Not Disturb or when a process has requested that the display not go to sleep

stringFocus Days Deadline
DeadlineDaysHard

The maximum number of days deferrals allowed before App Auto-Patch will no longer allow deferrals and will automatically patch when the timer expires

stringHard Days Deadline
DeferralTimerDefault

The number of minutes to defer until the next update workflow attempt if a user choses not install updates

stringDeferral Timer Default
DeferralTimerError

The number of minutes to defer if AAP detects an error in the workflow

stringDeferral Timer Error
DeferralTimerFocus

The number of minutes to defer the update restart dialog automatically if a process has prevented display sleep (for example, during an active meeting) or the user has Focus or Do Not Disturb enabled

stringDeferral Timer Focus
DeferralTimerMenu

Display a deferral time pop-up menu in the non-deadline install dialog that allows the user to override the Deferral Timer Default timer

stringDeferral Timer Menu
DeferralTimerWorkflowRelaunch

Amount of time in minutes until AAP is relaunched after a workflow. This timer results in AAP acting as a permanent agent that checks for app updates on a regular basis

stringDeferral Timer Workflow Relaunch
MonthlyPatchingCadenceEnabled
booleanMonthly Patching Cadence Enabled
MonthlyPatchingCadenceOrdinalValue

Week of the month you want AAP to be scheduled

Range: First Week (first), Second Week (second), Third Week (third), Fourth Week (fourth), Fifth Week (fifth), Final Week (final)

stringMonthly Patching Cadence Ordinal Value
MonthlyPatchingCadenceWeekdayIndex

Day of the week you want AAP to be scheduled

Range: Sunday (sunday), Monday (monday), Tuesday (tuesday), Wednesday (wednesday), Thursday (thursday), Friday (friday), Saturday (saturday)

stringMonthly Patching Cadence Weekday Index
MonthlyPatchingCadenceStartTime

Local time you want AAP to be scheduled

stringMonthly Patching Cadence Start Time
ZoomCallActiveCheck

When enabled, AAP will automatically skip updating Zoom if a call is active

booleanZoom Call Active Check
DialogOnTop

Forces the AAP dialogs to stay on top of all other windows

Range: Force Dialog On Top (TRUE), Do Not Force Dialog On Top (FALSE)

stringDialog On Top
DialogTimeoutDeferral

Time given to the user to respond to deferral prompt if enabled

integerDeferral Dialog Timeout
DialogTimeoutDeferralAction

What happens when the deferral timer expires

Range: Defer after timer expires (Defer), Continue after timer expires (Continue)

stringDeferral Dialog Timeout Action
UnattendedExit

Deterines if the Dialog should automatically close after completion if there is no response from the end-user

Range: Auto Close Dialog (TRUE), Do Not Auto Close Dialog (FALSE)

stringUnattended Exit
UnattendedExitSeconds

The number of seconds the AAP dialog will automatically close if UnattendedExit is set to TRUE

integerUnattended Exit Seconds
UseOverlayIcon

Toggles swiftDialog to use an overlay icon

Range: Use Overlay Icon (TRUE), Do Not Use Overlay Icon (FALSE)

stringUse Overlay Icon
DialogIcon

Allows you to set a custom icon for the dialog vs. the default Laptop/Desktop symbol

stringDialog Icon
IgnoredLabels

A space-separated list of Installomator labels to ignore for the AAP workflow. Supports wilddcards

stringIgnored Labels
RequiredLabels

a space-separated list of Installomator labels that are required, regardless if the app is installed or or the latest version. Supports wildcards.

stringRequired Labels
OptionalLabels

A space-separated list of optional Installomator labels. Labels in this category are only included if the app exists on the end-users device and will force install even if its the latest version. Does Not Support Wildcards

stringOptional Labels
AppTitle

Allows you to customize the name of App Auto-Patch to something else

Default: "App Auto-Patch"

stringApp Title
ConvertAppsInHomeFolder

This will convert any apps found in the users home folder to the /Applications folder

Default: "TRUE"

Range: Convert Apps (TRUE), Do Not Convert Apps (FALSE)

stringConvert Apps In Home Folder
IgnoreAppsInHomeFolder

Ignore apps found in '/Users/'. If an update is found in '/Users/' and variable is set to false, the app will be updated into the application's default path

Default: "FALSE"

Range: Ignore Apps in Home Folder (TRUE), Move Apps to the Default Path (FALSE)

stringIgnore Apps In Home Folder
InstallomatorOptions

A space-separated list of options to override default Installomator options (i.e., BLOCKING_PROCESS_ACTION=prompt_user NOTIFY=silent LOGO=appstore)

stringInstallomator Options
InstallomatorUpdateDisable

This will prevent Installomator from automatically updating. If Installomator does not exist in the working folder, it will still download from GitHub to prevent script failure

Default: "FALSE"

Range: Disable Installomator Updates (TRUE), Enable Installomator Updates (FALSE)

stringInstallomator Update Disable
InstallomatorVersion

Determines if the AAP script should use the Main, Release, or Custom version of Installomator. The version from the Main branch typically includes more recent updates from PR's to fix issues or add new labels. If using Custom, you must also set the InstallomatorVersionCustomRepoPath and InstallomatorVersionCustomBranchName keys

Default: "Main"

Range: Main, Release, Custom

stringInstallomator Version
InstallomatorVersionCustomRepoPath

If InstallomatorVersion is set to Custom, enter the Github Site and Repository name in the following format: site_name/repo_name . For example, if the custom fork is located at https://github.com/TechTrekkie/Installomator, you would set this key to techtrekkie/installomator

stringInstallomator Version custom Repo Path
InstallomatorVersionCustomBranchName

The name of the branch you want to use in your custom repo, typically main.

stringInstallomator Version Custom Branch Name
InteractiveMode

0 (Completely Silent) | 1 (Silent Discovery, Interactive Patching) | 2 (Full Interactive) (default)

Default: 2

Range: 0 - Completely Silent (0), 1 - Silent Discovery, Interactive Patching (1), 2 - Full Interactive (2)

integerInteractive Mode
RemoveInstallomatorPath

Remove Installomator after App Auto-Patch is completed

Default: "FALSE"

Range: Remove Installomator (TRUE), Do Not Remove Installomator (FALSE)

stringRemove Installomator Path
SupportTeamName

For the Support Team details that display in the Help Message

stringSupport Team Name
SupportTeamEmail

For the Support Team details that display in the Help Message

stringSupport Team Email
SupportTeamPhone

For the Support Team details that display in the Help Message

stringSupport Team Phone
SupportTeamWebsite

For the Support Team details that display in the Help Message

stringSupport Team Website
WebhookFeature

Determines if Webhooks are sent when patching is completed

Default: "FAILURES"

Range: FALSE, ALL, FAILURES

stringWebhook Feature
WebhookURLSlack

The Slack Webhook URL to use if WebhookFeature is set to TRUE

stringSlack Webhook URL
WebhookURLTeams

The Teams Webhook URL to use if WebhookFeature is set to TRUE

stringTeams Webhook URL
WorkflowDisableAppDiscovery

Disables the discovery of applications that require patching. If a list of labels from a previous discovery exists, AAP will use that list for the workflow

Default: "FALSE"

Range: Disable App Discovery (TRUE), Enable App Discovery (FALSE)

stringDisable App Discovery Workflow
WorkflowDisableRelaunch

Disable the automatic relaunch of AAP after the current workflow successfully completes

Default: "FALSE"

Range: Disable Automatic Relaunch (TRUE), Enable Automatic Relaunch (FALSE)

stringDisable Relaunch Workflow
WorkflowInstallNowPatchingStatusAction

Determines if the Patching Completion Status is set to true when using the --workflow-install-now trigger

Default: "SUCCESS"

Range: NEVER, ALWAYS, SUCCESS

stringWorkflow Install Now Patching Status Action
SelfUpdateEnabled

Determines if the Self Update feature is enabled. this will automatically update App Auto-Patch if a new version is posted on github

booleanSelf Update Enabled
SelfUpdateFrequency

The frequency to check for updates to the App Auto-Patch script

Range: Daily (daily), Weekly (weekly), Monthly (monthly)

stringSelf Update Frequency
versionComparisonMethod

Determines the version comparison method used when checking for updates

Range: Is At Least (IS_AT_LEAST), Equal To (EQUAL_TO)

stringVersion Comparison Method
VersionComparisonInstallomatorFallback

When enabled, if version comparison fails, AAP will fall back to using Installomator for version checking

Default: false

booleanVersion Comparison Installomator Fallback
userInterface

All features related to how App Auto Patch defines the user interface.

dictUser Interface
dialogElements

The individual buttons and text elements that can be customized. This includes per country localization.

arrayDialog Elements
dictdialogElements - Dictionary
language

The targeted language locale for the user interface. Note: For a list of locales, please run the following command in Terminal: /usr/bin/locale -a

stringLanguage
display_string_defer_today_button

Language for the defer button in dialogs when the deferral time is sometime today.

stringDefer Today Button
display_string_defer_tomorrow_button

Language for the defer button in dialogs when the deferral time is tomorrow

stringDefer Tomorrow Button
display_string_defer_future_button

Language for the defer button in dialogs when the deferral time is in the future.

stringDefer Future Button
display_string_minutes

Language for deferral timer durations - Minutes

stringMinutes Display String
display_string_hour

Language for deferral timer durations - Hour

stringHour Display String
display_string_hours

Language for deferral timer durations - Hours

stringHours Display String
display_string_and

Language for deferral timer durations - and

stringand Display String
display_string_days

Language for deferral timer durations - days

stringdays Display String
display_string_times

Language for deferral timer durations - times

stringtimes Display String
display_string_there_are

Language for deferral timer durations - There are

stringThere are Display String
display_string_discovery_message

Language for the message displayed during App Discovery

stringDiscovery Message
display_string_discovery_action_message

Language for the action message during App Discovery

stringDiscovery action message
display_string_discovery_progress

Langauge for the progress message during App Discovery

stringDiscovery progress message
display_string_deferral_button1

Language for Button1 of the Deferral Dialog

stringDeferral Dialog Button1
display_string_deferral_button2

Language for Button1 of the Deferral Dialog

stringDeferral Dialog Button2
display_string_deferral_infobox1

Langauge for part 1 of the infobox on the Deferral Dialog

stringDeferral Dialog Infobox part1
display_string_deferral_infobox2

Langauge for part 2 of the infobox on the Deferral Dialog

stringDeferral Dialog Infobox part2
display_string_deferral_infobox3

Langauge for part 3 of the infobox on the Deferral Dialog

stringDeferral Dialog Infobox part3
display_string_deferral_message_01

Langauge for part 1 of the message on the Deferral Dialog

stringDeferral Dialog Message part 1
display_string_deferral_message_02

Language for part 2 of the message on the Deferral Dialog

stringDeferral Dialog Message part 2
display_string_deferral_unlimited

Langauge for unlimited deferrals

stringDeferral Dialog Unlimited Deferrals
display_string_deferral_selecttitle

Langauge for deferral select title

stringDeferral Dialog Select Title
display_string_deferraldeadline_button1

Deferral Deadline Dialog button1

stringDeadline Dialog Button 1
display_string_deferraldeadline_button2

Deferral Deadline Dialog button2

stringDeadline Dialog Button 2
display_string_deferraldeadline_infobox

Deferral Deadline Dialog infbox

stringDeadline Dialog infobox
display_string_deferraldeadline_message_deadline

Deferral Deadline Dialog Message

stringDeadline Dialog Message
display_string_patching_button1

Patching Dialog button1

stringPatching Dialog Button 1
display_string_patching_checking

Patching Dialog Checking

stringPatching Dialog Checking
display_string_patching_progress

Patching Dialog Progress

stringPatching Dialog Progress
display_string_patching_infobox_computer_name

Patching Dialog Infobox Computer Name

stringPatching Dialog Infobox Computer Name
display_string_patching_infobox_macos_version

Patching Dialog Infobox macOS Version

stringPatching Dialog Infobox macOS Version
display_string_patching_infobox_updates

Patching Dialog infobox updates

stringPatching Dialog infobox updates
display_string_patching_message

Patching Dialog Message

stringPatching Dialog Message
display_string_complete_progress

Patching Complete Progress Message

stringPatching Complete Progress Message
display_string_uptodate_button1

All Apps Up To Date Button 1

stringAll Apps Up To Date Button 1
display_string_uptodate_message

All Apps Up To Date Message

stringAll Apps Up To Date Message
display_string_help_message_intro

Help Message - Intro

stringHelp Message - Intro
display_string_help_message_telephone

Help Message - Telephone

stringHelp Message - Telephone
display_string_help_message_email

Help Message - Email

stringHelp Message - Email
display_string_help_message_help_website

Help Message - Help Website

stringHelp Message - Help Website
display_string_help_message_computer_info

Help Message - Computer Info

stringHelp Message - Computer Info
display_string_help_message_operating_system

Help Message - Operating System

stringHelp Message - Operating System
display_string_help_message_serial

Help Message - Serial Number

stringHelp Message - Serial Number
display_string_help_message_dialog

Help Message - Dialog

stringHelp Message - Dialog
display_string_help_message_started

Help Message - Started

stringHelp Message - Started
display_string_help_message_script_version

Help Message - Script Version

stringHelp Message - Script Version