Menu Close

Display Message (0.0.8) via swiftDialog

| Dan K. Snelson

Leverage switftDialog and Jamf Pro Policy Script Parameters to easily display engaging end-user messages

Introduction

Using Bart Reardon’s swiftDialog and Jamf Pro Policy Script Parameters, creating engaging end-user messages is easy.

When you really want to get your user’s attention, one of my favorite options is --blurscreen, which “will blur the background of the display while dialog is showing.”

Configuration

Complete the following steps to display engaging messages to your users with swiftDialog.

A. Conduct a dry-run of the Display Message with swiftDialog script

Complete the following steps on an enrolled, testing Mac.

  1. Open the macOS Terminal.
  2. Download the latest production version of Display Message with swiftDialog script using the following command. (The script will be saved to your Downloads folder as Display-Message-via-Dialog-reference.bash): 
curl -o ~/Downloads/Display-Message-via-Dialog-reference.bash https://raw.githubusercontent.com/dan-snelson/dialog-scripts/main/Display%20Message/Display-Message-via-Dialog.bash
  1. Execute the Display Message with swiftDialog script (with elevated privileges) using the following command:
sudo bash ~/Downloads/Display-Message-via-Dialog-reference.bash
  1. Review the dialog’s various parameters:
    • Title [Parameter 4]
    • Message [Parameter 5]
    • Icon [Parameter 6]
    • Button 1 (i.e., OK) [Parameter 7]
    • Button 2 (i.e., quit) [Parameter 8]
    • Button 3 (i.e., infobutton) [Parameter 9]
    • Extra Flags (i.e., --moveable --timer 75 --position topright --blurscreen) [Parameter 10]
  2. Click Button 2 [Parameter 8] (i.e., quit) and observe the output in Terminal
% sudo bash ~/Downloads/Display-Message-via-Dialog-reference.bash 
2023-03-30 06:27:35 - 

###
# Display Message via swiftDialog (0.0.8)
###

2023-03-30 06:27:35 - PRE-FLIGHT CHECK: Initiating …
2023-03-30 06:27:35 - PRE-FLIGHT CHECK: macOS 13 installed; proceeding ...
2023-03-30 06:27:35 - PRE-FLIGHT CHECK: swiftDialog version 2.1.0.4148 found; proceeding...
2023-03-30 06:27:35 - Either Parameter 4 or Parameter 5 are NOT populated; displaying instructions …
2023-03-30 06:27:35 - Title: Title [Parameter 4] goes here
2023-03-30 06:27:35 - Message: ### Message [Parameter 5] goes here  

