Display Customization
The display interface for super dialogs and notifications can be customized in a variety of ways to better suite your organizational requirements.
Note that options differ between interactive dialogs (that appear in the middle of the screen and are expecting a response from the user) and temporary notifications (that appear in the top right and dissmiss automatically). Detailed documentation regarding customizing other display behavior options (like adding dialog timeouts) can be found here, and customizing the display language can be found here.
Size in number of pixels for the icon in super dialogs and notifications.
Command option example:
--display-icon-size=128
Command option disable example:
--display-icon-size=X
Configuration profile example:
<key>DisplayIconSize</key>
<string>128</string>
This overrides the default display icon size which is set to 96 pixels. Any size less than 32 pixels or more than 150 pixels is rounded accordingly.
Local path or http(s) URL to an image file to replace the default System Settings (or System Preferences) icon in super dialogs and notifications.
Command option example:
--display-icon-file=/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns
Command option disable example:
--display-icon-file=X
Configuration profile example:
<key>DisplayIconFile</key>
<string>/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns</string>
If a local path or web URL can not be found then the default System Settings (or System Preferences) icon is used. Also, when deploying super using the command line, if the local path contains any special characters or spaces then you should surround the text with single ' quotes. However, when deploying super using a Jamf Pro Policy with Script Parameters do not use single quotes.
This option also specifies the failover display icon should there be an error with either the --display-icon-light-file or --display-icon-dark-file options.
A custom icon in an update dialog
Local path or http(s) URL to an image file to replace the default System Settings (or System Preferences) icon in super dialogs and notifications when the system appearance is in light mode.
Command option example:
--display-icon-light-file=/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns
Command option disable example:
--display-icon-light-file=X
Configuration profile example:
<key>DisplayIconLightFile</key>
<string>/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns</string>
If a local path or web URL can not be found or the system appearance mode cannot be determined, then the --display-icon-file option is used. Also, when deploying super using the command line, if the local path contains any special characters or spaces then you should surround the text with single ' quotes. However, when deploying super using a Jamf Pro Policy with Script Parameters do not use single quotes.
Local path or http(s) URL to an image file to replace the default System Settings (or System Preferences) icon in super dialogs and notifications when the system appearance is in dark mode.
Command option example:
--display-icon-dark-file=/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns
Command option disable example:
--display-icon-dark-file=X
Configuration profile example:
<key>DisplayIconDarkFile</key>
<string>/System/Library/CoreServices/Finder.app/Contents/Resources/Finder.icns</string>
If a local path or web URL can not be found or the system appearance mode cannot be determined, then the --display-icon-file option is used. Also, when deploying super using the command line, if the local path contains any special characters or spaces then you should surround the text with single ' quotes. However, when deploying super using a Jamf Pro Policy with Script Parameters do not use single quotes.
Most interactive dialogs (not the insufficient storage or power required dialogs) can be easily customized via several display accessory options. The display accessory content appears below any deferral or deadline text but above any interactive item like the deferral pop-up menu or user authentication field.
Display accessory content can accept custom; plain text, Markdown formated text, html formated text, image, or video content. As shown in the example screenshots, HTML-based display accessories can be shown with or without a white bounding box. The plain text display accessory must always show a bounding box, while image and video display accessories do not have the option to show a white bounding box.
If you are using both a display accessory and a dialog timeout option at the same time, a limitation of IBM Notifier prevents the timeout countdown from being displayed in the dialog. However, the timeout still expires in the specified time.
An HTML display accessory in an update dialog
An HTML display accessory with bounding box in an update dialog
Specifying a display accessory requires at least two separate options. The first required display accessory option is the --display-accessory-type option which accepts a single word string that defines the file type of the display accessory content.
Command option example:
--display-accessory-type=TEXTBOX
Command option disable example:
--display-accessory-type=X
Configuration profile example:
<key>DisplayAccessoryType</key>
<string>TEXTBOX</string>
There can only be one display accessory type for all dialogs. The following display accessory types are supported:
-
Plain text or Markdown formated text in a white bounding box inside the dialogs:
--display-accessory-type=TEXTBOX -
HTML formated text in a white bounding box inside the dialog:
--display-accessory-type=HTMLBOX -
HTML formated text with a "blank" background as if part of the dialogs:
--display-accessory-type=HTML -
Display an image inside the dialogs:
--display-accessory-type=IMAGE -
Display a paused video inside the dialogs:
--display-accessory-type=VIDEO -
Display an auto-playing video inside the dialogs:
--display-accessory-type=VIDEOAUTO
The second required display accessory option specifies a local path or web URL to a file with the content to be shown in dialogs.
Command option example for local path:
--display-accessory-default-file=/Library/Management/Dialog.html
Command option example for URL:
--display-accessory-default-file=https://example.com/Dialog.html
Command option disable example:
--display-accessory-default-file=X
Configuration profile example for URL:
<key>DisplayAccessoryDefaultFile</key>
<string>https://example.com/Dialog.html</string>
Configuration profile example for local path:
<key>DisplayAccessoryDefaultFile</key>
<string>/Library/Management/Dialog.html</string>
There are multiple display accessory content path options available if you want to show different content for specific workflow targets:
-
The default display accessory content unless otherwise specified by another workflow target option:
--display-accessory-default-file=/local/path or URL -
Display accessory content when the workflow target is a macOS updates:
--display-accessory-macos-minor-update-file=/local/path or URL -
Display accessory content when the workflow target is a macOS upgrades:
--display-accessory-macos-major-upgrade-file=/local/path or URL -
Display accessory content when the workflow target is a non-system Apple software updates upgrades:
--display-accessory-non-system-updates-file=/local/path or URL -
Display accessory content when the workflow target is a Jamf Pro Policy Triggers upgrades:
--display-accessory-jamf-policy-triggers-file=/local/path or URL -
Display accessory content when the workflow target is to forcibly restarting the computer without updates upgrades:
--display-accessory-restart-without-updates-file=/local/path or URL
If a local path or web URL can not be found then the display accessory is not shown. Also, when deploying super using the command line, if the local path contains any special characters or spaces then you should surround the text with single ' quotes. However, when deploying super using a Jamf Pro Policy with Script Parameters do not use single quotes.
The Super-Friends folder contains several display accessory example files.
A plain text string or URL to open when the user clicks the help button (question mark icon) or the warning button (exclamation mark icon) in all interactive dialogs (but not notifications).
Command option examples for text:
--display-help-button-string='For assistance please contact 555-123-4567'
--display-warning-button-string='For assistance please contact 555-123-4567'
Command option examples for URL:
--display-help-button-string=https://support.apple.com/en-us/HT201222
--display-warning-button-string=https://support.apple.com/en-us/HT201222
Command option disable examples:
--display-help-button-string=X
--display-warning-button-string=X
Configuration profile examples for text:
<key>DisplayHelpButtonString</key>
<string>For assistance please contact 555-123-4567</string>
<key>DisplayWarningButtonString</key>
<string>For assistance please contact 555-123-4567</string>
Configuration profile examples for URL:
<key>DisplayHelpButtonString</key>
<string>https://support.apple.com/en-us/HT201222</string>
<key>DisplayWarningButtonString</key>
<string>https://support.apple.com/en-us/HT201222</string>
You can specify just one button or both help and warning buttons at the same time. If you specify a plain text string then a pop-up appears when the user selects a button. Conversely, if you specify a URL it opens in the appropriate default helper application. Supported URL types are; http://, https://, mailto:, and jamfselfservice://.
If a web URL cannot be found then the button is not shown. Also, when deploying super using the command line, if the local path contains any special characters or spaces then you should surround the text with single ' quotes. However, when deploying super using a Jamf Pro Policy with Script Parameters do not use single quotes.
The help button in an update dialog
The warning button in an update dialog
