Skip to content

optionalFeatures

Jump to bottom Edit New page
colorenz edited this page Jun 4, 2022 · 77 revisions

acceptableApplicationBundleIDs - Type: Array, Default Value: [], Required: No

Disables Nudge's re-activation logic for the listed applications. If one of the specified applications is foremost, Nudge will not reactivate itself. (This feature does not work for Nudge's initial activation.)

  • Xcode is forced added to the acceptableApplicationsList when Nudge is running in debug mode.

The application names using assertions which Nudge allows without taking focus. You can specify one or more applications. To find the names please run /usr/bin/pmset -g assertions in Terminal while the application is open and running.

For example this would be: us.zoom.xos com.microsoft.Word

v1.1.7 and higher only

acceptableAssertionUsage - Type: Boolean, Default Value: False, Required: No

When enabled, Nudge will not activate or re-activate when assertions are currently set.

v1.1.7 and higher only

acceptableCameraUsage - Type: Boolean, Default Value: False, Required: No

When enabled, Nudge will not activate or re-activate when the camera is on.

v1.1.7 and higher only

acceptableScreenSharingUsage - Type: Boolean, Default Value: False, Required: No

When enabled, Nudge will not activate or re-activate when screen sharing is active.

v1.1.7 and higher only

aggressiveUserExperience - Type: Boolean, Default Value: True, Required: No

When disabled, Nudge will not hide all non-acceptableApplicationBundleIDs after the requiredInstallationDate or allowedDeferrals.

v1.1.0 and higher only

aggressiveUserFullScreenExperience - Type: Boolean, Default Value: True, Required: No

When disabled, Nudge will not create a blurred background when the user is passed the deferral window.

  • Defaulted to on.

v1.1.7 and higher only

asyncronousSoftwareUpdate (deprecated) - Type: Boolean, Default Value: True, Required: No

When disabled, Nudge will wait for Software Update to finish downloading (if any) updates before showing its UI.

v1.1.3 and lower only. Deprecated for asynchronousSoftwareUpdate

asynchronousSoftwareUpdate - Type: Boolean, Default Value: True, Required: No

When disabled, Nudge will wait for Software Update to finish downloading (if any) updates before showing its UI.

v1.1.4 and higher only

attemptToFetchMajorUpgrade - Type: Boolean, Default Value: True, Required: No

When disabled, Nudge will not attempt to download a major upgrade application via softwareupdate.

v1.1.4 and higher only

attemptToBlockApplicationLaunches - Type: Boolean, Default Value: false, Required: No

When enabled, Nudge will attempt to block application launches after the required installation date. This key must be used in conjunction with blockedApplicationBundleIDs .

v1.1.7 and higher only

blockedApplicationBundleIDs - Type: Array, Default Value: [], Required: No

The application Bundle ID which Nudge disallows from lauching after the required installation date. You can specify one or more Bundle ID.

For example this would be: us.zoom.xos com.microsoft.Word

v1.1.7 and higher only

disableSoftwareUpdateWorkflow - Type: Boolean, Default Value: False, Required: No

When enabled, Nudge will not attempt to download a minor update via softwareupdate.

v1.1.5 and higher only

See also: majorUpgradeAppPath

enforceMinorUpdates - Type: Boolean, Default Value: True, Required: No

When enabled, Nudge will enforce minor updates. This should likely never be disabled.

terminateApplicationsOnLaunch - Type: Boolean, Default Value: False, Required: No

When enabled, Nudge will terminate the applications listed in blockedApplicationBundleIDs upon initial launch.

Example (JSON)

{
  "optionalFeatures": {
    "acceptableApplicationBundleIDs": [
      "us.zoom.xos"
    ],
    "asynchronousSoftwareUpdate": true,
    "attemptToFetchMajorUpgrade": true,
    "enforceMinorUpdates": true
  },
}

Example (Mobile Configuration)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>PayloadContent</key>
    <array>
      <dict>
        <key>PayloadDescription</key>
        <string>Configures optionalFeatures preferences</string>
        <key>PayloadDisplayName</key>
        <string>Nudge Preferences</string>
        <key>PayloadIdentifier</key>
        <string>com.github.macadmins.Nudge.preferences.example.optionalFeatures</string>
        <key>PayloadOrganization</key>
        <string></string>
        <key>PayloadType</key>
        <string>com.github.macadmins.Nudge</string>
        <key>PayloadUUID</key>
        <string>CA02957C-7472-446B-9F77-3E0414405556</string>
        <key>PayloadVersion</key>
        <integer>1</integer>
        <key>optionalFeatures</key>
        <dict>
          <key>acceptableApplicationBundleIDs</key>
          <array>
            <string>us.zoom.xos</string>
          </array>
          <key>asynchronousSoftwareUpdate</key>
          <true/>
          <key>attemptToFetchMajorUpgrade</key>
          <true/>
          <key>enforceMinorUpdates</key>
          <true/>
        </dict>
      </dict>
    </array>
    <key>PayloadDescription</key>
    <string>Configures Nudge application</string>
    <key>PayloadDisplayName</key>
    <string>Nudge</string>
    <key>PayloadIdentifier</key>
    <string>com.github.macadmins.Nudge.example.optionalFeatures</string>
    <key>PayloadOrganization</key>
    <string>Nudge</string>
    <key>PayloadScope</key>
    <string>System</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>2F54F734-132D-4539-B583-F1DCF23DB5EB</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
  </dict>
</plist>
Add a custom footer
Home
Getting Started
Common Issues
New Features
User Deferrals
Command Line Arguments
Preferences
Jamf Pro Guide
Logging
Clone this wiki locally