- [Dialog](https://github.com/bartreardon/swiftDialog) v`2.1.0.4148`  
- [Display Message via swiftDialog](https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/) v`0.0.8`  
- Displaying with the following `extraflags`:  

`--width 825 --height 400 --moveable --timer 75 --position topright --blurscreen --titlefont size=26 --messagefont size=13 --iconsize 125 --overlayicon /var/tmp/overlayicon.icns --quitoninfo`  

Thank you, [Bart Reardon](https://www.buymeacoffee.com/bartreardon), for making `swiftDialog`!  

---

**Note:** Please review this [blog post](https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/) for additional information.
2023-03-30 06:27:35 - Extra Flags: --width 825 --height 400 --moveable --timer 75 --position topright --blurscreen --titlefont size=26 --messagefont size=13 --iconsize 125 --overlayicon /var/tmp/overlayicon.icns --quitoninfo
2023-03-30 06:27:40 - Return Code: 2
dan clicked Button 2 [Parameter 8]
2023-03-30 06:27:40 - dan clicked Button 2 [Parameter 8];
2023-03-30 06:27:40 - Quitting …
2023-03-30 06:27:41 - Exiting …
2023-03-30 06:27:41 - Removing /var/tmp/dialogWelcomeLog.PCj …
2023-03-30 06:27:41 - Removing /var/tmp/overlayicon.icns …
2023-03-30 06:27:41 - Goodbye!
  1. Use your favorite editor to review ~/Downloads/Display-Message-via-Dialog-reference.bash
    • Observe that with version 0.0.8, the overlay icon (which defaults to your custom Self Service icon) is now available via --overlayicon /var/tmp/overlayicon.icns as an item in extraflags (Parameter 10).
B. Add the Display Message with swiftDialog script to your Jamf Pro server
  1. Add the Display Message via swiftDialog script to your Jamf Pro server
  2. Edit --infobuttonaction to the correct URL for your organization
  3. Specify the following for Options > Parameter Labels
    • Parameter 4: Title
    • Parameter 5: Message
    • Parameter 6: Icon (Absolute Path; leave blank to display Self Service's icon)
    • Parameter 7: Button 1 Text (i.e., Details)
    • Parameter 8: Button 2 Text (i.e., Close)
    • Parameter 9: Info Button Text (i.e., KB8675309)
    • Parameter 10: Extra Flags (i.e., --iconsize 128 --timer 120 --blurscreen --quitoninfo --overlayicon /var/tmp/overlayicon.icns )
    • Parameter 11: Action (i.e., jamfselfservice://content?entity=policy&id=39&action=view )
  4. Click Save

Latest version availble on GitHub.

#!/bin/bash

####################################################################################################
#
# Display Message via swiftDialog
#
# Purpose: Displays an end-user message via swiftDialog
# See: https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/
#
####################################################################################################
#
# HISTORY
#
# Version 0.0.1, 18-Feb-2022, Dan K. Snelson (@dan-snelson)
#   Original version
#
# Version 0.0.2, 06-Apr-2022, Dan K. Snelson (@dan-snelson)
#   Default icon to Jamf Pro Self Service if not specified
#
# Version 0.0.3, 19-Oct-2022, Dan K. Snelson (@dan-snelson)
#   Validate Operating System
#   Check for / install dialog (thanks, @acodega)
#   Added Client-side Script Logging
#   Changed Jamf Pro Script Parameters
#   - Friendly error message when Title or Message are not populated
#   - Changed Action (Parameter 11) to be optional (thanks for the idea, @eosrebel!)
#
# Version 0.0.4, 03-Nov-2022, Dan K. Snelson (@dan-snelson)
#   Reverted `action` code to version 0.0.2
#
# Version 0.0.5, 05-Dec-2022, Dan K. Snelson (@dan-snelson)
#   Added `returncode` of `20` for "Do Not Disturb"
#
# Version 0.0.6, 28-Dec-2022, Dan K. Snelson (@dan-snelson)
#   - Hard-code `overlayicon` to use Self Service's icon (to help overcome the inability to include
#     spaces in Jamf Pro Script Parameters)
#
# Version 0.0.7, 21-Mar-2023, Dan K. Snelson (@dan-snelson)
#   - Overlayicon can now be included via: `--overlayicon /var/tmp/overlayicon.icns`
#   - Updates from Setup Your Mac code
#   - Revised default dialog instructions
#
# Version 0.0.8, 30-Mar-2023, Dan K. Snelson (@dan-snelson)
#   - Updated default dialog instructions to include an `action`
#
####################################################################################################



####################################################################################################
#
# Variables
#
####################################################################################################

scriptVersion="0.0.8"
scriptLog="/var/tmp/org.churchofjesuschrist.log"
export PATH=/usr/bin:/bin:/usr/sbin:/sbin
loggedInUser=$( echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ { print $3 }' )
osVersion=$( sw_vers -productVersion )
osMajorVersion=$( echo "${osVersion}" | awk -F '.' '{print $1}' )
dialogBinary="/usr/local/bin/dialog"
dialogMessageLog=$( mktemp /var/tmp/dialogWelcomeLog.XXX )
if [[ -n ${4} ]]; then titleoption="--title"; title="${4}"; fi
if [[ -n ${5} ]]; then messageoption="--message"; message="${5}"; fi
if [[ -n ${6} ]]; then iconoption="--icon"; icon="${6}"; fi
if [[ -n ${7} ]]; then button1option="--button1text"; button1text="${7}"; fi
if [[ -n ${8} ]]; then button2option="--button2text"; button2text="${8}"; fi
if [[ -n ${9} ]]; then infobuttonoption="--infobuttontext"; infobuttontext="${9}"; fi
extraflags="${10}"
action="${11}"

# Create `overlayicon` from Self Service's custom icon (thanks, @meschwartz!)
xxd -p -s 260 "$(defaults read /Library/Preferences/com.jamfsoftware.jamf self_service_app_path)"/Icon$'\r'/..namedfork/rsrc | xxd -r -p > /var/tmp/overlayicon.icns
overlayicon="/var/tmp/overlayicon.icns"

# Default icon to Jamf Pro Self Service if not specified
if [[ -z ${icon} ]]; then
    iconoption="--icon"
    icon="/var/tmp/overlayicon.icns"
fi



####################################################################################################
#
# Pre-flight Checks
#
####################################################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Pre-flight Check: Client-side Logging
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

if [[ ! -f "${scriptLog}" ]]; then
    touch "${scriptLog}"
fi



# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Pre-flight Check: Client-side Script Logging Function
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

function updateScriptLog() {
    echo -e "$( date +%Y-%m-%d\ %H:%M:%S ) - ${1}" | tee -a "${scriptLog}"
}


# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Pre-flight Check: Logging Preamble
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

updateScriptLog "\n\n###\n# Display Message via swiftDialog (${scriptVersion})\n###\n"
updateScriptLog "PRE-FLIGHT CHECK: Initiating …"



# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Pre-flight Check: Validate Operating System
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

if [[ "${osMajorVersion}" -ge 11 ]] ; then
    updateScriptLog "PRE-FLIGHT CHECK: macOS ${osMajorVersion} installed; proceeding ..."
else
    updateScriptLog "PRE-FLIGHT CHECK: macOS ${osVersion} installed; exiting."
    osascript -e 'display dialog "Display Message via swiftDialog ('"${scriptVersion}"')\rby Dan K. Snelson (https://snelson.us)\r\rmacOS '"${osVersion}"' installed; macOS Big Sur 11\r(or later) required" buttons {"OK"} with icon caution with title "Display Message via swiftDialog: Error"'
    exit 1
fi



# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Pre-flight Check: Validate / install swiftDialog (Thanks big bunches, @acodega!)
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

function dialogCheck() {

    # Get the URL of the latest PKG From the Dialog GitHub repo
    dialogURL=$(curl --silent --fail "https://api.github.com/repos/bartreardon/swiftDialog/releases/latest" | awk -F '"' "/browser_download_url/ && /pkg\"/ { print \$4; exit }")

    # Expected Team ID of the downloaded PKG
    expectedDialogTeamID="PWA5E9TQ59"

    # Check for Dialog and install if not found
    if [ ! -e "/Library/Application Support/Dialog/Dialog.app" ]; then

        updateScriptLog "PRE-FLIGHT CHECK: Dialog not found. Installing..."

        # Create temporary working directory
        workDirectory=$( /usr/bin/basename "$0" )
        tempDirectory=$( /usr/bin/mktemp -d "/private/tmp/$workDirectory.XXXXXX" )

        # Download the installer package
        /usr/bin/curl --location --silent "$dialogURL" -o "$tempDirectory/Dialog.pkg"

        # Verify the download
        teamID=$(/usr/sbin/spctl -a -vv -t install "$tempDirectory/Dialog.pkg" 2>&1 | awk '/origin=/ {print $NF }' | tr -d '()')

        # Install the package if Team ID validates
        if [[ "$expectedDialogTeamID" == "$teamID" ]]; then

            /usr/sbin/installer -pkg "$tempDirectory/Dialog.pkg" -target /
            sleep 2
            dialogVersion=$( /usr/local/bin/dialog --version )
            updateScriptLog "PRE-FLIGHT CHECK: swiftDialog version ${dialogVersion} installed; proceeding..."

        else

            # Display a so-called "simple" dialog if Team ID fails to validate
            osascript -e 'display dialog "Please advise your Support Representative of the following error:\r\r• Dialog Team ID verification failed\r\r" with title "Setup Your Mac: Error" buttons {"Close"} with icon caution'
            quitScript "1"

        fi

        # Remove the temporary working directory when done
        /bin/rm -Rf "$tempDirectory"

    else

        updateScriptLog "PRE-FLIGHT CHECK: swiftDialog version $(${dialogBinary} --version) found; proceeding..."

    fi

}

if [[ ! -e "/Library/Application Support/Dialog/Dialog.app" ]]; then
    dialogCheck
else
    updateScriptLog "PRE-FLIGHT CHECK: swiftDialog version $(${dialogBinary} --version) found; proceeding..."
fi



####################################################################################################
#
# Functions
#
####################################################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Quit Script (thanks, @bartreadon!)
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

function quitScript() {

    updateScriptLog "Quitting …"
    echo "quit:" >> "${dialogMessageLog}"

    sleep 1
    updateScriptLog "Exiting …"

    # Remove dialogMessageLog
    if [[ -f ${dialogMessageLog} ]]; then
        updateScriptLog "Removing ${dialogMessageLog} …"
        rm "${dialogMessageLog}"
    fi

    # Remove overlayicon
    if [[ -f ${overlayicon} ]]; then
        updateScriptLog "Removing ${overlayicon} …"
        rm "${overlayicon}"
    fi

    updateScriptLog "Goodbye!"
    exit "${1}"

}



####################################################################################################
#
# Program
#
####################################################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Validate Script Parameters
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

if [[ -z "${title}" ]] || [[ -z "${message}" ]]; then

    updateScriptLog "Either Parameter 4 or Parameter 5 are NOT populated; displaying instructions …"

    extraflags="--width 825 --height 400 --moveable --timer 75 --position topright --blurscreen --titlefont size=26 --messagefont size=13 --iconsize 125 --overlayicon /var/tmp/overlayicon.icns --quitoninfo"

    titleoption="--title"
    title="Title [Parameter 4] goes here"

    messageoption="--message"
    message="### Message [Parameter 5] goes here  \n\n- [Dialog](https://github.com/bartreardon/swiftDialog) v\`$(${dialogBinary} --version)\`  \n- [Display Message via swiftDialog](https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/) v\`${scriptVersion}\`  \n- Displaying with the following \`extraflags\`:  \n\n\`${extraflags}\`  \n\nThank you, [Bart Reardon](https://www.buymeacoffee.com/bartreardon), for making \`swiftDialog\`!  \n\n---\n\n**Note:** Please review this [blog post](https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/) for additional information."

    button1option="--button1text"
    button1text="Button 1 [Parameter 7]"

    button2option="--button2text"
    button2text="Button 2 [Parameter 8]"

    infobuttonoption="--infobuttontext"
    infobuttontext="Infobutton [Paramter 9]"

    action="https://snelson.us/2023/03/display-message-0-0-7-via-swiftdialog/"

else

    updateScriptLog "Both \"title\" and \"message\" Parameters are populated; proceeding ..."

fi



# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Display Message: Dialog
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

updateScriptLog "Title: ${title}"
updateScriptLog "Message: ${message}"
updateScriptLog "Extra Flags: ${extraflags}"

# shellcheck disable=SC2086
${dialogBinary} \
    ${titleoption} "${title}" \
    ${messageoption} "${message}" \
    ${iconoption} "${icon}" \
    ${button1option} "${button1text}" \
    ${button2option} "${button2text}" \
    ${infobuttonoption} "${infobuttontext}" \
    --infobuttonaction "https://servicenow.company.com/support?id=kb_article_view&sysparm_article=${infobuttontext}" \
    --messagefont "size=14" \
    --commandfile "$dialogMessageLog}" \
    ${extraflags}

returncode=$?
updateScriptLog "Return Code: ${returncode}"

case ${returncode} in

    0)  ## Process exit code 0 scenario here
        echo "${loggedInUser} clicked ${button1text}"
        updateScriptLog "${loggedInUser} clicked ${button1text};"
        if [[ -n "${action}" ]]; then
            su - "${loggedInUser}" -c "open \"${action}\""
        fi
        quitScript "0"
        ;;

    2)  ## Process exit code 2 scenario here
        echo "${loggedInUser} clicked ${button2text}"
        updateScriptLog "${loggedInUser} clicked ${button2text};"
        quitScript "0"
        ;;

    3)  ## Process exit code 3 scenario here
        echo "${loggedInUser} clicked ${infobuttontext}"
        updateScriptLog "${loggedInUser} clicked ${infobuttontext};"
        ;;

    4)  ## Process exit code 4 scenario here
        echo "${loggedInUser} allowed timer to expire"
        updateScriptLog "${loggedInUser} allowed timer to expire;"
        ;;

    20) ## Process exit code 20 scenario here
        echo "${loggedInUser} had Do Not Disturb enabled"
        updateScriptLog "${loggedInUser} had Do Not Disturb enabled"
        quitScript "0"
        ;;

    *)  ## Catch all processing
        echo "Something else happened; Exit code: ${returncode}"
        updateScriptLog "Something else happened; Exit code: ${returncode};"
        quitScript "${returncode}"
        ;;

