-
Notifications
You must be signed in to change notification settings - Fork 24
Customizing Icons and Messaging
Baseline v1.1+ supports custom icons and messaging for all SwiftDialog windows. Any SwiftDialog option can be passed to any of the three main SwiftDialog windows that Baseline calls by including your desired options in the configuration profile.
While any SwiftDialog feature can theoretically be used, there are some options that obviously don't make sense in context. For instance: Don't try to use
--notification
or--checkbox
in the Baseline SwiftDialog windows.
- The "Dialog List Window"
- This is the window that displays each step that Baseline is processing along with the status of that item.
- The "Dialog Success Window"
- This is the window that displays when Baseline completes and there were no failed items.
- The "Dialog Failure Window"
- This is the window that displays when Baseline completes and there were one or more failed items.
- This is another List View window that will show the "Display Name" of any item that failed to run.
There is one MDM key for each SwiftDialog window, and your desired options can be configured as a <string>
for that respective key.
DialogListOptions
DialogSuccessOptions
DialogFailureOptions
You can pass any supported SwiftDialog options for these keys. You can customize one or all of the default options, simply by including your chosen customization in the string.
- In the following example, we will change the Title and add an Overlay Icon for the List Dialog window, but leave the other options (like
--message
and--icon
) at the Baseline default values. We will also use a custom icon for the Failure window:
<key>DialogListOptions</key>
<string>--title "This is a Custom Title" --overlayicon "/System/Applications/System Settings.app"</string>
<key>DialogFailureOptions</key>
<string>--icon "SF=desktopcomputer.trianglebadge.exclamationmark,color=red"</string>
- Configure your options exactly as you would when calling SwiftDialog from the command line. Remember to quote any file paths or strings that contain spaces (like your title or message values.)
- Please specify your file paths for features like
--icon
or--background
or--bannerimage
carefully. In some cases, an invalid file path will result in SwiftDialog not being able to draw the window and Baseline will exit.
- Please specify your file paths for features like
- The new keys are entirely optional. If you choose not to include them, then the default branding and messaging will be used.
- Note that MobileConfig files and .plist files have some limitations on special characters (
&
for example), so you may want to avoid them and test your profiles install correctly.
Any value that is not customized in the configuration profile will fall back to it's default. The defaults are as follows:
--icon "/System/Library/CoreServices/KeyboardSetupAssistant.app/Contents/Resources/AppIcon.icns"
-
--blurscreen
- This option cannot be disabled without editing the script directly to remove it.
--title "Your computer setup is underway"
--message "Feel free to step away, this could take 30 minutes or more. \n\nYour computer will restart when it's ready for use."
--width 900
--height 550
--quitkey ']'
--title "Your computer setup is complete"
-
--timer 120
- This option is only included by default if
Restart
istrue
.
- This option is only included by default if
-
--message "Your device needs to restart before you can begin use."
- This is used if
Restart
istrue
.
- This is used if
-
--message "Your device is ready for you."
- This is used if
Restart
isfalse
.
- This is used if
-
--button1text "Restart Now"
- This is used if
Restart
istrue
.
- This is used if
-
--button1text "Ok"
- This is used if
Restart
isfalse
.
- This is used if
--title "Your computer setup is complete"
--message "Your computer setup is complete, however not everything was installed as expected. Review the list below, and contact IT if you need assistance."
--height 550
-
--button1text "Restart Now"
- This is used if
Restart
istrue
.
- This is used if
-
--button1text "Ok"
- This is used if
Restart
isfalse
.
- This is used if
- Mosyle
- JumpCloud
- Addigy
- SimpleMDM
- FileWave
- Workspace ONE
- Jamf Pro
- Microsoft Intune
- Kandji (Need contributions!)
- Hexnode (Need contributions!)
- Jamf School (Need contributions!)