Notify Script Commands

Jamf Connect Documentation
Solution
Application
Jamf Connect
Content Type
Technical Documentation
Utilities & Services
ft:locale
en-US

General Commands

The following commands are commonly used to display the notify screen and shown in the figure below.
Image of commands commonly used to display the notify screen.
Image:

This command replaces the default notify image with an image at a specified path. The image will automatically scale to the correct size.

Example:

Command: Image: /tmp/logo.png

MainText:
This command changes the main text displayed to users.
Example:

Command: MainText: Please wait while your new MacBook Pro is set up.

MainTextImage:

This command replaces the main text with a custom icon at a specified path. Images can be up to 660 x 105 pixels and scale proportionally to fit.

Example:

Command: MainTextImage: /tmp/logo.png

MainTitle:

This command changes the main title displayed to users.

Example:

Command: MainTitle: Welcome to your new MacBook Pro

Interactive Commands

Interactive commands are used to customize the user interaction during the notify process and shown in the figure below.
Determinate:
This command sets the progress bar to be "determinate", progress in steps, instead of displaying a spinning bar. You must specify the number of steps you want to use during the notify process. Once set, every status update in your script will increment the bar by one stage.
Example:

Command: Determinate: 5

DeterminateManual:
This command sets the progress bar to be determinate and progress manually rather than with stage commands. You must specify the number of steps you want during the notify process. Once set, you must manually progress the status bar using the DeterminateManualStep: command.
Example:

Command: DeterminateManual: 5

DeterminateManualStep:
When in DeterminateManual: mode, this command will advance the progress bar by one step or a specified interval. The example below moves the progress bar by two steps.
Example:

Command: DeterminateManualStep: 2

DeterminateOff:
This command disables the determinate state for the progress bar. Steps that already occurred remain completed in the progress bar. This allows you to move between a determinate state and non-determinate state without losing your progress.
Example:

Command: DeterminateOff:

DeterminateOffReset:
After turning off the determinate state of the progress bar, you must reset it to zero.
Example:

Command: DeterminateOffReset:

Quit
This command quits the notify process.
Example:

Command: Quit

You can use echo Status: to update users on the notify process. The following is an example of a status update:

 Status: Installing Jamf
Note:

If the Determinate: command is used, the progress bar increments with each status update.

If you use Jamf Pro, you can also configure the notify screen to read and display policy logs from Jamf Pro to users instead by configuring the Notify Screen Log Style (NotifyLogStyle) setting to the value jamf.