esac

updateScriptLog "End-of-line."

quitScript "0"
C. Create a Jamf Pro Policy to display an end-user message
  1. Create a new Jamf Pro Policy, using the following as a guide for Options > General:
    • Set Display Name to macOS Sonoma 14 Installer Notification
    • Set Trigger to Recurring Check-in
    • Set Execution Frequency to the desired value
  2. Select the Scripts payload and add the Display Message via swiftDialog script
  3. Specify the Parameter Values
    • Title: Upgrade to macOS Sonoma
    • Message: macOS Sonoma 14 \n\n### Come for the power. Stay for the fun. \n\nWith macOS Sonoma, work and play on your Mac are even more powerful. Elevate your presence on video calls. Access information in all-new ways. Boost gaming performance. And discover even more ways to personalize your Mac. \n\nClick Details to learn more before upgrading. \n\nIf you need assistance, please contact the Global Services Department, \n+1 (801) 555-1212, and mention KB0054571.
    • Icon: /Applications/Install macOS Sonoma.app
    • Button 1 Text: Details
    • Button 2 Text: Close
    • Info Button Text: KB008675309
    • Extra Flags: --timer 120 --blurscreen --quitoninfo --overlayicon /var/tmp/overlayicon.icns
    • Action: jamfselfservice://content?entity=policy&id=363&action=view
  4. Adjust Scope to your liking
  5. Click Save
