App Auto-Patch
xyz.techitout.appAutoPatch
This will configure the settings for the App Auto-Patch tool
Configuration Keys (52)
| Key | Type | Title |
|---|---|---|
PFC_SegmentedControl_0required | string | — |
DaysUntilResetThe number of days after the patching cadence start date (Zero Date) that the patching complete status will reset from TRUE to FALSE | string | Days Until Reset |
PatchWeekStartDayThe 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) | integer | Patch Week Start Day |
DeadlineCountFocusThe 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 | string | Focus Count Deadline |
DeadlineCountHardThe maximum number of user selected deferrals allowed before App Auto-Patch will no longer allow deferrals and will automatically patch when the timer expires | string | Hard Count Deadline |
DeadlineDaysFocusThe 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 | string | Focus Days Deadline |
DeadlineDaysHardThe maximum number of days deferrals allowed before App Auto-Patch will no longer allow deferrals and will automatically patch when the timer expires | string | Hard Days Deadline |
DeferralTimerDefaultThe number of minutes to defer until the next update workflow attempt if a user choses not install updates | string | Deferral Timer Default |
DeferralTimerErrorThe number of minutes to defer if AAP detects an error in the workflow | string | Deferral Timer Error |
DeferralTimerFocusThe 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 | string | Deferral Timer Focus |
DeferralTimerMenuDisplay a deferral time pop-up menu in the non-deadline install dialog that allows the user to override the Deferral Timer Default timer | string | Deferral Timer Menu |
DeferralTimerWorkflowRelaunchAmount 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 | string | Deferral Timer Workflow Relaunch |
MonthlyPatchingCadenceEnabled | boolean | Monthly Patching Cadence Enabled |
MonthlyPatchingCadenceOrdinalValueWeek 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) | string | Monthly Patching Cadence Ordinal Value |
MonthlyPatchingCadenceWeekdayIndexDay of the week you want AAP to be scheduled Range: Sunday (sunday), Monday (monday), Tuesday (tuesday), Wednesday (wednesday), Thursday (thursday), Friday (friday), Saturday (saturday) | string | Monthly Patching Cadence Weekday Index |
MonthlyPatchingCadenceStartTimeLocal time you want AAP to be scheduled | string | Monthly Patching Cadence Start Time |
ZoomCallActiveCheckWhen enabled, AAP will automatically skip updating Zoom if a call is active | boolean | Zoom Call Active Check |
DialogOnTopForces the AAP dialogs to stay on top of all other windows Range: Force Dialog On Top (TRUE), Do Not Force Dialog On Top (FALSE) | string | Dialog On Top |
DialogTimeoutDeferralTime given to the user to respond to deferral prompt if enabled | integer | Deferral Dialog Timeout |
DialogTimeoutDeferralActionWhat happens when the deferral timer expires Range: Defer after timer expires (Defer), Continue after timer expires (Continue) | string | Deferral Dialog Timeout Action |
UnattendedExitDeterines 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) | string | Unattended Exit |
UnattendedExitSecondsThe number of seconds the AAP dialog will automatically close if UnattendedExit is set to TRUE | integer | Unattended Exit Seconds |
UseOverlayIconToggles swiftDialog to use an overlay icon Range: Use Overlay Icon (TRUE), Do Not Use Overlay Icon (FALSE) | string | Use Overlay Icon |
DialogIconAllows you to set a custom icon for the dialog vs. the default Laptop/Desktop symbol | string | Dialog Icon |
IgnoredLabelsA space-separated list of Installomator labels to ignore for the AAP workflow. Supports wilddcards | string | Ignored Labels |
RequiredLabelsa space-separated list of Installomator labels that are required, regardless if the app is installed or or the latest version. Supports wildcards. | string | Required Labels |
OptionalLabelsA 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 | string | Optional Labels |
AppTitleAllows you to customize the name of App Auto-Patch to something else Default: "App Auto-Patch" | string | App Title |
ConvertAppsInHomeFolderThis 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) | string | Convert Apps In Home Folder |
IgnoreAppsInHomeFolderIgnore 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) | string | Ignore Apps In Home Folder |
InstallomatorOptionsA space-separated list of options to override default Installomator options (i.e., BLOCKING_PROCESS_ACTION=prompt_user NOTIFY=silent LOGO=appstore) | string | Installomator Options |
InstallomatorUpdateDisableThis 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) | string | Installomator Update Disable |
InstallomatorVersionDetermines 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 | string | Installomator Version |
InstallomatorVersionCustomRepoPathIf 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 | string | Installomator Version custom Repo Path |
InstallomatorVersionCustomBranchNameThe name of the branch you want to use in your custom repo, typically main. | string | Installomator Version Custom Branch Name |
InteractiveMode0 (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) | integer | Interactive Mode |
RemoveInstallomatorPathRemove Installomator after App Auto-Patch is completed Default: "FALSE" Range: Remove Installomator (TRUE), Do Not Remove Installomator (FALSE) | string | Remove Installomator Path |
SupportTeamNameFor the Support Team details that display in the Help Message | string | Support Team Name |
SupportTeamEmailFor the Support Team details that display in the Help Message | string | Support Team Email |
SupportTeamPhoneFor the Support Team details that display in the Help Message | string | Support Team Phone |
SupportTeamWebsiteFor the Support Team details that display in the Help Message | string | Support Team Website |
WebhookFeatureDetermines if Webhooks are sent when patching is completed Default: "FAILURES" Range: FALSE, ALL, FAILURES | string | Webhook Feature |
WebhookURLSlackThe Slack Webhook URL to use if WebhookFeature is set to TRUE | string | Slack Webhook URL |
WebhookURLTeamsThe Teams Webhook URL to use if WebhookFeature is set to TRUE | string | Teams Webhook URL |
WorkflowDisableAppDiscoveryDisables 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) | string | Disable App Discovery Workflow |
WorkflowDisableRelaunchDisable the automatic relaunch of AAP after the current workflow successfully completes Default: "FALSE" Range: Disable Automatic Relaunch (TRUE), Enable Automatic Relaunch (FALSE) | string | Disable Relaunch Workflow |
WorkflowInstallNowPatchingStatusActionDetermines if the Patching Completion Status is set to true when using the --workflow-install-now trigger Default: "SUCCESS" Range: NEVER, ALWAYS, SUCCESS | string | Workflow Install Now Patching Status Action |
SelfUpdateEnabledDetermines if the Self Update feature is enabled. this will automatically update App Auto-Patch if a new version is posted on github | boolean | Self Update Enabled |
SelfUpdateFrequencyThe frequency to check for updates to the App Auto-Patch script Range: Daily (daily), Weekly (weekly), Monthly (monthly) | string | Self Update Frequency |
versionComparisonMethodDetermines the version comparison method used when checking for updates Range: Is At Least (IS_AT_LEAST), Equal To (EQUAL_TO) | string | Version Comparison Method |
VersionComparisonInstallomatorFallbackWhen enabled, if version comparison fails, AAP will fall back to using Installomator for version checking Default: false | boolean | Version Comparison Installomator Fallback |
userInterfaceAll features related to how App Auto Patch defines the user interface. | dict | User Interface |
dialogElementsThe individual buttons and text elements that can be customized. This includes per country localization. | array | Dialog Elements |
| dict | dialogElements - Dictionary |
languageThe targeted language locale for the user interface. Note: For a list of locales, please run the following command in Terminal: /usr/bin/locale -a | string | Language |
display_string_defer_today_buttonLanguage for the defer button in dialogs when the deferral time is sometime today. | string | Defer Today Button |
display_string_defer_tomorrow_buttonLanguage for the defer button in dialogs when the deferral time is tomorrow | string | Defer Tomorrow Button |
display_string_defer_future_buttonLanguage for the defer button in dialogs when the deferral time is in the future. | string | Defer Future Button |
display_string_minutesLanguage for deferral timer durations - Minutes | string | Minutes Display String |
display_string_hourLanguage for deferral timer durations - Hour | string | Hour Display String |
display_string_hoursLanguage for deferral timer durations - Hours | string | Hours Display String |
display_string_andLanguage for deferral timer durations - and | string | and Display String |
display_string_daysLanguage for deferral timer durations - days | string | days Display String |
display_string_timesLanguage for deferral timer durations - times | string | times Display String |
display_string_there_areLanguage for deferral timer durations - There are | string | There are Display String |
display_string_discovery_messageLanguage for the message displayed during App Discovery | string | Discovery Message |
display_string_discovery_action_messageLanguage for the action message during App Discovery | string | Discovery action message |
display_string_discovery_progressLangauge for the progress message during App Discovery | string | Discovery progress message |
display_string_deferral_button1Language for Button1 of the Deferral Dialog | string | Deferral Dialog Button1 |
display_string_deferral_button2Language for Button1 of the Deferral Dialog | string | Deferral Dialog Button2 |
display_string_deferral_infobox1Langauge for part 1 of the infobox on the Deferral Dialog | string | Deferral Dialog Infobox part1 |
display_string_deferral_infobox2Langauge for part 2 of the infobox on the Deferral Dialog | string | Deferral Dialog Infobox part2 |
display_string_deferral_infobox3Langauge for part 3 of the infobox on the Deferral Dialog | string | Deferral Dialog Infobox part3 |
display_string_deferral_message_01Langauge for part 1 of the message on the Deferral Dialog | string | Deferral Dialog Message part 1 |
display_string_deferral_message_02Language for part 2 of the message on the Deferral Dialog | string | Deferral Dialog Message part 2 |
display_string_deferral_unlimitedLangauge for unlimited deferrals | string | Deferral Dialog Unlimited Deferrals |
display_string_deferral_selecttitleLangauge for deferral select title | string | Deferral Dialog Select Title |
display_string_deferraldeadline_button1Deferral Deadline Dialog button1 | string | Deadline Dialog Button 1 |
display_string_deferraldeadline_button2Deferral Deadline Dialog button2 | string | Deadline Dialog Button 2 |
display_string_deferraldeadline_infoboxDeferral Deadline Dialog infbox | string | Deadline Dialog infobox |
display_string_deferraldeadline_message_deadlineDeferral Deadline Dialog Message | string | Deadline Dialog Message |
display_string_patching_button1Patching Dialog button1 | string | Patching Dialog Button 1 |
display_string_patching_checkingPatching Dialog Checking | string | Patching Dialog Checking |
display_string_patching_progressPatching Dialog Progress | string | Patching Dialog Progress |
display_string_patching_infobox_computer_namePatching Dialog Infobox Computer Name | string | Patching Dialog Infobox Computer Name |
display_string_patching_infobox_macos_versionPatching Dialog Infobox macOS Version | string | Patching Dialog Infobox macOS Version |
display_string_patching_infobox_updatesPatching Dialog infobox updates | string | Patching Dialog infobox updates |
display_string_patching_messagePatching Dialog Message | string | Patching Dialog Message |
display_string_complete_progressPatching Complete Progress Message | string | Patching Complete Progress Message |
display_string_uptodate_button1All Apps Up To Date Button 1 | string | All Apps Up To Date Button 1 |
display_string_uptodate_messageAll Apps Up To Date Message | string | All Apps Up To Date Message |
display_string_help_message_introHelp Message - Intro | string | Help Message - Intro |
display_string_help_message_telephoneHelp Message - Telephone | string | Help Message - Telephone |
display_string_help_message_emailHelp Message - Email | string | Help Message - Email |
display_string_help_message_help_websiteHelp Message - Help Website | string | Help Message - Help Website |
display_string_help_message_computer_infoHelp Message - Computer Info | string | Help Message - Computer Info |
display_string_help_message_operating_systemHelp Message - Operating System | string | Help Message - Operating System |
display_string_help_message_serialHelp Message - Serial Number | string | Help Message - Serial Number |
display_string_help_message_dialogHelp Message - Dialog | string | Help Message - Dialog |
display_string_help_message_startedHelp Message - Started | string | Help Message - Started |
display_string_help_message_script_versionHelp Message - Script Version | string | Help Message - Script Version |