Feature History

0.0.8 (30-Mar-2023)

  • Updated default dialog instructions to include an `action`

0.0.7 (21-Mar-2023)

  • Overlayicon can now be included via: --overlayicon /var/tmp/overlayicon.icns
  • Updates from Setup Your Mac code
  • Revised default dialog instructions

0.0.6 (28-Dec-2022)

  • Hard-code overlayicon to use Self Service’s icon (to help overcome the inability to include spaces in Jamf Pro Script Parameters)

0.0.5 (05-Dec-2022)

  • Added returncode of 20 for “Do Not Disturb”

0.0.4 (03-Nov-2022)

  • Reverted action code to version 0.0.2

0.0.3 (19-Oct-2022)

  • Validate Operating System
  • Check for / install dialog (thanks, acodega)
  • Added Client-side Script Logging
  • Changed Jamf Pro Script Parameters
    • Changed Action (Parameter 11) to be optional (thanks for the idea, eosrebel!)
    • Friendly error message when Title or Message are not populated (thanks, Bart. Two words: Rock. Star.)

0.0.2 (06-Apr-2022)

  • Default icon to Jamf Pro Self Service if not specified

0.0.1 (18-Feb-2022)

  • Original version
Posted in Jamf Pro, Scripts, Tips & Tricks
Tagged , ,

Related Posts